ffb34e882a15551735ff1a5635fe11383af3e7dc
[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 . --- Also one for multiple option def headings be grouped in a single
81 . --- table (but without the split capability).
82
83 .macro otable
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .endmacro
86
87 .macro orow
88 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
89 .endmacro
90
91 .macro option
92 .arg 5
93 .oindex "&%$5%&"
94 .endarg
95 .arg -5
96 .oindex "&%$1%&"
97 .endarg
98 .otable
99 .orow "$1" "$2" "$3" "$4"
100 .endtable
101 .endmacro
102
103 .macro options
104 .eacharg
105 .oindex "&%$+1%&"
106 .endeach 4
107 .otable
108 .eacharg
109 .orow "$+1" "$+2" "$+3" "$+4"
110 .endeach 4
111 .endtable
112 .endmacro
113
114 . --- A macro for the common 2-column tables. The width of the first column
115 . --- is suitable for the many tables at the start of the main options chapter;
116 . --- a small number of other 2-column tables override it.
117
118 .macro table2 196pt 254pt
119 .itable none 0 0 2 $1 left $2 left
120 .endmacro
121
122
123 . --- A macro for a plain variable, including the .vitem and .vindex
124 .macro var
125 .vitem $1
126 .vindex $1
127 .endmacro
128
129 . --- A macro for a "tainted" marker, done as a one-element table
130 .macro tmark
131 .itable none 0 0 1 10pt left
132 .row &'Tainted'&
133 .endtable
134 .endmacro
135
136 . --- A macro for a tainted variable, adding a taint-marker
137 .macro tvar
138 .var $1
139 .tmark
140 .endmacro
141
142 . --- A macro for a cmdline option, including a .oindex
143 . --- 1st arg is the option name, undecorated (we do that here).
144 . --- 2nd arg, optional, text (decorated as needed) to be appended to the name
145 .macro cmdopt
146 .vitem  &%$1%&$=2+&~$2+
147 .oindex &%$1%&
148 .endmacro
149
150 . --- A macro that generates .row, but puts &I; at the start of the first
151 . --- argument, thus indenting it. Assume a minimum of two arguments, and
152 . --- allow up to four arguments, which is as many as we'll ever need.
153
154 .macro irow
155 .arg 4
156 .row "&I;$1" "$2" "$3" "$4"
157 .endarg
158 .arg -4
159 .arg 3
160 .row "&I;$1" "$2" "$3"
161 .endarg
162 .arg -3
163 .row "&I;$1" "$2"
164 .endarg
165 .endarg
166 .endmacro
167
168 . --- Macros for option, variable, and concept index entries. For a "range"
169 . --- style of entry, use .scindex for the start and .ecindex for the end. The
170 . --- first argument of .scindex and the only argument of .ecindex must be the
171 . --- ID that ties them together.
172 . --- The index entry points to the most-recent chapter head, section or subsection
173 . --- head, or list-item.
174
175 .macro cindex
176 &<indexterm role="concept">&
177 &<primary>&$1&</primary>&
178 .arg 2
179 &<secondary>&$2&</secondary>&
180 .endarg
181 &</indexterm>&
182 .endmacro
183
184 .macro scindex
185 &<indexterm role="concept" id="$1" class="startofrange">&
186 &<primary>&$2&</primary>&
187 .arg 3
188 &<secondary>&$3&</secondary>&
189 .endarg
190 &</indexterm>&
191 .endmacro
192
193 .macro ecindex
194 &<indexterm role="concept" startref="$1" class="endofrange"/>&
195 .endmacro
196
197 .macro oindex
198 &<indexterm role="option">&
199 &<primary>&$1&</primary>&
200 .arg 2
201 &<secondary>&$2&</secondary>&
202 .endarg
203 &</indexterm>&
204 .endmacro
205
206 . --- The index entry points to the most-recent chapter head, section or subsection
207 . --- head, or varlist item.
208
209 .macro vindex
210 &<indexterm role="variable">&
211 &<primary>&$1&</primary>&
212 .arg 2
213 &<secondary>&$2&</secondary>&
214 .endarg
215 &</indexterm>&
216 .endmacro
217
218 .macro index
219 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
220 .endmacro
221
222
223 . use this for a concept-index entry for a header line
224 .macro chindex
225 .cindex "&'$1'& header line"
226 .cindex "header lines" $1
227 .endmacro
228 . ////////////////////////////////////////////////////////////////////////////
229
230
231 . ////////////////////////////////////////////////////////////////////////////
232 . The <bookinfo> element is removed from the XML before processing for ASCII
233 . output formats.
234 . ////////////////////////////////////////////////////////////////////////////
235
236 .literal xml
237 <bookinfo>
238 <title>Specification of the Exim Mail Transfer Agent</title>
239 <titleabbrev>The Exim MTA</titleabbrev>
240 <date>
241 .fulldate
242 </date>
243 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
244 <authorinitials>EM</authorinitials>
245 <revhistory><revision>
246 .versiondatexml
247   <authorinitials>EM</authorinitials>
248 </revision></revhistory>
249 <copyright><year>
250 .copyyear
251            </year><holder>The Exim Maintainers</holder></copyright>
252 </bookinfo>
253 .literal off
254
255
256 . /////////////////////////////////////////////////////////////////////////////
257 . These implement index entries of the form "x, see y" and "x, see also y".
258 . However, the DocBook DTD doesn't allow <indexterm> entries
259 . at the top level, so we have to put the .chapter directive first.
260 . /////////////////////////////////////////////////////////////////////////////
261
262 .chapter "Introduction" "CHID1"
263
264 .macro seeother
265 .literal xml
266 <indexterm role="$2">
267   <primary>$3</primary>
268 .arg 5
269   <secondary>$5</secondary>
270 .endarg
271   <$1><emphasis>$4</emphasis></$1>
272 </indexterm>
273 .literal off
274 .endmacro
275
276 . NB: for the 4-arg variant the ordering is awkward
277 .macro see
278 .seeother see "$1" "$2" "$3" "$4"
279 .endmacro
280 .macro seealso
281 .seeother seealso "$1" "$2" "$3" "$4"
282 .endmacro
283
284 .see     variable "<emphasis>$1</emphasis>, <emphasis>$2</emphasis>, etc." "numerical variables"
285 .see     concept address        rewriting                       rewriting
286 .see     concept "Bounce Address Tag Validation"        BATV
287 .see     concept "Client SMTP Authorization"            CSA
288 .see     concept "CR character" "carriage return"
289 .see     concept CRL            "certificate revocation list"
290 .seealso concept de-tainting    "tainted data"
291 .see     concept delivery       "bounce message"                "failure report"
292 .see     concept dialup         "intermittently connected hosts"
293 .see     concept exiscan        "content scanning"
294 .see     concept fallover       fallback
295 .see     concept filter         "Sieve filter"                  Sieve
296 .see     concept headers        "header lines"
297 .see     concept ident          "RFC 1413"
298 .see     concept "LF character" "linefeed"
299 .seealso concept maximum        limit
300 .see     concept monitor        "Exim monitor"
301 .see     concept "no_<emphasis>xxx</emphasis>"          "entry for xxx"
302 .see     concept NUL            "binary zero"
303 .see     concept "passwd file"  "/etc/passwd"
304 .see     concept "process id"   pid
305 .see     concept RBL            "DNS list"
306 .see     concept redirection    "address redirection"
307 .see     concept "return path"  "envelope sender"
308 .see     concept scanning       "content scanning"
309 .see     concept SSL            TLS
310 .see     concept string         expansion expansion
311 .see     concept "top bit"      "8-bit characters"
312 .see     concept variables      "expansion, variables"
313 .see     concept "zero, binary" "binary zero"
314
315
316 . /////////////////////////////////////////////////////////////////////////////
317 . This is the real start of the first chapter. See the comment above as to why
318 . we can't have the .chapter line here.
319 . chapter "Introduction"
320 . /////////////////////////////////////////////////////////////////////////////
321
322 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
323 Unix-like operating systems. It was designed on the assumption that it would be
324 run on hosts that are permanently connected to the Internet. However, it can be
325 used on intermittently connected hosts with suitable configuration adjustments.
326
327 Configuration files currently exist for the following operating systems: AIX,
328 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
329 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
330 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
331 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
332 Some of these operating systems are no longer current and cannot easily be
333 tested, so the configuration files may no longer work in practice.
334
335 There are also configuration files for compiling Exim in the Cygwin environment
336 that can be installed on systems running Windows. However, this document does
337 not contain any information about running Exim in the Cygwin environment.
338
339 The terms and conditions for the use and distribution of Exim are contained in
340 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
341 Public Licence, a copy of which may be found in the file &_LICENCE_&.
342
343 The use, supply, or promotion of Exim for the purpose of sending bulk,
344 unsolicited electronic mail is incompatible with the basic aims of Exim,
345 which revolve around the free provision of a service that enhances the quality
346 of personal communications. The author of Exim regards indiscriminate
347 mass-mailing as an antisocial, irresponsible abuse of the Internet.
348
349 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
350 experience of running and working on the Smail 3 code, I could never have
351 contemplated starting to write a new MTA. Many of the ideas and user interfaces
352 were originally taken from Smail 3, though the actual code of Exim is entirely
353 new, and has developed far beyond the initial concept.
354
355 Many people, both in Cambridge and around the world, have contributed to the
356 development and the testing of Exim, and to porting it to various operating
357 systems. I am grateful to them all. The distribution now contains a file called
358 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
359 contributors.
360
361
362 .section "Exim documentation" "SECID1"
363 . Keep this example change bar when updating the documentation!
364
365 .new
366 .cindex "documentation"
367 This edition of the Exim specification applies to version &version() of Exim.
368 Substantive changes from the &previousversion; edition are marked in some
369 renditions of this document; this paragraph is so marked if the rendition is
370 capable of showing a change indicator.
371 .wen
372
373 This document is very much a reference manual; it is not a tutorial. The reader
374 is expected to have some familiarity with the SMTP mail transfer protocol and
375 with general Unix system administration. Although there are some discussions
376 and examples in places, the information is mostly organized in a way that makes
377 it easy to look up, rather than in a natural order for sequential reading.
378 Furthermore, this manual aims to cover every aspect of Exim in detail, including
379 a number of rarely-used, special-purpose features that are unlikely to be of
380 very wide interest.
381
382 .cindex "books about Exim"
383 An &"easier"& discussion of Exim which provides more in-depth explanatory,
384 introductory, and tutorial material can be found in a book entitled &'The Exim
385 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
386 (&url(https://www.uit.co.uk/exim-book/)).
387
388 The book also contains a chapter that gives a general introduction to SMTP and
389 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
390 with the latest release of Exim. (Note that the earlier book about Exim,
391 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
392
393 .cindex "Debian" "information sources"
394 If you are using a Debian distribution of Exim, you will find information about
395 Debian-specific features in the file
396 &_/usr/share/doc/exim4-base/README.Debian_&.
397 The command &(man update-exim.conf)& is another source of Debian-specific
398 information.
399
400 .cindex "&_doc/NewStuff_&"
401 .cindex "&_doc/ChangeLog_&"
402 .cindex "change log"
403 As Exim develops, there may be features in newer versions that have not
404 yet made it into this document, which is updated only when the most significant
405 digit of the fractional part of the version number changes. Specifications of
406 new features that are not yet in this manual are placed in the file
407 &_doc/NewStuff_& in the Exim distribution.
408
409 Some features may be classified as &"experimental"&. These may change
410 incompatibly while they are developing, or even be withdrawn. For this reason,
411 they are not documented in this manual. Information about experimental features
412 can be found in the file &_doc/experimental.txt_&.
413
414 All changes to Exim (whether new features, bug fixes, or other kinds of
415 change) are noted briefly in the file called &_doc/ChangeLog_&.
416
417 .cindex "&_doc/spec.txt_&"
418 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
419 that it can easily be searched with a text editor. Other files in the &_doc_&
420 directory are:
421
422 .table2 100pt
423 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
424 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
425 .row &_exim.8_&              "a man page of Exim's command line options"
426 .row &_experimental.txt_&    "documentation of experimental features"
427 .row &_filter.txt_&          "specification of the filter language"
428 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
429 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
430 .row &_openssl.txt_&         "installing a current OpenSSL release"
431 .endtable
432
433 The main specification and the specification of the filtering language are also
434 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
435 &<<SECTavail>>& below tells you how to get hold of these.
436
437
438
439 .section "FTP site and websites" "SECID2"
440 .cindex "website"
441 .cindex "FTP site"
442 The primary site for Exim source distributions is the &%exim.org%& FTP site,
443 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
444 website, are hosted at the University of Cambridge.
445
446 .cindex "wiki"
447 .cindex "FAQ"
448 As well as Exim distribution tar files, the Exim website contains a number of
449 differently formatted versions of the documentation. A recent addition to the
450 online information is the Exim wiki (&url(https://wiki.exim.org)),
451 which contains what used to be a separate FAQ, as well as various other
452 examples, tips, and know-how that have been contributed by Exim users.
453 The wiki site should always redirect to the correct place, which is currently
454 provided by GitHub, and is open to editing by anyone with a GitHub account.
455
456 .cindex Bugzilla
457 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
458 this to report bugs, and also to add items to the wish list. Please search
459 first to check that you are not duplicating a previous entry.
460 Please do not ask for configuration help in the bug-tracker.
461
462
463 .section "Mailing lists" "SECID3"
464 .cindex "mailing lists" "for Exim users"
465 The following Exim mailing lists exist:
466
467 .table2 140pt
468 .row &'exim-announce@lists.exim.org'&   "Moderated, low volume announcements list"
469 .row &'exim-users@lists.exim.org'&      "General discussion list"
470 .row &'exim-users-de@lists.exim.org'&   "General discussion list in German language"
471 .row &'exim-dev@lists.exim.org'&        "Discussion of bugs, enhancements, etc."
472 .row &'exim-cvs@lists.exim.org'&        "Automated commit messages from the VCS"
473 .endtable
474
475 You can subscribe to these lists, change your existing subscriptions, and view
476 or search the archives via the mailing lists link on the Exim home page.
477 .cindex "Debian" "mailing list for"
478 If you are using a Debian distribution of Exim, you may wish to subscribe to
479 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
480 via this web page:
481 .display
482 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
483 .endd
484 Please ask Debian-specific questions on that list and not on the general Exim
485 lists.
486
487 .section "Bug reports" "SECID5"
488 .cindex "bug reports"
489 .cindex "reporting bugs"
490 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
491 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
492 whether some behaviour is a bug or not, the best thing to do is to post a
493 message to the &'exim-dev'& mailing list and have it discussed.
494
495
496
497 .section "Where to find the Exim distribution" "SECTavail"
498 .cindex "FTP site"
499 .cindex "HTTPS download site"
500 .cindex "distribution" "FTP site"
501 .cindex "distribution" "https site"
502 The master distribution site for the Exim distribution is
503 .display
504 &url(https://downloads.exim.org/)
505 .endd
506 The service is available over HTTPS, HTTP and FTP.
507 We encourage people to migrate to HTTPS.
508
509 The content served at &url(https://downloads.exim.org/) is identical to the
510 content served at &url(https://ftp.exim.org/pub/exim) and
511 &url(ftp://ftp.exim.org/pub/exim).
512
513 If accessing via a hostname containing &'ftp'&, then the file references that
514 follow are relative to the &_exim_& directories at these sites.
515 If accessing via the hostname &'downloads'& then the subdirectories described
516 here are top-level directories.
517
518 There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the top exim directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.xz_&
527 &_exim-n.nn.tar.gz_&
528 &_exim-n.nn.tar.bz2_&
529 .endd
530 where &'n.nn'& is the highest such version number in the directory. The three
531 files contain identical data; the only difference is the type of compression.
532 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
533 most portable to old systems.
534
535 .cindex "distribution" "signing details"
536 .cindex "distribution" "public key"
537 .cindex "public key for signed distribution"
538 The distributions will be PGP signed by an individual key of the Release
539 Coordinator.  This key will have a uid containing an email address in the
540 &'exim.org'& domain and will have signatures from other people, including
541 other Exim maintainers.  We expect that the key will be in the "strong set" of
542 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
543 PGP keys, a version of which can be found in the release directory in the file
544 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
545 such as &'pool.sks-keyservers.net'&.
546
547 At the time of the last update, releases were being made by Jeremy Harris and signed
548 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
549 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
550 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
551
552 The signatures for the tar bundles are in:
553 .display
554 &_exim-n.nn.tar.xz.asc_&
555 &_exim-n.nn.tar.gz.asc_&
556 &_exim-n.nn.tar.bz2.asc_&
557 .endd
558 For each released version, the log of changes is made available in a
559 separate file in the directory &_ChangeLogs_& so that it is possible to
560 find out what has changed without having to download the entire distribution.
561
562 .cindex "documentation" "available formats"
563 The main distribution contains ASCII versions of this specification and other
564 documentation; other formats of the documents are available in separate files
565 inside the &_exim4_& directory of the FTP site:
566 .display
567 &_exim-html-n.nn.tar.gz_&
568 &_exim-pdf-n.nn.tar.gz_&
569 &_exim-postscript-n.nn.tar.gz_&
570 &_exim-texinfo-n.nn.tar.gz_&
571 .endd
572 These tar files contain only the &_doc_& directory, not the complete
573 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
574
575
576 .section "Limitations" "SECID6"
577 .ilist
578 .cindex "limitations of Exim"
579 .cindex "bang paths" "not handled by Exim"
580 Exim is designed for use as an Internet MTA, and therefore handles addresses in
581 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
582 simple two-component bang paths can be converted by a straightforward rewriting
583 configuration. This restriction does not prevent Exim from being interfaced to
584 UUCP as a transport mechanism, provided that domain addresses are used.
585 .next
586 .cindex "domainless addresses"
587 .cindex "address" "without domain"
588 Exim insists that every address it handles has a domain attached. For incoming
589 local messages, domainless addresses are automatically qualified with a
590 configured domain value. Configuration options specify from which remote
591 systems unqualified addresses are acceptable. These are then qualified on
592 arrival.
593 .next
594 .cindex "transport" "external"
595 .cindex "external transports"
596 The only external transport mechanisms that are currently implemented are SMTP
597 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
598 transport is available, and there are facilities for writing messages to files
599 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
600 to send messages to other transport mechanisms such as UUCP, provided they can
601 handle domain-style addresses. Batched SMTP input is also catered for.
602 .next
603 Exim is not designed for storing mail for dial-in hosts. When the volumes of
604 such mail are large, it is better to get the messages &"delivered"& into files
605 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
606 other means.
607 .next
608 Although Exim does have basic facilities for scanning incoming messages, these
609 are not comprehensive enough to do full virus or spam scanning. Such operations
610 are best carried out using additional specialized software packages. If you
611 compile Exim with the content-scanning extension, straightforward interfaces to
612 a number of common scanners are provided.
613 .endlist
614
615
616 .section "Runtime configuration" "SECID7"
617 Exim's runtime configuration is held in a single text file that is divided
618 into a number of sections. The entries in this file consist of keywords and
619 values, in the style of Smail 3 configuration files. A default configuration
620 file which is suitable for simple online installations is provided in the
621 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
622
623
624 .section "Calling interface" "SECID8"
625 .cindex "Sendmail compatibility" "command line interface"
626 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
627 can be a straight replacement for &_/usr/lib/sendmail_& or
628 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
629 about Sendmail in order to run Exim. For actions other than sending messages,
630 Sendmail-compatible options also exist, but those that produce output (for
631 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
632 format. There are also some additional options that are compatible with Smail
633 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
634 documents all Exim's command line options. This information is automatically
635 made into the man page that forms part of the Exim distribution.
636
637 Control of messages in the queue can be done via certain privileged command
638 line options. There is also an optional monitor program called &'eximon'&,
639 which displays current information in an X window, and which contains a menu
640 interface to Exim's command line administration options.
641
642
643
644 .section "Terminology" "SECID9"
645 .cindex "terminology definitions"
646 .cindex "body of message" "definition of"
647 The &'body'& of a message is the actual data that the sender wants to transmit.
648 It is the last part of a message and is separated from the &'header'& (see
649 below) by a blank line.
650
651 .cindex "bounce message" "definition of"
652 When a message cannot be delivered, it is normally returned to the sender in a
653 delivery failure message or a &"non-delivery report"& (NDR). The term
654 &'bounce'& is commonly used for this action, and the error reports are often
655 called &'bounce messages'&. This is a convenient shorthand for &"delivery
656 failure error report"&. Such messages have an empty sender address in the
657 message's &'envelope'& (see below) to ensure that they cannot themselves give
658 rise to further bounce messages.
659
660 The term &'default'& appears frequently in this manual. It is used to qualify a
661 value which is used in the absence of any setting in the configuration. It may
662 also qualify an action which is taken unless a configuration setting specifies
663 otherwise.
664
665 The term &'defer'& is used when the delivery of a message to a specific
666 destination cannot immediately take place for some reason (a remote host may be
667 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
668 until a later time.
669
670 The word &'domain'& is sometimes used to mean all but the first component of a
671 host's name. It is &'not'& used in that sense here, where it normally refers to
672 the part of an email address following the @ sign.
673
674 .cindex "envelope, definition of"
675 .cindex "sender" "definition of"
676 A message in transit has an associated &'envelope'&, as well as a header and a
677 body. The envelope contains a sender address (to which bounce messages should
678 be delivered), and any number of recipient addresses. References to the
679 sender or the recipients of a message usually mean the addresses in the
680 envelope. An MTA uses these addresses for delivery, and for returning bounce
681 messages, not the addresses that appear in the header lines.
682
683 .cindex "message" "header, definition of"
684 .cindex "header section" "definition of"
685 The &'header'& of a message is the first part of a message's text, consisting
686 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
687 &'Subject:'&, etc. Long header lines can be split over several text lines by
688 indenting the continuations. The header is separated from the body by a blank
689 line.
690
691 .cindex "local part" "definition of"
692 .cindex "domain" "definition of"
693 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
694 part of an email address that precedes the @ sign. The part that follows the
695 @ sign is called the &'domain'& or &'mail domain'&.
696
697 .cindex "local delivery" "definition of"
698 .cindex "remote delivery, definition of"
699 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
700 delivery to a file or a pipe on the local host from delivery by SMTP over
701 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
702 host it is running on are &'remote'&.
703
704 .cindex "return path" "definition of"
705 &'Return path'& is another name that is used for the sender address in a
706 message's envelope.
707
708 .cindex "queue" "definition of"
709 The term &'queue'& is used to refer to the set of messages awaiting delivery
710 because this term is in widespread use in the context of MTAs. However, in
711 Exim's case, the reality is more like a pool than a queue, because there is
712 normally no ordering of waiting messages.
713
714 .cindex "queue runner" "definition of"
715 The term &'queue runner'& is used to describe a process that scans the queue
716 and attempts to deliver those messages whose retry times have come. This term
717 is used by other MTAs and also relates to the command &%runq%&, but in Exim
718 the waiting messages are normally processed in an unpredictable order.
719
720 .cindex "spool directory" "definition of"
721 The term &'spool directory'& is used for a directory in which Exim keeps the
722 messages in its queue &-- that is, those that it is in the process of
723 delivering. This should not be confused with the directory in which local
724 mailboxes are stored, which is called a &"spool directory"& by some people. In
725 the Exim documentation, &"spool"& is always used in the first sense.
726
727
728
729
730
731
732 . ////////////////////////////////////////////////////////////////////////////
733 . ////////////////////////////////////////////////////////////////////////////
734
735 .chapter "Incorporated code" "CHID2"
736 .cindex "incorporated code"
737 .cindex "regular expressions" "library"
738 .cindex "PCRE2"
739 .cindex "OpenDMARC"
740 A number of pieces of external code are included in the Exim distribution.
741
742 .ilist
743 Regular expressions are supported in the main Exim program and in the
744 Exim monitor using the freely-distributable PCRE2 library, copyright
745 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
746 Exim, so you will need to use the version of PCRE2 shipped with your system,
747 or obtain and install the full version of the library from
748 &url(https://github.com/PhilipHazel/pcre2/releases).
749 .next
750 .cindex "cdb" "acknowledgment"
751 Support for the cdb (Constant DataBase) lookup method is provided by code
752 contributed by Nigel Metheringham of (at the time he contributed it) Planet
753 Online Ltd. The implementation is completely contained within the code of Exim.
754 It does not link against an external cdb library. The code contains the
755 following statements:
756
757 .blockquote
758 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
759
760 This program is free software; you can redistribute it and/or modify it under
761 the terms of the GNU General Public License as published by the Free Software
762 Foundation; either version 2 of the License, or (at your option) any later
763 version.
764 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
765 the spec and sample code for cdb can be obtained from
766 &url(https://cr.yp.to/cdb.html). This implementation borrows
767 some code from Dan Bernstein's implementation (which has no license
768 restrictions applied to it).
769 .endblockquote
770 .next
771 .cindex "SPA authentication"
772 .cindex "Samba project"
773 .cindex "Microsoft Secure Password Authentication"
774 Client support for Microsoft's &'Secure Password Authentication'& is provided
775 by code contributed by Marc Prud'hommeaux. Server support was contributed by
776 Tom Kistner. This includes code taken from the Samba project, which is released
777 under the Gnu GPL.
778 .next
779 .cindex "Cyrus"
780 .cindex "&'pwcheck'& daemon"
781 .cindex "&'pwauthd'& daemon"
782 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
783 by code taken from the Cyrus-SASL library and adapted by Alexander S.
784 Sabourenkov. The permission notice appears below, in accordance with the
785 conditions expressed therein.
786
787 .blockquote
788 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
789
790 Redistribution and use in source and binary forms, with or without
791 modification, are permitted provided that the following conditions
792 are met:
793
794 .olist
795 Redistributions of source code must retain the above copyright
796 notice, this list of conditions and the following disclaimer.
797 .next
798 Redistributions in binary form must reproduce the above copyright
799 notice, this list of conditions and the following disclaimer in
800 the documentation and/or other materials provided with the
801 distribution.
802 .next
803 The name &"Carnegie Mellon University"& must not be used to
804 endorse or promote products derived from this software without
805 prior written permission. For permission or any other legal
806 details, please contact
807 .display
808               Office of Technology Transfer
809               Carnegie Mellon University
810               5000 Forbes Avenue
811               Pittsburgh, PA  15213-3890
812               (412) 268-4387, fax: (412) 268-7395
813               tech-transfer@andrew.cmu.edu
814 .endd
815 .next
816 Redistributions of any form whatsoever must retain the following
817 acknowledgment:
818
819 &"This product includes software developed by Computing Services
820 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
821
822 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
823 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
824 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
825 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
826 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
827 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
828 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
829 .endlist
830 .endblockquote
831
832 .next
833 .cindex "Exim monitor" "acknowledgment"
834 .cindex "X-windows"
835 .cindex "Athena"
836 The Exim Monitor program, which is an X-Window application, includes
837 modified versions of the Athena StripChart and TextPop widgets.
838 This code is copyright by DEC and MIT, and their permission notice appears
839 below, in accordance with the conditions expressed therein.
840
841 .blockquote
842 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
843 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
844
845 All Rights Reserved
846
847 Permission to use, copy, modify, and distribute this software and its
848 documentation for any purpose and without fee is hereby granted,
849 provided that the above copyright notice appear in all copies and that
850 both that copyright notice and this permission notice appear in
851 supporting documentation, and that the names of Digital or MIT not be
852 used in advertising or publicity pertaining to distribution of the
853 software without specific, written prior permission.
854
855 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
856 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
857 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
858 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
859 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
860 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
861 SOFTWARE.
862 .endblockquote
863
864 .next
865 .cindex "opendmarc" "acknowledgment"
866 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
867 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
868 derived code are indicated in the respective source files. The full OpenDMARC
869 license is provided in the LICENSE.opendmarc file contained in the distributed
870 source code.
871
872 .next
873 Many people have contributed code fragments, some large, some small, that were
874 not covered by any specific license requirements. It is assumed that the
875 contributors are happy to see their code incorporated into Exim under the GPL.
876 .endlist
877
878
879
880
881
882 . ////////////////////////////////////////////////////////////////////////////
883 . ////////////////////////////////////////////////////////////////////////////
884
885 .chapter "How Exim receives and delivers mail" "CHID11" &&&
886          "Receiving and delivering mail"
887
888
889 .section "Overall philosophy" "SECID10"
890 .cindex "design philosophy"
891 Exim is designed to work efficiently on systems that are permanently connected
892 to the Internet and are handling a general mix of mail. In such circumstances,
893 most messages can be delivered immediately. Consequently, Exim does not
894 maintain independent queues of messages for specific domains or hosts, though
895 it does try to send several messages in a single SMTP connection after a host
896 has been down, and it also maintains per-host retry information.
897
898
899 .section "Policy control" "SECID11"
900 .cindex "policy control" "overview"
901 Policy controls are now an important feature of MTAs that are connected to the
902 Internet. Perhaps their most important job is to stop MTAs from being abused as
903 &"open relays"& by misguided individuals who send out vast amounts of
904 unsolicited junk and want to disguise its source. Exim provides flexible
905 facilities for specifying policy controls on incoming mail:
906
907 .ilist
908 .cindex "&ACL;" "introduction"
909 Exim 4 (unlike previous versions of Exim) implements policy controls on
910 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
911 series of statements that may either grant or deny access. ACLs can be used at
912 several places in the SMTP dialogue while receiving a message from a remote
913 host. However, the most common places are after each RCPT command, and at the
914 very end of the message. The sysadmin can specify conditions for accepting or
915 rejecting individual recipients or the entire message, respectively, at these
916 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
917 error code.
918 .next
919 An ACL is also available for locally generated, non-SMTP messages. In this
920 case, the only available actions are to accept or deny the entire message.
921 .next
922 When Exim is compiled with the content-scanning extension, facilities are
923 provided in the ACL mechanism for passing the message to external virus and/or
924 spam scanning software. The result of such a scan is passed back to the ACL,
925 which can then use it to decide what to do with the message.
926 .next
927 When a message has been received, either from a remote host or from the local
928 host, but before the final acknowledgment has been sent, a locally supplied C
929 function called &[local_scan()]& can be run to inspect the message and decide
930 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
931 is accepted, the list of recipients can be modified by the function.
932 .next
933 Using the &[local_scan()]& mechanism is another way of calling external scanner
934 software. The &%SA-Exim%& add-on package works this way. It does not require
935 Exim to be compiled with the content-scanning extension.
936 .next
937 After a message has been accepted, a further checking mechanism is available in
938 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
939 runs at the start of every delivery process.
940 .endlist
941
942
943
944 .section "User filters" "SECID12"
945 .cindex "filter" "introduction"
946 .cindex "Sieve filter"
947 In a conventional Exim configuration, users are able to run private filters by
948 setting up appropriate &_.forward_& files in their home directories. See
949 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
950 configuration needed to support this, and the separate document entitled
951 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
952 of filtering are available:
953
954 .ilist
955 Sieve filters are written in the standard filtering language that is defined
956 by RFC 3028.
957 .next
958 Exim filters are written in a syntax that is unique to Exim, but which is more
959 powerful than Sieve, which it pre-dates.
960 .endlist
961
962 User filters are run as part of the routing process, described below.
963
964
965
966 .section "Message identification" "SECTmessiden"
967 .cindex "message ids" "details of format"
968 .cindex "format" "of message id"
969 .cindex "id of message"
970 .cindex "base62"
971 .cindex "base36"
972 .cindex "Darwin"
973 .cindex "Cygwin"
974 .cindex "exim_msgdate"
975 Every message handled by Exim is given a &'message id'& which is sixteen
976 characters long. It is divided into three parts, separated by hyphens, for
977 example &`16VDhn-000000001bo-D342`&. Each part is a sequence of letters and digits,
978 normally encoding numbers in base 62. However, in the Darwin operating
979 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
980 (avoiding the use of lower case letters) is used instead, because the message
981 id is used to construct filenames, and the names of files in those systems are
982 not always case-sensitive.
983
984 .cindex "pid (process id)" "re-use of"
985 The detail of the contents of the message id have changed as Exim has evolved.
986 Earlier versions relied on the operating system not re-using a process id (pid)
987 within one second. On modern operating systems, this assumption can no longer
988 be made, so the algorithm had to be changed. To retain backward compatibility,
989 the format of the message id was retained, which is why the following rules are
990 somewhat eccentric:
991
992 .ilist
993 The first six characters of the message id are the time at which the message
994 started to be received, to a granularity of one second. That is, this field
995 contains the number of seconds since the start of the epoch (the normal Unix
996 way of representing the date and time of day).
997 .next
998 After the first hyphen, the next
999 .new
1000 eleven
1001 .wen
1002 characters are the id of the process that received the message.
1003 .next
1004 .new
1005 There are two different possibilities for the final four characters:
1006 .olist
1007 .oindex "&%localhost_number%&"
1008 If &%localhost_number%& is not set, this value is the fractional part of the
1009 time of reception, normally in units of
1010 microseconds.
1011 but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are
1014 2 us.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by
1017 500000 (250000) and added to
1018 the fractional part of the time, which in this case is in units of 2 us (4 us).
1019 .endlist
1020 .wen
1021 .endlist
1022
1023 After a message has been received, Exim waits for the clock to tick at the
1024 appropriate resolution before proceeding, so that if another message is
1025 received by the same process, or by another process with the same (re-used)
1026 pid, it is guaranteed that the time will be different. In most cases, the clock
1027 will already have ticked while the message was being received.
1028
1029 The exim_msgdate utility (see section &<<SECTexim_msgdate>>&) can be
1030 used to display the date, and optionally the process id, of an Exim
1031 Message ID.
1032
1033
1034 .section "Receiving mail" "SECID13"
1035 .cindex "receiving mail"
1036 .cindex "message" "reception"
1037 The only way Exim can receive mail from another host is using SMTP over
1038 TCP/IP, in which case the sender and recipient addresses are transferred using
1039 SMTP commands. However, from a locally running process (such as a user's MUA),
1040 there are several possibilities:
1041
1042 .ilist
1043 If the process runs Exim with the &%-bm%& option, the message is read
1044 non-interactively (usually via a pipe), with the recipients taken from the
1045 command line, or from the body of the message if &%-t%& is also used.
1046 .next
1047 If the process runs Exim with the &%-bS%& option, the message is also read
1048 non-interactively, but in this case the recipients are listed at the start of
1049 the message in a series of SMTP RCPT commands, terminated by a DATA
1050 command. This is called &"batch SMTP"& format,
1051 but it isn't really SMTP. The SMTP commands are just another way of passing
1052 envelope addresses in a non-interactive submission.
1053 .next
1054 If the process runs Exim with the &%-bs%& option, the message is read
1055 interactively, using the SMTP protocol. A two-way pipe is normally used for
1056 passing data between the local process and the Exim process.
1057 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1058 example, the ACLs for SMTP commands are used for this form of submission.
1059 .next
1060 A local process may also make a TCP/IP call to the host's loopback address
1061 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1062 does not treat the loopback address specially. It treats all such connections
1063 in the same way as connections from other hosts.
1064 .endlist
1065
1066
1067 .cindex "message sender, constructed by Exim"
1068 .cindex "sender" "constructed by Exim"
1069 In the three cases that do not involve TCP/IP, the sender address is
1070 constructed from the login name of the user that called Exim and a default
1071 qualification domain (which can be set by the &%qualify_domain%& configuration
1072 option). For local or batch SMTP, a sender address that is passed using the
1073 SMTP MAIL command is ignored. However, the system administrator may allow
1074 certain users (&"trusted users"&) to specify a different sender addresses
1075 unconditionally, or all users to specify certain forms of different sender
1076 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1077 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1078 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1079 users to change sender addresses.
1080
1081 Messages received by either of the non-interactive mechanisms are subject to
1082 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1083 (either over TCP/IP or interacting with a local process) can be checked by a
1084 number of ACLs that operate at different times during the SMTP session. Either
1085 individual recipients or the entire message can be rejected if local policy
1086 requirements are not met. The &[local_scan()]& function (see chapter
1087 &<<CHAPlocalscan>>&) is run for all incoming messages.
1088
1089 Exim can be configured not to start a delivery process when a message is
1090 received; this can be unconditional, or depend on the number of incoming SMTP
1091 connections or the system load. In these situations, new messages wait on the
1092 queue until a queue runner process picks them up. However, in standard
1093 configurations under normal conditions, delivery is started as soon as a
1094 message is received.
1095
1096
1097
1098
1099
1100 .section "Handling an incoming message" "SECID14"
1101 .cindex "spool directory" "files that hold a message"
1102 .cindex "file" "how a message is held"
1103 When Exim accepts a message, it writes two files in its spool directory. The
1104 first contains the envelope information, the current status of the message, and
1105 the header lines, and the second contains the body of the message. The names of
1106 the two spool files consist of the message id, followed by &`-H`& for the
1107 file containing the envelope and header, and &`-D`& for the data file.
1108
1109 .cindex "spool directory" "&_input_& sub-directory"
1110 By default, all these message files are held in a single directory called
1111 &_input_& inside the general Exim spool directory. Some operating systems do
1112 not perform very well if the number of files in a directory gets large; to
1113 improve performance in such cases, the &%split_spool_directory%& option can be
1114 used. This causes Exim to split up the input files into 62 sub-directories
1115 whose names are single letters or digits. When this is done, the queue is
1116 processed one sub-directory at a time instead of all at once, which can improve
1117 overall performance even when there are not enough files in each directory to
1118 affect file system performance.
1119
1120 The envelope information consists of the address of the message's sender and
1121 the addresses of the recipients. This information is entirely separate from
1122 any addresses contained in the header lines. The status of the message includes
1123 a list of recipients who have already received the message. The format of the
1124 first spool file is described in chapter &<<CHAPspool>>&.
1125
1126 .cindex "rewriting" "addresses"
1127 Address rewriting that is specified in the rewrite section of the configuration
1128 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1129 both in the header lines and the envelope, at the time the message is accepted.
1130 If during the course of delivery additional addresses are generated (for
1131 example, via aliasing), these new addresses are rewritten as soon as they are
1132 generated. At the time a message is actually delivered (transported) further
1133 rewriting can take place; because this is a transport option, it can be
1134 different for different forms of delivery. It is also possible to specify the
1135 addition or removal of certain header lines at the time the message is
1136 delivered (see chapters &<<CHAProutergeneric>>& and
1137 &<<CHAPtransportgeneric>>&).
1138
1139
1140
1141 .section "Life of a message" "SECID15"
1142 .cindex "message" "life of"
1143 .cindex "message" "frozen"
1144 A message remains in the spool directory until it is completely delivered to
1145 its recipients or to an error address, or until it is deleted by an
1146 administrator or by the user who originally created it. In cases when delivery
1147 cannot proceed &-- for example when a message can neither be delivered to its
1148 recipients nor returned to its sender, the message is marked &"frozen"& on the
1149 spool, and no more deliveries are attempted.
1150
1151 .cindex "frozen messages" "thawing"
1152 .cindex "message" "thawing frozen"
1153 An administrator can &"thaw"& such messages when the problem has been
1154 corrected, and can also freeze individual messages by hand if necessary. In
1155 addition, an administrator can force a delivery error, causing a bounce message
1156 to be sent.
1157
1158 .oindex "&%timeout_frozen_after%&"
1159 .oindex "&%ignore_bounce_errors_after%&"
1160 There are options called &%ignore_bounce_errors_after%& and
1161 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1162 The first applies only to frozen bounces, the second to all frozen messages.
1163
1164 .cindex "message" "log file for"
1165 .cindex "log" "file for each message"
1166 While Exim is working on a message, it writes information about each delivery
1167 attempt to its main log file. This includes successful, unsuccessful, and
1168 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1169 lines are also written to a separate &'message log'& file for each message.
1170 These logs are solely for the benefit of the administrator and are normally
1171 deleted along with the spool files when processing of a message is complete.
1172 The use of individual message logs can be disabled by setting
1173 &%no_message_logs%&; this might give an improvement in performance on very busy
1174 systems.
1175
1176 .cindex "journal file"
1177 .cindex "file" "journal"
1178 All the information Exim itself needs to set up a delivery is kept in the first
1179 spool file, along with the header lines. When a successful delivery occurs, the
1180 address is immediately written at the end of a journal file, whose name is the
1181 message id followed by &`-J`&. At the end of a delivery run, if there are some
1182 addresses left to be tried again later, the first spool file (the &`-H`& file)
1183 is updated to indicate which these are, and the journal file is then deleted.
1184 Updating the spool file is done by writing a new file and renaming it, to
1185 minimize the possibility of data loss.
1186
1187 Should the system or Exim crash after a successful delivery but before
1188 the spool file has been updated, the journal is left lying around. The next
1189 time Exim attempts to deliver the message, it reads the journal file and
1190 updates the spool file before proceeding. This minimizes the chances of double
1191 deliveries caused by crashes.
1192
1193
1194
1195 .section "Processing an address for delivery" "SECTprocaddress"
1196 .cindex "drivers" "definition of"
1197 .cindex "router" "definition of"
1198 .cindex "transport" "definition of"
1199 The main delivery processing elements of Exim are called &'routers'& and
1200 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1201 number of them is provided in the source distribution, and compile-time options
1202 specify which ones are included in the binary. Runtime options specify which
1203 ones are actually used for delivering messages.
1204
1205 .cindex "drivers" "instance definition"
1206 Each driver that is specified in the runtime configuration is an &'instance'&
1207 of that particular driver type. Multiple instances are allowed; for example,
1208 you can set up several different &(smtp)& transports, each with different
1209 option values that might specify different ports or different timeouts. Each
1210 instance has its own identifying name. In what follows we will normally use the
1211 instance name when discussing one particular instance (that is, one specific
1212 configuration of the driver), and the generic driver name when discussing
1213 the driver's features in general.
1214
1215 A &'router'& is a driver that operates on an address, either determining how
1216 its delivery should happen, by assigning it to a specific transport, or
1217 converting the address into one or more new addresses (for example, via an
1218 alias file). A router may also explicitly choose to fail an address, causing it
1219 to be bounced.
1220
1221 A &'transport'& is a driver that transmits a copy of the message from Exim's
1222 spool to some destination. There are two kinds of transport: for a &'local'&
1223 transport, the destination is a file or a pipe on the local host, whereas for a
1224 &'remote'& transport the destination is some other host. A message is passed
1225 to a specific transport as a result of successful routing. If a message has
1226 several recipients, it may be passed to a number of different transports.
1227
1228 .cindex "preconditions" "definition of"
1229 An address is processed by passing it to each configured router instance in
1230 turn, subject to certain preconditions, until a router accepts the address or
1231 specifies that it should be bounced. We will describe this process in more
1232 detail shortly. First, as a simple example, we consider how each recipient
1233 address in a message is processed in a small configuration of three routers.
1234
1235 To make this a more concrete example, it is described in terms of some actual
1236 routers, but remember, this is only an example. You can configure Exim's
1237 routers in many different ways, and there may be any number of routers in a
1238 configuration.
1239
1240 The first router that is specified in a configuration is often one that handles
1241 addresses in domains that are not recognized specifically by the local host.
1242 Typically these are addresses for arbitrary domains on the Internet. A precondition
1243 is set up which looks for the special domains known to the host (for example,
1244 its own domain name), and the router is run for addresses that do &'not'&
1245 match. Typically, this is a router that looks up domains in the DNS in order to
1246 find the hosts to which this address routes. If it succeeds, the address is
1247 assigned to a suitable SMTP transport; if it does not succeed, the router is
1248 configured to fail the address.
1249
1250 The second router is reached only when the domain is recognized as one that
1251 &"belongs"& to the local host. This router does redirection &-- also known as
1252 aliasing and forwarding. When it generates one or more new addresses from the
1253 original, each of them is routed independently from the start. Otherwise, the
1254 router may cause an address to fail, or it may simply decline to handle the
1255 address, in which case the address is passed to the next router.
1256
1257 The final router in many configurations is one that checks to see if the
1258 address belongs to a local mailbox. The precondition may involve a check to
1259 see if the local part is the name of a login account, or it may look up the
1260 local part in a file or a database. If its preconditions are not met, or if
1261 the router declines, we have reached the end of the routers. When this happens,
1262 the address is bounced.
1263
1264
1265
1266 .section "Processing an address for verification" "SECID16"
1267 .cindex "router" "for verification"
1268 .cindex "verifying address" "overview"
1269 As well as being used to decide how to deliver to an address, Exim's routers
1270 are also used for &'address verification'&. Verification can be requested as
1271 one of the checks to be performed in an ACL for incoming messages, on both
1272 sender and recipient addresses, and it can be tested using the &%-bv%& and
1273 &%-bvs%& command line options.
1274
1275 When an address is being verified, the routers are run in &"verify mode"&. This
1276 does not affect the way the routers work, but it is a state that can be
1277 detected. By this means, a router can be skipped or made to behave differently
1278 when verifying. A common example is a configuration in which the first router
1279 sends all messages to a message-scanning program unless they have been
1280 previously scanned. Thus, the first router accepts all addresses without any
1281 checking, making it useless for verifying. Normally, the &%no_verify%& option
1282 would be set for such a router, causing it to be skipped in verify mode.
1283
1284
1285
1286
1287 .section "Running an individual router" "SECTrunindrou"
1288 .cindex "router" "running details"
1289 .cindex "preconditions" "checking"
1290 .cindex "router" "result of running"
1291 As explained in the example above, a number of preconditions are checked before
1292 running a router. If any are not met, the router is skipped, and the address is
1293 passed to the next router. When all the preconditions on a router &'are'& met,
1294 the router is run. What happens next depends on the outcome, which is one of
1295 the following:
1296
1297 .ilist
1298 &'accept'&: The router accepts the address, and either assigns it to a
1299 transport or generates one or more &"child"& addresses. Processing the
1300 original address ceases
1301 .oindex "&%unseen%&"
1302 unless the &%unseen%& option is set on the router. This option
1303 can be used to set up multiple deliveries with different routing (for example,
1304 for keeping archive copies of messages). When &%unseen%& is set, the address is
1305 passed to the next router. Normally, however, an &'accept'& return marks the
1306 end of routing.
1307
1308 Any child addresses generated by the router are processed independently,
1309 starting with the first router by default. It is possible to change this by
1310 setting the &%redirect_router%& option to specify which router to start at for
1311 child addresses. Unlike &%pass_router%& (see below) the router specified by
1312 &%redirect_router%& may be anywhere in the router configuration.
1313 .next
1314 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1315 requests that the address be passed to another router. By default, the address
1316 is passed to the next router, but this can be changed by setting the
1317 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1318 must be below the current router (to avoid loops).
1319 .next
1320 &'decline'&: The router declines to accept the address because it does not
1321 recognize it at all. By default, the address is passed to the next router, but
1322 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1323 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1324 &'decline'& into &'fail'&.
1325 .next
1326 &'fail'&: The router determines that the address should fail, and queues it for
1327 the generation of a bounce message. There is no further processing of the
1328 original address unless &%unseen%& is set on the router.
1329 .next
1330 &'defer'&: The router cannot handle the address at the present time. (A
1331 database may be offline, or a DNS lookup may have timed out.) No further
1332 processing of the address happens in this delivery attempt. It is tried again
1333 next time the message is considered for delivery.
1334 .next
1335 &'error'&: There is some error in the router (for example, a syntax error in
1336 its configuration). The action is as for defer.
1337 .endlist
1338
1339 If an address reaches the end of the routers without having been accepted by
1340 any of them, it is bounced as unrouteable. The default error message in this
1341 situation is &"unrouteable address"&, but you can set your own message by
1342 making use of the &%cannot_route_message%& option. This can be set for any
1343 router; the value from the last router that &"saw"& the address is used.
1344
1345 Sometimes while routing you want to fail a delivery when some conditions are
1346 met but others are not, instead of passing the address on for further routing.
1347 You can do this by having a second router that explicitly fails the delivery
1348 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1349 facility for this purpose.
1350
1351
1352 .section "Duplicate addresses" "SECID17"
1353 .cindex "case of local parts"
1354 .cindex "address duplicate, discarding"
1355 .cindex "duplicate addresses"
1356 Once routing is complete, Exim scans the addresses that are assigned to local
1357 and remote transports and discards any duplicates that it finds. During this
1358 check, local parts are treated case-sensitively. This happens only when
1359 actually delivering a message; when testing routers with &%-bt%&, all the
1360 routed addresses are shown.
1361
1362
1363
1364 .section "Router preconditions" "SECTrouprecon"
1365 .cindex "router" "preconditions, order of processing"
1366 .cindex "preconditions" "order of processing"
1367 The preconditions that are tested for each router are listed below, in the
1368 order in which they are tested. The individual configuration options are
1369 described in more detail in chapter &<<CHAProutergeneric>>&.
1370
1371 .olist
1372 .cindex affix "router precondition"
1373 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1374 the local parts handled by the router may or must have certain prefixes and/or
1375 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1376 skipped. These conditions are tested first. When an affix is present, it is
1377 removed from the local part before further processing, including the evaluation
1378 of any other conditions.
1379 .next
1380 Routers can be designated for use only when not verifying an address, that is,
1381 only when routing it for delivery (or testing its delivery routing). If the
1382 &%verify%& option is set false, the router is skipped when Exim is verifying an
1383 address.
1384 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1385 &%verify_recipient%&, which independently control the use of the router for
1386 sender and recipient verification. You can set these options directly if
1387 you want a router to be used for only one type of verification.
1388 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1389 .next
1390 If the &%address_test%& option is set false, the router is skipped when Exim is
1391 run with the &%-bt%& option to test an address routing. This can be helpful
1392 when the first router sends all new messages to a scanner of some sort; it
1393 makes it possible to use &%-bt%& to test subsequent delivery routing without
1394 having to simulate the effect of the scanner.
1395 .next
1396 Routers can be designated for use only when verifying an address, as
1397 opposed to routing it for delivery. The &%verify_only%& option controls this.
1398 Again, cutthrough delivery counts as a verification.
1399 .next
1400 Individual routers can be explicitly skipped when running the routers to
1401 check an address given in the SMTP EXPN command (see the &%expn%& option).
1402
1403 .next
1404 If the &%domains%& option is set, the domain of the address must be in the set
1405 of domains that it defines.
1406 .cindex "tainted data" "de-tainting"
1407 .cindex "de-tainting" "using router domains option"
1408 A match verifies the variable &$domain$& (which carries tainted data)
1409 and assigns an untainted value to the &$domain_data$& variable.
1410 Such an untainted value is often needed in the transport.
1411 For specifics of the matching operation and the resulting untainted value,
1412 refer to section &<<SECTdomainlist>>&.
1413
1414 When an untainted value is wanted, use this option
1415 rather than the generic &%condition%& option.
1416
1417 .next
1418 .vindex "&$local_part_prefix$&"
1419 .vindex "&$local_part_prefix_v$&"
1420 .vindex "&$local_part$&"
1421 .vindex "&$local_part_suffix$&"
1422 .vindex "&$local_part_suffix_v$&"
1423 .cindex affix "router precondition"
1424 If the &%local_parts%& option is set, the local part of the address must be in
1425 the set of local parts that it defines.
1426 A match verifies the variable &$local_part$& (which carries tainted data)
1427 and assigns an untainted value to the &$local_part_data$& variable.
1428 Such an untainted value is often needed in the transport.
1429 For specifics of the matching operation and the resulting untainted value,
1430 refer to section &<<SECTlocparlis>>&.
1431
1432 When an untainted value is wanted, use this option
1433 rather than the generic &%condition%& option.
1434
1435 If &%local_part_prefix%& or
1436 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1437 part before this check. If you want to do precondition tests on local parts
1438 that include affixes, you can do so by using a &%condition%& option (see below)
1439 that uses the variables &$local_part$&, &$local_part_prefix$&,
1440 &$local_part_prefix_v$&, &$local_part_suffix$&
1441 and &$local_part_suffix_v$& as necessary.
1442
1443 .next
1444 .vindex "&$local_user_uid$&"
1445 .vindex "&$local_user_gid$&"
1446 .vindex "&$home$&"
1447 If the &%check_local_user%& option is set, the local part must be the name of
1448 an account on the local host. If this check succeeds, the uid and gid of the
1449 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1450 user's home directory is placed in &$home$&; these values can be used in the
1451 remaining preconditions.
1452
1453 .next
1454 If the &%router_home_directory%& option is set, it is expanded at this point,
1455 because it overrides the value of &$home$&. If this expansion were left till
1456 later, the value of &$home$& as set by &%check_local_user%& would be used in
1457 subsequent tests. Having two different values of &$home$& in the same router
1458 could lead to confusion.
1459
1460 .next
1461 If the &%senders%& option is set, the envelope sender address must be in the
1462 set of addresses that it defines.
1463
1464 .next
1465 If the &%require_files%& option is set, the existence or non-existence of
1466 specified files is tested.
1467
1468 .next
1469 .cindex "customizing" "precondition"
1470 If the &%condition%& option is set, it is evaluated and tested. This option
1471 uses an expanded string to allow you to set up your own custom preconditions.
1472 Expanded strings are described in chapter &<<CHAPexpand>>&.
1473
1474 Note that while using
1475 this option for address matching technically works,
1476 it does not set any de-tainted values.
1477 Such values are often needed, either for router-specific options or
1478 for transport options.
1479 Using the &%domains%& and &%local_parts%& options is usually the most
1480 convenient way to obtain them.
1481 .endlist
1482
1483
1484 Note that &%require_files%& comes near the end of the list, so you cannot use
1485 it to check for the existence of a file in which to lookup up a domain, local
1486 part, or sender. However, as these options are all expanded, you can use the
1487 &%exists%& expansion condition to make such tests within each condition. The
1488 &%require_files%& option is intended for checking files that the router may be
1489 going to use internally, or which are needed by a specific transport (for
1490 example, &_.procmailrc_&).
1491
1492
1493
1494 .section "Delivery in detail" "SECID18"
1495 .cindex "delivery" "in detail"
1496 When a message is to be delivered, the sequence of events is as follows:
1497
1498 .olist
1499 If a system-wide filter file is specified, the message is passed to it. The
1500 filter may add recipients to the message, replace the recipients, discard the
1501 message, cause a new message to be generated, or cause the message delivery to
1502 fail. The format of the system filter file is the same as for Exim user filter
1503 files, described in the separate document entitled &'Exim's interfaces to mail
1504 filtering'&.
1505 .cindex "Sieve filter" "not available for system filter"
1506 (&*Note*&: Sieve cannot be used for system filter files.)
1507
1508 Some additional features are available in system filters &-- see chapter
1509 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1510 filter only once per delivery attempt, however many recipients it has. However,
1511 if there are several delivery attempts because one or more addresses could not
1512 be immediately delivered, the system filter is run each time. The filter
1513 condition &%first_delivery%& can be used to detect the first run of the system
1514 filter.
1515 .next
1516 Each recipient address is offered to each configured router, in turn, subject to
1517 its preconditions, until one is able to handle it. If no router can handle the
1518 address, that is, if they all decline, the address is failed. Because routers
1519 can be targeted at particular domains, several locally handled domains can be
1520 processed entirely independently of each other.
1521 .next
1522 .cindex "routing" "loops in"
1523 .cindex "loop" "while routing"
1524 A router that accepts an address may assign it to a local or a remote
1525 transport. However, the transport is not run at this time. Instead, the address
1526 is placed on a list for the particular transport, which will be run later.
1527 Alternatively, the router may generate one or more new addresses (typically
1528 from alias, forward, or filter files). New addresses are fed back into this
1529 process from the top, but in order to avoid loops, a router ignores any address
1530 which has an identically-named ancestor that was processed by itself.
1531 .next
1532 When all the routing has been done, addresses that have been successfully
1533 handled are passed to their assigned transports. When local transports are
1534 doing real local deliveries, they handle only one address at a time, but if a
1535 local transport is being used as a pseudo-remote transport (for example, to
1536 collect batched SMTP messages for transmission by some other means) multiple
1537 addresses can be handled. Remote transports can always handle more than one
1538 address at a time, but can be configured not to do so, or to restrict multiple
1539 addresses to the same domain.
1540 .next
1541 Each local delivery to a file or a pipe runs in a separate process under a
1542 non-privileged uid, and these deliveries are run one at a time. Remote
1543 deliveries also run in separate processes, normally under a uid that is private
1544 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1545 run in parallel. The maximum number of simultaneous remote deliveries for any
1546 one message is set by the &%remote_max_parallel%& option.
1547 The order in which deliveries are done is not defined, except that all local
1548 deliveries happen before any remote deliveries.
1549 .next
1550 .cindex "queue runner"
1551 When it encounters a local delivery during a queue run, Exim checks its retry
1552 database to see if there has been a previous temporary delivery failure for the
1553 address before running the local transport. If there was a previous failure,
1554 Exim does not attempt a new delivery until the retry time for the address is
1555 reached. However, this happens only for delivery attempts that are part of a
1556 queue run. Local deliveries are always attempted when delivery immediately
1557 follows message reception, even if retry times are set for them. This makes for
1558 better behaviour if one particular message is causing problems (for example,
1559 causing quota overflow, or provoking an error in a filter file).
1560 .next
1561 .cindex "delivery" "retry in remote transports"
1562 Remote transports do their own retry handling, since an address may be
1563 deliverable to one of a number of hosts, each of which may have a different
1564 retry time. If there have been previous temporary failures and no host has
1565 reached its retry time, no delivery is attempted, whether in a queue run or
1566 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1567 .next
1568 If there were any permanent errors, a bounce message is returned to an
1569 appropriate address (the sender in the common case), with details of the error
1570 for each failing address. Exim can be configured to send copies of bounce
1571 messages to other addresses.
1572 .next
1573 .cindex "delivery" "deferral"
1574 If one or more addresses suffered a temporary failure, the message is left on
1575 the queue, to be tried again later. Delivery of these addresses is said to be
1576 &'deferred'&.
1577 .next
1578 When all the recipient addresses have either been delivered or bounced,
1579 handling of the message is complete. The spool files and message log are
1580 deleted, though the message log can optionally be preserved if required.
1581 .endlist
1582
1583
1584
1585
1586 .section "Retry mechanism" "SECID19"
1587 .cindex "delivery" "retry mechanism"
1588 .cindex "retry" "description of mechanism"
1589 .cindex "queue runner"
1590 Exim's mechanism for retrying messages that fail to get delivered at the first
1591 attempt is the queue runner process. You must either run an Exim daemon that
1592 uses the &%-q%& option with a time interval to start queue runners at regular
1593 intervals or use some other means (such as &'cron'&) to start them. If you do
1594 not arrange for queue runners to be run, messages that fail temporarily at the
1595 first attempt will remain in your queue forever. A queue runner process works
1596 its way through the queue, one message at a time, trying each delivery that has
1597 passed its retry time.
1598 You can run several queue runners at once.
1599
1600 Exim uses a set of configured rules to determine when next to retry the failing
1601 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1602 should give up trying to deliver to the address, at which point it generates a
1603 bounce message. If no retry rules are set for a particular host, address, and
1604 error combination, no retries are attempted, and temporary errors are treated
1605 as permanent.
1606
1607
1608
1609 .subsection "Temporary delivery failure" SECID20
1610 .cindex "delivery" "temporary failure"
1611 There are many reasons why a message may not be immediately deliverable to a
1612 particular address. Failure to connect to a remote machine (because it, or the
1613 connection to it, is down) is one of the most common. Temporary failures may be
1614 detected during routing as well as during the transport stage of delivery.
1615 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1616 is on a file system where the user is over quota. Exim can be configured to
1617 impose its own quotas on local mailboxes; where system quotas are set they will
1618 also apply.
1619
1620 If a host is unreachable for a period of time, a number of messages may be
1621 waiting for it by the time it recovers, and sending them in a single SMTP
1622 connection is clearly beneficial. Whenever a delivery to a remote host is
1623 deferred,
1624 .cindex "hints database" "deferred deliveries"
1625 Exim makes a note in its hints database, and whenever a successful
1626 SMTP delivery has happened, it looks to see if any other messages are waiting
1627 for the same host. If any are found, they are sent over the same SMTP
1628 connection, subject to a configuration limit as to the maximum number in any
1629 one connection.
1630
1631
1632
1633 .subsection "Permanent delivery failure" SECID21
1634 .cindex "delivery" "permanent failure"
1635 .cindex "bounce message" "when generated"
1636 When a message cannot be delivered to some or all of its intended recipients, a
1637 bounce message is generated. Temporary delivery failures turn into permanent
1638 errors when their timeout expires. All the addresses that fail in a given
1639 delivery attempt are listed in a single message. If the original message has
1640 many recipients, it is possible for some addresses to fail in one delivery
1641 attempt and others to fail subsequently, giving rise to more than one bounce
1642 message. The wording of bounce messages can be customized by the administrator.
1643 See chapter &<<CHAPemsgcust>>& for details.
1644
1645 .cindex "&'X-Failed-Recipients:'& header line"
1646 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1647 failed addresses, for the benefit of programs that try to analyse such messages
1648 automatically.
1649
1650 .cindex "bounce message" "recipient of"
1651 A bounce message is normally sent to the sender of the original message, as
1652 obtained from the message's envelope. For incoming SMTP messages, this is the
1653 address given in the MAIL command. However, when an address is expanded via a
1654 forward or alias file, an alternative address can be specified for delivery
1655 failures of the generated addresses. For a mailing list expansion (see section
1656 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1657 of the list.
1658
1659
1660
1661 .subsection "Failures to deliver bounce messages" SECID22
1662 .cindex "bounce message" "failure to deliver"
1663 If a bounce message (either locally generated or received from a remote host)
1664 itself suffers a permanent delivery failure, the message is left in the queue,
1665 but it is frozen, awaiting the attention of an administrator. There are options
1666 that can be used to make Exim discard such failed messages, or to keep them
1667 for only a short time (see &%timeout_frozen_after%& and
1668 &%ignore_bounce_errors_after%&).
1669
1670
1671
1672
1673
1674 . ////////////////////////////////////////////////////////////////////////////
1675 . ////////////////////////////////////////////////////////////////////////////
1676
1677 .chapter "Building and installing Exim" "CHID3"
1678 .scindex IIDbuex "building Exim"
1679
1680 .section "Unpacking" "SECID23"
1681 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1682 creates a directory with the name of the current release (for example,
1683 &_exim-&version()_&) into which the following files are placed:
1684
1685 .table2 140pt
1686 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1687 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1688   documented"
1689 .irow &_LICENCE_&         "the GNU General Public Licence"
1690 .irow &_Makefile_&        "top-level make file"
1691 .irow &_NOTICE_&          "conditions for the use of Exim"
1692 .irow &_README_&          "list of files, directories and simple build &&&
1693   instructions"
1694 .endtable
1695
1696 Other files whose names begin with &_README_& may also be present. The
1697 following subdirectories are created:
1698
1699 .table2 140pt
1700 .irow &_Local_&           "an empty directory for local configuration files"
1701 .irow &_OS_&              "OS-specific files"
1702 .irow &_doc_&             "documentation files"
1703 .irow &_exim_monitor_&    "source files for the Exim monitor"
1704 .irow &_scripts_&         "scripts used in the build process"
1705 .irow &_src_&             "remaining source files"
1706 .irow &_util_&            "independent utilities"
1707 .endtable
1708
1709 The main utility programs are contained in the &_src_& directory and are built
1710 with the Exim binary. The &_util_& directory contains a few optional scripts
1711 that may be useful to some sites.
1712
1713
1714 .section "Multiple machine architectures and operating systems" "SECID24"
1715 .cindex "building Exim" "multiple OS/architectures"
1716 The building process for Exim is arranged to make it easy to build binaries for
1717 a number of different architectures and operating systems from the same set of
1718 source files. Compilation does not take place in the &_src_& directory.
1719 Instead, a &'build directory'& is created for each architecture and operating
1720 system.
1721 .cindex "symbolic link" "to build directory"
1722 Symbolic links to the sources are installed in this directory, which is where
1723 the actual building takes place. In most cases, Exim can discover the machine
1724 architecture and operating system for itself, but the defaults can be
1725 overridden if necessary.
1726 .cindex compiler requirements
1727 .cindex compiler version
1728 A C99-capable compiler will be required for the build.
1729
1730
1731 .section "PCRE2 library" "SECTpcre"
1732 .cindex "PCRE2 library"
1733 Exim no longer has an embedded regular-expression library as the vast majority of
1734 modern systems include PCRE2 as a system library, although you may need to
1735 install the PCRE2 package or the PCRE2 development package for your operating
1736 system. If your system has a normal PCRE2 installation the Exim build
1737 process will need no further configuration. If the library or the
1738 headers are in an unusual location you will need to either set the PCRE2_LIBS
1739 and INCLUDE directives appropriately,
1740 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1741 If your operating system has no
1742 PCRE2 support then you will need to obtain and build the current PCRE2
1743 from &url(https://github.com/PhilipHazel/pcre2/releases).
1744 More information on PCRE2 is available at &url(https://www.pcre.org/).
1745
1746 .section "DBM libraries" "SECTdb"
1747 .cindex "DBM libraries" "discussion of"
1748 .cindex "hints database" "DBM files used for"
1749 Even if you do not use any DBM files in your configuration, Exim still needs a
1750 DBM library in order to operate, because it uses indexed files for its hints
1751 databases. Unfortunately, there are a number of DBM libraries in existence, and
1752 different operating systems often have different ones installed.
1753
1754 .cindex "Solaris" "DBM library for"
1755 .cindex "IRIX, DBM library for"
1756 .cindex "BSD, DBM library for"
1757 .cindex "Linux, DBM library for"
1758 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1759 Linux distribution, the DBM configuration should happen automatically, and you
1760 may be able to ignore this section. Otherwise, you may have to learn more than
1761 you would like about DBM libraries from what follows.
1762
1763 .cindex "&'ndbm'& DBM library"
1764 Licensed versions of Unix normally contain a library of DBM functions operating
1765 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1766 versions of Unix seem to vary in what they contain as standard. In particular,
1767 some early versions of Linux have no default DBM library, and different
1768 distributors have chosen to bundle different libraries with their packaged
1769 versions. However, the more recent releases seem to have standardized on the
1770 Berkeley DB library.
1771
1772 Different DBM libraries have different conventions for naming the files they
1773 use. When a program opens a file called &_dbmfile_&, there are several
1774 possibilities:
1775
1776 .olist
1777 A traditional &'ndbm'& implementation, such as that supplied as part of
1778 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1779 .next
1780 .cindex "&'gdbm'& DBM library"
1781 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1782 compatibility interface it makes two different hard links to it with names
1783 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1784 filename is used unmodified.
1785 .next
1786 .cindex "Berkeley DB library"
1787 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1788 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1789 programmer exactly the same as the traditional &'ndbm'& implementation.
1790 .next
1791 If the Berkeley package is used in its native mode, it operates on a single
1792 file called &_dbmfile_&; the programmer's interface is somewhat different to
1793 the traditional &'ndbm'& interface.
1794 .next
1795 To complicate things further, there are several very different versions of the
1796 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1797 2.&'x'& and 3.&'x'& were current for a while,
1798 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1799 Maintenance of some of the earlier releases has ceased,
1800 and Exim no longer supports versions before 3.&'x'&.
1801 All versions of Berkeley DB could be obtained from
1802 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1803 page with far newer versions listed.
1804 It is probably wise to plan to move your storage configurations away from
1805 Berkeley DB format, as today there are smaller and simpler alternatives more
1806 suited to Exim's usage model.
1807 .next
1808 .cindex "&'tdb'& DBM library"
1809 Yet another DBM library, called &'tdb'&, is available from
1810 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1811 operates on a single file.
1812 .endlist
1813
1814 .cindex "USE_DB"
1815 .cindex "DBM libraries" "configuration for building"
1816 Exim and its utilities can be compiled to use any of these interfaces. In order
1817 to use any version of the Berkeley DB package in native mode, you must set
1818 USE_DB in an appropriate configuration file (typically
1819 &_Local/Makefile_&). For example:
1820 .code
1821 USE_DB=yes
1822 .endd
1823 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1824 error is diagnosed if you set more than one of these.
1825 You can set USE_NDBM if needed to override an operating system default.
1826
1827 At the lowest level, the build-time configuration sets none of these options,
1828 thereby assuming an interface of type (1). However, some operating system
1829 configuration files (for example, those for the BSD operating systems and
1830 Linux) assume type (4) by setting USE_DB as their default, and the
1831 configuration files for Cygwin set USE_GDBM. Anything you set in
1832 &_Local/Makefile_&, however, overrides these system defaults.
1833
1834 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1835 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1836 in one of these lines:
1837 .code
1838 DBMLIB = -ldb
1839 DBMLIB = -ltdb
1840 DBMLIB = -lgdbm -lgdbm_compat
1841 .endd
1842 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1843 Settings like that will work if the DBM library is installed in the standard
1844 place. Sometimes it is not, and the library's header file may also not be in
1845 the default path. You may need to set INCLUDE to specify where the header
1846 file is, and to specify the path to the library more fully in DBMLIB, as in
1847 this example:
1848 .code
1849 INCLUDE=-I/usr/local/include/db-4.1
1850 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1851 .endd
1852 There is further detailed discussion about the various DBM libraries in the
1853 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1854
1855
1856
1857 .section "Pre-building configuration" "SECID25"
1858 .cindex "building Exim" "pre-building configuration"
1859 .cindex "configuration for building Exim"
1860 .cindex "&_Local/Makefile_&"
1861 .cindex "&_src/EDITME_&"
1862 Before building Exim, a local configuration file that specifies options
1863 independent of any operating system has to be created with the name
1864 &_Local/Makefile_&. A template for this file is supplied as the file
1865 &_src/EDITME_&, and it contains full descriptions of all the option settings
1866 therein. These descriptions are therefore not repeated here. If you are
1867 building Exim for the first time, the simplest thing to do is to copy
1868 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1869
1870 There are three settings that you must supply, because Exim will not build
1871 without them. They are the location of the runtime configuration file
1872 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1873 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1874 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1875 a colon-separated list of filenames; Exim uses the first of them that exists.
1876
1877 There are a few other parameters that can be specified either at build time or
1878 at runtime, to enable the same binary to be used on a number of different
1879 machines. However, if the locations of Exim's spool directory and log file
1880 directory (if not within the spool directory) are fixed, it is recommended that
1881 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1882 detected early in Exim's execution (such as a malformed configuration file) can
1883 be logged.
1884
1885 .cindex "content scanning" "specifying at build time"
1886 Exim's interfaces for calling virus and spam scanning software directly from
1887 access control lists are not compiled by default. If you want to include these
1888 facilities, you need to set
1889 .code
1890 WITH_CONTENT_SCAN=yes
1891 .endd
1892 in your &_Local/Makefile_&. For details of the facilities themselves, see
1893 chapter &<<CHAPexiscan>>&.
1894
1895
1896 .cindex "&_Local/eximon.conf_&"
1897 .cindex "&_exim_monitor/EDITME_&"
1898 If you are going to build the Exim monitor, a similar configuration process is
1899 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1900 your installation and saved under the name &_Local/eximon.conf_&. If you are
1901 happy with the default settings described in &_exim_monitor/EDITME_&,
1902 &_Local/eximon.conf_& can be empty, but it must exist.
1903
1904 This is all the configuration that is needed in straightforward cases for known
1905 operating systems. However, the building process is set up so that it is easy
1906 to override options that are set by default or by operating-system-specific
1907 configuration files, for example, to change the C compiler, which
1908 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1909 do this.
1910
1911
1912
1913 .section "Support for iconv()" "SECID26"
1914 .cindex "&[iconv()]& support"
1915 .cindex "RFC 2047"
1916 The contents of header lines in messages may be encoded according to the rules
1917 described RFC 2047. This makes it possible to transmit characters that are not
1918 in the ASCII character set, and to label them as being in a particular
1919 character set. When Exim is inspecting header lines by means of the &%$h_%&
1920 mechanism, it decodes them, and translates them into a specified character set
1921 (default is set at build time). The translation is possible only if the operating system
1922 supports the &[iconv()]& function.
1923
1924 However, some of the operating systems that supply &[iconv()]& do not support
1925 very many conversions. The GNU &%libiconv%& library (available from
1926 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1927 systems to remedy this deficiency, as well as on systems that do not supply
1928 &[iconv()]& at all. After installing &%libiconv%&, you should add
1929 .code
1930 HAVE_ICONV=yes
1931 .endd
1932 to your &_Local/Makefile_& and rebuild Exim.
1933
1934
1935
1936 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1937 .cindex "TLS" "including support for TLS"
1938 .cindex "encryption" "including support for"
1939 .cindex "OpenSSL" "building Exim with"
1940 .cindex "GnuTLS" "building Exim with"
1941 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1942 command as per RFC 2487. It can also support clients that expect to
1943 start a TLS session immediately on connection to a non-standard port (see the
1944 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1945 line option).
1946
1947 If you want to build Exim with TLS support, you must first install either the
1948 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1949 implementing SSL.
1950
1951 If you do not want TLS support you should set
1952 .code
1953 DISABLE_TLS=yes
1954 .endd
1955 in &_Local/Makefile_&.
1956
1957 If OpenSSL is installed, you should set
1958 .code
1959 USE_OPENSL=yes
1960 TLS_LIBS=-lssl -lcrypto
1961 .endd
1962 in &_Local/Makefile_&. You may also need to specify the locations of the
1963 OpenSSL library and include files. For example:
1964 .code
1965 USE_OPENSSL=yes
1966 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1967 TLS_INCLUDE=-I/usr/local/openssl/include/
1968 .endd
1969 .cindex "pkg-config" "OpenSSL"
1970 If you have &'pkg-config'& available, then instead you can just use:
1971 .code
1972 USE_OPENSSL=yes
1973 USE_OPENSSL_PC=openssl
1974 .endd
1975 .cindex "USE_GNUTLS"
1976 If GnuTLS is installed, you should set
1977 .code
1978 USE_GNUTLS=yes
1979 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1980 .endd
1981 in &_Local/Makefile_&, and again you may need to specify the locations of the
1982 library and include files. For example:
1983 .code
1984 USE_GNUTLS=yes
1985 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1986 TLS_INCLUDE=-I/usr/gnu/include
1987 .endd
1988 .cindex "pkg-config" "GnuTLS"
1989 If you have &'pkg-config'& available, then instead you can just use:
1990 .code
1991 USE_GNUTLS=yes
1992 USE_GNUTLS_PC=gnutls
1993 .endd
1994
1995 You do not need to set TLS_INCLUDE if the relevant directory is already
1996 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1997 given in chapter &<<CHAPTLS>>&.
1998
1999
2000
2001
2002 .section "Use of tcpwrappers" "SECID27"
2003
2004 .cindex "tcpwrappers, building Exim to support"
2005 .cindex "USE_TCP_WRAPPERS"
2006 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2007 .cindex "tcp_wrappers_daemon_name"
2008 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2009 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2010 alternative to Exim's own checking facilities for installations that are
2011 already making use of &'tcpwrappers'& for other purposes. To do this, you
2012 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2013 &_tcpd.h_& to be available at compile time, and also ensure that the library
2014 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2015 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2016 you might have
2017 .code
2018 USE_TCP_WRAPPERS=yes
2019 CFLAGS=-O -I/usr/local/include
2020 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2021 .endd
2022 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2023 files is &"exim"&. For example, the line
2024 .code
2025 exim : LOCAL  192.168.1.  .friendly.domain.example
2026 .endd
2027 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2028 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2029 All other connections are denied. The daemon name used by &'tcpwrappers'&
2030 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2031 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2032 configure file. Consult the &'tcpwrappers'& documentation for
2033 further details.
2034
2035
2036 .section "Including support for IPv6" "SECID28"
2037 .cindex "IPv6" "including support for"
2038 Exim contains code for use on systems that have IPv6 support. Setting
2039 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2040 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2041 where the IPv6 support is not fully integrated into the normal include and
2042 library files.
2043
2044 Two different types of DNS record for handling IPv6 addresses have been
2045 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2046 currently seen as the mainstream. Another record type called A6 was proposed
2047 as better than AAAA because it had more flexibility. However, it was felt to be
2048 over-complex, and its status was reduced to &"experimental"&.
2049 Exim used to
2050 have a compile option for including A6 record support but this has now been
2051 withdrawn.
2052
2053
2054
2055 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2056 .cindex "lookup modules"
2057 .cindex "dynamic modules"
2058 .cindex ".so building"
2059 On some platforms, Exim supports not compiling all lookup types directly into
2060 the main binary, instead putting some into external modules which can be loaded
2061 on demand.
2062 This permits packagers to build Exim with support for lookups with extensive
2063 library dependencies without requiring all users to install all of those
2064 dependencies.
2065 Most, but not all, lookup types can be built this way.
2066
2067 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2068 installed; Exim will only load modules from that directory, as a security
2069 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2070 for your OS; see &_OS/Makefile-Linux_& for an example.
2071 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2072 see &_src/EDITME_& for details.
2073
2074 Then, for each module to be loaded dynamically, define the relevant
2075 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2076 For example, this will build in lsearch but load sqlite and mysql support
2077 on demand:
2078 .code
2079 LOOKUP_LSEARCH=yes
2080 LOOKUP_SQLITE=2
2081 LOOKUP_MYSQL=2
2082 .endd
2083
2084
2085 .section "The building process" "SECID29"
2086 .cindex "build directory"
2087 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2088 created, run &'make'& at the top level. It determines the architecture and
2089 operating system types, and creates a build directory if one does not exist.
2090 For example, on a Sun system running Solaris 8, the directory
2091 &_build-SunOS5-5.8-sparc_& is created.
2092 .cindex "symbolic link" "to source files"
2093 Symbolic links to relevant source files are installed in the build directory.
2094
2095 If this is the first time &'make'& has been run, it calls a script that builds
2096 a make file inside the build directory, using the configuration files from the
2097 &_Local_& directory. The new make file is then passed to another instance of
2098 &'make'&. This does the real work, building a number of utility scripts, and
2099 then compiling and linking the binaries for the Exim monitor (if configured), a
2100 number of utility programs, and finally Exim itself. The command &`make
2101 makefile`& can be used to force a rebuild of the make file in the build
2102 directory, should this ever be necessary.
2103
2104 If you have problems building Exim, check for any comments there may be in the
2105 &_README_& file concerning your operating system, and also take a look at the
2106 FAQ, where some common problems are covered.
2107
2108
2109
2110 .section 'Output from &"make"&' "SECID283"
2111 The output produced by the &'make'& process for compile lines is often very
2112 unreadable, because these lines can be very long. For this reason, the normal
2113 output is suppressed by default, and instead output similar to that which
2114 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2115 each module that is being compiled or linked. However, it is still possible to
2116 get the full output, by calling &'make'& like this:
2117 .code
2118 FULLECHO='' make -e
2119 .endd
2120 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2121 command reflection in &'make'&. When you ask for the full output, it is
2122 given in addition to the short output.
2123
2124
2125
2126 .section "Overriding build-time options for Exim" "SECToverride"
2127 .cindex "build-time options, overriding"
2128 The main make file that is created at the beginning of the building process
2129 consists of the concatenation of a number of files which set configuration
2130 values, followed by a fixed set of &'make'& instructions. If a value is set
2131 more than once, the last setting overrides any previous ones. This provides a
2132 convenient way of overriding defaults. The files that are concatenated are, in
2133 order:
2134 .display
2135 &_OS/Makefile-Default_&
2136 &_OS/Makefile-_&<&'ostype'&>
2137 &_Local/Makefile_&
2138 &_Local/Makefile-_&<&'ostype'&>
2139 &_Local/Makefile-_&<&'archtype'&>
2140 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2141 &_OS/Makefile-Base_&
2142 .endd
2143 .cindex "&_Local/Makefile_&"
2144 .cindex "building Exim" "operating system type"
2145 .cindex "building Exim" "architecture type"
2146 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2147 architecture type. &_Local/Makefile_& is required to exist, and the building
2148 process fails if it is absent. The other three &_Local_& files are optional,
2149 and are often not needed.
2150
2151 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2152 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2153 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2154 values are used, thereby providing a means of forcing particular settings.
2155 Otherwise, the scripts try to get values from the &%uname%& command. If this
2156 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2157 of &'ad hoc'& transformations are then applied, to produce the standard names
2158 that Exim expects. You can run these scripts directly from the shell in order
2159 to find out what values are being used on your system.
2160
2161
2162 &_OS/Makefile-Default_& contains comments about the variables that are set
2163 therein. Some (but not all) are mentioned below. If there is something that
2164 needs changing, review the contents of this file and the contents of the make
2165 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2166 default values are.
2167
2168
2169 .cindex "building Exim" "overriding default settings"
2170 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2171 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2172 need to change the original files. Instead, you should make the changes by
2173 putting the new values in an appropriate &_Local_& file. For example,
2174 .cindex "Tru64-Unix build-time settings"
2175 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2176 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2177 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2178 called with the option &%-std1%&, to make it recognize some of the features of
2179 Standard C that Exim uses. (Most other compilers recognize Standard C by
2180 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2181 containing the lines
2182 .code
2183 CC=cc
2184 CFLAGS=-std1
2185 .endd
2186 If you are compiling for just one operating system, it may be easier to put
2187 these lines directly into &_Local/Makefile_&.
2188
2189 Keeping all your local configuration settings separate from the distributed
2190 files makes it easy to transfer them to new versions of Exim simply by copying
2191 the contents of the &_Local_& directory.
2192
2193
2194 .cindex "NIS lookup type" "including support for"
2195 .cindex "NIS+ lookup type" "including support for"
2196 .cindex "LDAP" "including support for"
2197 .cindex "lookup" "inclusion in binary"
2198 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2199 lookup, but not all systems have these components installed, so the default is
2200 not to include the relevant code in the binary. All the different kinds of file
2201 and database lookup that Exim supports are implemented as separate code modules
2202 which are included only if the relevant compile-time options are set. In the
2203 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2204 .code
2205 LOOKUP_LDAP=yes
2206 LOOKUP_NIS=yes
2207 LOOKUP_NISPLUS=yes
2208 .endd
2209 and similar settings apply to the other lookup types. They are all listed in
2210 &_src/EDITME_&. In many cases the relevant include files and interface
2211 libraries need to be installed before compiling Exim.
2212 .cindex "cdb" "including support for"
2213 However, there are some optional lookup types (such as cdb) for which
2214 the code is entirely contained within Exim, and no external include
2215 files or libraries are required. When a lookup type is not included in the
2216 binary, attempts to configure Exim to use it cause runtime configuration
2217 errors.
2218
2219 .cindex "pkg-config" "lookups"
2220 .cindex "pkg-config" "authenticators"
2221 Many systems now use a tool called &'pkg-config'& to encapsulate information
2222 about how to compile against a library; Exim has some initial support for
2223 being able to use pkg-config for lookups and authenticators.  For any given
2224 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2225 variable with the &`_PC`& suffix in the name and assign as the value the
2226 name of the package to be queried.  The results of querying via the
2227 &'pkg-config'& command will be added to the appropriate Makefile variables
2228 with &`+=`& directives, so your version of &'make'& will need to support that
2229 syntax.  For instance:
2230 .code
2231 LOOKUP_SQLITE=yes
2232 LOOKUP_SQLITE_PC=sqlite3
2233 AUTH_GSASL=yes
2234 AUTH_GSASL_PC=libgsasl
2235 AUTH_HEIMDAL_GSSAPI=yes
2236 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2237 .endd
2238
2239 .cindex "Perl" "including support for"
2240 Exim can be linked with an embedded Perl interpreter, allowing Perl
2241 subroutines to be called during string expansion. To enable this facility,
2242 .code
2243 EXIM_PERL=perl.o
2244 .endd
2245 must be defined in &_Local/Makefile_&. Details of this facility are given in
2246 chapter &<<CHAPperl>>&.
2247
2248 .cindex "X11 libraries, location of"
2249 The location of the X11 libraries is something that varies a lot between
2250 operating systems, and there may be different versions of X11 to cope
2251 with. Exim itself makes no use of X11, but if you are compiling the Exim
2252 monitor, the X11 libraries must be available.
2253 The following three variables are set in &_OS/Makefile-Default_&:
2254 .code
2255 X11=/usr/X11R6
2256 XINCLUDE=-I$(X11)/include
2257 XLFLAGS=-L$(X11)/lib
2258 .endd
2259 These are overridden in some of the operating-system configuration files. For
2260 example, in &_OS/Makefile-SunOS5_& there is
2261 .code
2262 X11=/usr/openwin
2263 XINCLUDE=-I$(X11)/include
2264 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2265 .endd
2266 If you need to override the default setting for your operating system, place a
2267 definition of all three of these variables into your
2268 &_Local/Makefile-<ostype>_& file.
2269
2270 .cindex "EXTRALIBS"
2271 If you need to add any extra libraries to the link steps, these can be put in a
2272 variable called EXTRALIBS, which appears in all the link commands, but by
2273 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2274 command for linking the main Exim binary, and not for any associated utilities.
2275
2276 .cindex "DBM libraries" "configuration for building"
2277 There is also DBMLIB, which appears in the link commands for binaries that
2278 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2279 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2280 binary, and which can be used, for example, to include additional X11
2281 libraries.
2282
2283 .cindex "configuration file" "editing"
2284 The make file copes with rebuilding Exim correctly if any of the configuration
2285 files are edited. However, if an optional configuration file is deleted, it is
2286 necessary to touch the associated non-optional file (that is,
2287 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2288
2289
2290 .section "OS-specific header files" "SECID30"
2291 .cindex "&_os.h_&"
2292 .cindex "building Exim" "OS-specific C header files"
2293 The &_OS_& directory contains a number of files with names of the form
2294 &_os.h-<ostype>_&. These are system-specific C header files that should not
2295 normally need to be changed. There is a list of macro settings that are
2296 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2297 are porting Exim to a new operating system.
2298
2299
2300
2301 .section "Overriding build-time options for the monitor" "SECID31"
2302 .cindex "building Eximon"
2303 A similar process is used for overriding things when building the Exim monitor,
2304 where the files that are involved are
2305 .display
2306 &_OS/eximon.conf-Default_&
2307 &_OS/eximon.conf-_&<&'ostype'&>
2308 &_Local/eximon.conf_&
2309 &_Local/eximon.conf-_&<&'ostype'&>
2310 &_Local/eximon.conf-_&<&'archtype'&>
2311 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2312 .endd
2313 .cindex "&_Local/eximon.conf_&"
2314 As with Exim itself, the final three files need not exist, and in this case the
2315 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2316 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2317 variables of the same name, preceded by EXIMON_. For example, setting
2318 EXIMON_LOG_DEPTH in the environment overrides the value of
2319 LOG_DEPTH at runtime.
2320 .ecindex IIDbuex
2321
2322
2323 .section "Installing Exim binaries and scripts" "SECID32"
2324 .cindex "installing Exim"
2325 .cindex "BIN_DIRECTORY"
2326 The command &`make install`& runs the &(exim_install)& script with no
2327 arguments. The script copies binaries and utility scripts into the directory
2328 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2329 .cindex "setuid" "installing Exim with"
2330 The install script copies files only if they are newer than the files they are
2331 going to replace. The Exim binary is required to be owned by root and have the
2332 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2333 install`& as root so that it can set up the Exim binary in this way. However, in
2334 some special situations (for example, if a host is doing no local deliveries)
2335 it may be possible to run Exim without making the binary setuid root (see
2336 chapter &<<CHAPsecurity>>& for details).
2337
2338 .cindex "CONFIGURE_FILE"
2339 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2340 in &_Local/Makefile_&. If this names a single file, and the file does not
2341 exist, the default configuration file &_src/configure.default_& is copied there
2342 by the installation script. If a runtime configuration file already exists, it
2343 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2344 alternative files, no default is installed.
2345
2346 .cindex "system aliases file"
2347 .cindex "&_/etc/aliases_&"
2348 One change is made to the default configuration file when it is installed: the
2349 default configuration contains a router that references a system aliases file.
2350 The path to this file is set to the value specified by
2351 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2352 If the system aliases file does not exist, the installation script creates it,
2353 and outputs a comment to the user.
2354
2355 The created file contains no aliases, but it does contain comments about the
2356 aliases a site should normally have. Mail aliases have traditionally been
2357 kept in &_/etc/aliases_&. However, some operating systems are now using
2358 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2359 Exim's configuration if necessary.
2360
2361 The default configuration uses the local host's name as the only local domain,
2362 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2363 running as the local user. System aliases and &_.forward_& files in users' home
2364 directories are supported, but no NIS or NIS+ support is configured. Domains
2365 other than the name of the local host are routed using the DNS, with delivery
2366 over SMTP.
2367
2368 It is possible to install Exim for special purposes (such as building a binary
2369 distribution) in a private part of the file system. You can do this by a
2370 command such as
2371 .code
2372 make DESTDIR=/some/directory/ install
2373 .endd
2374 This has the effect of pre-pending the specified directory to all the file
2375 paths, except the name of the system aliases file that appears in the default
2376 configuration. (If a default alias file is created, its name &'is'& modified.)
2377 For backwards compatibility, ROOT is used if DESTDIR is not set,
2378 but this usage is deprecated.
2379
2380 .cindex "installing Exim" "what is not installed"
2381 Running &'make install'& does not copy the Exim 4 conversion script
2382 &'convert4r4'&. You will probably run this only once if you are
2383 upgrading from Exim 3. None of the documentation files in the &_doc_&
2384 directory are copied, except for the info files when you have set
2385 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2386
2387 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2388 to their names. The Exim binary itself, however, is handled differently. It is
2389 installed under a name that includes the version number and the compile number,
2390 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2391 called &_exim_& to point to the binary. If you are updating a previous version
2392 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2393 from the directory (as seen by other processes).
2394
2395 .cindex "installing Exim" "testing the script"
2396 If you want to see what the &'make install'& will do before running it for
2397 real, you can pass the &%-n%& option to the installation script by this
2398 command:
2399 .code
2400 make INSTALL_ARG=-n install
2401 .endd
2402 The contents of the variable INSTALL_ARG are passed to the installation
2403 script. You do not need to be root to run this test. Alternatively, you can run
2404 the installation script directly, but this must be from within the build
2405 directory. For example, from the top-level Exim directory you could use this
2406 command:
2407 .code
2408 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2409 .endd
2410 .cindex "installing Exim" "install script options"
2411 There are two other options that can be supplied to the installation script.
2412
2413 .ilist
2414 &%-no_chown%& bypasses the call to change the owner of the installed binary
2415 to root, and the call to make it a setuid binary.
2416 .next
2417 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2418 installed binary.
2419 .endlist
2420
2421 INSTALL_ARG can be used to pass these options to the script. For example:
2422 .code
2423 make INSTALL_ARG=-no_symlink install
2424 .endd
2425 The installation script can also be given arguments specifying which files are
2426 to be copied. For example, to install just the Exim binary, and nothing else,
2427 without creating the symbolic link, you could use:
2428 .code
2429 make INSTALL_ARG='-no_symlink exim' install
2430 .endd
2431
2432
2433
2434 .section "Installing info documentation" "SECTinsinfdoc"
2435 .cindex "installing Exim" "&'info'& documentation"
2436 Not all systems use the GNU &'info'& system for documentation, and for this
2437 reason, the Texinfo source of Exim's documentation is not included in the main
2438 distribution. Instead it is available separately from the FTP site (see section
2439 &<<SECTavail>>&).
2440
2441 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2442 source of the documentation is found in the source tree, running &`make
2443 install`& automatically builds the info files and installs them.
2444
2445
2446
2447 .section "Setting up the spool directory" "SECID33"
2448 .cindex "spool directory" "creating"
2449 When it starts up, Exim tries to create its spool directory if it does not
2450 exist. The Exim uid and gid are used for the owner and group of the spool
2451 directory. Sub-directories are automatically created in the spool directory as
2452 necessary.
2453
2454
2455
2456
2457 .section "Testing" "SECID34"
2458 .cindex "testing" "installation"
2459 Having installed Exim, you can check that the runtime configuration file is
2460 syntactically valid by running the following command, which assumes that the
2461 Exim binary directory is within your PATH environment variable:
2462 .code
2463 exim -bV
2464 .endd
2465 If there are any errors in the configuration file, Exim outputs error messages.
2466 Otherwise it outputs the version number and build date,
2467 the DBM library that is being used, and information about which drivers and
2468 other optional code modules are included in the binary.
2469 Some simple routing tests can be done by using the address testing option. For
2470 example,
2471 .display
2472 &`exim -bt`& <&'local username'&>
2473 .endd
2474 should verify that it recognizes a local mailbox, and
2475 .display
2476 &`exim -bt`& <&'remote address'&>
2477 .endd
2478 a remote one. Then try getting it to deliver mail, both locally and remotely.
2479 This can be done by passing messages directly to Exim, without going through a
2480 user agent. For example:
2481 .code
2482 exim -v postmaster@your.domain.example
2483 From: user@your.domain.example
2484 To: postmaster@your.domain.example
2485 Subject: Testing Exim
2486
2487 This is a test message.
2488 ^D
2489 .endd
2490 The &%-v%& option causes Exim to output some verification of what it is doing.
2491 In this case you should see copies of three log lines, one for the message's
2492 arrival, one for its delivery, and one containing &"Completed"&.
2493
2494 .cindex "delivery" "problems with"
2495 If you encounter problems, look at Exim's log files (&'mainlog'& and
2496 &'paniclog'&) to see if there is any relevant information there. Another source
2497 of information is running Exim with debugging turned on, by specifying the
2498 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2499 with debugging turned on by a command of the form
2500 .display
2501 &`exim -d -M`& <&'exim-message-id'&>
2502 .endd
2503 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2504 produces rather a lot of output, but you can cut this down to specific areas.
2505 For example, if you use &%-d-all+route%& only the debugging information
2506 relevant to routing is included. (See the &%-d%& option in chapter
2507 &<<CHAPcommandline>>& for more details.)
2508
2509 .cindex '&"sticky"& bit'
2510 .cindex "lock files"
2511 One specific problem that has shown up on some sites is the inability to do
2512 local deliveries into a shared mailbox directory, because it does not have the
2513 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2514 writing to a mailbox file, and if it cannot create the lock file, the delivery
2515 is deferred. You can get round this either by setting the &"sticky bit"& on the
2516 directory, or by setting a specific group for local deliveries and allowing
2517 that group to create files in the directory (see the comments above the
2518 &(local_delivery)& transport in the default configuration file). Another
2519 approach is to configure Exim not to use lock files, but just to rely on
2520 &[fcntl()]& locking instead. However, you should do this only if all user
2521 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2522 see chapter &<<CHAPappendfile>>&.
2523
2524 One thing that cannot be tested on a system that is already running an MTA is
2525 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2526 &%-oX%& option can be used to run an Exim daemon that listens on some other
2527 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2528 &'exim_checkaccess'& utility can be used to check out policy controls on
2529 incoming SMTP mail.
2530
2531 Testing a new version on a system that is already running Exim can most easily
2532 be done by building a binary with a different CONFIGURE_FILE setting. From
2533 within the runtime configuration, all other file and directory names
2534 that Exim uses can be altered, in order to keep it entirely clear of the
2535 production version.
2536
2537
2538 .section "Replacing another MTA with Exim" "SECID35"
2539 .cindex "replacing another MTA"
2540 Building and installing Exim for the first time does not of itself put it in
2541 general use. The name by which the system's MTA is called by mail user agents
2542 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2543 operating system), and it is necessary to make this name point to the &'exim'&
2544 binary in order to get the user agents to pass messages to Exim. This is
2545 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2546 or &_/usr/lib/sendmail_&
2547 .cindex "symbolic link" "to &'exim'& binary"
2548 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2549 privilege and executable status from the old MTA. It is then necessary to stop
2550 and restart the mailer daemon, if one is running.
2551
2552 .cindex "FreeBSD, MTA indirection"
2553 .cindex "&_/etc/mail/mailer.conf_&"
2554 Some operating systems have introduced alternative ways of switching MTAs. For
2555 example, if you are running FreeBSD, you need to edit the file
2556 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2557 described. A typical example of the contents of this file for running Exim is
2558 as follows:
2559 .code
2560 sendmail            /usr/exim/bin/exim
2561 send-mail           /usr/exim/bin/exim
2562 mailq               /usr/exim/bin/exim -bp
2563 newaliases          /usr/bin/true
2564 .endd
2565 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2566 your Exim installation is &"live"&. Check it by sending a message from your
2567 favourite user agent.
2568
2569 You should consider what to tell your users about the change of MTA. Exim may
2570 have different capabilities to what was previously running, and there are
2571 various operational differences such as the text of messages produced by
2572 command line options and in bounce messages. If you allow your users to make
2573 use of Exim's filtering capabilities, you should make the document entitled
2574 &'Exim's interface to mail filtering'& available to them.
2575
2576
2577
2578 .section "Running the daemon" SECTdaemonLaunch
2579 The most common command line for launching the Exim daemon looks like
2580 .code
2581 exim -bd -q5m
2582 .endd
2583 This starts a daemon which
2584 .ilist
2585 listens for incoming smtp connections, launching handler processes for
2586 each new one
2587 .next
2588 starts a queue-runner process every five minutes, to inspect queued messages
2589 and run delivery attempts on any that have arrived at their retry time
2590 .endlist
2591 Should a queue run take longer than the time between queue-runner starts,
2592 they will run in parallel.
2593 Numbers of jobs of the various types are subject to policy controls
2594 defined in the configuration.
2595
2596
2597 .section "Upgrading Exim" "SECID36"
2598 .cindex "upgrading Exim"
2599 If you are already running Exim on your host, building and installing a new
2600 version automatically makes it available to MUAs, or any other programs that
2601 call the MTA directly. However, if you are running an Exim daemon, you do need
2602 .cindex restart "on HUP signal"
2603 .cindex signal "HUP, to restart"
2604 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2605 new binary. You do not need to stop processing mail in order to install a new
2606 version of Exim. The install script does not modify an existing runtime
2607 configuration file.
2608
2609
2610
2611
2612 .section "Stopping the Exim daemon on Solaris" "SECID37"
2613 .cindex "Solaris" "stopping Exim on"
2614 The standard command for stopping the mailer daemon on Solaris is
2615 .code
2616 /etc/init.d/sendmail stop
2617 .endd
2618 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2619 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2620 for the text &"sendmail"&; this is not present because the actual program name
2621 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2622 solution is to replace the line that finds the process id with something like
2623 .code
2624 pid=`cat /var/spool/exim/exim-daemon.pid`
2625 .endd
2626 to obtain the daemon's pid directly from the file that Exim saves it in.
2627
2628 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2629 still be received from local processes, and if automatic delivery is configured
2630 (the normal case), deliveries will still occur.
2631
2632
2633
2634
2635 . ////////////////////////////////////////////////////////////////////////////
2636 . ////////////////////////////////////////////////////////////////////////////
2637
2638 .chapter "The Exim command line" "CHAPcommandline"
2639 .scindex IIDclo1 "command line" "options"
2640 .scindex IIDclo2 "options" "command line"
2641 Exim's command line takes the standard Unix form of a sequence of options,
2642 each starting with a hyphen character, followed by a number of arguments. The
2643 options are compatible with the main options of Sendmail, and there are also
2644 some additional options, some of which are compatible with Smail 3. Certain
2645 combinations of options do not make sense, and provoke an error if used.
2646 The form of the arguments depends on which options are set.
2647
2648
2649 .section "Setting options by program name" "SECID38"
2650 .cindex "&'mailq'&"
2651 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2652 were present before any other options.
2653 The &%-bp%& option requests a listing of the contents of the mail queue on the
2654 standard output.
2655 This feature is for compatibility with some systems that contain a command of
2656 that name in one of the standard libraries, symbolically linked to
2657 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2658
2659 .cindex "&'rsmtp'&"
2660 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2661 were present before any other options, for compatibility with Smail. The
2662 &%-bS%& option is used for reading in a number of messages in batched SMTP
2663 format.
2664
2665 .cindex "&'rmail'&"
2666 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2667 &%-oee%& options were present before any other options, for compatibility with
2668 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2669
2670 .cindex "&'runq'&"
2671 .cindex "queue runner"
2672 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2673 were present before any other options, for compatibility with Smail. The &%-q%&
2674 option causes a single queue runner process to be started.
2675
2676 .cindex "&'newaliases'&"
2677 .cindex "alias file" "building"
2678 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2679 If Exim is called under the name &'newaliases'& it behaves as if the option
2680 &%-bi%& were present before any other options, for compatibility with Sendmail.
2681 This option is used for rebuilding Sendmail's alias file. Exim does not have
2682 the concept of a single alias file, but can be configured to run a given
2683 command if called with the &%-bi%& option.
2684
2685
2686 .section "Trusted and admin users" "SECTtrustedadmin"
2687 Some Exim options are available only to &'trusted users'& and others are
2688 available only to &'admin users'&. In the description below, the phrases &"Exim
2689 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2690 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2691 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2692
2693 .ilist
2694 .cindex "trusted users" "definition of"
2695 .cindex "user" "trusted definition of"
2696 The trusted users are root, the Exim user, any user listed in the
2697 &%trusted_users%& configuration option, and any user whose current group or any
2698 supplementary group is one of those listed in the &%trusted_groups%&
2699 configuration option. Note that the Exim group is not automatically trusted.
2700
2701 .cindex '&"From"& line'
2702 .cindex "envelope from"
2703 .cindex "envelope sender"
2704 Trusted users are always permitted to use the &%-f%& option or a leading
2705 &"From&~"& line to specify the envelope sender of a message that is passed to
2706 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2707 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2708 users to set envelope senders.
2709
2710 .chindex From:
2711 .chindex Sender:
2712 For a trusted user, there is never any check on the contents of the &'From:'&
2713 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2714 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2715
2716 Trusted users may also specify a host name, host address, interface address,
2717 protocol name, ident value, and authentication data when submitting a message
2718 locally. Thus, they are able to insert messages into Exim's queue locally that
2719 have the characteristics of messages received from a remote host. Untrusted
2720 users may in some circumstances use &%-f%&, but can never set the other values
2721 that are available to trusted users.
2722 .next
2723 .cindex "user" "admin definition of"
2724 .cindex "admin user" "definition of"
2725 The admin users are root, the Exim user, and any user that is a member of the
2726 Exim group or of any group listed in the &%admin_groups%& configuration option.
2727 The current group does not have to be one of these groups.
2728
2729 Admin users are permitted to list the queue, and to carry out certain
2730 operations on messages, for example, to force delivery failures. It is also
2731 necessary to be an admin user in order to see the full information provided by
2732 the Exim monitor, and full debugging output.
2733
2734 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2735 Exim to attempt delivery of messages on its queue is restricted to admin users.
2736 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2737 option false (that is, specifying &%no_prod_requires_admin%&).
2738
2739 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2740 is restricted to admin users unless &%queue_list_requires_admin%& is set
2741 false.
2742 .endlist
2743
2744
2745 &*Warning*&: If you configure your system so that admin users are able to
2746 edit Exim's configuration file, you are giving those users an easy way of
2747 getting root. There is further discussion of this issue at the start of chapter
2748 &<<CHAPconf>>&.
2749
2750
2751
2752
2753 .section "Command line options" "SECID39"
2754 Exim's command line options are described in alphabetical order below. If none
2755 of the options that specifies a specific action (such as starting the daemon or
2756 a queue runner, or testing an address, or receiving a message in a specific
2757 format, or listing the queue) are present, and there is at least one argument
2758 on the command line, &%-bm%& (accept a local message on the standard input,
2759 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2760 outputs a brief message about itself and exits.
2761
2762 . ////////////////////////////////////////////////////////////////////////////
2763 . Insert a stylized XML comment here, to identify the start of the command line
2764 . options. This is for the benefit of the Perl script that automatically
2765 . creates a man page for the options.
2766 . ////////////////////////////////////////////////////////////////////////////
2767
2768 .literal xml
2769 <!-- === Start of command line options === -->
2770 .literal off
2771
2772
2773 .vlist
2774 .cmdopt "--" "--"
2775 .cindex "options" "command line; terminating"
2776 This is a pseudo-option whose only purpose is to terminate the options and
2777 therefore to cause subsequent command line items to be treated as arguments
2778 rather than options, even if they begin with hyphens.
2779
2780 .cmdopt --help
2781 This option causes Exim to output a few sentences stating what it is.
2782 The same output is generated if the Exim binary is called with no options and
2783 no arguments.
2784
2785 .cmdopt --version
2786 This option is an alias for &%-bV%& and causes version information to be
2787 displayed.
2788
2789 .vitem &%-Ac%& &&&
2790        &%-Am%&
2791 .oindex "&%-Ac%&"
2792 .oindex "&%-Am%&"
2793 These options are used by Sendmail for selecting configuration files and are
2794 ignored by Exim.
2795
2796 .cmdopt -B <&'type'&>
2797 .oindex "&%-B%&"
2798 .cindex "8-bit characters"
2799 .cindex "Sendmail compatibility" "8-bit characters"
2800 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2801 clean; it ignores this option.
2802
2803 .cmdopt -bd
2804 .cindex "daemon"
2805 .cindex "SMTP" "listener"
2806 .cindex "queue runner"
2807 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2808 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2809 that the daemon should also initiate periodic queue runs.
2810
2811 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2812 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2813 disconnect from the controlling terminal. When running this way, it can be
2814 stopped by pressing ctrl-C.
2815
2816 By default, Exim listens for incoming connections to the standard SMTP port on
2817 all the host's running interfaces. However, it is possible to listen on other
2818 ports, on multiple ports, and only on specific interfaces. Chapter
2819 &<<CHAPinterfaces>>& contains a description of the options that control this.
2820
2821 When a listening daemon
2822 .cindex "daemon" "process id (pid)"
2823 .cindex "pid (process id)" "of daemon"
2824 is started without the use of &%-oX%& (that is, without overriding the normal
2825 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2826 in Exim's spool directory. This location can be overridden by setting
2827 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2828 running as root.
2829
2830 When &%-oX%& is used on the command line to start a listening daemon, the
2831 process id is not written to the normal pid file path. However, &%-oP%& can be
2832 used to specify a path on the command line if a pid file is required.
2833
2834 The SIGHUP signal
2835 .cindex "SIGHUP"
2836 .cindex restart "on HUP signal"
2837 .cindex signal "HUP, to restart"
2838 .cindex "daemon" "restarting"
2839 .cindex signal "to reload configuration"
2840 .cindex daemon "reload configuration"
2841 .cindex reload configuration
2842 can be used to cause the daemon to re-execute itself. This should be done
2843 whenever Exim's configuration file, or any file that is incorporated into it by
2844 means of the &%.include%& facility, is changed, and also whenever a new version
2845 of Exim is installed. It is not necessary to do this when other files that are
2846 referenced from the configuration (for example, alias files) are changed,
2847 because these are reread each time they are used.
2848
2849 .new
2850 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2851 to cleanly shut down.
2852 Subprocesses handling recceiving or delivering messages,
2853 or for scanning the queue,
2854 will not be affected by the termination of the daemon process.
2855 .wen
2856
2857 .cmdopt -bdf
2858 This option has the same effect as &%-bd%& except that it never disconnects
2859 from the controlling terminal, even when no debugging is specified.
2860
2861 .cmdopt -be
2862 .cindex "testing" "string expansion"
2863 .cindex "expansion" "testing"
2864 Run Exim in expansion testing mode. Exim discards its root privilege, to
2865 prevent ordinary users from using this mode to read otherwise inaccessible
2866 files. If no arguments are given, Exim runs interactively, prompting for lines
2867 of data. Otherwise, it processes each argument in turn.
2868
2869 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2870 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2871 used without command line arguments. If successful, it uses the &[readline()]&
2872 function, which provides extensive line-editing facilities, for reading the
2873 test data. A line history is supported.
2874
2875 Long expansion expressions can be split over several lines by using backslash
2876 continuations. As in Exim's runtime configuration, white space at the start of
2877 continuation lines is ignored. Each argument or data line is passed through the
2878 string expansion mechanism, and the result is output. Variable values from the
2879 configuration file (for example, &$qualify_domain$&) are available, but no
2880 message-specific values (such as &$message_exim_id$&) are set, because no message
2881 is being processed (but see &%-bem%& and &%-Mset%&).
2882
2883 &*Note*&: If you use this mechanism to test lookups, and you change the data
2884 files or databases you are using, you must exit and restart Exim before trying
2885 the same lookup again. Otherwise, because each Exim process caches the results
2886 of lookups, you will just get the same result as before.
2887
2888 Macro processing is done on lines before string-expansion: new macros can be
2889 defined and macros will be expanded.
2890 Because macros in the config file are often used for secrets, those are only
2891 available to admin users.
2892
2893 .new
2894 The word &"set"& at the start of a line, followed by a single space,
2895 is recognised specially as defining a value for a variable.
2896 The syntax is otherwise the same as the ACL modifier &"set ="&.
2897 .wen
2898
2899 .cmdopt -bem <&'filename'&>
2900 .cindex "testing" "string expansion"
2901 .cindex "expansion" "testing"
2902 This option operates like &%-be%& except that it must be followed by the name
2903 of a file. For example:
2904 .code
2905 exim -bem /tmp/testmessage
2906 .endd
2907 The file is read as a message (as if receiving a locally-submitted non-SMTP
2908 message) before any of the test expansions are done. Thus, message-specific
2909 variables such as &$message_size$& and &$header_from:$& are available. However,
2910 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2911 recipients are read from the headers in the normal way, and are shown in the
2912 &$recipients$& variable. Note that recipients cannot be given on the command
2913 line, because further arguments are taken as strings to expand (just like
2914 &%-be%&).
2915
2916 .cmdopt -bF <&'filename'&>
2917 .cindex "system filter" "testing"
2918 .cindex "testing" "system filter"
2919 This option is the same as &%-bf%& except that it assumes that the filter being
2920 tested is a system filter. The additional commands that are available only in
2921 system filters are recognized.
2922
2923 .cmdopt -bf <&'filename'&>
2924 .cindex "filter" "testing"
2925 .cindex "testing" "filter file"
2926 .cindex "forward file" "testing"
2927 .cindex "testing" "forward file"
2928 .cindex "Sieve filter" "testing"
2929 This option runs Exim in user filter testing mode; the file is the filter file
2930 to be tested, and a test message must be supplied on the standard input. If
2931 there are no message-dependent tests in the filter, an empty file can be
2932 supplied.
2933
2934 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2935 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2936 filter and a user filter in the same run. For example:
2937 .code
2938 exim -bF /system/filter -bf /user/filter </test/message
2939 .endd
2940 This is helpful when the system filter adds header lines or sets filter
2941 variables that are used by the user filter.
2942
2943 If the test filter file does not begin with one of the special lines
2944 .code
2945 # Exim filter
2946 # Sieve filter
2947 .endd
2948 it is taken to be a normal &_.forward_& file, and is tested for validity under
2949 that interpretation. See sections &<<SECTitenonfilred>>& to
2950 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2951 redirection lists.
2952
2953 The result of an Exim command that uses &%-bf%&, provided no errors are
2954 detected, is a list of the actions that Exim would try to take if presented
2955 with the message for real. More details of filter testing are given in the
2956 separate document entitled &'Exim's interfaces to mail filtering'&.
2957
2958 When testing a filter file,
2959 .cindex "&""From""& line"
2960 .cindex "envelope from"
2961 .cindex "envelope sender"
2962 .oindex "&%-f%&" "for filter testing"
2963 the envelope sender can be set by the &%-f%& option,
2964 or by a &"From&~"& line at the start of the test message. Various parameters
2965 that would normally be taken from the envelope recipient address of the message
2966 can be set by means of additional command line options (see the next four
2967 options).
2968
2969 .cmdopt -bfd <&'domain'&>
2970 .vindex "&$qualify_domain$&"
2971 This sets the domain of the recipient address when a filter file is being
2972 tested by means of the &%-bf%& option. The default is the value of
2973 &$qualify_domain$&.
2974
2975 .cmdopt -bfl <&'local&~part'&>
2976 This sets the local part of the recipient address when a filter file is being
2977 tested by means of the &%-bf%& option. The default is the username of the
2978 process that calls Exim. A local part should be specified with any prefix or
2979 suffix stripped, because that is how it appears to the filter when a message is
2980 actually being delivered.
2981
2982 .cmdopt -bfp <&'prefix'&>
2983 .cindex affix "filter testing"
2984 This sets the prefix of the local part of the recipient address when a filter
2985 file is being tested by means of the &%-bf%& option. The default is an empty
2986 prefix.
2987
2988 .cmdopt -bfs <&'suffix'&>
2989 .cindex affix "filter testing"
2990 This sets the suffix of the local part of the recipient address when a filter
2991 file is being tested by means of the &%-bf%& option. The default is an empty
2992 suffix.
2993
2994 .cmdopt -bh <&'IP&~address'&>
2995 .cindex "testing" "incoming SMTP"
2996 .cindex "SMTP" "testing incoming"
2997 .cindex "testing" "relay control"
2998 .cindex "relaying" "testing configuration"
2999 .cindex "policy control" "testing"
3000 .cindex "debugging" "&%-bh%& option"
3001 This option runs a fake SMTP session as if from the given IP address, using the
3002 standard input and output. The IP address may include a port number at the end,
3003 after a full stop. For example:
3004 .code
3005 exim -bh 10.9.8.7.1234
3006 exim -bh fe80::a00:20ff:fe86:a061.5678
3007 .endd
3008 When an IPv6 address is given, it is converted into canonical form. In the case
3009 of the second example above, the value of &$sender_host_address$& after
3010 conversion to the canonical form is
3011 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3012
3013 Comments as to what is going on are written to the standard error file. These
3014 include lines beginning with &"LOG"& for anything that would have been logged.
3015 This facility is provided for testing configuration options for incoming
3016 messages, to make sure they implement the required policy. For example, you can
3017 test your relay controls using &%-bh%&.
3018
3019 &*Warning 1*&:
3020 .cindex "RFC 1413"
3021 You can test features of the configuration that rely on ident (RFC 1413)
3022 information by using the &%-oMt%& option. However, Exim cannot actually perform
3023 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3024 connection.
3025
3026 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3027 are also skipped when testing using &%-bh%&. If you want these callouts to
3028 occur, use &%-bhc%& instead.
3029
3030 Messages supplied during the testing session are discarded, and nothing is
3031 written to any of the real log files. There may be pauses when DNS (and other)
3032 lookups are taking place, and of course these may time out. The &%-oMi%& option
3033 can be used to specify a specific IP interface and port if this is important,
3034 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3035 session were authenticated.
3036
3037 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3038 output just states whether a given recipient address from a given host is
3039 acceptable or not. See section &<<SECTcheckaccess>>&.
3040
3041 Features such as authentication and encryption, where the client input is not
3042 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3043 specialized SMTP test program such as
3044 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3045
3046 .cmdopt -bhc <&'IP&~address'&>
3047 This option operates in the same way as &%-bh%&, except that address
3048 verification callouts are performed if required. This includes consulting and
3049 updating the callout cache database.
3050
3051 .cmdopt -bi
3052 .cindex "alias file" "building"
3053 .cindex "building alias file"
3054 .cindex "Sendmail compatibility" "&%-bi%& option"
3055 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3056 Exim does not have the concept of a single alias file, and so it cannot mimic
3057 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3058 tend to appear in various scripts such as NIS make files, so the option must be
3059 recognized.
3060
3061 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3062 configuration option is run, under the uid and gid of the caller of Exim. If
3063 the &%-oA%& option is used, its value is passed to the command as an argument.
3064 The command set by &%bi_command%& may not contain arguments. The command can
3065 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3066 if this is required. If the &%bi_command%& option is not set, calling Exim with
3067 &%-bi%& is a no-op.
3068
3069 . // Keep :help first, then the rest in alphabetical order
3070 .cmdopt -bI:help
3071 .cindex "querying exim information"
3072 We shall provide various options starting &`-bI:`& for querying Exim for
3073 information.  The output of many of these will be intended for machine
3074 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3075 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3076 options shall cause Exim to exit after producing the requested output.
3077
3078 .cmdopt -bI:dscp
3079 .cindex "DSCP" "values"
3080 This option causes Exim to emit an alphabetically sorted list of all
3081 recognised DSCP names.
3082
3083 .cmdopt -bI:sieve
3084 .cindex "Sieve filter" "capabilities"
3085 This option causes Exim to emit an alphabetically sorted list of all supported
3086 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3087 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3088 &`SIEVE`& capability response line.  As the precise list may depend upon
3089 compile-time build options, which this option will adapt to, this is the only
3090 way to guarantee a correct response.
3091
3092 .cmdopt -bm
3093 .cindex "local message reception"
3094 This option runs an Exim receiving process that accepts an incoming,
3095 locally-generated message on the standard input. The recipients are given as the
3096 command arguments (except when &%-t%& is also present &-- see below). Each
3097 argument can be a comma-separated list of RFC 2822 addresses. This is the
3098 default option for selecting the overall action of an Exim call; it is assumed
3099 if no other conflicting option is present.
3100
3101 If any addresses in the message are unqualified (have no domain), they are
3102 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3103 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3104 suppressing this for special cases.
3105
3106 Policy checks on the contents of local messages can be enforced by means of
3107 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3108
3109 .cindex "return code" "for &%-bm%&"
3110 The return code is zero if the message is successfully accepted. Otherwise, the
3111 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3112
3113 The format
3114 .cindex "message" "format"
3115 .cindex "format" "message"
3116 .cindex "&""From""& line"
3117 .cindex "UUCP" "&""From""& line"
3118 .cindex "Sendmail compatibility" "&""From""& line"
3119 of the message must be as defined in RFC 2822, except that, for
3120 compatibility with Sendmail and Smail, a line in one of the forms
3121 .code
3122 From sender Fri Jan  5 12:55 GMT 1997
3123 From sender Fri, 5 Jan 97 12:55:01
3124 .endd
3125 (with the weekday optional, and possibly with additional text after the date)
3126 is permitted to appear at the start of the message. There appears to be no
3127 authoritative specification of the format of this line. Exim recognizes it by
3128 matching against the regular expression defined by the &%uucp_from_pattern%&
3129 option, which can be changed if necessary.
3130
3131 .oindex "&%-f%&" "overriding &""From""& line"
3132 The specified sender is treated as if it were given as the argument to the
3133 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3134 preference to the address taken from the message. The caller of Exim must be a
3135 trusted user for the sender of a message to be set in this way.
3136
3137 .cmdopt -bmalware <&'filename'&>
3138 .cindex "testing", "malware"
3139 .cindex "malware scan test"
3140 This debugging option causes Exim to scan the given file or directory
3141 (depending on the used scanner interface),
3142 using the malware scanning framework.  The option of &%av_scanner%& influences
3143 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3144 the expansion should have defaults which apply to this invocation.  ACLs are
3145 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3146 will never be populated and &%-bmalware%& will fail.
3147
3148 Exim will have changed working directory before resolving the filename, so
3149 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3150 user when it tries to open the file, rather than as the invoking user.
3151 This option requires admin privileges.
3152
3153 The &%-bmalware%& option will not be extended to be more generally useful,
3154 there are better tools for file-scanning.  This option exists to help
3155 administrators verify their Exim and AV scanner configuration.
3156
3157 .cmdopt -bnq
3158 .cindex "address qualification, suppressing"
3159 By default, Exim automatically qualifies unqualified addresses (those
3160 without domains) that appear in messages that are submitted locally (that
3161 is, not over TCP/IP). This qualification applies both to addresses in
3162 envelopes, and addresses in header lines. Sender addresses are qualified using
3163 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3164 defaults to the value of &%qualify_domain%&).
3165
3166 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3167 being used to re-submit messages that originally came from remote hosts after
3168 content scanning, you probably do not want to qualify unqualified addresses in
3169 header lines. (Such lines will be present only if you have not enabled a header
3170 syntax check in the appropriate ACL.)
3171
3172 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3173 messages that originate on the local host. When this is used, unqualified
3174 addresses in the envelope provoke errors (causing message rejection) and
3175 unqualified addresses in header lines are left alone.
3176
3177
3178 .cmdopt -bP
3179 .cindex "configuration options" "extracting"
3180 .cindex "options" "configuration &-- extracting"
3181 If this option is given with no arguments, it causes the values of all Exim's
3182 main configuration options to be written to the standard output. The values
3183 of one or more specific options can be requested by giving their names as
3184 arguments, for example:
3185 .code
3186 exim -bP qualify_domain hold_domains
3187 .endd
3188 .cindex "hiding configuration option values"
3189 .cindex "configuration options" "hiding value of"
3190 .cindex "options" "hiding value of"
3191 However, any option setting that is preceded by the word &"hide"& in the
3192 configuration file is not shown in full, except to an admin user. For other
3193 users, the output is as in this example:
3194 .code
3195 mysql_servers = <value not displayable>
3196 .endd
3197 If &%config%& is given as an argument, the config is
3198 output, as it was parsed, any include file resolved, any comment removed.
3199
3200 If &%config_file%& is given as an argument, the name of the runtime
3201 configuration file is output. (&%configure_file%& works too, for
3202 backward compatibility.)
3203 If a list of configuration files was supplied, the value that is output here
3204 is the name of the file that was actually used.
3205
3206 .cindex "options" "hiding name of"
3207 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3208 name will not be output.
3209
3210 .cindex "daemon" "process id (pid)"
3211 .cindex "pid (process id)" "of daemon"
3212 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3213 directories where log files and daemon pid files are written are output,
3214 respectively. If these values are unset, log files are written in a
3215 sub-directory of the spool directory called &%log%&, and the pid file is
3216 written directly into the spool directory.
3217
3218 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3219 .code
3220 exim -bP +local_domains
3221 .endd
3222 it searches for a matching named list of any type (domain, host, address, or
3223 local part) and outputs what it finds.
3224
3225 .cindex "options" "router &-- extracting"
3226 .cindex "options" "transport &-- extracting"
3227 .cindex "options" "authenticator &-- extracting"
3228 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3229 followed by the name of an appropriate driver instance, the option settings for
3230 that driver are output. For example:
3231 .code
3232 exim -bP transport local_delivery
3233 .endd
3234 The generic driver options are output first, followed by the driver's private
3235 options. A list of the names of drivers of a particular type can be obtained by
3236 using one of the words &%router_list%&, &%transport_list%&, or
3237 &%authenticator_list%&, and a complete list of all drivers with their option
3238 settings can be obtained by using &%routers%&, &%transports%&, or
3239 &%authenticators%&.
3240
3241 .cindex "environment"
3242 If &%environment%& is given as an argument, the set of environment
3243 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3244 variables.
3245
3246 .cindex "options" "macro &-- extracting"
3247 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3248 are available, similarly to the drivers.  Because macros are sometimes used
3249 for storing passwords, this option is restricted.
3250 The output format is one item per line.
3251 For the "-bP macro <name>" form, if no such macro is found
3252 the exit status will be nonzero.
3253
3254 .cmdopt -bp
3255 .cindex "queue" "listing messages in"
3256 .cindex "listing" "messages in the queue"
3257 This option requests a listing of the contents of the mail queue on the
3258 standard output. If the &%-bp%& option is followed by a list of message ids,
3259 just those messages are listed. By default, this option can be used only by an
3260 admin user. However, the &%queue_list_requires_admin%& option can be set false
3261 to allow any user to see the queue.
3262
3263 Each message in the queue is displayed as in the following example:
3264 .code
3265 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3266           red.king@looking-glass.fict.example
3267           <other addresses>
3268 .endd
3269 .cindex "message" "size in queue listing"
3270 .cindex "size" "of message"
3271 The first line contains the length of time the message has been in the queue
3272 (in this case 25 minutes), the size of the message (2.9K), the unique local
3273 identifier for the message, and the message sender, as contained in the
3274 envelope. For bounce messages, the sender address is empty, and appears as
3275 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3276 the default sender address, the user's login name is shown in parentheses
3277 before the sender address.
3278
3279 .cindex "frozen messages" "in queue listing"
3280 If the message is frozen (attempts to deliver it are suspended) then the text
3281 &"*** frozen ***"& is displayed at the end of this line.
3282
3283 The recipients of the message (taken from the envelope, not the headers) are
3284 displayed on subsequent lines. Those addresses to which the message has already
3285 been delivered are marked with the letter D. If an original address gets
3286 expanded into several addresses via an alias or forward file, the original is
3287 displayed with a D only when deliveries for all of its child addresses are
3288 complete.
3289
3290
3291 .cmdopt -bpa
3292 This option operates like &%-bp%&, but in addition it shows delivered addresses
3293 that were generated from the original top level address(es) in each message by
3294 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3295 of just &"D"&.
3296
3297
3298 .cmdopt -bpc
3299 .cindex "queue" "count of messages on"
3300 This option counts the number of messages in the queue, and writes the total
3301 to the standard output. It is restricted to admin users, unless
3302 &%queue_list_requires_admin%& is set false.
3303
3304
3305 .cmdopt -bpi
3306 .cindex queue "list of message IDs"
3307 This option operates like &%-bp%&, but only outputs message ids
3308 (one per line).
3309
3310
3311 .cmdopt -bpr
3312 This option operates like &%-bp%&, but the output is not sorted into
3313 chronological order of message arrival. This can speed it up when there are
3314 lots of messages in the queue, and is particularly useful if the output is
3315 going to be post-processed in a way that doesn't need the sorting.
3316
3317 .cmdopt -bpra
3318 This option is a combination of &%-bpr%& and &%-bpa%&.
3319
3320 .cmdopt -bpri
3321 This option is a combination of &%-bpr%& and &%-bpi%&.
3322
3323 .cmdopt -bpru
3324 This option is a combination of &%-bpr%& and &%-bpu%&.
3325
3326
3327 .cmdopt -bpu
3328 This option operates like &%-bp%& but shows only undelivered top-level
3329 addresses for each message displayed. Addresses generated by aliasing or
3330 forwarding are not shown, unless the message was deferred after processing by a
3331 router with the &%one_time%& option set.
3332
3333
3334 .cmdopt -brt
3335 .cindex "testing" "retry configuration"
3336 .cindex "retry" "configuration testing"
3337 This option is for testing retry rules, and it must be followed by up to three
3338 arguments. It causes Exim to look for a retry rule that matches the values
3339 and to write it to the standard output. For example:
3340 .code
3341 exim -brt bach.comp.mus.example
3342 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3343 .endd
3344 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3345 argument, which is required, can be a complete address in the form
3346 &'local_part@domain'&, or it can be just a domain name. If the second argument
3347 contains a dot, it is interpreted as an optional second domain name; if no
3348 retry rule is found for the first argument, the second is tried. This ties in
3349 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3350 rule is found that matches the host, one that matches the mail domain is
3351 sought. Finally, an argument that is the name of a specific delivery error, as
3352 used in setting up retry rules, can be given. For example:
3353 .code
3354 exim -brt haydn.comp.mus.example quota_3d
3355 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3356 .endd
3357
3358 .cmdopt -brw
3359 .cindex "testing" "rewriting"
3360 .cindex "rewriting" "testing"
3361 This option is for testing address rewriting rules, and it must be followed by
3362 a single argument, consisting of either a local part without a domain, or a
3363 complete address with a fully qualified domain. Exim outputs how this address
3364 would be rewritten for each possible place it might appear. See chapter
3365 &<<CHAPrewrite>>& for further details.
3366
3367 .cmdopt -bS
3368 .cindex "SMTP" "batched incoming"
3369 .cindex "batched SMTP input"
3370 This option is used for batched SMTP input, which is an alternative interface
3371 for non-interactive local message submission. A number of messages can be
3372 submitted in a single run. However, despite its name, this is not really SMTP
3373 input. Exim reads each message's envelope from SMTP commands on the standard
3374 input, but generates no responses. If the caller is trusted, or
3375 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3376 believed; otherwise the sender is always the caller of Exim.
3377
3378 The message itself is read from the standard input, in SMTP format (leading
3379 dots doubled), terminated by a line containing just a single dot. An error is
3380 provoked if the terminating dot is missing. A further message may then follow.
3381
3382 As for other local message submissions, the contents of incoming batch SMTP
3383 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3384 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3385 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3386
3387 Some other SMTP commands are recognized in the input. HELO and EHLO act
3388 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3389 QUIT quits, ignoring the rest of the standard input.
3390
3391 .cindex "return code" "for &%-bS%&"
3392 If any error is encountered, reports are written to the standard output and
3393 error streams, and Exim gives up immediately. The return code is 0 if no error
3394 was detected; it is 1 if one or more messages were accepted before the error
3395 was detected; otherwise it is 2.
3396
3397 More details of input using batched SMTP are given in section
3398 &<<SECTincomingbatchedSMTP>>&.
3399
3400 .cmdopt -bs
3401 .cindex "SMTP" "local input"
3402 .cindex "local SMTP input"
3403 This option causes Exim to accept one or more messages by reading SMTP commands
3404 on the standard input, and producing SMTP replies on the standard output. SMTP
3405 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3406 Some user agents use this interface as a way of passing locally-generated
3407 messages to the MTA.
3408
3409 In
3410 .cindex "sender" "source of"
3411 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3412 set, the senders of messages are taken from the SMTP MAIL commands.
3413 Otherwise the content of these commands is ignored and the sender is set up as
3414 the calling user. Unqualified addresses are automatically qualified using
3415 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3416 &%-bnq%& option is used.
3417
3418 .cindex "inetd"
3419 The
3420 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3421 using a listening daemon. Exim can distinguish the two cases by checking
3422 whether the standard input is a TCP/IP socket. When Exim is called from
3423 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3424 above concerning senders and qualification do not apply. In this situation,
3425 Exim behaves in exactly the same way as it does when receiving a message via
3426 the listening daemon.
3427
3428 .cmdopt -bt
3429 .cindex "testing" "addresses"
3430 .cindex "address" "testing"
3431 This option runs Exim in address testing mode, in which each argument is taken
3432 as a recipient address to be tested for deliverability. The results are
3433 written to the standard output. If a test fails, and the caller is not an admin
3434 user, no details of the failure are output, because these might contain
3435 sensitive information such as usernames and passwords for database lookups.
3436
3437 If no arguments are given, Exim runs in an interactive manner, prompting with a
3438 right angle bracket for addresses to be tested.
3439
3440 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3441 &[readline()]& function, because it is running as &'root'& and there are
3442 security issues.
3443
3444 Each address is handled as if it were the recipient address of a message
3445 (compare the &%-bv%& option). It is passed to the routers and the result is
3446 written to the standard output. However, any router that has
3447 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3448 genuine routing tests if your first router passes everything to a scanner
3449 program.
3450
3451 .cindex "return code" "for &%-bt%&"
3452 The return code is 2 if any address failed outright; it is 1 if no address
3453 failed outright but at least one could not be resolved for some reason. Return
3454 code 0 is given only when all addresses succeed.
3455
3456 .cindex "duplicate addresses"
3457 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3458 addresses after routing is complete, so that only one delivery takes place.
3459 This does not happen when testing with &%-bt%&; the full results of routing are
3460 always shown.
3461
3462 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3463 routers in the configuration makes any tests on the sender address of a
3464 message,
3465 .oindex "&%-f%&" "for address testing"
3466 you can use the &%-f%& option to set an appropriate sender when running
3467 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3468 default qualifying domain. However, if you have set up (for example) routers
3469 whose behaviour depends on the contents of an incoming message, you cannot test
3470 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3471 doing such tests.
3472
3473 .cmdopt -bV
3474 .cindex "version number of Exim"
3475 This option causes Exim to write the current version number, compilation
3476 number, and compilation date of the &'exim'& binary to the standard output.
3477 It also lists the DBM library that is being used, the optional modules (such as
3478 specific lookup types), the drivers that are included in the binary, and the
3479 name of the runtime configuration file that is in use.
3480
3481 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3482 configuration file. However, this is a static check only. It cannot check
3483 values that are to be expanded. For example, although a misspelt ACL verb is
3484 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3485 alone to discover (for example) all the typos in the configuration; some
3486 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3487 dynamic testing facilities.
3488
3489 .cmdopt -bv
3490 .cindex "verifying address" "using &%-bv%&"
3491 .cindex "address" "verification"
3492 This option runs Exim in address verification mode, in which each argument is
3493 taken as a recipient address to be verified by the routers. (This does
3494 not involve any verification callouts). During normal operation, verification
3495 happens mostly as a consequence processing a &%verify%& condition in an ACL
3496 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3497 including callouts, see the &%-bh%& and &%-bhc%& options.
3498
3499 If verification fails, and the caller is not an admin user, no details of the
3500 failure are output, because these might contain sensitive information such as
3501 usernames and passwords for database lookups.
3502
3503 If no arguments are given, Exim runs in an interactive manner, prompting with a
3504 right angle bracket for addresses to be verified.
3505
3506 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3507 &[readline()]& function, because it is running as &'exim'& and there are
3508 security issues.
3509
3510 Verification differs from address testing (the &%-bt%& option) in that routers
3511 that have &%no_verify%& set are skipped, and if the address is accepted by a
3512 router that has &%fail_verify%& set, verification fails. The address is
3513 verified as a recipient if &%-bv%& is used; to test verification for a sender
3514 address, &%-bvs%& should be used.
3515
3516 If the &%-v%& option is not set, the output consists of a single line for each
3517 address, stating whether it was verified or not, and giving a reason in the
3518 latter case. Without &%-v%&, generating more than one address by redirection
3519 causes verification to end successfully, without considering the generated
3520 addresses. However, if just one address is generated, processing continues,
3521 and the generated address must verify successfully for the overall verification
3522 to succeed.
3523
3524 When &%-v%& is set, more details are given of how the address has been handled,
3525 and in the case of address redirection, all the generated addresses are also
3526 considered. Verification may succeed for some and fail for others.
3527
3528 The
3529 .cindex "return code" "for &%-bv%&"
3530 return code is 2 if any address failed outright; it is 1 if no address
3531 failed outright but at least one could not be resolved for some reason. Return
3532 code 0 is given only when all addresses succeed.
3533
3534 If any of the routers in the configuration makes any tests on the sender
3535 address of a message, you should use the &%-f%& option to set an appropriate
3536 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3537 calling user at the default qualifying domain.
3538
3539 .cmdopt -bvs
3540 This option acts like &%-bv%&, but verifies the address as a sender rather
3541 than a recipient address. This affects any rewriting and qualification that
3542 might happen.
3543
3544 .cmdopt -bw
3545 .cindex "daemon"
3546 .cindex "inetd"
3547 .cindex "inetd" "wait mode"
3548 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3549 similarly to the &%-bd%& option.  All port specifications on the command-line
3550 and in the configuration file are ignored.  Queue-running may not be specified.
3551
3552 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3553 listening for connections.  This permits the system to start up and have
3554 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3555 each port only when the first connection is received.
3556
3557 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3558 which the daemon will exit, which should cause inetd to listen once more.
3559
3560 .cmdopt -C <&'filelist'&>
3561 .cindex "configuration file" "alternate"
3562 .cindex "CONFIGURE_FILE"
3563 .cindex "alternate configuration file"
3564 This option causes Exim to find the runtime configuration file from the given
3565 list instead of from the list specified by the CONFIGURE_FILE
3566 compile-time setting. Usually, the list will consist of just a single filename,
3567 but it can be a colon-separated list of names. In this case, the first
3568 file that exists is used. Failure to open an existing file stops Exim from
3569 proceeding any further along the list, and an error is generated.
3570
3571 When this option is used by a caller other than root, and the list is different
3572 from the compiled-in list, Exim gives up its root privilege immediately, and
3573 runs with the real and effective uid and gid set to those of the caller.
3574 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3575 file contains a list of full pathnames, one per line, for configuration files
3576 which are trusted. Root privilege is retained for any configuration file so
3577 listed, as long as the caller is the Exim user (or the user specified in the
3578 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3579 not writeable by inappropriate users or groups.
3580
3581 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3582 configuration using &%-C%& right through message reception and delivery,
3583 even if the caller is root. The reception works, but by that time, Exim is
3584 running as the Exim user, so when it re-executes to regain privilege for the
3585 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3586 test reception and delivery using two separate commands (one to put a message
3587 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3588
3589 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3590 prefix string with which any file named in a &%-C%& command line option
3591 must start. In addition, the filename must not contain the sequence &`/../`&.
3592 However, if the value of the &%-C%& option is identical to the value of
3593 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3594 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3595 unset, any filename can be used with &%-C%&.
3596
3597 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3598 to a directory to which only root has access. This prevents someone who has
3599 broken into the Exim account from running a privileged Exim with an arbitrary
3600 configuration file.
3601
3602 The &%-C%& facility is useful for ensuring that configuration files are
3603 syntactically correct, but cannot be used for test deliveries, unless the
3604 caller is privileged, or unless it is an exotic configuration that does not
3605 require privilege. No check is made on the owner or group of the files
3606 specified by this option.
3607
3608
3609 .vitem &%-D%&<&'macro'&>=<&'value'&>
3610 .oindex "&%-D%&"
3611 .cindex "macro" "setting on command line"
3612 This option can be used to override macro definitions in the configuration file
3613 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3614 unprivileged caller, it causes Exim to give up its root privilege.
3615 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3616 completely disabled, and its use causes an immediate error exit.
3617
3618 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3619 colon-separated list of macros which are considered safe and, if &%-D%& only
3620 supplies macros from this list, and the values are acceptable, then Exim will
3621 not give up root privilege if the caller is root, the Exim run-time user, or
3622 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3623 to be removed in the future.  Acceptable values for the macros satisfy the
3624 regexp: &`^[A-Za-z0-9_/.-]*$`&
3625
3626 The entire option (including equals sign if present) must all be within one
3627 command line item. &%-D%& can be used to set the value of a macro to the empty
3628 string, in which case the equals sign is optional. These two commands are
3629 synonymous:
3630 .code
3631 exim -DABC  ...
3632 exim -DABC= ...
3633 .endd
3634 To include spaces in a macro definition item, quotes must be used. If you use
3635 quotes, spaces are permitted around the macro name and the equals sign. For
3636 example:
3637 .code
3638 exim '-D ABC = something' ...
3639 .endd
3640 &%-D%& may be repeated up to 10 times on a command line.
3641 Only macro names up to 22 letters long can be set.
3642
3643
3644 .vitem &%-d%&<&'debug&~options'&>
3645 .oindex "&%-d%&"
3646 .cindex "debugging" "list of selectors"
3647 .cindex "debugging" "&%-d%& option"
3648 This option causes debugging information to be written to the standard
3649 error stream. It is restricted to admin users because debugging output may show
3650 database queries that contain password information. Also, the details of users'
3651 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3652 writes an error message to the standard error stream and exits with a non-zero
3653 return code.
3654
3655 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3656 standard debugging data is output. This can be reduced, or increased to include
3657 some more rarely needed information, by directly following &%-d%& with a string
3658 made up of names preceded by plus or minus characters. These add or remove sets
3659 of debugging data, respectively. For example, &%-d+filter%& adds filter
3660 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3661 no spaces are allowed in the debug setting. The available debugging categories
3662 are:
3663 .itable none 0 0 2 20* left 80* left
3664 .irow acl            "ACL interpretation"
3665 .irow auth           "authenticators"
3666 .irow deliver        "general delivery logic"
3667 .irow dns            "DNS lookups (see also resolver)"
3668 .irow dnsbl          "DNS black list (aka RBL) code"
3669 .irow exec           "arguments for &[execv()]& calls"
3670 .irow expand         "detailed debugging for string expansions"
3671 .irow filter         "filter handling"
3672 .irow hints_lookup   "hints data lookups"
3673 .irow host_lookup    "all types of name-to-IP address handling"
3674 .irow ident          "ident lookup"
3675 .irow interface      "lists of local interfaces"
3676 .irow lists          "matching things in lists"
3677 .irow load           "system load checks"
3678 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3679                     &<<CHAPlocalscan>>&)"
3680 .irow lookup         "general lookup code and all lookups"
3681 .irow memory         "memory handling"
3682 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3683 .irow pid            "modifier: add pid to debug output lines"
3684 .irow process_info   "setting info for the process log"
3685 .irow queue_run      "queue runs"
3686 .irow receive        "general message reception logic"
3687 .irow resolver       "turn on the DNS resolver's debugging output"
3688 .irow retry          "retry handling"
3689 .irow rewrite        "address rewriting""
3690 .irow route          "address routing"
3691 .irow timestamp      "modifier: add timestamp to debug output lines"
3692 .irow tls            "TLS logic"
3693 .irow transport      "transports"
3694 .irow uid            "changes of uid/gid and looking up uid/gid"
3695 .irow verify         "address verification logic"
3696 .irow all            "almost all of the above (see below), and also &%-v%&"
3697 .endtable
3698 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3699 for &`-all`&. The reason for this is that &`+all`& is something that people
3700 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3701 is included, an awful lot of output that is very rarely of interest is
3702 generated, so it now has to be explicitly requested. However, &`-all`& does
3703 turn everything off.
3704
3705 .cindex "resolver, debugging output"
3706 .cindex "DNS resolver, debugging output"
3707 The &`resolver`& option produces output only if the DNS resolver was compiled
3708 with DEBUG enabled. This is not the case in some operating systems. Also,
3709 unfortunately, debugging output from the DNS resolver is written to stdout
3710 rather than stderr.
3711
3712 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3713 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3714 However, the &`pid`& selector is forced when debugging is turned on for a
3715 daemon, which then passes it on to any re-executed Exims. Exim also
3716 automatically adds the pid to debug lines when several remote deliveries are
3717 run in parallel.
3718
3719 The &`timestamp`& selector causes the current time to be inserted at the start
3720 of all debug output lines. This can be useful when trying to track down delays
3721 in processing.
3722
3723 .cindex debugging "UTF-8 in"
3724 .cindex UTF-8 "in debug output"
3725 The &`noutf8`& selector disables the use of
3726 UTF-8 line-drawing characters to group related information.
3727 When disabled. ascii-art is used instead.
3728 Using the &`+all`& option does not set this modifier,
3729
3730 If the &%debug_print%& option is set in any driver, it produces output whenever
3731 any debugging is selected, or if &%-v%& is used.
3732
3733 .vitem &%-dd%&<&'debug&~options'&>
3734 .oindex "&%-dd%&"
3735 This option behaves exactly like &%-d%& except when used on a command that
3736 starts a daemon process. In that case, debugging is turned off for the
3737 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3738 behaviour of the daemon without creating as much output as full debugging does.
3739
3740 .cmdopt -dropcr
3741 This is an obsolete option that is now a no-op. It used to affect the way Exim
3742 handled CR and LF characters in incoming messages. What happens now is
3743 described in section &<<SECTlineendings>>&.
3744
3745 .cmdopt -E
3746 .cindex "bounce message" "generating"
3747 This option specifies that an incoming message is a locally-generated delivery
3748 failure report. It is used internally by Exim when handling delivery failures
3749 and is not intended for external use. Its only effect is to stop Exim
3750 generating certain messages to the postmaster, as otherwise message cascades
3751 could occur in some situations. As part of the same option, a message id may
3752 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3753 new message contains the id, following &"R="&, as a cross-reference.
3754
3755 .vitem &%-e%&&'x'&
3756 .oindex "&%-e%&&'x'&"
3757 There are a number of Sendmail options starting with &%-oe%& which seem to be
3758 called by various programs without the leading &%o%& in the option. For
3759 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3760 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3761
3762 .cmdopt -F <&'string'&>
3763 .cindex "sender" "name"
3764 .cindex "name" "of sender"
3765 This option sets the sender's full name for use when a locally-generated
3766 message is being accepted. In the absence of this option, the user's &'gecos'&
3767 entry from the password data is used. As users are generally permitted to alter
3768 their &'gecos'& entries, no security considerations are involved. White space
3769 between &%-F%& and the <&'string'&> is optional.
3770
3771 .cmdopt -f <&'address'&>
3772 .cindex "sender" "address"
3773 .cindex "address" "sender"
3774 .cindex "trusted users"
3775 .cindex "envelope from"
3776 .cindex "envelope sender"
3777 .cindex "user" "trusted"
3778 This option sets the address of the envelope sender of a locally-generated
3779 message (also known as the return path). The option can normally be used only
3780 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3781 users to use it.
3782
3783 Processes running as root or the Exim user are always trusted. Other
3784 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3785 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3786 of a local message is set to the caller's login name at the default qualify
3787 domain.
3788
3789 There is one exception to the restriction on the use of &%-f%&: an empty sender
3790 can be specified by any user, trusted or not, to create a message that can
3791 never provoke a bounce. An empty sender can be specified either as an empty
3792 string, or as a pair of angle brackets with nothing between them, as in these
3793 examples of shell commands:
3794 .code
3795 exim -f '<>' user@domain
3796 exim -f "" user@domain
3797 .endd
3798 In addition, the use of &%-f%& is not restricted when testing a filter file
3799 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3800 &%-bv%& options.
3801
3802 Allowing untrusted users to change the sender address does not of itself make
3803 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3804 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3805 though this can be overridden by setting &%no_local_from_check%&.
3806
3807 White
3808 .cindex "&""From""& line"
3809 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3810 given as two arguments or one combined argument). The sender of a
3811 locally-generated message can also be set (when permitted) by an initial
3812 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3813 if &%-f%& is also present, it overrides &"From&~"&.
3814
3815 .cmdopt -G
3816 .cindex "submission fixups, suppressing (command-line)"
3817 This option is equivalent to an ACL applying:
3818 .code
3819 control = suppress_local_fixups
3820 .endd
3821 for every message received.  Note that Sendmail will complain about such
3822 bad formatting, where Exim silently just does not fix it up.  This may change
3823 in future.
3824
3825 As this affects audit information, the caller must be a trusted user to use
3826 this option.
3827
3828 .cmdopt -h <&'number'&>
3829 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3830 This option is accepted for compatibility with Sendmail, but has no effect. (In
3831 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3832 headers.)
3833
3834 .cmdopt -i
3835 .cindex "Solaris" "&'mail'& command"
3836 .cindex "dot" "in incoming non-SMTP message"
3837 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3838 line by itself should not terminate an incoming, non-SMTP message.
3839 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3840 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3841 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3842 by its &'mailx'& command.
3843
3844 .cmdopt -L <&'tag'&>
3845 .cindex "syslog" "process name; set with flag"
3846 This option is equivalent to setting &%syslog_processname%& in the config
3847 file and setting &%log_file_path%& to &`syslog`&.
3848 Its use is restricted to administrators.  The configuration file has to be
3849 read and parsed, to determine access rights, before this is set and takes
3850 effect, so early configuration file errors will not honour this flag.
3851
3852 The tag should not be longer than 32 characters.
3853
3854 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3855 .cindex "forcing delivery"
3856 .cindex "delivery" "forcing attempt"
3857 .cindex "frozen messages" "forcing delivery"
3858 This option requests Exim to run a delivery attempt on each message in turn. If
3859 any of the messages are frozen, they are automatically thawed before the
3860 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3861 and &%hold_domains%& are ignored.
3862
3863 Retry
3864 .cindex "hints database" "overriding retry hints"
3865 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3866 the normal retry time has not yet been reached. This option requires the caller
3867 to be an admin user. However, there is an option called &%prod_requires_admin%&
3868 which can be set false to relax this restriction (and also the same requirement
3869 for the &%-q%&, &%-R%&, and &%-S%& options).
3870
3871 The deliveries happen synchronously, that is, the original Exim process does
3872 not terminate until all the delivery attempts have finished. No output is
3873 produced unless there is a serious error. If you want to see what is happening,
3874 use the &%-v%& option as well, or inspect Exim's main log.
3875
3876 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3877 .cindex "message" "adding recipients"
3878 .cindex "recipient" "adding"
3879 This option requests Exim to add the addresses to the list of recipients of the
3880 message (&"ar"& for &"add recipients"&). The first argument must be a message
3881 id, and the remaining ones must be email addresses. However, if the message is
3882 active (in the middle of a delivery attempt), it is not altered. This option
3883 can be used only by an admin user.
3884
3885 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3886         &~<&'host&~IP'&>&&&
3887         &~<&'sequence&~number'&>&&&
3888         &~<&'message&~id'&>"
3889 .oindex "&%-MC%&"
3890 .cindex "SMTP" "passed connection"
3891 .cindex "SMTP" "multiple deliveries"
3892 .cindex "multiple SMTP deliveries"
3893 This option is not intended for use by external callers. It is used internally
3894 by Exim to invoke another instance of itself to deliver a waiting message using
3895 an existing SMTP connection, which is passed as the standard input. Details are
3896 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3897 must be root or the Exim user in order to use it.
3898
3899 .cmdopt -MCA
3900 This option is not intended for use by external callers. It is used internally
3901 by Exim in conjunction with the &%-MC%& option. It signifies that the
3902 connection to the remote host has been authenticated.
3903
3904 .cmdopt -MCD
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option. It signifies that the
3907 remote host supports the ESMTP &_DSN_& extension.
3908
3909 .cmdopt -MCd
3910 This option is not intended for use by external callers. It is used internally
3911 by Exim in conjunction with the &%-d%& option
3912 to pass on an information string on the purpose of the process.
3913
3914 .cmdopt -MCG <&'queue&~name'&>
3915 This option is not intended for use by external callers. It is used internally
3916 by Exim in conjunction with the &%-MC%& option. It signifies that an
3917 alternate queue is used, named by the following argument.
3918
3919 .cmdopt -MCK
3920 This option is not intended for use by external callers. It is used internally
3921 by Exim in conjunction with the &%-MC%& option. It signifies that a
3922 remote host supports the ESMTP &_CHUNKING_& extension.
3923
3924 .cmdopt -MCL
3925 This option is not intended for use by external callers. It is used internally
3926 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3927 which Exim is connected advertised limits on numbers of mails, recipients or
3928 recipient domains.
3929 The limits are given by the following three arguments.
3930
3931 .cmdopt -MCP
3932 This option is not intended for use by external callers. It is used internally
3933 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3934 which Exim is connected supports pipelining.
3935
3936 .cmdopt -MCp
3937 This option is not intended for use by external callers. It is used internally
3938 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3939 t a remote server is via a SOCKS proxy, using addresses and ports given by
3940 the following four arguments.
3941
3942 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3943 This option is not intended for use by external callers. It is used internally
3944 by Exim in conjunction with the &%-MC%& option when the original delivery was
3945 started by a queue runner. It passes on the process id of the queue runner,
3946 together with the file descriptor number of an open pipe. Closure of the pipe
3947 signals the final completion of the sequence of processes that are passing
3948 messages through the same SMTP connection.
3949
3950 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3951 This option is not intended for use by external callers. It is used internally
3952 by Exim to implement quota checking for local users.
3953
3954 .cmdopt -MCS
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 ESMTP SIZE option should be used on messages delivered down the existing
3958 connection.
3959
3960 .cmdopt -MCT
3961 This option is not intended for use by external callers. It is used internally
3962 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3963 host to which Exim is connected supports TLS encryption.
3964
3965 .vitem &%-MCr%&&~<&'SNI'&> &&&
3966        &%-MCs%&&~<&'SNI'&>
3967 .oindex "&%-MCs%&"
3968 .oindex "&%-MCr%&"
3969 These options are not intended for use by external callers. It is used internally
3970 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3971 a TLS Server Name Indication was sent as part of the channel establishment.
3972 The argument gives the SNI string.
3973 The "r" variant indicates a DANE-verified connection.
3974
3975 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3976 This option is not intended for use by external callers. It is used internally
3977 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3978 connection is being proxied by a parent process for handling TLS encryption.
3979 The arguments give the local address and port being proxied, and the TLS cipher.
3980
3981 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3982 .cindex "hints database" "not overridden by &%-Mc%&"
3983 .cindex "delivery" "manually started &-- not forced"
3984 This option requests Exim to run a delivery attempt on each message, in turn,
3985 but unlike the &%-M%& option, it does check for retry hints, and respects any
3986 that are found. This option is not very useful to external callers. It is
3987 provided mainly for internal use by Exim when it needs to re-invoke itself in
3988 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3989 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3990 respects retry times and other options such as &%hold_domains%& that are
3991 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3992 If you want to run a specific delivery as if in a queue run, you should use
3993 &%-q%& with a message id argument. A distinction between queue run deliveries
3994 and other deliveries is made in one or two places.
3995
3996 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3997 .cindex "message" "changing sender"
3998 .cindex "sender" "changing"
3999 This option requests Exim to change the sender address in the message to the
4000 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4001 &"edit sender"&). There must be exactly two arguments. The first argument must
4002 be a message id, and the second one an email address. However, if the message
4003 is active (in the middle of a delivery attempt), its status is not altered.
4004 This option can be used only by an admin user.
4005
4006 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
4007 .cindex "freezing messages"
4008 .cindex "message" "manually freezing"
4009 This option requests Exim to mark each listed message as &"frozen"&. This
4010 prevents any delivery attempts taking place until the message is &"thawed"&,
4011 either manually or as a result of the &%auto_thaw%& configuration option.
4012 However, if any of the messages are active (in the middle of a delivery
4013 attempt), their status is not altered. This option can be used only by an admin
4014 user.
4015
4016 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
4017 .cindex "giving up on messages"
4018 .cindex "message" "abandoning delivery attempts"
4019 .cindex "delivery" "abandoning further attempts"
4020 This option requests Exim to give up trying to deliver the listed messages,
4021 including any that are frozen. However, if any of the messages are active,
4022 their status is not altered. For non-bounce messages, a delivery error message
4023 is sent to the sender, containing the text &"cancelled by administrator"&.
4024 Bounce messages are just discarded. This option can be used only by an admin
4025 user.
4026
4027 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4028 .cindex queue named
4029 .cindex "named queues" "moving messages"
4030 .cindex "queue" "moving messages"
4031 This option requests that each listed message be moved from its current
4032 queue to the given named queue.
4033 The destination queue name argument is required, but can be an empty
4034 string to define the default queue.
4035 If the messages are not currently located in the default queue,
4036 a &%-qG<name>%& option will be required to define the source queue.
4037
4038 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4039 .cindex "delivery" "cancelling all"
4040 This option requests Exim to mark all the recipient addresses in the messages
4041 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4042 message is active (in the middle of a delivery attempt), its status is not
4043 altered. This option can be used only by an admin user.
4044
4045 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4046 .cindex "delivery" "cancelling by address"
4047 .cindex "recipient" "removing"
4048 .cindex "removing recipients"
4049 This option requests Exim to mark the given addresses as already delivered
4050 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4051 the remaining ones must be email addresses. These are matched to recipient
4052 addresses in the message in a case-sensitive manner. If the message is active
4053 (in the middle of a delivery attempt), its status is not altered. This option
4054 can be used only by an admin user.
4055
4056 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4057 .cindex "removing messages"
4058 .cindex "abandoning mail"
4059 .cindex "message" "manually discarding"
4060 This option requests Exim to remove the given messages from the queue. No
4061 bounce messages are sent; each message is simply forgotten. However, if any of
4062 the messages are active, their status is not altered. This option can be used
4063 only by an admin user or by the user who originally caused the message to be
4064 placed in the queue.
4065
4066 . .new
4067 . .vitem &%-MS%&
4068 . .oindex "&%-MS%&"
4069 . .cindex REQUIRETLS
4070 . This option is used to request REQUIRETLS processing on the message.
4071 . It is used internally by Exim in conjunction with -E when generating
4072 . a bounce message.
4073 . .wen
4074
4075 .cmdopt -Mset <&'message&~id'&>
4076 .cindex "testing" "string expansion"
4077 .cindex "expansion" "testing"
4078 This option is useful only in conjunction with &%-be%& (that is, when testing
4079 string expansions). Exim loads the given message from its spool before doing
4080 the test expansions, thus setting message-specific variables such as
4081 &$message_size$& and the header variables. The &$recipients$& variable is made
4082 available. This feature is provided to make it easier to test expansions that
4083 make use of these variables. However, this option can be used only by an admin
4084 user. See also &%-bem%&.
4085
4086 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4087 .cindex "thawing messages"
4088 .cindex "unfreezing messages"
4089 .cindex "frozen messages" "thawing"
4090 .cindex "message" "thawing frozen"
4091 This option requests Exim to &"thaw"& any of the listed messages that are
4092 &"frozen"&, so that delivery attempts can resume. However, if any of the
4093 messages are active, their status is not altered. This option can be used only
4094 by an admin user.
4095
4096 .cmdopt -Mvb <&'message&~id'&>
4097 .cindex "listing" "message body"
4098 .cindex "message" "listing body of"
4099 This option causes the contents of the message body (-D) spool file to be
4100 written to the standard output. This option can be used only by an admin user.
4101
4102 .cmdopt -Mvc <&'message&~id'&>
4103 .cindex "message" "listing in RFC 2822 format"
4104 .cindex "listing" "message in RFC 2822 format"
4105 This option causes a copy of the complete message (header lines plus body) to
4106 be written to the standard output in RFC 2822 format. This option can be used
4107 only by an admin user.
4108
4109 .cmdopt -Mvh <&'message&~id'&>
4110 .cindex "listing" "message headers"
4111 .cindex "header lines" "listing"
4112 .cindex "message" "listing header lines"
4113 This option causes the contents of the message headers (-H) spool file to be
4114 written to the standard output. This option can be used only by an admin user.
4115
4116 .cmdopt -Mvl <&'message&~id'&>
4117 .cindex "listing" "message log"
4118 .cindex "message" "listing message log"
4119 This option causes the contents of the message log spool file to be written to
4120 the standard output. This option can be used only by an admin user.
4121
4122 .cmdopt -m
4123 This is a synonym for &%-om%& that is accepted by Sendmail
4124 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4125 p. 1M-258), so Exim treats it that way too.
4126
4127 .cmdopt -N
4128 .cindex "debugging" "&%-N%& option"
4129 .cindex "debugging" "suppressing delivery"
4130 This is a debugging option that inhibits delivery of a message at the transport
4131 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4132 it just doesn't actually transport the message, but instead behaves as if it
4133 had successfully done so. However, it does not make any updates to the retry
4134 database, and the log entries for deliveries are flagged with &"*>"& rather
4135 than &"=>"&.
4136
4137 Because &%-N%& discards any message to which it applies, only root or the Exim
4138 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4139 words, an ordinary user can use it only when supplying an incoming message to
4140 which it will apply. Although transportation never fails when &%-N%& is set, an
4141 address may be deferred because of a configuration problem on a transport, or a
4142 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4143 the message, and applies to any subsequent delivery attempts that may happen
4144 for that message.
4145
4146 .cmdopt -n
4147 This option is interpreted by Sendmail to mean &"no aliasing"&.
4148 For normal modes of operation, it is ignored by Exim.
4149 When combined with &%-bP%& it makes the output more terse (suppresses
4150 option names, environment values and config pretty printing).
4151
4152 .cmdopt -O <&'data'&>
4153 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4154 Exim.
4155
4156 .cmdopt -oA <&'file&~name'&>
4157 .cindex "Sendmail compatibility" "&%-oA%& option"
4158 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4159 alternative alias filename. Exim handles &%-bi%& differently; see the
4160 description above.
4161
4162 .cmdopt -oB <&'n'&>
4163 .cindex "SMTP" "passed connection"
4164 .cindex "SMTP" "multiple deliveries"
4165 .cindex "multiple SMTP deliveries"
4166 This is a debugging option which limits the maximum number of messages that can
4167 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4168 transport. If <&'n'&> is omitted, the limit is set to 1.
4169
4170 .cmdopt -odb
4171 .cindex "background delivery"
4172 .cindex "delivery" "in the background"
4173 This option applies to all modes in which Exim accepts incoming messages,
4174 including the listening daemon. It requests &"background"& delivery of such
4175 messages, which means that the accepting process automatically starts a
4176 delivery process for each message received, but does not wait for the delivery
4177 processes to finish.
4178
4179 When all the messages have been received, the reception process exits,
4180 leaving the delivery processes to finish in their own time. The standard output
4181 and error streams are closed at the start of each delivery process.
4182 This is the default action if none of the &%-od%& options are present.
4183
4184 If one of the queueing options in the configuration file
4185 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4186 overrides it if &%queue_only_override%& is set true, which is the default
4187 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4188
4189 .cmdopt -odf
4190 .cindex "foreground delivery"
4191 .cindex "delivery" "in the foreground"
4192 This option requests &"foreground"& (synchronous) delivery when Exim has
4193 accepted a locally-generated message. (For the daemon it is exactly the same as
4194 &%-odb%&.) A delivery process is automatically started to deliver the message,
4195 and Exim waits for it to complete before proceeding.
4196
4197 The original Exim reception process does not finish until the delivery
4198 process for the final message has ended. The standard error stream is left open
4199 during deliveries.
4200
4201 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4202 false and one of the queueing options in the configuration file is in effect.
4203
4204 If there is a temporary delivery error during foreground delivery, the
4205 message is left in the queue for later delivery, and the original reception
4206 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4207 restricted configuration that never queues messages.
4208
4209
4210 .cmdopt -odi
4211 This option is synonymous with &%-odf%&. It is provided for compatibility with
4212 Sendmail.
4213
4214 .cmdopt -odq
4215 .cindex "non-immediate delivery"
4216 .cindex "delivery" "suppressing immediate"
4217 .cindex "queueing incoming messages"
4218 This option applies to all modes in which Exim accepts incoming messages,
4219 including the listening daemon. It specifies that the accepting process should
4220 not automatically start a delivery process for each message received. Messages
4221 are placed in the queue, and remain there until a subsequent queue runner
4222 process encounters them. There are several configuration options (such as
4223 &%queue_only%&) that can be used to queue incoming messages under certain
4224 conditions. This option overrides all of them and also &%-odqs%&. It always
4225 forces queueing.
4226
4227 .cmdopt -odqs
4228 .cindex "SMTP" "delaying delivery"
4229 .cindex "first pass routing"
4230 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4231 However, like &%-odb%& and &%-odi%&, this option has no effect if
4232 &%queue_only_override%& is false and one of the queueing options in the
4233 configuration file is in effect.
4234
4235 When &%-odqs%& does operate, a delivery process is started for each incoming
4236 message, in the background by default, but in the foreground if &%-odi%& is
4237 also present. The recipient addresses are routed, and local deliveries are done
4238 in the normal way. However, if any SMTP deliveries are required, they are not
4239 done at this time, so the message remains in the queue until a subsequent queue
4240 runner process encounters it. Because routing was done, Exim knows which
4241 messages are waiting for which hosts, and so a number of messages for the same
4242 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4243 configuration option has the same effect for specific domains. See also the
4244 &%-qq%& option.
4245
4246 .cmdopt -oee
4247 .cindex "error" "reporting"
4248 If an error is detected while a non-SMTP message is being received (for
4249 example, a malformed address), the error is reported to the sender in a mail
4250 message.
4251
4252 .cindex "return code" "for &%-oee%&"
4253 Provided
4254 this error message is successfully sent, the Exim receiving process
4255 exits with a return code of zero. If not, the return code is 2 if the problem
4256 is that the original message has no recipients, or 1 for any other error.
4257 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4258
4259 .cmdopt -oem
4260 .cindex "error" "reporting"
4261 .cindex "return code" "for &%-oem%&"
4262 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4263 return code, whether or not the error message was successfully sent.
4264 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4265
4266 .cmdopt -oep
4267 .cindex "error" "reporting"
4268 If an error is detected while a non-SMTP message is being received, the
4269 error is reported by writing a message to the standard error file (stderr).
4270 .cindex "return code" "for &%-oep%&"
4271 The return code is 1 for all errors.
4272
4273 .cmdopt -oeq
4274 .cindex "error" "reporting"
4275 This option is supported for compatibility with Sendmail, but has the same
4276 effect as &%-oep%&.
4277
4278 .cmdopt -oew
4279 .cindex "error" "reporting"
4280 This option is supported for compatibility with Sendmail, but has the same
4281 effect as &%-oem%&.
4282
4283 .cmdopt -oi
4284 .cindex "dot" "in incoming non-SMTP message"
4285 This option, which has the same effect as &%-i%&, specifies that a dot on a
4286 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4287 single dot does terminate, though Exim does no special processing for other
4288 lines that start with a dot. This option is set by default if Exim is called as
4289 &'rmail'&. See also &%-ti%&.
4290
4291 .cmdopt -oitrue
4292 This option is treated as synonymous with &%-oi%&.
4293
4294 .cmdopt -oMa <&'host&~address'&>
4295 .cindex "sender" "host address, specifying for local message"
4296 A number of options starting with &%-oM%& can be used to set values associated
4297 with remote hosts on locally-submitted messages (that is, messages not received
4298 over TCP/IP). These options can be used by any caller in conjunction with the
4299 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4300 other circumstances, they are ignored unless the caller is trusted.
4301
4302 The &%-oMa%& option sets the sender host address. This may include a port
4303 number at the end, after a full stop (period). For example:
4304 .code
4305 exim -bs -oMa 10.9.8.7.1234
4306 .endd
4307 An alternative syntax is to enclose the IP address in square brackets,
4308 followed by a colon and the port number:
4309 .code
4310 exim -bs -oMa [10.9.8.7]:1234
4311 .endd
4312 The IP address is placed in the &$sender_host_address$& variable, and the
4313 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4314 are present on the command line, the sender host IP address is taken from
4315 whichever one is last.
4316
4317 .cmdopt -oMaa <&'name'&>
4318 .cindex "authentication" "name, specifying for local message"
4319 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4320 option sets the value of &$sender_host_authenticated$& (the authenticator
4321 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4322 This option can be used with &%-bh%& and &%-bs%& to set up an
4323 authenticated SMTP session without actually using the SMTP AUTH command.
4324
4325 .cmdopt -oMai <&'string'&>
4326 .cindex "authentication" "id, specifying for local message"
4327 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4328 option sets the value of &$authenticated_id$& (the id that was authenticated).
4329 This overrides the default value (the caller's login id, except with &%-bh%&,
4330 where there is no default) for messages from local sources. See chapter
4331 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4332
4333 .cmdopt -oMas <&'address'&>
4334 .cindex "authentication" "sender, specifying for local message"
4335 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4336 option sets the authenticated sender value in &$authenticated_sender$&. It
4337 overrides the sender address that is created from the caller's login id for
4338 messages from local sources, except when &%-bh%& is used, when there is no
4339 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4340 specified on a MAIL command overrides this value. See chapter
4341 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4342
4343 .cmdopt -oMi <&'interface&~address'&>
4344 .cindex "interface" "address, specifying for local message"
4345 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4346 option sets the IP interface address value. A port number may be included,
4347 using the same syntax as for &%-oMa%&. The interface address is placed in
4348 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4349
4350 .cmdopt -oMm <&'message&~reference'&>
4351 .cindex "message reference" "message reference, specifying for local message"
4352 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4353 option sets the message reference, e.g. message-id, and is logged during
4354 delivery. This is useful when some kind of audit trail is required to tie
4355 messages together. The format of the message reference is checked and will
4356 abort if the format is invalid. The option will only be accepted if exim is
4357 running in trusted mode, not as any regular user.
4358
4359 The best example of a message reference is when Exim sends a bounce message.
4360 The message reference is the message-id of the original message for which Exim
4361 is sending the bounce.
4362
4363 .cmdopt -oMr <&'protocol&~name'&>
4364 .cindex "protocol, specifying for local message"
4365 .vindex "&$received_protocol$&"
4366 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4367 option sets the received protocol value that is stored in
4368 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4369 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4370 SMTP protocol names (see the description of &$received_protocol$& in section
4371 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4372 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4373 be set by &%-oMr%&. Repeated use of this option is not supported.
4374
4375 .cmdopt -oMs <&'host&~name'&>
4376 .cindex "sender" "host name, specifying for local message"
4377 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4378 option sets the sender host name in &$sender_host_name$&. When this option is
4379 present, Exim does not attempt to look up a host name from an IP address; it
4380 uses the name it is given.
4381
4382 .cmdopt -oMt <&'ident&~string'&>
4383 .cindex "sender" "ident string, specifying for local message"
4384 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4385 option sets the sender ident value in &$sender_ident$&. The default setting for
4386 local callers is the login id of the calling process, except when &%-bh%& is
4387 used, when there is no default.
4388
4389 .cmdopt -om
4390 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4391 In Sendmail, this option means &"me too"&, indicating that the sender of a
4392 message should receive a copy of the message if the sender appears in an alias
4393 expansion. Exim always does this, so the option does nothing.
4394
4395 .cmdopt -oo
4396 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4397 This option is ignored. In Sendmail it specifies &"old style headers"&,
4398 whatever that means.
4399
4400 .cmdopt -oP <&'path'&>
4401 .cindex "pid (process id)" "of daemon"
4402 .cindex "daemon" "process id (pid)"
4403 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4404 value. The option specifies the file to which the process id of the daemon is
4405 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4406 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4407 because in those cases, the normal pid file is not used.
4408
4409 .cmdopt -oPX
4410 .cindex "pid (process id)" "of daemon"
4411 .cindex "daemon" "process id (pid)"
4412 This option is not intended for general use.
4413 The daemon uses it when terminating due to a SIGTEM, possibly in
4414 combination with &%-oP%&&~<&'path'&>.
4415 It causes the pid file to be removed.
4416
4417 .cmdopt -or <&'time'&>
4418 .cindex "timeout" "for non-SMTP input"
4419 This option sets a timeout value for incoming non-SMTP messages. If it is not
4420 set, Exim will wait forever for the standard input. The value can also be set
4421 by the &%receive_timeout%& option. The format used for specifying times is
4422 described in section &<<SECTtimeformat>>&.
4423
4424 .cmdopt -os <&'time'&>
4425 .cindex "timeout" "for SMTP input"
4426 .cindex "SMTP" "input timeout"
4427 This option sets a timeout value for incoming SMTP messages. The timeout
4428 applies to each SMTP command and block of data. The value can also be set by
4429 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4430 for specifying times is described in section &<<SECTtimeformat>>&.
4431
4432 .cmdopt -ov
4433 This option has exactly the same effect as &%-v%&.
4434
4435 .cmdopt -oX <&'number&~or&~string'&>
4436 .cindex "TCP/IP" "setting listening ports"
4437 .cindex "TCP/IP" "setting listening interfaces"
4438 .cindex "port" "receiving TCP/IP"
4439 This option is relevant only when the &%-bd%& (start listening daemon) option
4440 is also given. It controls which ports and interfaces the daemon uses. Details
4441 of the syntax, and how it interacts with configuration file options, are given
4442 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4443 file is written unless &%-oP%& is also present to specify a pid filename.
4444
4445 .cmdopt -oY
4446 .cindex "daemon notifier socket"
4447 This option controls the creation of an inter-process communications endpoint
4448 by the Exim daemon.
4449 It is only relevant when the &%-bd%& (start listening daemon) option is also
4450 given.
4451 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4452 option is also present.
4453 .new
4454 If this option is given then the socket will not be created.  This is required
4455 if the system is running multiple daemons, in which case it should
4456 be used on all.
4457 The features supported by the socket will not be available in such cases.
4458
4459 The socket is currently used for
4460 .ilist
4461 fast ramp-up of queue runner processes
4462 .next
4463 caching compiled regexes
4464 .next
4465 obtaining a current queue size
4466 .endlist
4467 .wen
4468
4469 .cmdopt -pd
4470 .cindex "Perl" "starting the interpreter"
4471 This option applies when an embedded Perl interpreter is linked with Exim (see
4472 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4473 option, forcing the starting of the interpreter to be delayed until it is
4474 needed.
4475
4476 .cmdopt -ps
4477 .cindex "Perl" "starting the interpreter"
4478 This option applies when an embedded Perl interpreter is linked with Exim (see
4479 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4480 option, forcing the starting of the interpreter to occur as soon as Exim is
4481 started.
4482
4483 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4484 .oindex "&%-p%&"
4485 For compatibility with Sendmail, this option is equivalent to
4486 .display
4487 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4488 .endd
4489 It sets the incoming protocol and host name (for trusted callers). The
4490 host name and its colon can be omitted when only the protocol is to be set.
4491 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4492 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4493 or &`s`& using this option (but that does not seem a real limitation).
4494 Repeated use of this option is not supported.
4495
4496 .cmdopt -q
4497 .cindex "queue runner" "starting manually"
4498 This option is normally restricted to admin users. However, there is a
4499 configuration option called &%prod_requires_admin%& which can be set false to
4500 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4501 and &%-S%& options).
4502
4503 .cindex "queue runner" "description of operation"
4504 If other commandline options do not specify an action,
4505 the &%-q%& option starts one queue runner process. This scans the queue of
4506 waiting messages, and runs a delivery process for each one in turn. It waits
4507 for each delivery process to finish before starting the next one. A delivery
4508 process may not actually do any deliveries if the retry times for the addresses
4509 have not been reached. Use &%-qf%& (see below) if you want to override this.
4510
4511 If
4512 .cindex "SMTP" "passed connection"
4513 .cindex "SMTP" "multiple deliveries"
4514 .cindex "multiple SMTP deliveries"
4515 the delivery process spawns other processes to deliver other messages down
4516 passed SMTP connections, the queue runner waits for these to finish before
4517 proceeding.
4518
4519 When all the queued messages have been considered, the original queue runner
4520 process terminates. In other words, a single pass is made over the waiting
4521 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4522 this to be repeated periodically.
4523
4524 Exim processes the waiting messages in an unpredictable order. It isn't very
4525 random, but it is likely to be different each time, which is all that matters.
4526 If one particular message screws up a remote MTA, other messages to the same
4527 MTA have a chance of getting through if they get tried first.
4528
4529 It is possible to cause the messages to be processed in lexical message id
4530 order, which is essentially the order in which they arrived, by setting the
4531 &%queue_run_in_order%& option, but this is not recommended for normal use.
4532
4533 .vitem &%-q%&<&'qflags'&>
4534 The &%-q%& option may be followed by one or more flag letters that change its
4535 behaviour. They are all optional, but if more than one is present, they must
4536 appear in the correct order. Each flag is described in a separate item below.
4537
4538 .vitem &%-qq...%&
4539 .oindex "&%-qq%&"
4540 .cindex "queue" "double scanning"
4541 .cindex "queue" "routing"
4542 .cindex "routing" "whole queue before delivery"
4543 .cindex "first pass routing"
4544 .cindex "queue runner" "two phase"
4545 An option starting with &%-qq%& requests a two-stage queue run. In the first
4546 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4547 every domain. Addresses are routed, local deliveries happen, but no remote
4548 transports are run.
4549
4550 Performance will be best if the &%queue_run_in_order%& option is false.
4551 If that is so and
4552 the &%queue_fast_ramp%& option is true
4553 and a daemon-notifier socket is available
4554 then in the first phase of the run,
4555 once a threshold number of messages are routed for a given host,
4556 a delivery process is forked in parallel with the rest of the scan.
4557
4558 .cindex "hints database" "remembering routing"
4559 The hints database that remembers which messages are waiting for specific hosts
4560 is updated, as if delivery to those hosts had been deferred.
4561
4562 After the first queue scan complete,
4563 a second, normal queue scan is done, with routing and delivery taking
4564 place as normal.
4565 Messages that are routed to the same host should mostly be
4566 delivered down a single SMTP
4567 .cindex "SMTP" "passed connection"
4568 .cindex "SMTP" "multiple deliveries"
4569 .cindex "multiple SMTP deliveries"
4570 connection because of the hints that were set up during the first queue scan.
4571
4572 .new
4573 Two-phase queue runs should be used on systems which, even intermittently,
4574 have a large queue (such as mailing-list operators).
4575 They may also be useful for hosts that are connected to the Internet
4576 intermittently.
4577 .wen
4578
4579 .vitem &%-q[q]i...%&
4580 .oindex "&%-qi%&"
4581 .cindex "queue" "initial delivery"
4582 If the &'i'& flag is present, the queue runner runs delivery processes only for
4583 those messages that haven't previously been tried. (&'i'& stands for &"initial
4584 delivery"&.) This can be helpful if you are putting messages in the queue using
4585 &%-odq%& and want a queue runner just to process the new messages.
4586
4587 .vitem &%-q[q][i]f...%&
4588 .oindex "&%-qf%&"
4589 .cindex "queue" "forcing delivery"
4590 .cindex "delivery" "forcing in queue run"
4591 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4592 message, whereas without &'f'& only those non-frozen addresses that have passed
4593 their retry times are tried.
4594
4595 .vitem &%-q[q][i]ff...%&
4596 .oindex "&%-qff%&"
4597 .cindex "frozen messages" "forcing delivery"
4598 If &'ff'& is present, a delivery attempt is forced for every message, whether
4599 frozen or not.
4600
4601 .vitem &%-q[q][i][f[f]]l%&
4602 .oindex "&%-ql%&"
4603 .cindex "queue" "local deliveries only"
4604 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4605 be done. If a message requires any remote deliveries, it remains in the queue
4606 for later delivery.
4607
4608 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4609 .oindex "&%-qG%&"
4610 .cindex queue named
4611 .cindex "named queues"  "deliver from"
4612 .cindex "queue" "delivering specific messages"
4613 If the &'G'& flag and a name is present, the queue runner operates on the
4614 queue with the given name rather than the default queue.
4615 The name should not contain a &'/'& character.
4616 For a periodic queue run (see below)
4617 append to the name a slash and a time value.
4618
4619 If other commandline options specify an action, a &'-qG<name>'& option
4620 will specify a queue to operate on.
4621 For example:
4622 .code
4623 exim -bp -qGquarantine
4624 mailq -qGquarantine
4625 exim -qGoffpeak -Rf @special.domain.example
4626 .endd
4627
4628 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4629 When scanning the queue, Exim can be made to skip over messages whose ids are
4630 lexically less than a given value by following the &%-q%& option with a
4631 starting message id. For example:
4632 .code
4633 exim -q 0t5C6f-0000c8-00
4634 .endd
4635 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4636 second message id is given, messages whose ids are lexically greater than it
4637 are also skipped. If the same id is given twice, for example,
4638 .code
4639 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4640 .endd
4641 just one delivery process is started, for that message. This differs from
4642 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4643 that it counts as a delivery from a queue run. Note that the selection
4644 mechanism does not affect the order in which the messages are scanned. There
4645 are also other ways of selecting specific sets of messages for delivery in a
4646 queue run &-- see &%-R%& and &%-S%&.
4647
4648 .vitem &%-q%&<&'qflags'&><&'time'&>
4649 .cindex "queue runner" "starting periodically"
4650 .cindex "periodic queue running"
4651 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4652 starting a queue runner process at intervals specified by the given time value
4653 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4654 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4655 single daemon process handles both functions. A common way of starting up a
4656 combined daemon at system boot time is to use a command such as
4657 .code
4658 /usr/exim/bin/exim -bd -q30m
4659 .endd
4660 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4661 process every 30 minutes.
4662
4663 .new
4664 .cindex "named queues" "queue runners"
4665 It is possible to set up runners for multiple named queues within one daemon,
4666 For example:
4667 .code
4668 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4669 .endd
4670 .wen
4671
4672 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4673 pid file is written unless one is explicitly requested by the &%-oP%& option.
4674
4675 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4676 .oindex "&%-qR%&"
4677 This option is synonymous with &%-R%&. It is provided for Sendmail
4678 compatibility.
4679
4680 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4681 .oindex "&%-qS%&"
4682 This option is synonymous with &%-S%&.
4683
4684 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4685 .oindex "&%-R%&"
4686 .cindex "queue runner" "for specific recipients"
4687 .cindex "delivery" "to given domain"
4688 .cindex "domain" "delivery to"
4689 The <&'rsflags'&> may be empty, in which case the white space before the string
4690 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4691 which are the possible values for <&'rsflags'&>. White space is required if
4692 <&'rsflags'&> is not empty.
4693
4694 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4695 perform a single queue run, except that, when scanning the messages on the
4696 queue, Exim processes only those that have at least one undelivered recipient
4697 address containing the given string, which is checked in a case-independent
4698 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4699 regular expression; otherwise it is a literal string.
4700
4701 If you want to do periodic queue runs for messages with specific recipients,
4702 you can combine &%-R%& with &%-q%& and a time value. For example:
4703 .code
4704 exim -q25m -R @special.domain.example
4705 .endd
4706 This example does a queue run for messages with recipients in the given domain
4707 every 25 minutes. Any additional flags that are specified with &%-q%& are
4708 applied to each queue run.
4709
4710 Once a message is selected for delivery by this mechanism, all its addresses
4711 are processed. For the first selected message, Exim overrides any retry
4712 information and forces a delivery attempt for each undelivered address. This
4713 means that if delivery of any address in the first message is successful, any
4714 existing retry information is deleted, and so delivery attempts for that
4715 address in subsequently selected messages (which are processed without forcing)
4716 will run. However, if delivery of any address does not succeed, the retry
4717 information is updated, and in subsequently selected messages, the failing
4718 address will be skipped.
4719
4720 .cindex "frozen messages" "forcing delivery"
4721 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4722 all selected messages, not just the first; frozen messages are included when
4723 &'ff'& is present.
4724
4725 The &%-R%& option makes it straightforward to initiate delivery of all messages
4726 to a given domain after a host has been down for some time. When the SMTP
4727 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4728 effect is to run Exim with the &%-R%& option, but it can be configured to run
4729 an arbitrary command instead.
4730
4731 .cmdopt -r
4732 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4733
4734 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4735 .oindex "&%-S%&"
4736 .cindex "delivery" "from given sender"
4737 .cindex "queue runner" "for specific senders"
4738 This option acts like &%-R%& except that it checks the string against each
4739 message's sender instead of against the recipients. If &%-R%& is also set, both
4740 conditions must be met for a message to be selected. If either of the options
4741 has &'f'& or &'ff'& in its flags, the associated action is taken.
4742
4743 .cmdopt -Tqt <&'times'&>
4744 This is an option that is exclusively for use by the Exim testing suite. It is not
4745 recognized when Exim is run normally. It allows for the setting up of explicit
4746 &"queue times"& so that various warning/retry features can be tested.
4747
4748 .cmdopt -t
4749 .cindex "recipient" "extracting from header lines"
4750 .chindex Bcc:
4751 .chindex Cc:
4752 .chindex To:
4753 When Exim is receiving a locally-generated, non-SMTP message on its standard
4754 input, the &%-t%& option causes the recipients of the message to be obtained
4755 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4756 from the command arguments. The addresses are extracted before any rewriting
4757 takes place and the &'Bcc:'& header line, if present, is then removed.
4758
4759 .cindex "Sendmail compatibility" "&%-t%& option"
4760 If the command has any arguments, they specify addresses to which the message
4761 is &'not'& to be delivered. That is, the argument addresses are removed from
4762 the recipients list obtained from the headers. This is compatible with Smail 3
4763 and in accordance with the documented behaviour of several versions of
4764 Sendmail, as described in man pages on a number of operating systems (e.g.
4765 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4766 argument addresses to those obtained from the headers, and the O'Reilly
4767 Sendmail book documents it that way. Exim can be made to add argument addresses
4768 instead of subtracting them by setting the option
4769 &%extract_addresses_remove_arguments%& false.
4770
4771 .cindex "&%Resent-%& header lines" "with &%-t%&"
4772 If there are any &%Resent-%& header lines in the message, Exim extracts
4773 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4774 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4775 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4776 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4777
4778 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4779 message is resent several times). The RFC also specifies that they should be
4780 added at the front of the message, and separated by &'Received:'& lines. It is
4781 not at all clear how &%-t%& should operate in the present of multiple sets,
4782 nor indeed exactly what constitutes a &"set"&.
4783 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4784 are often added at the end of the header, and if a message is resent more than
4785 once, it is common for the original set of &%Resent-%& headers to be renamed as
4786 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4787
4788 .cmdopt -ti
4789 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4790 compatibility with Sendmail.
4791
4792 .cmdopt -tls-on-connect
4793 .cindex "TLS" "use without STARTTLS"
4794 .cindex "TLS" "automatic start"
4795 This option is available when Exim is compiled with TLS support. It forces all
4796 incoming SMTP connections to behave as if the incoming port is listed in the
4797 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4798 &<<CHAPTLS>>& for further details.
4799
4800
4801 .cmdopt -U
4802 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4803 Sendmail uses this option for &"initial message submission"&, and its
4804 documentation states that in future releases, it may complain about
4805 syntactically invalid messages rather than fixing them when this flag is not
4806 set. Exim ignores this option.
4807
4808 .cmdopt -v
4809 This option causes Exim to write information to the standard error stream,
4810 describing what it is doing. In particular, it shows the log lines for
4811 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4812 dialogue is shown. Some of the log lines shown may not actually be written to
4813 the log if the setting of &%log_selector%& discards them. Any relevant
4814 selectors are shown with each log line. If none are shown, the logging is
4815 unconditional.
4816
4817 .cmdopt -x
4818 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4819 National Language Support extended characters in the body of the mail item"&).
4820 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4821 this option.
4822
4823 .cmdopt -X <&'logfile'&>
4824 This option is interpreted by Sendmail to cause debug information to be sent
4825 to the named file.  It is ignored by Exim.
4826
4827 .cmdopt -z <&'log-line'&>
4828 This option writes its argument to Exim's logfile.
4829 Use is restricted to administrators; the intent is for operational notes.
4830 Quotes should be used to maintain a multi-word item as a single argument,
4831 under most shells.
4832 .endlist
4833
4834 .ecindex IIDclo1
4835 .ecindex IIDclo2
4836
4837
4838 . ////////////////////////////////////////////////////////////////////////////
4839 . Insert a stylized DocBook comment here, to identify the end of the command
4840 . line options. This is for the benefit of the Perl script that automatically
4841 . creates a man page for the options.
4842 . ////////////////////////////////////////////////////////////////////////////
4843
4844 .literal xml
4845 <!-- === End of command line options === -->
4846 .literal off
4847
4848
4849
4850
4851
4852 . ////////////////////////////////////////////////////////////////////////////
4853 . ////////////////////////////////////////////////////////////////////////////
4854
4855
4856 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4857          "The runtime configuration file"
4858
4859 .cindex "runtime configuration"
4860 .cindex "configuration file" "general description"
4861 .cindex "CONFIGURE_FILE"
4862 .cindex "configuration file" "errors in"
4863 .cindex "error" "in configuration file"
4864 .cindex "return code" "for bad configuration"
4865 Exim uses a single runtime configuration file that is read whenever an Exim
4866 binary is executed. Note that in normal operation, this happens frequently,
4867 because Exim is designed to operate in a distributed manner, without central
4868 control.
4869
4870 If a syntax error is detected while reading the configuration file, Exim
4871 writes a message on the standard error, and exits with a non-zero return code.
4872 The message is also written to the panic log. &*Note*&: Only simple syntax
4873 errors can be detected at this time. The values of any expanded options are
4874 not checked until the expansion happens, even when the expansion does not
4875 actually alter the string.
4876
4877 The name of the configuration file is compiled into the binary for security
4878 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4879 most configurations, this specifies a single file. However, it is permitted to
4880 give a colon-separated list of filenames, in which case Exim uses the first
4881 existing file in the list.
4882
4883 .cindex "EXIM_USER"
4884 .cindex "EXIM_GROUP"
4885 .cindex "CONFIGURE_OWNER"
4886 .cindex "CONFIGURE_GROUP"
4887 .cindex "configuration file" "ownership"
4888 .cindex "ownership" "configuration file"
4889 The runtime configuration file must be owned by root or by the user that is
4890 specified at compile time by the CONFIGURE_OWNER option (if set). The
4891 configuration file must not be world-writeable, or group-writeable unless its
4892 group is the root group or the one specified at compile time by the
4893 CONFIGURE_GROUP option.
4894
4895 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4896 to root, anybody who is able to edit the runtime configuration file has an
4897 easy way to run commands as root. If you specify a user or group in the
4898 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4899 who are members of that group will trivially be able to obtain root privileges.
4900
4901 Up to Exim version 4.72, the runtime configuration file was also permitted to
4902 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4903 since it offered a simple privilege escalation for any attacker who managed to
4904 compromise the Exim user account.
4905
4906 A default configuration file, which will work correctly in simple situations,
4907 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4908 defines just one filename, the installation process copies the default
4909 configuration to a new file of that name if it did not previously exist. If
4910 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4911 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4912 configuration.
4913
4914
4915
4916 .section "Using a different configuration file" "SECID40"
4917 .cindex "configuration file" "alternate"
4918 A one-off alternate configuration can be specified by the &%-C%& command line
4919 option, which may specify a single file or a list of files. However, when
4920 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4921 unless the argument for &%-C%& is identical to the built-in value from
4922 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4923 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4924 is useful mainly for checking the syntax of configuration files before
4925 installing them. No owner or group checks are done on a configuration file
4926 specified by &%-C%&, if root privilege has been dropped.
4927
4928 Even the Exim user is not trusted to specify an arbitrary configuration file
4929 with the &%-C%& option to be used with root privileges, unless that file is
4930 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4931 testing a configuration using &%-C%& right through message reception and
4932 delivery, even if the caller is root. The reception works, but by that time,
4933 Exim is running as the Exim user, so when it re-execs to regain privilege for
4934 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4935 can test reception and delivery using two separate commands (one to put a
4936 message in the queue, using &%-odq%&, and another to do the delivery, using
4937 &%-M%&).
4938
4939 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4940 prefix string with which any file named in a &%-C%& command line option must
4941 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4942 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4943 filename can be used with &%-C%&.
4944
4945 One-off changes to a configuration can be specified by the &%-D%& command line
4946 option, which defines and overrides values for macros used inside the
4947 configuration file. However, like &%-C%&, the use of this option by a
4948 non-privileged user causes Exim to discard its root privilege.
4949 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4950 completely disabled, and its use causes an immediate error exit.
4951
4952 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4953 to declare certain macro names trusted, such that root privilege will not
4954 necessarily be discarded.
4955 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4956 considered safe and, if &%-D%& only supplies macros from this list, and the
4957 values are acceptable, then Exim will not give up root privilege if the caller
4958 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4959 transition mechanism and is expected to be removed in the future.  Acceptable
4960 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4961
4962 Some sites may wish to use the same Exim binary on different machines that
4963 share a file system, but to use different configuration files on each machine.
4964 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4965 looks for a file whose name is the configuration filename followed by a dot
4966 and the machine's node name, as obtained from the &[uname()]& function. If this
4967 file does not exist, the standard name is tried. This processing occurs for
4968 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4969
4970 In some esoteric situations different versions of Exim may be run under
4971 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4972 help with this. See the comments in &_src/EDITME_& for details.
4973
4974
4975
4976 .section "Configuration file format" "SECTconffilfor"
4977 .cindex "configuration file" "format of"
4978 .cindex "format" "configuration file"
4979 Exim's configuration file is divided into a number of different parts. General
4980 option settings must always appear at the start of the file. The other parts
4981 are all optional, and may appear in any order. Each part other than the first
4982 is introduced by the word &"begin"& followed by at least one literal
4983 space, and the name of the part. The optional parts are:
4984
4985 .ilist
4986 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4987 &<<CHAPACL>>&).
4988 .next
4989 .cindex "AUTH" "configuration"
4990 &'authenticators'&: Configuration settings for the authenticator drivers. These
4991 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4992 .next
4993 &'routers'&: Configuration settings for the router drivers. Routers process
4994 addresses and determine how the message is to be delivered (see chapters
4995 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4996 .next
4997 &'transports'&: Configuration settings for the transport drivers. Transports
4998 define mechanisms for copying messages to destinations (see chapters
4999 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5000 .next
5001 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5002 If there is no retry section, or if it is empty (that is, no retry rules are
5003 defined), Exim will not retry deliveries. In this situation, temporary errors
5004 are treated the same as permanent errors. Retry rules are discussed in chapter
5005 &<<CHAPretry>>&.
5006 .next
5007 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5008 when new addresses are generated during delivery. Rewriting is discussed in
5009 chapter &<<CHAPrewrite>>&.
5010 .next
5011 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5012 want to use this feature, you must set
5013 .code
5014 LOCAL_SCAN_HAS_OPTIONS=yes
5015 .endd
5016 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5017 facility are given in chapter &<<CHAPlocalscan>>&.
5018 .endlist
5019
5020 .cindex "configuration file" "leading white space in"
5021 .cindex "configuration file" "trailing white space in"
5022 .cindex "white space" "in configuration file"
5023 Leading and trailing white space in configuration lines is always ignored.
5024
5025 Blank lines in the file, and lines starting with a # character (ignoring
5026 leading white space) are treated as comments and are ignored. &*Note*&: A
5027 # character other than at the beginning of a line is not treated specially,
5028 and does not introduce a comment.
5029
5030 Any non-comment line can be continued by ending it with a backslash. Note that
5031 the general rule for white space means that trailing white space after the
5032 backslash and leading white space at the start of continuation
5033 lines is ignored. Comment lines beginning with # (but not empty lines) may
5034 appear in the middle of a sequence of continuation lines.
5035
5036 A convenient way to create a configuration file is to start from the
5037 default, which is supplied in &_src/configure.default_&, and add, delete, or
5038 change settings as required.
5039
5040 The ACLs, retry rules, and rewriting rules have their own syntax which is
5041 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5042 respectively. The other parts of the configuration file have some syntactic
5043 items in common, and these are described below, from section &<<SECTcos>>&
5044 onwards. Before that, the inclusion, macro, and conditional facilities are
5045 described.
5046
5047
5048
5049 .section "File inclusions in the configuration file" "SECID41"
5050 .cindex "inclusions in configuration file"
5051 .cindex "configuration file" "including other files"
5052 .cindex "&`.include`& in configuration file"
5053 .cindex "&`.include_if_exists`& in configuration file"
5054 You can include other files inside Exim's runtime configuration file by
5055 using this syntax:
5056 .display
5057 &`.include`& <&'filename'&>
5058 &`.include_if_exists`& <&'filename'&>
5059 .endd
5060 on a line by itself. Double quotes round the filename are optional. If you use
5061 the first form, a configuration error occurs if the file does not exist; the
5062 second form does nothing for non-existent files.
5063 The first form allows a relative name. It is resolved relative to
5064 the directory of the including file. For the second form an absolute filename
5065 is required.
5066
5067 Includes may be nested to any depth, but remember that Exim reads its
5068 configuration file often, so it is a good idea to keep them to a minimum.
5069 If you change the contents of an included file, you must HUP the daemon,
5070 because an included file is read only when the configuration itself is read.
5071
5072 The processing of inclusions happens early, at a physical line level, so, like
5073 comment lines, an inclusion can be used in the middle of an option setting,
5074 for example:
5075 .code
5076 hosts_lookup = a.b.c \
5077                .include /some/file
5078 .endd
5079 Include processing happens after macro processing (see below). Its effect is to
5080 process the lines of the included file as if they occurred inline where the
5081 inclusion appears.
5082
5083
5084
5085 .section "Macros in the configuration file" "SECTmacrodefs"
5086 .cindex "macro" "description of"
5087 .cindex "configuration file" "macros"
5088 If a line in the main part of the configuration (that is, before the first
5089 &"begin"& line) begins with an upper case letter, it is taken as a macro
5090 definition, and must be of the form
5091 .display
5092 <&'name'&> = <&'rest of line'&>
5093 .endd
5094 The name must consist of letters, digits, and underscores, and need not all be
5095 in upper case, though that is recommended. The rest of the line, including any
5096 continuations, is the replacement text, and has leading and trailing white
5097 space removed. Quotes are not removed. The replacement text can never end with
5098 a backslash character, but this doesn't seem to be a serious limitation.
5099
5100 Macros may also be defined between router, transport, authenticator, or ACL
5101 definitions. They may not, however, be defined within an individual driver or
5102 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5103
5104 .section "Macro substitution" "SECID42"
5105 Once a macro is defined, all subsequent lines in the file (and any included
5106 files) are scanned for the macro name; if there are several macros, the line is
5107 scanned for each, in turn, in the order in which the macros are defined. The
5108 replacement text is not re-scanned for the current macro, though it is scanned
5109 for subsequently defined macros. For this reason, a macro name may not contain
5110 the name of a previously defined macro as a substring. You could, for example,
5111 define
5112 .display
5113 &`ABCD_XYZ = `&<&'something'&>
5114 &`ABCD = `&<&'something else'&>
5115 .endd
5116 but putting the definitions in the opposite order would provoke a configuration
5117 error. Macro expansion is applied to individual physical lines from the file,
5118 before checking for line continuation or file inclusion (see above). If a line
5119 consists solely of a macro name, and the expansion of the macro is empty, the
5120 line is ignored. A macro at the start of a line may turn the line into a
5121 comment line or a &`.include`& line.
5122
5123
5124 .section "Redefining macros" "SECID43"
5125 Once defined, the value of a macro can be redefined later in the configuration
5126 (or in an included file). Redefinition is specified by using &'=='& instead of
5127 &'='&. For example:
5128 .code
5129 MAC =  initial value
5130 ...
5131 MAC == updated value
5132 .endd
5133 Redefinition does not alter the order in which the macros are applied to the
5134 subsequent lines of the configuration file. It is still the same order in which
5135 the macros were originally defined. All that changes is the macro's value.
5136 Redefinition makes it possible to accumulate values. For example:
5137 .code
5138 MAC =  initial value
5139 ...
5140 MAC == MAC and something added
5141 .endd
5142 This can be helpful in situations where the configuration file is built
5143 from a number of other files.
5144
5145 .section "Overriding macro values" "SECID44"
5146 The values set for macros in the configuration file can be overridden by the
5147 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5148 used, unless called by root or the Exim user. A definition on the command line
5149 using the &%-D%& option causes all definitions and redefinitions within the
5150 file to be ignored.
5151
5152
5153
5154 .section "Example of macro usage" "SECID45"
5155 As an example of macro usage, consider a configuration where aliases are looked
5156 up in a MySQL database. It helps to keep the file less cluttered if long
5157 strings such as SQL statements are defined separately as macros, for example:
5158 .code
5159 ALIAS_QUERY = select mailbox from user where \
5160               login='${quote_mysql:$local_part}';
5161 .endd
5162 This can then be used in a &(redirect)& router setting like this:
5163 .code
5164 data = ${lookup mysql{ALIAS_QUERY}}
5165 .endd
5166 In earlier versions of Exim macros were sometimes used for domain, host, or
5167 address lists. In Exim 4 these are handled better by named lists &-- see
5168 section &<<SECTnamedlists>>&.
5169
5170
5171 .section "Builtin macros" "SECTbuiltinmacros"
5172 Exim defines some macros depending on facilities available, which may
5173 differ due to build-time definitions and from one release to another.
5174 All of these macros start with an underscore.
5175 They can be used to conditionally include parts of a configuration
5176 (see below).
5177
5178 The following classes of macros are defined:
5179 .display
5180 &` _HAVE_*                    `&  build-time defines
5181 &` _DRIVER_ROUTER_*           `&  router drivers
5182 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5183 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5184 &` _EXP_COND_*                `&  expansion conditions
5185 &` _EXP_ITEM_*                `&  expansion items
5186 &` _EXP_OP_*                  `&  expansion operators
5187 &` _EXP_VAR_*                 `&  expansion variables
5188 &` _LOG_*                     `&  log_selector values
5189 &` _OPT_MAIN_*                `&  main config options
5190 &` _OPT_ROUTERS_*             `&  generic router options
5191 &` _OPT_TRANSPORTS_*          `&  generic transport options
5192 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5193 &` _OPT_ROUTER_*_*            `&  private router options
5194 &` _OPT_TRANSPORT_*_*         `&  private transport options
5195 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5196 .endd
5197
5198 Use an &"exim -bP macros"& command to get the list of macros.
5199
5200
5201 .section "Conditional skips in the configuration file" "SECID46"
5202 .cindex "configuration file" "conditional skips"
5203 .cindex "&`.ifdef`&"
5204 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5205 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5206 portions of the configuration file. The processing happens whenever the file is
5207 read (that is, when an Exim binary starts to run).
5208
5209 The implementation is very simple. Instances of the first four directives must
5210 be followed by text that includes the names of one or macros. The condition
5211 that is tested is whether or not any macro substitution has taken place in the
5212 line. Thus:
5213 .code
5214 .ifdef AAA
5215 message_size_limit = 50M
5216 .else
5217 message_size_limit = 100M
5218 .endif
5219 .endd
5220 sets a message size limit of 50M if the macro &`AAA`& is defined
5221 (or &`A`& or &`AA`&), and 100M
5222 otherwise. If there is more than one macro named on the line, the condition
5223 is true if any of them are defined. That is, it is an &"or"& condition. To
5224 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5225
5226 Although you can use a macro expansion to generate one of these directives,
5227 it is not very useful, because the condition &"there was a macro substitution
5228 in this line"& will always be true.
5229
5230 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5231 to clarify complicated nestings.
5232
5233
5234
5235 .section "Common option syntax" "SECTcos"
5236 .cindex "common option syntax"
5237 .cindex "syntax of common options"
5238 .cindex "configuration file" "common option syntax"
5239 For the main set of options, driver options, and &[local_scan()]& options,
5240 each setting is on a line by itself, and starts with a name consisting of
5241 lower-case letters and underscores. Many options require a data value, and in
5242 these cases the name must be followed by an equals sign (with optional white
5243 space) and then the value. For example:
5244 .code
5245 qualify_domain = mydomain.example.com
5246 .endd
5247 .cindex "hiding configuration option values"
5248 .cindex "configuration options" "hiding value of"
5249 .cindex "options" "hiding value of"
5250 Some option settings may contain sensitive data, for example, passwords for
5251 accessing databases. To stop non-admin users from using the &%-bP%& command
5252 line option to read these values, you can precede the option settings with the
5253 word &"hide"&. For example:
5254 .code
5255 hide mysql_servers = localhost/users/admin/secret-password
5256 .endd
5257 For non-admin users, such options are displayed like this:
5258 .code
5259 mysql_servers = <value not displayable>
5260 .endd
5261 If &"hide"& is used on a driver option, it hides the value of that option on
5262 all instances of the same driver.
5263
5264 The following sections describe the syntax used for the different data types
5265 that are found in option settings.
5266
5267
5268 .section "Boolean options" "SECID47"
5269 .cindex "format" "boolean"
5270 .cindex "boolean configuration values"
5271 .oindex "&%no_%&&'xxx'&"
5272 .oindex "&%not_%&&'xxx'&"
5273 Options whose type is given as boolean are on/off switches. There are two
5274 different ways of specifying such options: with and without a data value. If
5275 the option name is specified on its own without data, the switch is turned on;
5276 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5277 boolean options may be followed by an equals sign and one of the words
5278 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5279 the following two settings have exactly the same effect:
5280 .code
5281 queue_only
5282 queue_only = true
5283 .endd
5284 The following two lines also have the same (opposite) effect:
5285 .code
5286 no_queue_only
5287 queue_only = false
5288 .endd
5289 You can use whichever syntax you prefer.
5290
5291
5292
5293
5294 .section "Integer values" "SECID48"
5295 .cindex "integer configuration values"
5296 .cindex "format" "integer"
5297 If an option's type is given as &"integer"&, the value can be given in decimal,
5298 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5299 number is assumed. Otherwise, it is treated as an octal number unless it starts
5300 with the characters &"0x"&, in which case the remainder is interpreted as a
5301 hexadecimal number.
5302
5303 If an integer value is followed by the letter K, it is multiplied by 1024; if
5304 it is followed by the letter M, it is multiplied by 1024x1024;
5305 if by the letter G, 1024x1024x1024.
5306 When the values
5307 of integer option settings are output, values which are an exact multiple of
5308 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5309 and M. The printing style is independent of the actual input format that was
5310 used.
5311
5312
5313 .section "Octal integer values" "SECID49"
5314 .cindex "integer format"
5315 .cindex "format" "octal integer"
5316 If an option's type is given as &"octal integer"&, its value is always
5317 interpreted as an octal number, whether or not it starts with the digit zero.
5318 Such options are always output in octal.
5319
5320
5321 .section "Fixed point numbers" "SECID50"
5322 .cindex "fixed point configuration values"
5323 .cindex "format" "fixed point"
5324 If an option's type is given as &"fixed-point"&, its value must be a decimal
5325 integer, optionally followed by a decimal point and up to three further digits.
5326
5327
5328
5329 .section "Time intervals" "SECTtimeformat"
5330 .cindex "time interval" "specifying in configuration"
5331 .cindex "format" "time interval"
5332 A time interval is specified as a sequence of numbers, each followed by one of
5333 the following letters, with no intervening white space:
5334
5335 .table2 30pt
5336 .irow &%s%& seconds
5337 .irow &%m%& minutes
5338 .irow &%h%& hours
5339 .irow &%d%& days
5340 .irow &%w%& weeks
5341 .endtable
5342
5343 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5344 intervals are output in the same format. Exim does not restrict the values; it
5345 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5346
5347
5348
5349 .section "String values" "SECTstrings"
5350 .cindex "string" "format of configuration values"
5351 .cindex "format" "string"
5352 If an option's type is specified as &"string"&, the value can be specified with
5353 or without double-quotes. If it does not start with a double-quote, the value
5354 consists of the remainder of the line plus any continuation lines, starting at
5355 the first character after any leading white space, with trailing white space
5356 removed, and with no interpretation of the characters in the string. Because
5357 Exim removes comment lines (those beginning with #) at an early stage, they can
5358 appear in the middle of a multi-line string. The following two settings are
5359 therefore equivalent:
5360 .code
5361 trusted_users = uucp:mail
5362 trusted_users = uucp:\
5363                 # This comment line is ignored
5364                 mail
5365 .endd
5366 .cindex "string" "quoted"
5367 .cindex "escape characters in quoted strings"
5368 If a string does start with a double-quote, it must end with a closing
5369 double-quote, and any backslash characters other than those used for line
5370 continuation are interpreted as escape characters, as follows:
5371
5372 .table2 100pt
5373 .irow &`\\`&                     "single backslash"
5374 .irow &`\n`&                     "newline"
5375 .irow &`\r`&                     "carriage return"
5376 .irow &`\t`&                     "tab"
5377 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5378 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5379                                    character"
5380 .endtable
5381
5382 If a backslash is followed by some other character, including a double-quote
5383 character, that character replaces the pair.
5384
5385 Quoting is necessary only if you want to make use of the backslash escapes to
5386 insert special characters, or if you need to specify a value with leading or
5387 trailing spaces. These cases are rare, so quoting is almost never needed in
5388 current versions of Exim. In versions of Exim before 3.14, quoting was required
5389 in order to continue lines, so you may come across older configuration files
5390 and examples that apparently quote unnecessarily.
5391
5392
5393 .section "Expanded strings" "SECID51"
5394 .cindex "expansion" "definition of"
5395 Some strings in the configuration file are subjected to &'string expansion'&,
5396 by which means various parts of the string may be changed according to the
5397 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5398 is as just described; in particular, the handling of backslashes in quoted
5399 strings is done as part of the input process, before expansion takes place.
5400 However, backslash is also an escape character for the expander, so any
5401 backslashes that are required for that reason must be doubled if they are
5402 within a quoted configuration string.
5403
5404
5405 .section "User and group names" "SECID52"
5406 .cindex "user name" "format of"
5407 .cindex "format" "user name"
5408 .cindex "groups" "name format"
5409 .cindex "format" "group name"
5410 User and group names are specified as strings, using the syntax described
5411 above, but the strings are interpreted specially. A user or group name must
5412 either consist entirely of digits, or be a name that can be looked up using the
5413 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5414
5415
5416 .section "List construction" "SECTlistconstruct"
5417 .cindex "list" "syntax of in configuration"
5418 .cindex "format" "list item in configuration"
5419 .cindex "string" "list, definition of"
5420 The data for some configuration options is a list of items, with colon as the
5421 default separator. Many of these options are shown with type &"string list"& in
5422 the descriptions later in this document. Others are listed as &"domain list"&,
5423 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5424 are all the same; however, those other than &"string list"& are subject to
5425 particular kinds of interpretation, as described in chapter
5426 &<<CHAPdomhosaddlists>>&.
5427
5428 In all these cases, the entire list is treated as a single string as far as the
5429 input syntax is concerned. The &%trusted_users%& setting in section
5430 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5431 in a list, it must be entered as two colons. Leading and trailing white space
5432 on each item in a list is ignored. This makes it possible to include items that
5433 start with a colon, and in particular, certain forms of IPv6 address. For
5434 example, the list
5435 .code
5436 local_interfaces = 127.0.0.1 : ::::1
5437 .endd
5438 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5439
5440 &*Note*&: Although leading and trailing white space is ignored in individual
5441 list items, it is not ignored when parsing the list. The spaces around the first
5442 colon in the example above are necessary. If they were not there, the list would
5443 be interpreted as the two items 127.0.0.1:: and 1.
5444
5445 .section "Changing list separators" "SECTlistsepchange"
5446 .cindex "list separator" "changing"
5447 .cindex "IPv6" "addresses in lists"
5448 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5449 introduced to allow the separator character to be changed. If a list begins
5450 with a left angle bracket, followed by any punctuation character, that
5451 character is used instead of colon as the list separator. For example, the list
5452 above can be rewritten to use a semicolon separator like this:
5453 .code
5454 local_interfaces = <; 127.0.0.1 ; ::1
5455 .endd
5456 This facility applies to all lists, with the exception of the list in
5457 &%log_file_path%&. It is recommended that the use of non-colon separators be
5458 confined to circumstances where they really are needed.
5459
5460 .cindex "list separator" "newline as"
5461 .cindex "newline" "as list separator"
5462 It is also possible to use newline and other control characters (those with
5463 code values less than 32, plus DEL) as separators in lists. Such separators
5464 must be provided literally at the time the list is processed. For options that
5465 are string-expanded, you can write the separator using a normal escape
5466 sequence. This will be processed by the expander before the string is
5467 interpreted as a list. For example, if a newline-separated list of domains is
5468 generated by a lookup, you can process it directly by a line such as this:
5469 .code
5470 domains = <\n ${lookup mysql{.....}}
5471 .endd
5472 This avoids having to change the list separator in such data. You are unlikely
5473 to want to use a control character as a separator in an option that is not
5474 expanded, because the value is literal text. However, it can be done by giving
5475 the value in quotes. For example:
5476 .code
5477 local_interfaces = "<\n 127.0.0.1 \n ::1"
5478 .endd
5479 Unlike printing character separators, which can be included in list items by
5480 doubling, it is not possible to include a control character as data when it is
5481 set as the separator. Two such characters in succession are interpreted as
5482 enclosing an empty list item.
5483
5484
5485
5486 .section "Empty items in lists" "SECTempitelis"
5487 .cindex "list" "empty item in"
5488 An empty item at the end of a list is always ignored. In other words, trailing
5489 separator characters are ignored. Thus, the list in
5490 .code
5491 senders = user@domain :
5492 .endd
5493 contains only a single item. If you want to include an empty string as one item
5494 in a list, it must not be the last item. For example, this list contains three
5495 items, the second of which is empty:
5496 .code
5497 senders = user1@domain : : user2@domain
5498 .endd
5499 &*Note*&: There must be white space between the two colons, as otherwise they
5500 are interpreted as representing a single colon data character (and the list
5501 would then contain just one item). If you want to specify a list that contains
5502 just one, empty item, you can do it as in this example:
5503 .code
5504 senders = :
5505 .endd
5506 In this case, the first item is empty, and the second is discarded because it
5507 is at the end of the list.
5508
5509
5510
5511
5512 .section "Format of driver configurations" "SECTfordricon"
5513 .cindex "drivers" "configuration format"
5514 There are separate parts in the configuration for defining routers, transports,
5515 and authenticators. In each part, you are defining a number of driver
5516 instances, each with its own set of options. Each driver instance is defined by
5517 a sequence of lines like this:
5518 .display
5519 <&'instance name'&>:
5520   <&'option'&>
5521   ...
5522   <&'option'&>
5523 .endd
5524 In the following example, the instance name is &(localuser)&, and it is
5525 followed by three options settings:
5526 .code
5527 localuser:
5528   driver = accept
5529   check_local_user
5530   transport = local_delivery
5531 .endd
5532 For each driver instance, you specify which Exim code module it uses &-- by the
5533 setting of the &%driver%& option &-- and (optionally) some configuration
5534 settings. For example, in the case of transports, if you want a transport to
5535 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5536 a local file you would use the &(appendfile)& driver. Each of the drivers is
5537 described in detail in its own separate chapter later in this manual.
5538
5539 You can have several routers, transports, or authenticators that are based on
5540 the same underlying driver (each must have a different instance name).
5541
5542 The order in which routers are defined is important, because addresses are
5543 passed to individual routers one by one, in order. The order in which
5544 transports are defined does not matter at all. The order in which
5545 authenticators are defined is used only when Exim, as a client, is searching
5546 them to find one that matches an authentication mechanism offered by the
5547 server.
5548
5549 .cindex "generic options"
5550 .cindex "options" "generic &-- definition of"
5551 Within a driver instance definition, there are two kinds of option: &'generic'&
5552 and &'private'&. The generic options are those that apply to all drivers of the
5553 same type (that is, all routers, all transports or all authenticators). The
5554 &%driver%& option is a generic option that must appear in every definition.
5555 .cindex "private options"
5556 The private options are special for each driver, and none need appear, because
5557 they all have default values.
5558
5559 The options may appear in any order, except that the &%driver%& option must
5560 precede any private options, since these depend on the particular driver. For
5561 this reason, it is recommended that &%driver%& always be the first option.
5562
5563 Driver instance names, which are used for reference in log entries and
5564 elsewhere, can be any sequence of letters, digits, and underscores (starting
5565 with a letter) and must be unique among drivers of the same type. A router and
5566 a transport (for example) can each have the same name, but no two router
5567 instances can have the same name. The name of a driver instance should not be
5568 confused with the name of the underlying driver module. For example, the
5569 configuration lines:
5570 .code
5571 remote_smtp:
5572   driver = smtp
5573 .endd
5574 create an instance of the &(smtp)& transport driver whose name is
5575 &(remote_smtp)&. The same driver code can be used more than once, with
5576 different instance names and different option settings each time. A second
5577 instance of the &(smtp)& transport, with different options, might be defined
5578 thus:
5579 .code
5580 special_smtp:
5581   driver = smtp
5582   port = 1234
5583   command_timeout = 10s
5584 .endd
5585 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5586 these transport instances from routers, and these names would appear in log
5587 lines.
5588
5589 Comment lines may be present in the middle of driver specifications. The full
5590 list of option settings for any particular driver instance, including all the
5591 defaulted values, can be extracted by making use of the &%-bP%& command line
5592 option.
5593
5594
5595
5596
5597
5598
5599 . ////////////////////////////////////////////////////////////////////////////
5600 . ////////////////////////////////////////////////////////////////////////////
5601
5602 .chapter "The default configuration file" "CHAPdefconfil"
5603 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5604 .cindex "default" "configuration file &""walk through""&"
5605 The default configuration file supplied with Exim as &_src/configure.default_&
5606 is sufficient for a host with simple mail requirements. As an introduction to
5607 the way Exim is configured, this chapter &"walks through"& the default
5608 configuration, giving brief explanations of the settings. Detailed descriptions
5609 of the options are given in subsequent chapters. The default configuration file
5610 itself contains extensive comments about ways you might want to modify the
5611 initial settings. However, note that there are many options that are not
5612 mentioned at all in the default configuration.
5613
5614
5615
5616 .section "Macros" "SECTdefconfmacros"
5617 All macros should be defined before any options.
5618
5619 One macro is specified, but commented out, in the default configuration:
5620 .code
5621 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5622 .endd
5623 If all off-site mail is expected to be delivered to a "smarthost", then set the
5624 hostname here and uncomment the macro.  This will affect which router is used
5625 later on.  If this is left commented out, then Exim will perform direct-to-MX
5626 deliveries using a &(dnslookup)& router.
5627
5628 In addition to macros defined here, Exim includes a number of built-in macros
5629 to enable configuration to be guarded by a binary built with support for a
5630 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5631
5632
5633 .section "Main configuration settings" "SECTdefconfmain"
5634 The main (global) configuration option settings section must always come first
5635 in the file, after the macros.
5636 The first thing you'll see in the file, after some initial comments, is the line
5637 .code
5638 # primary_hostname =
5639 .endd
5640 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5641 to know the official, fully qualified name of your host, and this is where you
5642 can specify it. However, in most cases you do not need to set this option. When
5643 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5644
5645 The first three non-comment configuration lines are as follows:
5646 .code
5647 domainlist local_domains    = @
5648 domainlist relay_to_domains =
5649 hostlist   relay_from_hosts = 127.0.0.1
5650 .endd
5651 These are not, in fact, option settings. They are definitions of two named
5652 domain lists and one named host list. Exim allows you to give names to lists of
5653 domains, hosts, and email addresses, in order to make it easier to manage the
5654 configuration file (see section &<<SECTnamedlists>>&).
5655
5656 The first line defines a domain list called &'local_domains'&; this is used
5657 later in the configuration to identify domains that are to be delivered
5658 on the local host.
5659
5660 .cindex "@ in a domain list"
5661 There is just one item in this list, the string &"@"&. This is a special form
5662 of entry which means &"the name of the local host"&. Thus, if the local host is
5663 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5664 be delivered locally. Because the local host's name is referenced indirectly,
5665 the same configuration file can be used on different hosts.
5666
5667 The second line defines a domain list called &'relay_to_domains'&, but the
5668 list itself is empty. Later in the configuration we will come to the part that
5669 controls mail relaying through the local host; it allows relaying to any
5670 domains in this list. By default, therefore, no relaying on the basis of a mail
5671 domain is permitted.
5672
5673 The third line defines a host list called &'relay_from_hosts'&. This list is
5674 used later in the configuration to permit relaying from any host or IP address
5675 that matches the list. The default contains just the IP address of the IPv4
5676 loopback interface, which means that processes on the local host are able to
5677 submit mail for relaying by sending it over TCP/IP to that interface. No other
5678 hosts are permitted to submit messages for relaying.
5679
5680 Just to be sure there's no misunderstanding: at this point in the configuration
5681 we aren't actually setting up any controls. We are just defining some domains
5682 and hosts that will be used in the controls that are specified later.
5683
5684 The next two configuration lines are genuine option settings:
5685 .code
5686 acl_smtp_rcpt = acl_check_rcpt
5687 acl_smtp_data = acl_check_data
5688 .endd
5689 These options specify &'Access Control Lists'& (ACLs) that are to be used
5690 during an incoming SMTP session for every recipient of a message (every RCPT
5691 command), and after the contents of the message have been received,
5692 respectively. The names of the lists are &'acl_check_rcpt'& and
5693 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5694 section of the configuration. The RCPT ACL controls which recipients are
5695 accepted for an incoming message &-- if a configuration does not provide an ACL
5696 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5697 contents of a message to be checked.
5698
5699 Two commented-out option settings are next:
5700 .code
5701 # av_scanner = clamd:/tmp/clamd
5702 # spamd_address = 127.0.0.1 783
5703 .endd
5704 These are example settings that can be used when Exim is compiled with the
5705 content-scanning extension. The first specifies the interface to the virus
5706 scanner, and the second specifies the interface to SpamAssassin. Further
5707 details are given in chapter &<<CHAPexiscan>>&.
5708
5709 Three more commented-out option settings follow:
5710 .code
5711 # tls_advertise_hosts = *
5712 # tls_certificate = /etc/ssl/exim.crt
5713 # tls_privatekey = /etc/ssl/exim.pem
5714 .endd
5715 These are example settings that can be used when Exim is compiled with
5716 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5717 first one specifies the list of clients that are allowed to use TLS when
5718 connecting to this server; in this case, the wildcard means all clients. The
5719 other options specify where Exim should find its TLS certificate and private
5720 key, which together prove the server's identity to any clients that connect.
5721 More details are given in chapter &<<CHAPTLS>>&.
5722
5723 Another two commented-out option settings follow:
5724 .code
5725 # daemon_smtp_ports = 25 : 465 : 587
5726 # tls_on_connect_ports = 465
5727 .endd
5728 .cindex "port" "465 and 587"
5729 .cindex "port" "for message submission"
5730 .cindex "message" "submission, ports for"
5731 .cindex "submissions protocol"
5732 .cindex "smtps protocol"
5733 .cindex "ssmtp protocol"
5734 .cindex "SMTP" "submissions protocol"
5735 .cindex "SMTP" "ssmtp protocol"
5736 .cindex "SMTP" "smtps protocol"
5737 These options provide better support for roaming users who wish to use this
5738 server for message submission. They are not much use unless you have turned on
5739 TLS (as described in the previous paragraph) and authentication (about which
5740 more in section &<<SECTdefconfauth>>&).
5741 Mail submission from mail clients (MUAs) should be separate from inbound mail
5742 to your domain (MX delivery) for various good reasons (eg, ability to impose
5743 much saner TLS protocol and ciphersuite requirements without unintended
5744 consequences).
5745 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5746 which uses STARTTLS, so this is the &"submission"& port.
5747 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5748 which should be used in preference to 587.
5749 You should also consider deploying SRV records to help clients find
5750 these ports.
5751 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5752
5753 Two more commented-out options settings follow:
5754 .code
5755 # qualify_domain =
5756 # qualify_recipient =
5757 .endd
5758 The first of these specifies a domain that Exim uses when it constructs a
5759 complete email address from a local login name. This is often needed when Exim
5760 receives a message from a local process. If you do not set &%qualify_domain%&,
5761 the value of &%primary_hostname%& is used. If you set both of these options,
5762 you can have different qualification domains for sender and recipient
5763 addresses. If you set only the first one, its value is used in both cases.
5764
5765 .cindex "domain literal" "recognizing format"
5766 The following line must be uncommented if you want Exim to recognize
5767 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5768 (an IP address within square brackets) instead of a named domain.
5769 .code
5770 # allow_domain_literals
5771 .endd
5772 The RFCs still require this form, but many people think that in the modern
5773 Internet it makes little sense to permit mail to be sent to specific hosts by
5774 quoting their IP addresses. This ancient format has been used by people who
5775 try to abuse hosts by using them for unwanted relaying. However, some
5776 people believe there are circumstances (for example, messages addressed to
5777 &'postmaster'&) where domain literals are still useful.
5778
5779 The next configuration line is a kind of trigger guard:
5780 .code
5781 never_users = root
5782 .endd
5783 It specifies that no delivery must ever be run as the root user. The normal
5784 convention is to set up &'root'& as an alias for the system administrator. This
5785 setting is a guard against slips in the configuration.
5786 The list of users specified by &%never_users%& is not, however, the complete
5787 list; the build-time configuration in &_Local/Makefile_& has an option called
5788 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5789 contents of &%never_users%& are added to this list. By default
5790 FIXED_NEVER_USERS also specifies root.
5791
5792 When a remote host connects to Exim in order to send mail, the only information
5793 Exim has about the host's identity is its IP address. The next configuration
5794 line,
5795 .code
5796 host_lookup = *
5797 .endd
5798 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5799 in order to get a host name. This improves the quality of the logging
5800 information, but if you feel it is too expensive, you can remove it entirely,
5801 or restrict the lookup to hosts on &"nearby"& networks.
5802 Note that it is not always possible to find a host name from an IP address,
5803 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5804 unreachable.
5805
5806 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5807 1413 (hence their names):
5808 .code
5809 rfc1413_hosts = *
5810 rfc1413_query_timeout = 0s
5811 .endd
5812 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5813 Few hosts offer RFC1413 service these days; calls have to be
5814 terminated by a timeout and this needlessly delays the startup
5815 of an incoming SMTP connection.
5816 If you have hosts for which you trust RFC1413 and need this
5817 information, you can change this.
5818
5819 This line enables an efficiency SMTP option.  It is negotiated by clients
5820 and not expected to cause problems but can be disabled if needed.
5821 .code
5822 prdr_enable = true
5823 .endd
5824
5825 When Exim receives messages over SMTP connections, it expects all addresses to
5826 be fully qualified with a domain, as required by the SMTP definition. However,
5827 if you are running a server to which simple clients submit messages, you may
5828 find that they send unqualified addresses. The two commented-out options:
5829 .code
5830 # sender_unqualified_hosts =
5831 # recipient_unqualified_hosts =
5832 .endd
5833 show how you can specify hosts that are permitted to send unqualified sender
5834 and recipient addresses, respectively.
5835
5836 The &%log_selector%& option is used to increase the detail of logging
5837 over the default:
5838 .code
5839 log_selector = +smtp_protocol_error +smtp_syntax_error \
5840                +tls_certificate_verified
5841 .endd
5842
5843 The &%percent_hack_domains%& option is also commented out:
5844 .code
5845 # percent_hack_domains =
5846 .endd
5847 It provides a list of domains for which the &"percent hack"& is to operate.
5848 This is an almost obsolete form of explicit email routing. If you do not know
5849 anything about it, you can safely ignore this topic.
5850
5851 The next two settings in the main part of the default configuration are
5852 concerned with messages that have been &"frozen"& on Exim's queue. When a
5853 message is frozen, Exim no longer continues to try to deliver it. Freezing
5854 occurs when a bounce message encounters a permanent failure because the sender
5855 address of the original message that caused the bounce is invalid, so the
5856 bounce cannot be delivered. This is probably the most common case, but there
5857 are also other conditions that cause freezing, and frozen messages are not
5858 always bounce messages.
5859 .code
5860 ignore_bounce_errors_after = 2d
5861 timeout_frozen_after = 7d
5862 .endd
5863 The first of these options specifies that failing bounce messages are to be
5864 discarded after 2 days in the queue. The second specifies that any frozen
5865 message (whether a bounce message or not) is to be timed out (and discarded)
5866 after a week. In this configuration, the first setting ensures that no failing
5867 bounce message ever lasts a week.
5868
5869 Exim queues it's messages in a spool directory. If you expect to have
5870 large queues, you may consider using this option. It splits the spool
5871 directory into subdirectories to avoid file system degradation from
5872 many files in a single directory, resulting in better performance.
5873 Manual manipulation of queued messages becomes more complex (though fortunately
5874 not often needed).
5875 .code
5876 # split_spool_directory = true
5877 .endd
5878
5879 In an ideal world everybody follows the standards. For non-ASCII
5880 messages RFC 2047 is a standard, allowing a maximum line length of 76
5881 characters. Exim adheres that standard and won't process messages which
5882 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5883 In particular, the Exim maintainers have had multiple reports of
5884 problems from Russian administrators of issues until they disable this
5885 check, because of some popular, yet buggy, mail composition software.
5886 .code
5887 # check_rfc2047_length = false
5888 .endd
5889
5890 If you need to be strictly RFC compliant you may wish to disable the
5891 8BITMIME advertisement. Use this, if you exchange mails with systems
5892 that are not 8-bit clean.
5893 .code
5894 # accept_8bitmime = false
5895 .endd
5896
5897 Libraries you use may depend on specific environment settings.  This
5898 imposes a security risk (e.g. PATH). There are two lists:
5899 &%keep_environment%& for the variables to import as they are, and
5900 &%add_environment%& for variables we want to set to a fixed value.
5901 Note that TZ is handled separately, by the &%timezone%& runtime
5902 option and by the TIMEZONE_DEFAULT buildtime option.
5903 .code
5904 # keep_environment = ^LDAP
5905 # add_environment = PATH=/usr/bin::/bin
5906 .endd
5907
5908
5909 .section "ACL configuration" "SECID54"
5910 .cindex "default" "ACLs"
5911 .cindex "&ACL;" "default configuration"
5912 In the default configuration, the ACL section follows the main configuration.
5913 It starts with the line
5914 .code
5915 begin acl
5916 .endd
5917 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5918 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5919 and &%acl_smtp_data%& above.
5920
5921 .cindex "RCPT" "ACL for"
5922 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5923 RCPT command specifies one of the message's recipients. The ACL statements
5924 are considered in order, until the recipient address is either accepted or
5925 rejected. The RCPT command is then accepted or rejected, according to the
5926 result of the ACL processing.
5927 .code
5928 acl_check_rcpt:
5929 .endd
5930 This line, consisting of a name terminated by a colon, marks the start of the
5931 ACL, and names it.
5932 .code
5933 accept  hosts = :
5934 .endd
5935 This ACL statement accepts the recipient if the sending host matches the list.
5936 But what does that strange list mean? It doesn't actually contain any host
5937 names or IP addresses. The presence of the colon puts an empty item in the
5938 list; Exim matches this only if the incoming message did not come from a remote
5939 host, because in that case, the remote hostname is empty. The colon is
5940 important. Without it, the list itself is empty, and can never match anything.
5941
5942 What this statement is doing is to accept unconditionally all recipients in
5943 messages that are submitted by SMTP from local processes using the standard
5944 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5945 manner.
5946 .code
5947 deny    domains       = +local_domains
5948         local_parts   = ^[.] : ^.*[@%!/|]
5949         message       = Restricted characters in address
5950
5951 deny    domains       = !+local_domains
5952         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5953         message       = Restricted characters in address
5954 .endd
5955 These statements are concerned with local parts that contain any of the
5956 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5957 Although these characters are entirely legal in local parts (in the case of
5958 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5959 in Internet mail addresses.
5960
5961 The first three have in the past been associated with explicitly routed
5962 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5963 option). Addresses containing these characters are regularly tried by spammers
5964 in an attempt to bypass relaying restrictions, and also by open relay testing
5965 programs. Unless you really need them it is safest to reject these characters
5966 at this early stage. This configuration is heavy-handed in rejecting these
5967 characters for all messages it accepts from remote hosts. This is a deliberate
5968 policy of being as safe as possible.
5969
5970 The first rule above is stricter, and is applied to messages that are addressed
5971 to one of the local domains handled by this host. This is implemented by the
5972 first condition, which restricts it to domains that are listed in the
5973 &'local_domains'& domain list. The &"+"& character is used to indicate a
5974 reference to a named list. In this configuration, there is just one domain in
5975 &'local_domains'&, but in general there may be many.
5976
5977 The second condition on the first statement uses two regular expressions to
5978 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5979 or &"|"&. If you have local accounts that include these characters, you will
5980 have to modify this rule.
5981
5982 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5983 allows them because they have been encountered in practice. (Consider the
5984 common convention of local parts constructed as
5985 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5986 the author of Exim, who has no second initial.) However, a local part starting
5987 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5988 filename (for example, for a mailing list). This is also true for local parts
5989 that contain slashes. A pipe symbol can also be troublesome if the local part
5990 is incorporated unthinkingly into a shell command line.
5991
5992 The second rule above applies to all other domains, and is less strict. This
5993 allows your own users to send outgoing messages to sites that use slashes
5994 and vertical bars in their local parts. It blocks local parts that begin
5995 with a dot, slash, or vertical bar, but allows these characters within the
5996 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5997 and &"!"& is blocked, as before. The motivation here is to prevent your users
5998 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5999 .code
6000 accept  local_parts   = postmaster
6001         domains       = +local_domains
6002 .endd
6003 This statement, which has two conditions, accepts an incoming address if the
6004 local part is &'postmaster'& and the domain is one of those listed in the
6005 &'local_domains'& domain list. The &"+"& character is used to indicate a
6006 reference to a named list. In this configuration, there is just one domain in
6007 &'local_domains'&, but in general there may be many.
6008
6009 The presence of this statement means that mail to postmaster is never blocked
6010 by any of the subsequent tests. This can be helpful while sorting out problems
6011 in cases where the subsequent tests are incorrectly denying access.
6012 .code
6013 require verify        = sender
6014 .endd
6015 This statement requires the sender address to be verified before any subsequent
6016 ACL statement can be used. If verification fails, the incoming recipient
6017 address is refused. Verification consists of trying to route the address, to
6018 see if a bounce message could be delivered to it. In the case of remote
6019 addresses, basic verification checks only the domain, but &'callouts'& can be
6020 used for more verification if required. Section &<<SECTaddressverification>>&
6021 discusses the details of address verification.
6022 .code
6023 accept  hosts         = +relay_from_hosts
6024         control       = submission
6025 .endd
6026 This statement accepts the address if the message is coming from one of the
6027 hosts that are defined as being allowed to relay through this host. Recipient
6028 verification is omitted here, because in many cases the clients are dumb MUAs
6029 that do not cope well with SMTP error responses. For the same reason, the
6030 second line specifies &"submission mode"& for messages that are accepted. This
6031 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6032 messages that are deficient in some way, for example, because they lack a
6033 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6034 probably add recipient verification here, and disable submission mode.
6035 .code
6036 accept  authenticated = *
6037         control       = submission
6038 .endd
6039 This statement accepts the address if the client host has authenticated itself.
6040 Submission mode is again specified, on the grounds that such messages are most
6041 likely to come from MUAs. The default configuration does not define any
6042 authenticators, though it does include some nearly complete commented-out
6043 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6044 fact authenticate until you complete the authenticator definitions.
6045 .code
6046 require message = relay not permitted
6047         domains = +local_domains : +relay_to_domains
6048 .endd
6049 This statement rejects the address if its domain is neither a local domain nor
6050 one of the domains for which this host is a relay.
6051 .code
6052 require verify = recipient
6053 .endd
6054 This statement requires the recipient address to be verified; if verification
6055 fails, the address is rejected.
6056 .code
6057 # deny    dnslists    = black.list.example
6058 #         message     = rejected because $sender_host_address \
6059 #                       is in a black list at $dnslist_domain\n\
6060 #                       $dnslist_text
6061 #
6062 # warn    dnslists    = black.list.example
6063 #         add_header  = X-Warning: $sender_host_address is in \
6064 #                       a black list at $dnslist_domain
6065 #         log_message = found in $dnslist_domain
6066 .endd
6067 These commented-out lines are examples of how you could configure Exim to check
6068 sending hosts against a DNS black list. The first statement rejects messages
6069 from blacklisted hosts, whereas the second just inserts a warning header
6070 line.
6071 .code
6072 # require verify = csa
6073 .endd
6074 This commented-out line is an example of how you could turn on client SMTP
6075 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6076 records.
6077 .code
6078 accept
6079 .endd
6080 The final statement in the first ACL unconditionally accepts any recipient
6081 address that has successfully passed all the previous tests.
6082 .code
6083 acl_check_data:
6084 .endd
6085 This line marks the start of the second ACL, and names it. Most of the contents
6086 of this ACL are commented out:
6087 .code
6088 # deny    malware   = *
6089 #         message   = This message contains a virus \
6090 #                     ($malware_name).
6091 .endd
6092 These lines are examples of how to arrange for messages to be scanned for
6093 viruses when Exim has been compiled with the content-scanning extension, and a
6094 suitable virus scanner is installed. If the message is found to contain a
6095 virus, it is rejected with the given custom error message.
6096 .code
6097 # warn    spam      = nobody
6098 #         message   = X-Spam_score: $spam_score\n\
6099 #                     X-Spam_score_int: $spam_score_int\n\
6100 #                     X-Spam_bar: $spam_bar\n\
6101 #                     X-Spam_report: $spam_report
6102 .endd
6103 These lines are an example of how to arrange for messages to be scanned by
6104 SpamAssassin when Exim has been compiled with the content-scanning extension,
6105 and SpamAssassin has been installed. The SpamAssassin check is run with
6106 &`nobody`& as its user parameter, and the results are added to the message as a
6107 series of extra header line. In this case, the message is not rejected,
6108 whatever the spam score.
6109 .code
6110 accept
6111 .endd
6112 This final line in the DATA ACL accepts the message unconditionally.
6113
6114
6115 .section "Router configuration" "SECID55"
6116 .cindex "default" "routers"
6117 .cindex "routers" "default"
6118 The router configuration comes next in the default configuration, introduced
6119 by the line
6120 .code
6121 begin routers
6122 .endd
6123 Routers are the modules in Exim that make decisions about where to send
6124 messages. An address is passed to each router, in turn, until it is either
6125 accepted, or failed. This means that the order in which you define the routers
6126 matters. Each router is fully described in its own chapter later in this
6127 manual. Here we give only brief overviews.
6128 .code
6129 # domain_literal:
6130 #   driver = ipliteral
6131 #   domains = !+local_domains
6132 #   transport = remote_smtp
6133 .endd
6134 .cindex "domain literal" "default router"
6135 This router is commented out because the majority of sites do not want to
6136 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6137 you uncomment this router, you also need to uncomment the setting of
6138 &%allow_domain_literals%& in the main part of the configuration.
6139
6140 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6141 macro has been defined, per
6142 .code
6143 .ifdef ROUTER_SMARTHOST
6144 smarthost:
6145 #...
6146 .else
6147 dnslookup:
6148 #...
6149 .endif
6150 .endd
6151
6152 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6153 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6154 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6155 skip these routers because of the &%domains%& option.
6156
6157 .code
6158 smarthost:
6159   driver = manualroute
6160   domains = ! +local_domains
6161   transport = smarthost_smtp
6162   route_data = ROUTER_SMARTHOST
6163   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6164   no_more
6165 .endd
6166 This router only handles mail which is not to any local domains; this is
6167 specified by the line
6168 .code
6169 domains = ! +local_domains
6170 .endd
6171 The &%domains%& option lists the domains to which this router applies, but the
6172 exclamation mark is a negation sign, so the router is used only for domains
6173 that are not in the domain list called &'local_domains'& (which was defined at
6174 the start of the configuration). The plus sign before &'local_domains'&
6175 indicates that it is referring to a named list. Addresses in other domains are
6176 passed on to the following routers.
6177
6178 The name of the router driver is &(manualroute)& because we are manually
6179 specifying how mail should be routed onwards, instead of using DNS MX.
6180 While the name of this router instance is arbitrary, the &%driver%& option must
6181 be one of the driver modules that is in the Exim binary.
6182
6183 With no pre-conditions other than &%domains%&, all mail for non-local domains
6184 will be handled by this router, and the &%no_more%& setting will ensure that no
6185 other routers will be used for messages matching the pre-conditions.  See
6186 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6187 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6188 and the macro supplies the value; the address is then queued for the
6189 &(smarthost_smtp)& transport.
6190
6191 .code
6192 dnslookup:
6193   driver = dnslookup
6194   domains = ! +local_domains
6195   transport = remote_smtp
6196   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6197   no_more
6198 .endd
6199 The &%domains%& option behaves as per smarthost, above.
6200
6201 The name of the router driver is &(dnslookup)&,
6202 and is specified by the &%driver%& option. Do not be confused by the fact that
6203 the name of this router instance is the same as the name of the driver. The
6204 instance name is arbitrary, but the name set in the &%driver%& option must be
6205 one of the driver modules that is in the Exim binary.
6206
6207 The &(dnslookup)& router routes addresses by looking up their domains in the
6208 DNS in order to obtain a list of hosts to which the address is routed. If the
6209 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6210 specified by the &%transport%& option. If the router does not find the domain
6211 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6212 the address fails and is bounced.
6213
6214 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6215 be entirely ignored. This option is present because a number of cases have been
6216 encountered where MX records in the DNS point to host names
6217 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6218 Completely ignoring these IP addresses causes Exim to fail to route the
6219 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6220 continue to try to deliver the message periodically until the address timed
6221 out.
6222 .code
6223 system_aliases:
6224   driver = redirect
6225   allow_fail
6226   allow_defer
6227   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6228 # user = exim
6229   file_transport = address_file
6230   pipe_transport = address_pipe
6231 .endd
6232 Control reaches this and subsequent routers only for addresses in the local
6233 domains. This router checks to see whether the local part is defined as an
6234 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6235 data that it looks up from that file. If no data is found for the local part,
6236 the value of the &%data%& option is empty, causing the address to be passed to
6237 the next router.
6238
6239 &_/etc/aliases_& is a conventional name for the system aliases file that is
6240 often used. That is why it is referenced by from the default configuration
6241 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6242 &_Local/Makefile_& before building Exim.
6243 .code
6244 userforward:
6245   driver = redirect
6246   check_local_user
6247 # local_part_suffix = +* : -*
6248 # local_part_suffix_optional
6249   file = $home/.forward
6250 # allow_filter
6251   no_verify
6252   no_expn
6253   check_ancestor
6254   file_transport = address_file
6255   pipe_transport = address_pipe
6256   reply_transport = address_reply
6257 .endd
6258 This is the most complicated router in the default configuration. It is another
6259 redirection router, but this time it is looking for forwarding data set up by
6260 individual users. The &%check_local_user%& setting specifies a check that the
6261 local part of the address is the login name of a local user. If it is not, the
6262 router is skipped. The two commented options that follow &%check_local_user%&,
6263 namely:
6264 .code
6265 # local_part_suffix = +* : -*
6266 # local_part_suffix_optional
6267 .endd
6268 .vindex "&$local_part_suffix$&"
6269 show how you can specify the recognition of local part suffixes. If the first
6270 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6271 by any sequence of characters, is removed from the local part and placed in the
6272 variable &$local_part_suffix$&. The second suffix option specifies that the
6273 presence of a suffix in the local part is optional. When a suffix is present,
6274 the check for a local login uses the local part with the suffix removed.
6275
6276 When a local user account is found, the file called &_.forward_& in the user's
6277 home directory is consulted. If it does not exist, or is empty, the router
6278 declines. Otherwise, the contents of &_.forward_& are interpreted as
6279 redirection data (see chapter &<<CHAPredirect>>& for more details).
6280
6281 .cindex "Sieve filter" "enabling in default router"
6282 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6283 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6284 is commented out by default), the contents of the file are interpreted as a set
6285 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6286 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6287 separate document entitled &'Exim's interfaces to mail filtering'&.
6288
6289 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6290 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6291 There are two reasons for doing this:
6292
6293 .olist
6294 Whether or not a local user has a &_.forward_& file is not really relevant when
6295 checking an address for validity; it makes sense not to waste resources doing
6296 unnecessary work.
6297 .next
6298 More importantly, when Exim is verifying addresses or handling an EXPN
6299 command during an SMTP session, it is running as the Exim user, not as root.
6300 The group is the Exim group, and no additional groups are set up.
6301 It may therefore not be possible for Exim to read users' &_.forward_& files at
6302 this time.
6303 .endlist
6304
6305 The setting of &%check_ancestor%& prevents the router from generating a new
6306 address that is the same as any previous address that was redirected. (This
6307 works round a problem concerning a bad interaction between aliasing and
6308 forwarding &-- see section &<<SECTredlocmai>>&).
6309
6310 The final three option settings specify the transports that are to be used when
6311 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6312 auto-reply, respectively. For example, if a &_.forward_& file contains
6313 .code
6314 a.nother@elsewhere.example, /home/spqr/archive
6315 .endd
6316 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6317 transport.
6318 .code
6319 localuser:
6320   driver = accept
6321   check_local_user
6322 # local_part_suffix = +* : -*
6323 # local_part_suffix_optional
6324   transport = local_delivery
6325 .endd
6326 The final router sets up delivery into local mailboxes, provided that the local
6327 part is the name of a local login, by accepting the address and assigning it to
6328 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6329 routers, so the address is bounced. The commented suffix settings fulfil the
6330 same purpose as they do for the &(userforward)& router.
6331
6332
6333 .section "Transport configuration" "SECID56"
6334 .cindex "default" "transports"
6335 .cindex "transports" "default"
6336 Transports define mechanisms for actually delivering messages. They operate
6337 only when referenced from routers, so the order in which they are defined does
6338 not matter. The transports section of the configuration starts with
6339 .code
6340 begin transports
6341 .endd
6342 Two remote transports and four local transports are defined.
6343 .code
6344 remote_smtp:
6345   driver = smtp
6346   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6347 .ifdef _HAVE_PRDR
6348   hosts_try_prdr = *
6349 .endif
6350 .endd
6351 This transport is used for delivering messages over SMTP connections.
6352 The list of remote hosts comes from the router.
6353 The &%message_size_limit%& usage is a hack to avoid sending on messages
6354 with over-long lines.
6355
6356 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6357 negotiated between client and server and not expected to cause problems
6358 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6359 use of the &%hosts_try_prdr%& configuration option.
6360
6361 The other remote transport is used when delivering to a specific smarthost
6362 with whom there must be some kind of existing relationship, instead of the
6363 usual federated system.
6364
6365 .code
6366 smarthost_smtp:
6367   driver = smtp
6368   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6369   multi_domain
6370   #
6371 .ifdef _HAVE_TLS
6372   # Comment out any of these which you have to, then file a Support
6373   # request with your smarthost provider to get things fixed:
6374   hosts_require_tls = *
6375   tls_verify_hosts = *
6376   # As long as tls_verify_hosts is enabled, this this will have no effect,
6377   # but if you have to comment it out then this will at least log whether
6378   # you succeed or not:
6379   tls_try_verify_hosts = *
6380   #
6381   # The SNI name should match the name which we'll expect to verify;
6382   # many mail systems don't use SNI and this doesn't matter, but if it does,
6383   # we need to send a name which the remote site will recognize.
6384   # This _should_ be the name which the smarthost operators specified as
6385   # the hostname for sending your mail to.
6386   tls_sni = ROUTER_SMARTHOST
6387   #
6388 .ifdef _HAVE_OPENSSL
6389   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6390 .endif
6391 .ifdef _HAVE_GNUTLS
6392   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6393 .endif
6394 .endif
6395 .ifdef _HAVE_PRDR
6396   hosts_try_prdr = *
6397 .endif
6398 .endd
6399 After the same &%message_size_limit%& hack, we then specify that this Transport
6400 can handle messages to multiple domains in one run.  The assumption here is
6401 that you're routing all non-local mail to the same place and that place is
6402 happy to take all messages from you as quickly as possible.
6403 All other options depend upon built-in macros; if Exim was built without TLS support
6404 then no other options are defined.
6405 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6406 and versions using the &%tls_require_ciphers%& option, where the value to be
6407 used depends upon the library providing TLS.
6408 Beyond that, the options adopt the stance that you should have TLS support available
6409 from your smarthost on today's Internet, so we turn on requiring TLS for the
6410 mail to be delivered, and requiring that the certificate be valid, and match
6411 the expected hostname.  The &%tls_sni%& option can be used by service providers
6412 to select an appropriate certificate to present to you and here we re-use the
6413 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6414 You want to specify the hostname which you'll expect to validate for, and that
6415 should not be subject to insecure tampering via DNS results.
6416
6417 For the &%hosts_try_prdr%& option see the previous transport.
6418
6419 All other options are defaulted.
6420 .code
6421 local_delivery:
6422   driver = appendfile
6423   file = /var/mail/$local_part_data
6424   delivery_date_add
6425   envelope_to_add
6426   return_path_add
6427 # group = mail
6428 # mode = 0660
6429 .endd
6430 This &(appendfile)& transport is used for local delivery to user mailboxes in
6431 traditional BSD mailbox format.
6432
6433 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6434 as it is provided by a potential bad actor.
6435 Instead we use &$local_part_data$&,
6436 the result of looking up &$local_part$& in the user database
6437 (done by using &%check_local_user%& in the the router).
6438
6439 By default &(appendfile)& runs under the uid and gid of the
6440 local user, which requires the sticky bit to be set on the &_/var/mail_&
6441 directory. Some systems use the alternative approach of running mail deliveries
6442 under a particular group instead of using the sticky bit. The commented options
6443 show how this can be done.
6444
6445 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6446 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6447 similarly-named options above.
6448 .code
6449 address_pipe:
6450   driver = pipe
6451   return_output
6452 .endd
6453 This transport is used for handling deliveries to pipes that are generated by
6454 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6455 option specifies that any output on stdout or stderr generated by the pipe is to
6456 be returned to the sender.
6457 .code
6458 address_file:
6459   driver = appendfile
6460   delivery_date_add
6461   envelope_to_add
6462   return_path_add
6463 .endd
6464 This transport is used for handling deliveries to files that are generated by
6465 redirection. The name of the file is not specified in this instance of
6466 &(appendfile)&, because it comes from the &(redirect)& router.
6467 .code
6468 address_reply:
6469   driver = autoreply
6470 .endd
6471 This transport is used for handling automatic replies generated by users'
6472 filter files.
6473
6474
6475
6476 .section "Default retry rule" "SECID57"
6477 .cindex "retry" "default rule"
6478 .cindex "default" "retry rule"
6479 The retry section of the configuration file contains rules which affect the way
6480 Exim retries deliveries that cannot be completed at the first attempt. It is
6481 introduced by the line
6482 .code
6483 begin retry
6484 .endd
6485 In the default configuration, there is just one rule, which applies to all
6486 errors:
6487 .code
6488 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6489 .endd
6490 This causes any temporarily failing address to be retried every 15 minutes for
6491 2 hours, then at intervals starting at one hour and increasing by a factor of
6492 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6493 is not delivered after 4 days of temporary failure, it is bounced. The time is
6494 measured from first failure, not from the time the message was received.
6495
6496 If the retry section is removed from the configuration, or is empty (that is,
6497 if no retry rules are defined), Exim will not retry deliveries. This turns
6498 temporary errors into permanent errors.
6499
6500
6501 .section "Rewriting configuration" "SECID58"
6502 The rewriting section of the configuration, introduced by
6503 .code
6504 begin rewrite
6505 .endd
6506 contains rules for rewriting addresses in messages as they arrive. There are no
6507 rewriting rules in the default configuration file.
6508
6509
6510
6511 .section "Authenticators configuration" "SECTdefconfauth"
6512 .cindex "AUTH" "configuration"
6513 The authenticators section of the configuration, introduced by
6514 .code
6515 begin authenticators
6516 .endd
6517 defines mechanisms for the use of the SMTP AUTH command. The default
6518 configuration file contains two commented-out example authenticators
6519 which support plaintext username/password authentication using the
6520 standard PLAIN mechanism and the traditional but non-standard LOGIN
6521 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6522 to support most MUA software.
6523
6524 The example PLAIN authenticator looks like this:
6525 .code
6526 #PLAIN:
6527 #  driver                  = plaintext
6528 #  server_set_id           = $auth2
6529 #  server_prompts          = :
6530 #  server_condition        = Authentication is not yet configured
6531 #  server_advertise_condition = ${if def:tls_in_cipher }
6532 .endd
6533 And the example LOGIN authenticator looks like this:
6534 .code
6535 #LOGIN:
6536 #  driver                  = plaintext
6537 #  server_set_id           = $auth1
6538 #  server_prompts          = <| Username: | Password:
6539 #  server_condition        = Authentication is not yet configured
6540 #  server_advertise_condition = ${if def:tls_in_cipher }
6541 .endd
6542
6543 The &%server_set_id%& option makes Exim remember the authenticated username
6544 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6545 &%server_prompts%& option configures the &(plaintext)& authenticator so
6546 that it implements the details of the specific authentication mechanism,
6547 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6548 when Exim offers authentication to clients; in the examples, this is only
6549 when TLS or SSL has been started, so to enable the authenticators you also
6550 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6551
6552 The &%server_condition%& setting defines how to verify that the username and
6553 password are correct. In the examples it just produces an error message.
6554 To make the authenticators work, you can use a string expansion
6555 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6556
6557 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6558 usercode and password are in different positions.
6559 Chapter &<<CHAPplaintext>>& covers both.
6560
6561 .ecindex IIDconfiwal
6562
6563
6564
6565 . ////////////////////////////////////////////////////////////////////////////
6566 . ////////////////////////////////////////////////////////////////////////////
6567
6568 .chapter "Regular expressions" "CHAPregexp"
6569
6570 .cindex "regular expressions" "library"
6571 .cindex "PCRE2"
6572 Exim supports the use of regular expressions in many of its options. It
6573 uses the PCRE2 regular expression library; this provides regular expression
6574 matching that is compatible with Perl 5. The syntax and semantics of
6575 regular expressions is discussed in
6576 online Perl manpages, in
6577 many Perl reference books, and also in
6578 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6579 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6580 . --- the http: URL here redirects to another page with the ISBN in the URL
6581 . --- where trying to use https: just redirects back to http:, so sticking
6582 . --- to the old URL for now.  2018-09-07.
6583
6584 The documentation for the syntax and semantics of the regular expressions that
6585 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6586 description is included here. The PCRE2 functions are called from Exim using
6587 the default option settings (that is, with no PCRE2 options set), except that
6588 the PCRE2_CASELESS option is set when the matching is required to be
6589 case-insensitive.
6590
6591 In most cases, when a regular expression is required in an Exim configuration,
6592 it has to start with a circumflex, in order to distinguish it from plain text
6593 or an &"ends with"& wildcard. In this example of a configuration setting, the
6594 second item in the colon-separated list is a regular expression.
6595 .code
6596 domains = a.b.c : ^\\d{3} : *.y.z : ...
6597 .endd
6598 The doubling of the backslash is required because of string expansion that
6599 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6600 of this issue, and a way of avoiding the need for doubling backslashes. The
6601 regular expression that is eventually used in this example contains just one
6602 backslash. The circumflex is included in the regular expression, and has the
6603 normal effect of &"anchoring"& it to the start of the string that is being
6604 matched.
6605
6606 There are, however, two cases where a circumflex is not required for the
6607 recognition of a regular expression: these are the &%match%& condition in a
6608 string expansion, and the &%matches%& condition in an Exim filter file. In
6609 these cases, the relevant string is always treated as a regular expression; if
6610 it does not start with a circumflex, the expression is not anchored, and can
6611 match anywhere in the subject string.
6612
6613 In all cases, if you want a regular expression to match at the end of a string,
6614 you must code the $ metacharacter to indicate this. For example:
6615 .code
6616 domains = ^\\d{3}\\.example
6617 .endd
6618 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6619 You need to use:
6620 .code
6621 domains = ^\\d{3}\\.example\$
6622 .endd
6623 if you want &'example'& to be the top-level domain. The backslash before the
6624 $ is needed because string expansion also interprets dollar characters.
6625
6626
6627
6628 . ////////////////////////////////////////////////////////////////////////////
6629 . ////////////////////////////////////////////////////////////////////////////
6630
6631 .chapter "File and database lookups" "CHAPfdlookup"
6632 .scindex IIDfidalo1 "file" "lookups"
6633 .scindex IIDfidalo2 "database" "lookups"
6634 .cindex "lookup" "description of"
6635 Exim can be configured to look up data in files or databases as it processes
6636 messages. Two different kinds of syntax are used:
6637
6638 .olist
6639 A string that is to be expanded may contain explicit lookup requests. These
6640 cause parts of the string to be replaced by data that is obtained from the
6641 lookup. Lookups of this type are conditional expansion items. Different results
6642 can be defined for the cases of lookup success and failure. See chapter
6643 &<<CHAPexpand>>&, where string expansions are described in detail.
6644 The key for the lookup is &*specified*& as part of the string to be expanded.
6645 .next
6646 Lists of domains, hosts, and email addresses can contain lookup requests as a
6647 way of avoiding excessively long linear lists. In this case, the data that is
6648 returned by the lookup is often (but not always) discarded; whether the lookup
6649 succeeds or fails is what really counts. These kinds of list are described in
6650 chapter &<<CHAPdomhosaddlists>>&.
6651 Depending on the lookup type (see below)
6652 the key for the lookup may need to be &*specified*& as above
6653 or may be &*implicit*&,
6654 given by the context in which the list is being checked.
6655 .endlist
6656
6657 String expansions, lists, and lookups interact with each other in such a way
6658 that there is no order in which to describe any one of them that does not
6659 involve references to the others. Each of these three chapters makes more sense
6660 if you have read the other two first. If you are reading this for the first
6661 time, be aware that some of it will make a lot more sense after you have read
6662 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6663
6664 .section "Examples of different lookup syntax" "SECID60"
6665 It is easy to confuse the two different kinds of lookup, especially as the
6666 lists that may contain the second kind are always expanded before being
6667 processed as lists. Therefore, they may also contain lookups of the first kind.
6668 Be careful to distinguish between the following two examples:
6669 .code
6670 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6671 domains = lsearch;/some/file
6672 .endd
6673 .ilist
6674 The first uses a string expansion, the result of which must be a domain list.
6675 The key for an expansion-style lookup must be given explicitly.
6676 No strings have been specified for a successful or a failing lookup; the
6677 defaults in this case are the looked-up data and an empty string, respectively.
6678 The expansion takes place before the string is processed as a list, and the
6679 file that is searched could contain lines like this:
6680 .code
6681 192.168.3.4: domain1:domain2:...
6682 192.168.1.9: domain3:domain4:...
6683 .endd
6684 When the lookup succeeds, the result of the expansion is a list of domains (and
6685 possibly other types of item that are allowed in domain lists).
6686 .cindex "tainted data" "de-tainting"
6687 .cindex "de-tainting" "using a lookup expansion"
6688 The result of the expansion is not tainted.
6689
6690 .next
6691 In the second example, the lookup is a single item in a domain list. It causes
6692 Exim to use a lookup to see if the domain that is being processed can be found
6693 in the file.
6694 The file could contains lines like this:
6695 .code
6696 domain1:
6697 domain2:
6698 .endd
6699 Any data that follows the keys is not relevant when checking that the domain
6700 matches the list item.
6701
6702 The key for a list-style lookup is implicit, from the lookup context, if
6703 the lookup is a single-key type (see below).
6704 For query-style lookup types the query must be given explicitly.
6705 .endlist
6706
6707 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6708 Consider a file containing lines like this:
6709 .code
6710 192.168.5.6: lsearch;/another/file
6711 .endd
6712 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6713 first &%domains%& setting above generates the second setting, which therefore
6714 causes a second lookup to occur.
6715
6716 The lookup type may optionally be followed by a comma
6717 and a comma-separated list of options.
6718 Each option is a &"name=value"& pair.
6719 Whether an option is meaningful depends on the lookup type.
6720
6721 All lookups support the option &"cache=no_rd"&.
6722 If this is given then the cache that Exim manages for lookup results
6723 is not checked before doing the lookup.
6724 The result of the lookup is still written to the cache.
6725
6726 The rest of this chapter describes the different lookup types that are
6727 available. Any of them can be used in any part of the configuration where a
6728 lookup is permitted.
6729
6730
6731 .section "Lookup types" "SECID61"
6732 .cindex "lookup" "types of"
6733 .cindex "single-key lookup" "definition of"
6734 Two different types of data lookup are implemented:
6735
6736 .ilist
6737 The &'single-key'& type requires the specification of a file in which to look,
6738 and a single key to search for. The key must be a non-empty string for the
6739 lookup to succeed. The lookup type determines how the file is searched.
6740 .cindex "tainted data" "single-key lookups"
6741 The file string may not be tainted.
6742
6743 .cindex "tainted data" "de-tainting"
6744 .cindex "de-tainting" "using a single-key lookup"
6745 All single-key lookups support the option &"ret=key"&.
6746 If this is given and the lookup
6747 (either underlying implementation or cached value)
6748 returns data, the result is replaced with a non-tainted
6749 version of the lookup key.
6750
6751 .next
6752 .cindex "query-style lookup" "definition of"
6753 The &'query-style'& type accepts a generalized database query. No particular
6754 key value is assumed by Exim for query-style lookups. You can use whichever
6755 Exim variables you need to construct the database query.
6756
6757 For the string-expansion kind of lookups, the query is given in the first
6758 bracketed argument of the &${lookup ...}$& expansion.
6759 For the list-argument kind of lookup the quury is given by the remainder of the
6760 list item after the first semicolon.
6761
6762 .cindex "tainted data" "quoting for lookups"
6763 If tainted data is used in the query then it should be quuted by
6764 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6765 appropriate for the lookup.
6766 .endlist
6767
6768 The code for each lookup type is in a separate source file that is included in
6769 the binary of Exim only if the corresponding compile-time option is set. The
6770 default settings in &_src/EDITME_& are:
6771 .code
6772 LOOKUP_DBM=yes
6773 LOOKUP_LSEARCH=yes
6774 .endd
6775 which means that only linear searching and DBM lookups are included by default.
6776 For some types of lookup (e.g. SQL databases), you need to install appropriate
6777 libraries and header files before building Exim.
6778
6779
6780
6781
6782 .section "Single-key lookup types" "SECTsinglekeylookups"
6783 .cindex "lookup" "single-key types"
6784 .cindex "single-key lookup" "list of types"
6785 The following single-key lookup types are implemented:
6786
6787 .subsection cdb
6788 .cindex "cdb" "description of"
6789 .cindex "lookup" "cdb"
6790 .cindex "binary zero" "in lookup key"
6791 The given file is searched as a Constant DataBase file, using the key
6792 string without a terminating binary zero. The cdb format is designed for
6793 indexed files that are read frequently and never updated, except by total
6794 re-creation. As such, it is particularly suitable for large files containing
6795 aliases or other indexed data referenced by an MTA. Information about cdb and
6796 tools for building the files can be found in several places:
6797 .display
6798 &url(https://cr.yp.to/cdb.html)
6799 &url(https://www.corpit.ru/mjt/tinycdb.html)
6800 &url(https://packages.debian.org/stable/utils/freecdb)
6801 &url(https://github.com/philpennock/cdbtools) (in Go)
6802 .endd
6803 A cdb distribution is not needed in order to build Exim with cdb support,
6804 because the code for reading cdb files is included directly in Exim itself.
6805 However, no means of building or testing cdb files is provided with Exim, so
6806 you need to obtain a cdb distribution in order to do this.
6807
6808 .subsection dbm
6809 .cindex "DBM" "lookup type"
6810 .cindex "lookup" "dbm"
6811 .cindex "binary zero" "in lookup key"
6812 Calls to DBM library functions are used to extract data from the given
6813 DBM file by looking up the record with the given key. A terminating binary
6814 zero is included in the key that is passed to the DBM library. See section
6815 &<<SECTdb>>& for a discussion of DBM libraries.
6816
6817 .cindex "Berkeley DB library" "file format"
6818 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6819 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6820 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6821 the DB_UNKNOWN option. This enables it to handle any of the types of database
6822 that the library supports, and can be useful for accessing DBM files created by
6823 other applications. (For earlier DB versions, DB_HASH is always used.)
6824
6825 .subsection dbmjz
6826 .cindex "lookup" "dbmjz"
6827 .cindex "lookup" "dbm &-- embedded NULs"
6828 .cindex "sasldb2"
6829 .cindex "dbmjz lookup type"
6830 This is the same as &(dbm)&, except that the lookup key is
6831 interpreted as an Exim list; the elements of the list are joined together with
6832 ASCII NUL characters to form the lookup key.  An example usage would be to
6833 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6834 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6835 &(cram_md5)& authenticator.
6836
6837 .subsection dbmnz
6838 .cindex "lookup" "dbmnz"
6839 .cindex "lookup" "dbm &-- terminating zero"
6840 .cindex "binary zero" "in lookup key"
6841 .cindex "Courier"
6842 .cindex "&_/etc/userdbshadow.dat_&"
6843 .cindex "dbmnz lookup type"
6844 This is the same as &(dbm)&, except that a terminating binary zero
6845 is not included in the key that is passed to the DBM library. You may need this
6846 if you want to look up data in files that are created by or shared with some
6847 other application that does not use terminating zeros. For example, you need to
6848 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6849 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6850 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6851 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6852
6853 .subsection dsearch
6854 .cindex "lookup" "dsearch"
6855 .cindex "dsearch lookup type"
6856 The given file must be an absolute directory path; this is searched for an entry
6857 whose name is the key by calling the &[lstat()]& function.
6858 The key may not contain any forward slash characters.
6859 If &[lstat()]& succeeds then so does the lookup.
6860 .cindex "tainted data" "dsearch result"
6861 The result is regarded as untainted.
6862
6863 Options for the lookup can be given by appending them after the word "dsearch",
6864 separated by a comma.  Options, if present, are a comma-separated list having
6865 each element starting with a tag name and an equals.
6866
6867 Two options are supported, for the return value and for filtering match
6868 candidates.
6869 The "ret" option requests an alternate result value of
6870 the entire path for the entry. Example:
6871 .code
6872 ${lookup {passwd} dsearch,ret=full {/etc}}
6873 .endd
6874 The default result is just the requested entry.
6875 The "filter" option requests that only directory entries of a given type
6876 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6877 not matching "." or ".."). Example:
6878 .code
6879 ${lookup {passwd} dsearch,filter=file {/etc}}
6880 .endd
6881 The default matching is for any entry type, including directories
6882 and symlinks.
6883
6884 An example of how this
6885 lookup can be used to support virtual domains is given in section
6886 &<<SECTvirtualdomains>>&.
6887
6888 .subsection iplsearch
6889 .cindex "lookup" "iplsearch"
6890 .cindex "iplsearch lookup type"
6891 The given file is a text file containing keys and data. A key is
6892 terminated by a colon or white space or the end of the line. The keys in the
6893 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6894 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6895 being interpreted as a key terminator. For example:
6896 .code
6897 1.2.3.4:           data for 1.2.3.4
6898 192.168.0.0/16:    data for 192.168.0.0/16
6899 "abcd::cdab":      data for abcd::cdab
6900 "abcd:abcd::/32"   data for abcd:abcd::/32
6901 .endd
6902 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6903 file is searched linearly, using the CIDR masks where present, until a matching
6904 key is found. The first key that matches is used; there is no attempt to find a
6905 &"best"& match. Apart from the way the keys are matched, the processing for
6906 &(iplsearch)& is the same as for &(lsearch)&.
6907
6908 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6909 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6910 lookup types support only literal keys.
6911
6912 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6913 the implicit key is the host's IP address rather than its name (see section
6914 &<<SECThoslispatsikey>>&).
6915
6916 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6917 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6918 notation before executing the lookup.)
6919
6920 One option is supported, "ret=full", to request the return of the entire line
6921 rather than omitting the key portion.
6922 Note however that the key portion will have been de-quoted.
6923
6924 .subsection json
6925 .cindex lookup json
6926 .cindex json "lookup type"
6927 .cindex JSON expansions
6928 The given file is a text file with a JSON structure.
6929 An element of the structure is extracted, defined by the search key.
6930 The key is a list of subelement selectors
6931 (colon-separated by default but changeable in the usual way)
6932 which are applied in turn to select smaller and smaller portions
6933 of the JSON structure.
6934 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6935 nunbered array element is selected.
6936 Otherwise it must apply to a JSON object; the named element is selected.
6937 The final resulting element can be a simple JSON type or a JSON object
6938 or array; for the latter two a string-representation of the JSON
6939 is returned.
6940 For elements of type string, the returned value is de-quoted.
6941
6942
6943 .subsection lmdb
6944 .cindex LMDB
6945 .cindex lookup lmdb
6946 .cindex database lmdb
6947 The given file is an LMDB database.
6948 LMDB is a memory-mapped key-value store,
6949 with API modeled loosely on that of BerkeleyDB.
6950 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6951 for the feature set and operation modes.
6952
6953 Exim provides read-only access via the LMDB C library.
6954 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6955 or your operating system package repository.
6956 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6957
6958 You will need to separately create the LMDB database file,
6959 possibly using the &"mdb_load"& utility.
6960
6961
6962 .subsection lsearch
6963 .cindex "linear search"
6964 .cindex "lookup" "lsearch"
6965 .cindex "lsearch lookup type"
6966 .cindex "case sensitivity" "in lsearch lookup"
6967 The given file is a text file that is searched linearly for a
6968 line beginning with the search key, terminated by a colon or white space or the
6969 end of the line. The search is case-insensitive; that is, upper and lower case
6970 letters are treated as the same. The first occurrence of the key that is found
6971 in the file is used.
6972
6973 White space between the key and the colon is permitted. The remainder of the
6974 line, with leading and trailing white space removed, is the data. This can be
6975 continued onto subsequent lines by starting them with any amount of white
6976 space, but only a single space character is included in the data at such a
6977 junction. If the data begins with a colon, the key must be terminated by a
6978 colon, for example:
6979 .code
6980 baduser:  :fail:
6981 .endd
6982 Empty lines and lines beginning with # are ignored, even if they occur in the
6983 middle of an item. This is the traditional textual format of alias files. Note
6984 that the keys in an &(lsearch)& file are literal strings. There is no
6985 wildcarding of any kind.
6986
6987 .cindex "lookup" "lsearch &-- colons in keys"
6988 .cindex "white space" "in lsearch key"
6989 In most &(lsearch)& files, keys are not required to contain colons or #
6990 characters, or white space. However, if you need this feature, it is available.
6991 If a key begins with a doublequote character, it is terminated only by a
6992 matching quote (or end of line), and the normal escaping rules apply to its
6993 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6994 quoted keys (exactly as for unquoted keys). There is no special handling of
6995 quotes for the data part of an &(lsearch)& line.
6996
6997 .subsection nis
6998 .cindex "NIS lookup type"
6999 .cindex "lookup" "NIS"
7000 .cindex "binary zero" "in lookup key"
7001 The given file is the name of a NIS map, and a NIS lookup is done with
7002 the given key, without a terminating binary zero. There is a variant called
7003 &(nis0)& which does include the terminating binary zero in the key. This is
7004 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7005 aliases; the full map names must be used.
7006
7007 .subsection (n)wildlsearch
7008 .cindex "wildlsearch lookup type"
7009 .cindex "lookup" "wildlsearch"
7010 .cindex "nwildlsearch lookup type"
7011 .cindex "lookup" "nwildlsearch"
7012 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7013 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7014 the file may be wildcarded. The difference between these two lookup types is
7015 that for &(wildlsearch)&, each key in the file is string-expanded before being
7016 used, whereas for &(nwildlsearch)&, no expansion takes place.
7017
7018 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7019 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7020 file that are regular expressions can be made case-sensitive by the use of
7021 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7022
7023 .olist
7024 The string may begin with an asterisk to mean &"ends with"&. For example:
7025 .code
7026 *.a.b.c       data for anything.a.b.c
7027 *fish         data for anythingfish
7028 .endd
7029 .next
7030 The string may begin with a circumflex to indicate a regular expression. For
7031 example, for &(wildlsearch)&:
7032 .code
7033 ^\N\d+\.a\.b\N    data for <digits>.a.b
7034 .endd
7035 Note the use of &`\N`& to disable expansion of the contents of the regular
7036 expression. If you are using &(nwildlsearch)&, where the keys are not
7037 string-expanded, the equivalent entry is:
7038 .code
7039 ^\d+\.a\.b        data for <digits>.a.b
7040 .endd
7041 The case-insensitive flag is set at the start of compiling the regular
7042 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7043 For example, to make the entire pattern case-sensitive:
7044 .code
7045 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7046 .endd
7047
7048 If the regular expression contains white space or colon characters, you must
7049 either quote it (see &(lsearch)& above), or represent these characters in other
7050 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7051 colon. This may be easier than quoting, because if you quote, you have to
7052 escape all the backslashes inside the quotes.
7053
7054 &*Note*&: It is not possible to capture substrings in a regular expression
7055 match for later use, because the results of all lookups are cached. If a lookup
7056 is repeated, the result is taken from the cache, and no actual pattern matching
7057 takes place. The values of all the numeric variables are unset after a
7058 &((n)wildlsearch)& match.
7059
7060 .next
7061 Although I cannot see it being of much use, the general matching function that
7062 is used to implement &((n)wildlsearch)& means that the string may begin with a
7063 lookup name terminated by a semicolon, and followed by lookup data. For
7064 example:
7065 .code
7066 cdb;/some/file  data for keys that match the file
7067 .endd
7068 The data that is obtained from the nested lookup is discarded.
7069 .endlist olist
7070
7071 Keys that do not match any of these patterns are interpreted literally. The
7072 continuation rules for the data are the same as for &(lsearch)&, and keys may
7073 be followed by optional colons.
7074
7075 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7076 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7077 lookup types support only literal keys.
7078
7079 .subsection spf
7080 .cindex "spf lookup type"
7081 .cindex "lookup" "spf"
7082 If Exim is built with SPF support, manual lookups can be done
7083 (as opposed to the standard ACL condition method).
7084 For details see section &<<SECSPF>>&.
7085
7086
7087 .section "Query-style lookup types" "SECTquerystylelookups"
7088 .cindex "lookup" "query-style types"
7089 .cindex "query-style lookup" "list of types"
7090 The supported query-style lookup types are listed below. Further details about
7091 many of them are given in later sections.
7092
7093 .subsection dnsdb
7094 .cindex "DNS" "as a lookup type"
7095 .cindex "lookup" "DNS"
7096 This does a DNS search for one or more records whose domain names
7097 are given in the supplied query. The resulting data is the contents of the
7098 records. See section &<<SECTdnsdb>>&.
7099
7100 .subsection ibase
7101 .cindex "InterBase lookup type"
7102 .cindex "lookup" "InterBase"
7103 This does a lookup in an InterBase database.
7104
7105 .subsection ldap
7106 .cindex "LDAP" "lookup type"
7107 .cindex "lookup" "LDAP"
7108 This does an LDAP lookup using a query in the form of a URL, and
7109 returns attributes from a single entry. There is a variant called &(ldapm)&
7110 that permits values from multiple entries to be returned. A third variant
7111 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7112 any attribute values. See section &<<SECTldap>>&.
7113
7114 .subsection mysql
7115 .cindex "MySQL" "lookup type"
7116 .cindex "lookup" "MySQL"
7117 The format of the query is an SQL statement that is passed to a
7118 MySQL database. See section &<<SECTsql>>&.
7119
7120 .subsection nisplus
7121 .cindex "NIS+ lookup type"
7122 .cindex "lookup" "NIS+"
7123 This does a NIS+ lookup using a query that can specify the name of
7124 the field to be returned. See section &<<SECTnisplus>>&.
7125
7126 .subsection oracle
7127 .cindex "Oracle" "lookup type"
7128 .cindex "lookup" "Oracle"
7129 The format of the query is an SQL statement that is passed to an
7130 Oracle database. See section &<<SECTsql>>&.
7131
7132 .subsection passwd
7133 .cindex "lookup" "passwd"
7134 .cindex "passwd lookup type"
7135 .cindex "&_/etc/passwd_&"
7136 This is a query-style lookup with queries that are just user names. The
7137 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7138 success, the result string is the same as you would get from an &(lsearch)&
7139 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7140 password value. For example:
7141 .code
7142 *:42:42:King Rat:/home/kr:/bin/bash
7143 .endd
7144
7145 .subsection pgsql
7146 .cindex "PostgreSQL lookup type"
7147 .cindex "lookup" "PostgreSQL"
7148 The format of the query is an SQL statement that is passed to a
7149 PostgreSQL database. See section &<<SECTsql>>&.
7150
7151 .subsection redis
7152 .cindex "Redis lookup type"
7153 .cindex lookup Redis
7154 The format of the query is either a simple get or simple set,
7155 passed to a Redis database. See section &<<SECTsql>>&.
7156
7157 .subsection sqlite
7158 .cindex "sqlite lookup type"
7159 .cindex "lookup" "sqlite"
7160 The format of the query is
7161 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7162
7163 .subsection testdb
7164 This is a lookup type that is used for testing Exim. It is
7165 not likely to be useful in normal operation.
7166
7167 .subsection whoson
7168 .cindex "whoson lookup type"
7169 .cindex "lookup" "whoson"
7170 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7171 allows a server to check whether a particular (dynamically allocated) IP
7172 address is currently allocated to a known (trusted) user and, optionally, to
7173 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7174 at one time for &"POP before SMTP"& authentication, but that approach has been
7175 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7176 &"POP before SMTP"& checking using ACL statements such as
7177 .code
7178 require condition = \
7179   ${lookup whoson {$sender_host_address}{yes}{no}}
7180 .endd
7181 The query consists of a single IP address. The value returned is the name of
7182 the authenticated user, which is stored in the variable &$value$&. However, in
7183 this example, the data in &$value$& is not used; the result of the lookup is
7184 one of the fixed strings &"yes"& or &"no"&.
7185
7186
7187
7188 .section "Temporary errors in lookups" "SECID63"
7189 .cindex "lookup" "temporary error in"
7190 Lookup functions can return temporary error codes if the lookup cannot be
7191 completed. For example, an SQL or LDAP database might be unavailable. For this
7192 reason, it is not advisable to use a lookup that might do this for critical
7193 options such as a list of local domains.
7194
7195 When a lookup cannot be completed in a router or transport, delivery
7196 of the message (to the relevant address) is deferred, as for any other
7197 temporary error. In other circumstances Exim may assume the lookup has failed,
7198 or may give up altogether.
7199
7200
7201
7202 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7203 .cindex "wildcard lookups"
7204 .cindex "lookup" "default values"
7205 .cindex "lookup" "wildcard"
7206 .cindex "lookup" "* added to type"
7207 .cindex "default" "in single-key lookups"
7208 In this context, a &"default value"& is a value specified by the administrator
7209 that is to be used if a lookup fails.
7210
7211 &*Note:*& This section applies only to single-key lookups. For query-style
7212 lookups, the facilities of the query language must be used. An attempt to
7213 specify a default for a query-style lookup provokes an error.
7214
7215 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7216 and the initial lookup fails, the key &"*"& is looked up in the file to
7217 provide a default value. See also the section on partial matching below.
7218
7219 .cindex "*@ with single-key lookup"
7220 .cindex "lookup" "*@ added to type"
7221 .cindex "alias file" "per-domain default"
7222 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7223 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7224 character, a second lookup is done with everything before the last @ replaced
7225 by *. This makes it possible to provide per-domain defaults in alias files
7226 that include the domains in the keys. If the second lookup fails (or doesn't
7227 take place because there is no @ in the key), &"*"& is looked up.
7228 For example, a &(redirect)& router might contain:
7229 .code
7230 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7231 .endd
7232 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7233 looks up these keys, in this order:
7234 .code
7235 jane@eyre.example
7236 *@eyre.example
7237 *
7238 .endd
7239 The data is taken from whichever key it finds first. &*Note*&: In an
7240 &(lsearch)& file, this does not mean the first of these keys in the file. A
7241 complete scan is done for each key, and only if it is not found at all does
7242 Exim move on to try the next key.
7243
7244
7245
7246 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7247 .cindex "partial matching"
7248 .cindex "wildcard lookups"
7249 .cindex "lookup" "partial matching"
7250 .cindex "lookup" "wildcard"
7251 .cindex "asterisk" "in search type"
7252 The normal operation of a single-key lookup is to search the file for an exact
7253 match with the given key. However, in a number of situations where domains are
7254 being looked up, it is useful to be able to do partial matching. In this case,
7255 information in the file that has a key starting with &"*."& is matched by any
7256 domain that ends with the components that follow the full stop. For example, if
7257 a key in a DBM file is
7258 .code
7259 *.dates.fict.example
7260 .endd
7261 then when partial matching is enabled this is matched by (amongst others)
7262 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7263 by &'dates.fict.example'&, if that does not appear as a separate key in the
7264 file.
7265
7266 &*Note*&: Partial matching is not available for query-style lookups. It is
7267 also not available for any lookup items in address lists (see section
7268 &<<SECTaddresslist>>&).
7269
7270 Partial matching is implemented by doing a series of separate lookups using
7271 keys constructed by modifying the original subject key. This means that it can
7272 be used with any of the single-key lookup types, provided that
7273 partial matching keys
7274 beginning with a special prefix (default &"*."&) are included in the data file.
7275 Keys in the file that do not begin with the prefix are matched only by
7276 unmodified subject keys when partial matching is in use.
7277
7278 Partial matching is requested by adding the string &"partial-"& to the front of
7279 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7280 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7281 is added at the start of the subject key, and it is looked up again. If that
7282 fails, further lookups are tried with dot-separated components removed from the
7283 start of the subject key, one-by-one, and &"*."& added on the front of what
7284 remains.
7285
7286 A minimum number of two non-* components are required. This can be adjusted
7287 by including a number before the hyphen in the search type. For example,
7288 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7289 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7290 subject key is &'2250.dates.fict.example'& then the following keys are looked
7291 up when the minimum number of non-* components is two:
7292 .code
7293 2250.dates.fict.example
7294 *.2250.dates.fict.example
7295 *.dates.fict.example
7296 *.fict.example
7297 .endd
7298 As soon as one key in the sequence is successfully looked up, the lookup
7299 finishes.
7300
7301 .cindex "lookup" "partial matching &-- changing prefix"
7302 .cindex "prefix" "for partial matching"
7303 The use of &"*."& as the partial matching prefix is a default that can be
7304 changed. The motivation for this feature is to allow Exim to operate with file
7305 formats that are used by other MTAs. A different prefix can be supplied in
7306 parentheses instead of the hyphen after &"partial"&. For example:
7307 .code
7308 domains = partial(.)lsearch;/some/file
7309 .endd
7310 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7311 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7312 components is unchanged). The prefix may consist of any punctuation characters
7313 other than a closing parenthesis. It may be empty, for example:
7314 .code
7315 domains = partial1()cdb;/some/file
7316 .endd
7317 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7318 &`a.b.c`&, &`b.c`&, and &`c`&.
7319
7320 If &"partial0"& is specified, what happens at the end (when the lookup with
7321 just one non-wild component has failed, and the original key is shortened right
7322 down to the null string) depends on the prefix:
7323
7324 .ilist
7325 If the prefix has zero length, the whole lookup fails.
7326 .next
7327 If the prefix has length 1, a lookup for just the prefix is done. For
7328 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7329 .next
7330 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7331 remainder is looked up. With the default prefix, therefore, the final lookup is
7332 for &"*"& on its own.
7333 .next
7334 Otherwise, the whole prefix is looked up.
7335 .endlist
7336
7337
7338 If the search type ends in &"*"& or &"*@"& (see section
7339 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7340 this implies happens after all partial lookups have failed. If &"partial0"& is
7341 specified, adding &"*"& to the search type has no effect with the default
7342 prefix, because the &"*"& key is already included in the sequence of partial
7343 lookups. However, there might be a use for lookup types such as
7344 &"partial0(.)lsearch*"&.
7345
7346 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7347 in domain lists and the like. Partial matching works only in terms of
7348 dot-separated components; a key such as &`*fict.example`&
7349 in a database file is useless, because the asterisk in a partial matching
7350 subject key is always followed by a dot.
7351
7352
7353
7354
7355 .section "Lookup caching" "SECID64"
7356 .cindex "lookup" "caching"
7357 .cindex "caching" "lookup data"
7358 Exim caches all lookup results in order to avoid needless repetition of
7359 lookups. However, because (apart from the daemon) Exim operates as a collection
7360 of independent, short-lived processes, this caching applies only within a
7361 single Exim process. There is no inter-process lookup caching facility.
7362
7363 If an option &"cache=no_rd"& is used on the lookup then
7364 the cache is only written to, cached data is not used for the operation
7365 and a real lookup is done.
7366
7367 For single-key lookups, Exim keeps the relevant files open in case there is
7368 another lookup that needs them. In some types of configuration this can lead to
7369 many files being kept open for messages with many recipients. To avoid hitting
7370 the operating system limit on the number of simultaneously open files, Exim
7371 closes the least recently used file when it needs to open more files than its
7372 own internal limit, which can be changed via the &%lookup_open_max%& option.
7373
7374 The single-key lookup files are closed and the lookup caches are flushed at
7375 strategic points during delivery &-- for example, after all routing is
7376 complete.
7377
7378
7379
7380
7381 .section "Quoting lookup data" "SECID65"
7382 .cindex "lookup" "quoting"
7383 .cindex "quoting" "in lookups"
7384 When data from an incoming message is included in a query-style lookup, there
7385 is the possibility of special characters in the data messing up the syntax of
7386 the query. For example, a NIS+ query that contains
7387 .code
7388 [name=$local_part]
7389 .endd
7390 will be broken if the local part happens to contain a closing square bracket.
7391 For NIS+, data can be enclosed in double quotes like this:
7392 .code
7393 [name="$local_part"]
7394 .endd
7395 but this still leaves the problem of a double quote in the data. The rule for
7396 NIS+ is that double quotes must be doubled. Other lookup types have different
7397 rules, and to cope with the differing requirements, an expansion operator
7398 of the following form is provided:
7399 .code
7400 ${quote_<lookup-type>:<string>}
7401 .endd
7402 For example, the way to write the NIS+ query is
7403 .code
7404 [name="${quote_nisplus:$local_part}"]
7405 .endd
7406 .cindex "tainted data" "in lookups"
7407 .new
7408 &*All*& tainted data used in a query-style lookup must be quoted
7409 using a mechanism appropriate for the lookup type.
7410 .wen
7411 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7412 operator can be used for all lookup types, but has no effect for single-key
7413 lookups, since no quoting is ever needed in their key strings.
7414
7415
7416
7417
7418 .section "More about dnsdb" "SECTdnsdb"
7419 .cindex "dnsdb lookup"
7420 .cindex "lookup" "dnsdb"
7421 .cindex "DNS" "as a lookup type"
7422 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7423 of a record type and a domain name, separated by an equals sign. For example,
7424 an expansion string could contain:
7425 .code
7426 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7427 .endd
7428 If the lookup succeeds, the result is placed in &$value$&, which in this case
7429 is used on its own as the result. If the lookup does not succeed, the
7430 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7431 &<<SECTforexpfai>>& for an explanation of what this means.
7432
7433 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7434 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7435 If no type is given, TXT is assumed.
7436
7437 For any record type, if multiple records are found, the data is returned as a
7438 concatenation, with newline as the default separator. The order, of course,
7439 depends on the DNS resolver. You can specify a different separator character
7440 between multiple records by putting a right angle-bracket followed immediately
7441 by the new separator at the start of the query. For example:
7442 .code
7443 ${lookup dnsdb{>: a=host1.example}}
7444 .endd
7445 It is permitted to specify a space as the separator character. Further
7446 white space is ignored.
7447 For lookup types that return multiple fields per record,
7448 an alternate field separator can be specified using a comma after the main
7449 separator character, followed immediately by the field separator.
7450
7451 .cindex "PTR record" "in &(dnsdb)& lookup"
7452 When the type is PTR,
7453 the data can be an IP address, written as normal; inversion and the addition of
7454 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7455 .code
7456 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7457 .endd
7458 If the data for a PTR record is not a syntactically valid IP address, it is not
7459 altered and nothing is added.
7460
7461 .cindex "MX record" "in &(dnsdb)& lookup"
7462 .cindex "SRV record" "in &(dnsdb)& lookup"
7463 For an MX lookup, both the preference value and the host name are returned for
7464 each record, separated by a space. For an SRV lookup, the priority, weight,
7465 port, and host name are returned for each record, separated by spaces.
7466 The field separator can be modified as above.
7467
7468 .cindex "TXT record" "in &(dnsdb)& lookup"
7469 .cindex "SPF record" "in &(dnsdb)& lookup"
7470 For TXT records with multiple items of data, only the first item is returned,
7471 unless a field separator is specified.
7472 To concatenate items without a separator, use a semicolon instead.
7473 For SPF records the
7474 default behaviour is to concatenate multiple items without using a separator.
7475 .code
7476 ${lookup dnsdb{>\n,: txt=a.b.example}}
7477 ${lookup dnsdb{>\n; txt=a.b.example}}
7478 ${lookup dnsdb{spf=example.org}}
7479 .endd
7480 It is permitted to specify a space as the separator character. Further
7481 white space is ignored.
7482
7483 .cindex "SOA record" "in &(dnsdb)& lookup"
7484 For an SOA lookup, while no result is obtained the lookup is redone with
7485 successively more leading components dropped from the given domain.
7486 Only the primary-nameserver field is returned unless a field separator is
7487 specified.
7488 .code
7489 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7490 .endd
7491
7492 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7493 .cindex "dnsdb modifiers"
7494 .cindex "modifiers" "dnsdb"
7495 .cindex "options" "dnsdb"
7496 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7497 each followed by a comma,
7498 that may appear before the record type.
7499
7500 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7501 temporary DNS error for any of them, the behaviour is controlled by
7502 a defer-option modifier.
7503 The possible keywords are
7504 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7505 With &"strict"& behaviour, any temporary DNS error causes the
7506 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7507 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7508 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7509 error causes the whole lookup to defer only if none of the other lookups
7510 succeed. The default is &"lax"&, so the following lookups are equivalent:
7511 .code
7512 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7513 ${lookup dnsdb{a=one.host.com:two.host.com}}
7514 .endd
7515 Thus, in the default case, as long as at least one of the DNS lookups
7516 yields some data, the lookup succeeds.
7517
7518 .cindex "DNSSEC" "dns lookup"
7519 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7520 The possible keywords are
7521 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7522 With &"strict"& or &"lax"& DNSSEC information is requested
7523 with the lookup.
7524 With &"strict"& a response from the DNS resolver that
7525 is not labelled as authenticated data
7526 is treated as equivalent to a temporary DNS error.
7527 The default is &"lax"&.
7528
7529 See also the &$lookup_dnssec_authenticated$& variable.
7530
7531 .cindex timeout "dns lookup"
7532 .cindex "DNS" timeout
7533 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7534 The form is &"retrans_VAL"& where VAL is an Exim time specification
7535 (e.g. &"5s"&).
7536 The default value is set by the main configuration option &%dns_retrans%&.
7537
7538 Retries for the dnsdb lookup can be controlled by a retry modifier.
7539 The form if &"retry_VAL"& where VAL is an integer.
7540 The default count is set by the main configuration option &%dns_retry%&.
7541
7542 .cindex caching "of dns lookup"
7543 .cindex TTL "of dns lookup"
7544 .cindex DNS TTL
7545 Dnsdb lookup results are cached within a single process (and its children).
7546 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7547 value of the set of returned DNS records.
7548
7549
7550 .subsection "Pseudo dnsdb record types" SECID66
7551 .cindex "MX record" "in &(dnsdb)& lookup"
7552 By default, both the preference value and the host name are returned for
7553 each MX record, separated by a space. If you want only host names, you can use
7554 the pseudo-type MXH:
7555 .code
7556 ${lookup dnsdb{mxh=a.b.example}}
7557 .endd
7558 In this case, the preference values are omitted, and just the host names are
7559 returned.
7560
7561 .cindex "name server for enclosing domain"
7562 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7563 records on the given domain, but if none are found, it removes the first
7564 component of the domain name, and tries again. This process continues until NS
7565 records are found or there are no more components left (or there is a DNS
7566 error). In other words, it may return the name servers for a top-level domain,
7567 but it never returns the root name servers. If there are no NS records for the
7568 top-level domain, the lookup fails. Consider these examples:
7569 .code
7570 ${lookup dnsdb{zns=xxx.quercite.com}}
7571 ${lookup dnsdb{zns=xxx.edu}}
7572 .endd
7573 Assuming that in each case there are no NS records for the full domain name,
7574 the first returns the name servers for &%quercite.com%&, and the second returns
7575 the name servers for &%edu%&.
7576
7577 You should be careful about how you use this lookup because, unless the
7578 top-level domain does not exist, the lookup always returns some host names. The
7579 sort of use to which this might be put is for seeing if the name servers for a
7580 given domain are on a blacklist. You can probably assume that the name servers
7581 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7582 such a list.
7583
7584 .cindex "CSA" "in &(dnsdb)& lookup"
7585 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7586 records according to the CSA rules, which are described in section
7587 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7588 not sufficient because of the extra parent domain search behaviour of CSA. The
7589 result of a successful lookup such as:
7590 .code
7591 ${lookup dnsdb {csa=$sender_helo_name}}
7592 .endd
7593 has two space-separated fields: an authorization code and a target host name.
7594 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7595 authorization required but absent, or &"?"& for unknown.
7596
7597 .cindex "A+" "in &(dnsdb)& lookup"
7598 The pseudo-type A+ performs an AAAA
7599 and then an A lookup.  All results are returned; defer processing
7600 (see below) is handled separately for each lookup.  Example:
7601 .code
7602 ${lookup dnsdb {>; a+=$sender_helo_name}}
7603 .endd
7604
7605
7606 .subsection "Multiple dnsdb lookups" SECID67
7607 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7608 However, you can specify a list of domains or IP addresses in a single
7609 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7610 the default separator, but with the ability to change this. For example:
7611 .code
7612 ${lookup dnsdb{one.domain.com:two.domain.com}}
7613 ${lookup dnsdb{a=one.host.com:two.host.com}}
7614 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7615 .endd
7616 In order to retain backwards compatibility, there is one special case: if
7617 the lookup type is PTR and no change of separator is specified, Exim looks
7618 to see if the rest of the string is precisely one IPv6 address. In this
7619 case, it does not treat it as a list.
7620
7621 The data from each lookup is concatenated, with newline separators by default,
7622 in the same way that multiple DNS records for a single item are handled. A
7623 different separator can be specified, as described above.
7624
7625
7626
7627
7628 .section "More about LDAP" "SECTldap"
7629 .cindex "LDAP" "lookup, more about"
7630 .cindex "lookup" "LDAP"
7631 .cindex "Solaris" "LDAP"
7632 The original LDAP implementation came from the University of Michigan; this has
7633 become &"Open LDAP"&, and there are now two different releases. Another
7634 implementation comes from Netscape, and Solaris 7 and subsequent releases
7635 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7636 the lookup function level, their error handling is different. For this reason
7637 it is necessary to set a compile-time variable when building Exim with LDAP, to
7638 indicate which LDAP library is in use. One of the following should appear in
7639 your &_Local/Makefile_&:
7640 .code
7641 LDAP_LIB_TYPE=UMICHIGAN
7642 LDAP_LIB_TYPE=OPENLDAP1
7643 LDAP_LIB_TYPE=OPENLDAP2
7644 LDAP_LIB_TYPE=NETSCAPE
7645 LDAP_LIB_TYPE=SOLARIS
7646 .endd
7647 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7648 same interface as the University of Michigan version.
7649
7650 There are three LDAP lookup types in Exim. These behave slightly differently in
7651 the way they handle the results of a query:
7652
7653 .ilist
7654 &(ldap)& requires the result to contain just one entry; if there are more, it
7655 gives an error.
7656 .next
7657 &(ldapdn)& also requires the result to contain just one entry, but it is the
7658 Distinguished Name that is returned rather than any attribute values.
7659 .next
7660 &(ldapm)& permits the result to contain more than one entry; the attributes
7661 from all of them are returned.
7662 .endlist
7663
7664
7665 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7666 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7667 the data returned by a successful lookup is described in the next section.
7668 First we explain how LDAP queries are coded.
7669
7670
7671 .subsection "Format of LDAP queries" SECTforldaque
7672 .cindex "LDAP" "query format"
7673 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7674 the configuration of a &(redirect)& router one might have this setting:
7675 .code
7676 data = ${lookup ldap \
7677   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7678   c=UK?mailbox?base?}}
7679 .endd
7680 .cindex "LDAP" "with TLS"
7681 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7682 secure (encrypted) LDAP connections. The second of these ensures that an
7683 encrypted TLS connection is used.
7684
7685 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7686 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7687 See the &%ldap_start_tls%& option.
7688
7689 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7690 controlled. Every part of the TLS configuration can be configured by settings in
7691 &_exim.conf_&. Depending on the version of the client libraries installed on
7692 your system, some of the initialization may have required setting options in
7693 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7694 certificates. This revealed a nuance where the current UID that exim was
7695 running as could affect which config files it read. With Exim 4.83, these
7696 methods become optional, only taking effect if not specifically set in
7697 &_exim.conf_&.
7698
7699
7700 .subsection "LDAP quoting" SECID68
7701 .cindex "LDAP" "quoting"
7702 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7703 and the second because the LDAP query is represented as a URL. Furthermore,
7704 within an LDAP query, two different kinds of quoting are required. For this
7705 reason, there are two different LDAP-specific quoting operators.
7706
7707 The &%quote_ldap%& operator is designed for use on strings that are part of
7708 filter specifications. Conceptually, it first does the following conversions on
7709 the string:
7710 .code
7711 *   =>   \2A
7712 (   =>   \28
7713 )   =>   \29
7714 \   =>   \5C
7715 .endd
7716 in accordance with RFC 2254. The resulting string is then quoted according
7717 to the rules for URLs, that is, all non-alphanumeric characters except
7718 .code
7719 ! $ ' - . _ ( ) * +
7720 .endd
7721 are converted to their hex values, preceded by a percent sign. For example:
7722 .code
7723 ${quote_ldap: a(bc)*, a<yz>; }
7724 .endd
7725 yields
7726 .code
7727 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7728 .endd
7729 Removing the URL quoting, this is (with a leading and a trailing space):
7730 .code
7731 a\28bc\29\2A, a<yz>;
7732 .endd
7733 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7734 base DN specifications in queries. Conceptually, it first converts the string
7735 by inserting a backslash in front of any of the following characters:
7736 .code
7737 , + " \ < > ;
7738 .endd
7739 It also inserts a backslash before any leading spaces or # characters, and
7740 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7741 is then quoted according to the rules for URLs. For example:
7742 .code
7743 ${quote_ldap_dn: a(bc)*, a<yz>; }
7744 .endd
7745 yields
7746 .code
7747 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7748 .endd
7749 Removing the URL quoting, this is (with a trailing space):
7750 .code
7751 \ a(bc)*\, a\<yz\>\;\
7752 .endd
7753 There are some further comments about quoting in the section on LDAP
7754 authentication below.
7755
7756
7757 .subsection "LDAP connections" SECID69
7758 .cindex "LDAP" "connections"
7759 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7760 is in use, via a Unix domain socket. The example given above does not specify
7761 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7762 by starting it with
7763 .code
7764 ldap://<hostname>:<port>/...
7765 .endd
7766 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7767 used. When no server is specified in a query, a list of default servers is
7768 taken from the &%ldap_default_servers%& configuration option. This supplies a
7769 colon-separated list of servers which are tried in turn until one successfully
7770 handles a query, or there is a serious error. Successful handling either
7771 returns the requested data, or indicates that it does not exist. Serious errors
7772 are syntactical, or multiple values when only a single value is expected.
7773 Errors which cause the next server to be tried are connection failures, bind
7774 failures, and timeouts.
7775
7776 For each server name in the list, a port number can be given. The standard way
7777 of specifying a host and port is to use a colon separator (RFC 1738). Because
7778 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7779 doubled. For example
7780 .code
7781 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7782 .endd
7783 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7784 to the LDAP library with no server name, and the library's default (normally
7785 the local host) is used.
7786
7787 If you are using the OpenLDAP library, you can connect to an LDAP server using
7788 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7789 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7790 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7791 not available.
7792
7793 For this type of connection, instead of a host name for the server, a pathname
7794 for the socket is required, and the port number is not relevant. The pathname
7795 can be specified either as an item in &%ldap_default_servers%&, or inline in
7796 the query. In the former case, you can have settings such as
7797 .code
7798 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7799 .endd
7800 When the pathname is given in the query, you have to escape the slashes as
7801 &`%2F`& to fit in with the LDAP URL syntax. For example:
7802 .code
7803 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7804 .endd
7805 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7806 a pathname, it uses the Unix domain socket code, even if the query actually
7807 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7808 socket connection. This behaviour means that you can use a setting of
7809 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7810 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7811 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7812 backup host.
7813
7814 If an explicit &`ldapi`& type is given in a query when a host name is
7815 specified, an error is diagnosed. However, if there are more items in
7816 &%ldap_default_servers%&, they are tried. In other words:
7817
7818 .ilist
7819 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7820 interface.
7821 .next
7822 Using &`ldapi`& with a host name causes an error.
7823 .endlist
7824
7825
7826 Using &`ldapi`& with no host or path in the query, and no setting of
7827 &%ldap_default_servers%&, does whatever the library does by default.
7828
7829
7830
7831 .subsection "LDAP authentication and control information" SECID70
7832 .cindex "LDAP" "authentication"
7833 The LDAP URL syntax provides no way of passing authentication and other control
7834 information to the server. To make this possible, the URL in an LDAP query may
7835 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7836 spaces. If a value contains spaces it must be enclosed in double quotes, and
7837 when double quotes are used, backslash is interpreted in the usual way inside
7838 them. The following names are recognized:
7839 .itable none 0 0 2 20* left 80* left
7840 .irow DEREFERENCE "set the dereferencing parameter"
7841 .irow NETTIME     "set a timeout for a network operation"
7842 .irow USER        "set the DN, for authenticating the LDAP bind"
7843 .irow PASS        "set the password, likewise"
7844 .irow REFERRALS   "set the referrals parameter"
7845 .irow SERVERS     "set alternate server list for this query only"
7846 .irow SIZE        "set the limit for the number of entries returned"
7847 .irow TIME        "set the maximum waiting time for a query"
7848 .endtable
7849 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7850 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7851 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7852 library from trying to follow referrals issued by the LDAP server.
7853
7854 .cindex LDAP timeout
7855 .cindex timeout "LDAP lookup"
7856 The name CONNECT is an obsolete name for NETTIME, retained for
7857 backwards compatibility. This timeout (specified as a number of seconds) is
7858 enforced from the client end for operations that can be carried out over a
7859 network. Specifically, it applies to network connections and calls to the
7860 &'ldap_result()'& function. If the value is greater than zero, it is used if
7861 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7862 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7863 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7864 Netscape SDK; for OpenLDAP no action is taken.
7865
7866 The TIME parameter (also a number of seconds) is passed to the server to
7867 set a server-side limit on the time taken to complete a search.
7868
7869 The SERVERS parameter allows you to specify an alternate list of ldap servers
7870 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7871 default list of ldap servers, and a single lookup can specify a single ldap
7872 server to use.  But when you need to do a lookup with a list of servers that is
7873 different than the default list (maybe different order, maybe a completely
7874 different set of servers), the SERVERS parameter allows you to specify this
7875 alternate list (colon-separated).
7876
7877 Here is an example of an LDAP query in an Exim lookup that uses some of these
7878 values. This is a single line, folded to fit on the page:
7879 .code
7880 ${lookup ldap
7881   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7882   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7883   {$value}fail}
7884 .endd
7885 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7886 any of the auxiliary data. Exim configuration settings that include lookups
7887 which contain password information should be preceded by &"hide"& to prevent
7888 non-admin users from using the &%-bP%& option to see their values.
7889
7890 The auxiliary data items may be given in any order. The default is no
7891 connection timeout (the system timeout is used), no user or password, no limit
7892 on the number of entries returned, and no time limit on queries.
7893
7894 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7895 removes any URL quoting that it may contain before passing it to the LDAP library.
7896 Apparently
7897 some libraries do this for themselves, but some do not. Removing the URL
7898 quoting has two advantages:
7899
7900 .ilist
7901 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7902 DNs as with DNs inside actual queries.
7903 .next
7904 It permits spaces inside USER= DNs.
7905 .endlist
7906
7907 For example, a setting such as
7908 .code
7909 USER=cn=${quote_ldap_dn:$1}
7910 .endd
7911 should work even if &$1$& contains spaces.
7912
7913 Expanded data for the PASS= value should be quoted using the &%quote%&
7914 expansion operator, rather than the LDAP quote operators. The only reason this
7915 field needs quoting is to ensure that it conforms to the Exim syntax, which
7916 does not allow unquoted spaces. For example:
7917 .code
7918 PASS=${quote:$3}
7919 .endd
7920 The LDAP authentication mechanism can be used to check passwords as part of
7921 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7922 &<<CHAPexpand>>&.
7923
7924
7925
7926 .subsection "Format of data returned by LDAP" SECID71
7927 .cindex "LDAP" "returned data formats"
7928 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7929 as a sequence of values, for example
7930 .code
7931 cn=manager,o=University of Cambridge,c=UK
7932 .endd
7933 The &(ldap)& lookup type generates an error if more than one entry matches the
7934 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7935 the result between the data from different entries. It is possible for multiple
7936 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7937 you know that whatever values are returned all came from a single entry in the
7938 directory.
7939
7940 In the common case where you specify a single attribute in your LDAP query, the
7941 result is not quoted, and does not contain the attribute name. If the attribute
7942 has multiple values, they are separated by commas. Any comma that is
7943 part of an attribute's value is doubled.
7944
7945 If you specify multiple attributes, the result contains space-separated, quoted
7946 strings, each preceded by the attribute name and an equals sign. Within the
7947 quotes, the quote character, backslash, and newline are escaped with
7948 backslashes, and commas are used to separate multiple values for the attribute.
7949 Any commas in attribute values are doubled
7950 (permitting treatment of the values as a comma-separated list).
7951 Apart from the escaping, the string within quotes takes the same form as the
7952 output when a single attribute is requested. Specifying no attributes is the
7953 same as specifying all of an entry's attributes.
7954
7955 Here are some examples of the output format. The first line of each pair is an
7956 LDAP query, and the second is the data that is returned. The attribute called
7957 &%attr1%& has two values, one of them with an embedded comma, whereas
7958 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7959 (they have SUP &%attr%& in their schema definitions).
7960
7961 .code
7962 ldap:///o=base?attr1?sub?(uid=fred)
7963 value1.1,value1,,2
7964
7965 ldap:///o=base?attr2?sub?(uid=fred)
7966 value two
7967
7968 ldap:///o=base?attr?sub?(uid=fred)
7969 value1.1,value1,,2,value two
7970
7971 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7972 attr1="value1.1,value1,,2" attr2="value two"
7973
7974 ldap:///o=base??sub?(uid=fred)
7975 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7976 .endd
7977 You can
7978 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7979 results of LDAP lookups.
7980 The &%extract%& operator in string expansions can be used to pick out
7981 individual fields from data that consists of &'key'&=&'value'& pairs.
7982 The &%listextract%& operator should be used to pick out individual values
7983 of attributes, even when only a single value is expected.
7984 The doubling of embedded commas allows you to use the returned data as a
7985 comma separated list (using the "<," syntax for changing the input list separator).
7986
7987
7988
7989
7990 .section "More about NIS+" "SECTnisplus"
7991 .cindex "NIS+ lookup type"
7992 .cindex "lookup" "NIS+"
7993 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7994 and field name. If this is given, the result of a successful query is the
7995 contents of the named field; otherwise the result consists of a concatenation
7996 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7997 values containing spaces are quoted. For example, the query
7998 .code
7999 [name=mg1456],passwd.org_dir
8000 .endd
8001 might return the string
8002 .code
8003 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8004 home=/home/mg1456 shell=/bin/bash shadow=""
8005 .endd
8006 (split over two lines here to fit on the page), whereas
8007 .code
8008 [name=mg1456],passwd.org_dir:gcos
8009 .endd
8010 would just return
8011 .code
8012 Martin Guerre
8013 .endd
8014 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8015 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8016 operator is to double any quote characters within the text.
8017
8018
8019
8020 .section "SQL lookups" "SECTsql"
8021 .cindex "SQL lookup types"
8022 .cindex "MySQL" "lookup type"
8023 .cindex "PostgreSQL lookup type"
8024 .cindex "lookup" "MySQL"
8025 .cindex "lookup" "PostgreSQL"
8026 .cindex "Oracle" "lookup type"
8027 .cindex "lookup" "Oracle"
8028 .cindex "InterBase lookup type"
8029 .cindex "lookup" "InterBase"
8030 .cindex "Redis lookup type"
8031 .cindex lookup Redis
8032 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8033 and SQLite
8034 databases. Queries for these databases contain SQL statements, so an example
8035 might be
8036 .code
8037 ${lookup mysql{select mailbox from users where id='userx'}\
8038   {$value}fail}
8039 .endd
8040 If the result of the query contains more than one field, the data for each
8041 field in the row is returned, preceded by its name, so the result of
8042 .code
8043 ${lookup pgsql{select home,name from users where id='userx'}\
8044   {$value}}
8045 .endd
8046 might be
8047 .code
8048 home=/home/userx name="Mister X"
8049 .endd
8050 Empty values and values containing spaces are double quoted, with embedded
8051 quotes escaped by a backslash. If the result of the query contains just one
8052 field, the value is passed back verbatim, without a field name, for example:
8053 .code
8054 Mister X
8055 .endd
8056 If the result of the query yields more than one row, it is all concatenated,
8057 with a newline between the data for each row.
8058
8059
8060 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8061 .cindex "MySQL" "lookup type"
8062 .cindex "PostgreSQL lookup type"
8063 .cindex "lookup" "MySQL"
8064 .cindex "lookup" "PostgreSQL"
8065 .cindex "Oracle" "lookup type"
8066 .cindex "lookup" "Oracle"
8067 .cindex "InterBase lookup type"
8068 .cindex "lookup" "InterBase"
8069 .cindex "Redis lookup type"
8070 .cindex lookup Redis
8071 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8072 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8073 or &%redis_servers%&
8074 option (as appropriate) must be set to a colon-separated list of server
8075 information.
8076 .oindex &%mysql_servers%&
8077 .oindex &%pgsql_servers%&
8078 .oindex &%oracle_servers%&
8079 .oindex &%ibase_servers%&
8080 .oindex &%redis_servers%&
8081 (For MySQL and PostgreSQL, the global option need not be set if all
8082 queries contain their own server information &-- see section
8083 &<<SECTspeserque>>&.)
8084 For all but Redis
8085 each item in the list is a slash-separated list of four
8086 items: host name, database name, user name, and password. In the case of
8087 Oracle, the host name field is used for the &"service name"&, and the database
8088 name field is not used and should be empty. For example:
8089 .code
8090 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8091 .endd
8092 Because password data is sensitive, you should always precede the setting with
8093 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8094 option. Here is an example where two MySQL servers are listed:
8095 .code
8096 hide mysql_servers = localhost/users/root/secret:\
8097                      otherhost/users/root/othersecret
8098 .endd
8099 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8100 because this is a colon-separated list, the colon has to be doubled. For each
8101 query, these parameter groups are tried in order until a connection is made and
8102 a query is successfully processed. The result of a query may be that no data is
8103 found, but that is still a successful query. In other words, the list of
8104 servers provides a backup facility, not a list of different places to look.
8105
8106 For Redis the global option need not be specified if all queries contain their
8107 own server information &-- see section &<<SECTspeserque>>&.
8108 If specified, the option must be set to a colon-separated list of server
8109 information.
8110 Each item in the list is a slash-separated list of three items:
8111 host, database number, and password.
8112 .olist
8113 The host is required and may be either an IPv4 address and optional
8114 port number (separated by a colon, which needs doubling due to the
8115 higher-level list), or a Unix socket pathname enclosed in parentheses
8116 .next
8117 The database number is optional; if present that number is selected in the backend
8118 .next
8119 The password is optional; if present it is used to authenticate to the backend
8120 .endlist
8121
8122 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8123 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8124 respectively, and the characters single-quote, double-quote, and backslash
8125 itself are escaped with backslashes.
8126
8127 The &%quote_redis%& expansion operator
8128 escapes whitespace and backslash characters with a backslash.
8129
8130 .subsection "Specifying the server in the query" SECTspeserque
8131 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8132 it is possible to specify a list of servers with an individual query. This is
8133 done by appending a comma-separated option to the query type:
8134 .display
8135 &`,servers=`&&'server1:server2:server3:...'&
8136 .endd
8137 Each item in the list may take one of two forms:
8138 .olist
8139 If it contains no slashes it is assumed to be just a host name. The appropriate
8140 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8141 of the same name, and the remaining parameters (database, user, password) are
8142 taken from there.
8143 .next
8144 If it contains any slashes, it is taken as a complete parameter set.
8145 .endlist
8146 The list of servers is used in exactly the same way as the global list.
8147 Once a connection to a server has happened and a query has been
8148 successfully executed, processing of the lookup ceases.
8149
8150 This feature is intended for use in master/slave situations where updates
8151 are occurring and you want to update the master rather than a slave. If the
8152 master is in the list as a backup for reading, you might have a global setting
8153 like this:
8154 .code
8155 mysql_servers = slave1/db/name/pw:\
8156                 slave2/db/name/pw:\
8157                 master/db/name/pw
8158 .endd
8159 In an updating lookup, you could then write:
8160 .code
8161 ${lookup mysql,servers=master {UPDATE ...} }
8162 .endd
8163 That query would then be sent only to the master server. If, on the other hand,
8164 the master is not to be used for reading, and so is not present in the global
8165 option, you can still update it by a query of this form:
8166 .code
8167 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8168 .endd
8169
8170 An older syntax places the servers specification before the query,
8171 semicolon separated:
8172 .code
8173 ${lookup mysql{servers=master; UPDATE ...} }
8174 .endd
8175 The new version avoids potential issues with tainted
8176 arguments in the query, for explicit expansion.
8177 &*Note*&: server specifications in list-style lookups are still problematic.
8178
8179
8180 .subsection "Special MySQL features" SECID73
8181 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8182 causes a connection to the server on the local host by means of a Unix domain
8183 socket. An alternate socket can be specified in parentheses.
8184 An option group name for MySQL option files can be specified in square brackets;
8185 the default value is &"exim"&.
8186 The full syntax of each item in &%mysql_servers%& is:
8187 .display
8188 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8189   <&'database'&>/<&'user'&>/<&'password'&>
8190 .endd
8191 Any of the four sub-parts of the first field can be omitted. For normal use on
8192 the local host it can be left blank or set to just &"localhost"&.
8193
8194 No database need be supplied &-- but if it is absent here, it must be given in
8195 the queries.
8196
8197 If a MySQL query is issued that does not request any data (an insert, update,
8198 or delete command), the result of the lookup is the number of rows affected.
8199
8200 &*Warning*&: This can be misleading. If an update does not actually change
8201 anything (for example, setting a field to the value it already has), the result
8202 is zero because no rows are affected.
8203
8204
8205 .subsection "Special PostgreSQL features" SECID74
8206 PostgreSQL lookups can also use Unix domain socket connections to the database.
8207 This is usually faster and costs less CPU time than a TCP/IP connection.
8208 However it can be used only if the mail server runs on the same machine as the
8209 database server. A configuration line for PostgreSQL via Unix domain sockets
8210 looks like this:
8211 .code
8212 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8213 .endd
8214 In other words, instead of supplying a host name, a path to the socket is
8215 given. The path name is enclosed in parentheses so that its slashes aren't
8216 visually confused with the delimiters for the other server parameters.
8217
8218 If a PostgreSQL query is issued that does not request any data (an insert,
8219 update, or delete command), the result of the lookup is the number of rows
8220 affected.
8221
8222 .subsection "More about SQLite" SECTsqlite
8223 .cindex "lookup" "SQLite"
8224 .cindex "sqlite lookup type"
8225 SQLite is different to the other SQL lookups because a filename is required in
8226 addition to the SQL query. An SQLite database is a single file, and there is no
8227 daemon as in the other SQL databases.
8228
8229 .oindex &%sqlite_dbfile%&
8230 There are two ways of
8231 specifying the file.
8232 The first is is by using the &%sqlite_dbfile%& main option.
8233 The second, which allows separate files for each query,
8234 is to use an option appended, comma-separated, to the &"sqlite"&
8235 lookup type word.  The option is the word &"file"&, then an equals,
8236 then the filename.
8237 The filename in this case cannot contain whitespace or open-brace charachters.
8238
8239 A deprecated method is available, prefixing the query with the filename
8240 separated by white space.
8241 This means that
8242 .cindex "tainted data" "sqlite file"
8243 the query cannot use any tainted values, as that taints
8244 the entire query including the filename - resulting in a refusal to open
8245 the file.
8246
8247 In all the above cases the filename must be an absolute path.
8248
8249 Here is a lookup expansion example:
8250 .code
8251 sqlite_dbfile = /some/thing/sqlitedb
8252 ...
8253 ${lookup sqlite {select name from aliases where id='userx';}}
8254 .endd
8255 In a list, the syntax is similar. For example:
8256 .code
8257 domainlist relay_to_domains = sqlite;\
8258    select * from relays where ip='$sender_host_address';
8259 .endd
8260 The only character affected by the &%quote_sqlite%& operator is a single
8261 quote, which it doubles.
8262
8263 .cindex timeout SQLite
8264 .cindex sqlite "lookup timeout"
8265 The SQLite library handles multiple simultaneous accesses to the database
8266 internally. Multiple readers are permitted, but only one process can
8267 update at once. Attempts to access the database while it is being updated
8268 are rejected after a timeout period, during which the SQLite library
8269 waits for the lock to be released. In Exim, the default timeout is set
8270 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8271 option.
8272
8273 .subsection "More about Redis" SECTredis
8274 .cindex "lookup" "Redis"
8275 .cindex "redis lookup type"
8276 Redis is a non-SQL database. Commands are simple get and set.
8277 Examples:
8278 .code
8279 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8280 ${lookup redis{get keyname}}
8281 .endd
8282
8283 As of release 4.91, "lightweight" support for Redis Cluster is available.
8284 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8285 of which must be reachable from the running exim instance. If the cluster has
8286 master/slave replication, the list must contain all the master and slave
8287 servers.
8288
8289 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8290 immediately follow the redirection but treats the response as a DEFER, moving on
8291 to the next server in the &%redis_servers%& list until the correct server is
8292 reached.
8293
8294 .ecindex IIDfidalo1
8295 .ecindex IIDfidalo2
8296
8297
8298 . ////////////////////////////////////////////////////////////////////////////
8299 . ////////////////////////////////////////////////////////////////////////////
8300
8301 .chapter "Domain, host, address, and local part lists" &&&
8302          "CHAPdomhosaddlists" &&&
8303          "Domain, host, and address lists"
8304 .scindex IIDdohoadli "lists of domains; hosts; etc."
8305 A number of Exim configuration options contain lists of domains, hosts,
8306 email addresses, or local parts. For example, the &%hold_domains%& option
8307 contains a list of domains whose delivery is currently suspended. These lists
8308 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8309 arguments to expansion conditions such as &%match_domain%&.
8310
8311 Each item in one of these lists is a pattern to be matched against a domain,
8312 host, email address, or local part, respectively. In the sections below, the
8313 different types of pattern for each case are described, but first we cover some
8314 general facilities that apply to all four kinds of list.
8315
8316 Note that other parts of Exim use a &'string list'& which does not
8317 support all the complexity available in
8318 domain, host, address and local part lists.
8319
8320
8321
8322 .section "Results of list checking" SECTlistresults
8323 The primary result of doing a list check is a truth value.
8324 In some contexts additional information is stored
8325 about the list element that matched:
8326 .vlist
8327 .vitem hosts
8328 A &%hosts%& ACL condition
8329 will store a result in the &$host_data$& variable.
8330 .vitem local_parts
8331 A &%local_parts%& router option or &%local_parts%& ACL condition
8332 will store a result in the &$local_part_data$& variable.
8333 .vitem domains
8334 A &%domains%& router option or &%domains%& ACL condition
8335 will store a result in the &$domain_data$& variable.
8336 .vitem senders
8337 A &%senders%& router option or &%senders%& ACL condition
8338 will store a result in the &$sender_data$& variable.
8339 .vitem recipients
8340 A &%recipients%& ACL condition
8341 will store a result in the &$recipient_data$& variable.
8342 .endlist
8343
8344 The detail of the additional information depends on the
8345 type of match and is given below as the &*value*& information.
8346
8347
8348
8349
8350 .section "Expansion of lists" "SECTlistexpand"
8351 .cindex "expansion" "of lists"
8352 Each list is expanded as a single string before it is used.
8353
8354 &'Exception: the router headers_remove option, where list-item
8355 splitting is done before string-expansion.'&
8356
8357 The result of
8358 expansion must be a list, possibly containing empty items, which is split up
8359 into separate items for matching. By default, colon is the separator character,
8360 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8361 &<<SECTempitelis>>& for details of the list syntax; the second of these
8362 discusses the way to specify empty list items.
8363
8364
8365 If the string expansion is forced to fail, Exim behaves as if the item it is
8366 testing (domain, host, address, or local part) is not in the list. Other
8367 expansion failures cause temporary errors.
8368
8369 If an item in a list is a regular expression, backslashes, dollars and possibly
8370 other special characters in the expression must be protected against
8371 misinterpretation by the string expander. The easiest way to do this is to use
8372 the &`\N`& expansion feature to indicate that the contents of the regular
8373 expression should not be expanded. For example, in an ACL you might have:
8374 .code
8375 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8376                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8377 .endd
8378 The first item is a regular expression that is protected from expansion by
8379 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8380 senders based on the receiving domain.
8381
8382
8383
8384
8385 .subsection "Negated items in lists" SECID76
8386 .cindex "list" "negation"
8387 .cindex "negation" "in lists"
8388 Items in a list may be positive or negative. Negative items are indicated by a
8389 leading exclamation mark, which may be followed by optional white space. A list
8390 defines a set of items (domains, etc). When Exim processes one of these lists,
8391 it is trying to find out whether a domain, host, address, or local part
8392 (respectively) is in the set that is defined by the list. It works like this:
8393
8394 The list is scanned from left to right. If a positive item is matched, the
8395 subject that is being checked is in the set; if a negative item is matched, the
8396 subject is not in the set. If the end of the list is reached without the
8397 subject having matched any of the patterns, it is in the set if the last item
8398 was a negative one, but not if it was a positive one. For example, the list in
8399 .code
8400 domainlist relay_to_domains = !a.b.c : *.b.c
8401 .endd
8402 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8403 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8404 list is positive. However, if the setting were
8405 .code
8406 domainlist relay_to_domains = !a.b.c
8407 .endd
8408 then all domains other than &'a.b.c'& would match because the last item in the
8409 list is negative. In other words, a list that ends with a negative item behaves
8410 as if it had an extra item &`:*`& on the end.
8411
8412 Another way of thinking about positive and negative items in lists is to read
8413 the connector as &"or"& after a positive item and as &"and"& after a negative
8414 item.
8415
8416
8417
8418 .subsection "File names in lists" SECTfilnamlis
8419 .cindex "list" "filename in"
8420 If an item in a domain, host, address, or local part list is an absolute
8421 filename (beginning with a slash character), each line of the file is read and
8422 processed as if it were an independent item in the list, except that further
8423 filenames are not allowed,
8424 and no expansion of the data from the file takes place.
8425 Empty lines in the file are ignored, and the file may also contain comment
8426 lines:
8427
8428 .ilist
8429 For domain and host lists, if a # character appears anywhere in a line of the
8430 file, it and all following characters are ignored.
8431 .next
8432 Because local parts may legitimately contain # characters, a comment in an
8433 address list or local part list file is recognized only if # is preceded by
8434 white space or the start of the line. For example:
8435 .code
8436 not#comment@x.y.z   # but this is a comment
8437 .endd
8438 .endlist
8439
8440 Putting a filename in a list has the same effect as inserting each line of the
8441 file as an item in the list (blank lines and comments excepted). However, there
8442 is one important difference: the file is read each time the list is processed,
8443 so if its contents vary over time, Exim's behaviour changes.
8444
8445 If a filename is preceded by an exclamation mark, the sense of any match
8446 within the file is inverted. For example, if
8447 .code
8448 hold_domains = !/etc/nohold-domains
8449 .endd
8450 and the file contains the lines
8451 .code
8452 !a.b.c
8453 *.b.c
8454 .endd
8455 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8456 any domain matching &`*.b.c`& is not.
8457
8458
8459
8460 .subsection "An lsearch file is not an out-of-line list" SECID77
8461 As will be described in the sections that follow, lookups can be used in lists
8462 to provide indexed methods of checking list membership. There has been some
8463 confusion about the way &(lsearch)& lookups work in lists. Because
8464 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8465 sometimes thought that it is allowed to contain wild cards and other kinds of
8466 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8467 always fixed strings, just as for any other single-key lookup type.
8468
8469 If you want to use a file to contain wild-card patterns that form part of a
8470 list, just give the filename on its own, without a search type, as described
8471 in the previous section. You could also use the &(wildlsearch)& or
8472 &(nwildlsearch)&, but there is no advantage in doing this.
8473
8474
8475
8476
8477 .subsection "Named lists" SECTnamedlists
8478 .cindex "named lists"
8479 .cindex "list" "named"
8480 A list of domains, hosts, email addresses, or local parts can be given a name
8481 which is then used to refer to the list elsewhere in the configuration. This is
8482 particularly convenient if the same list is required in several different
8483 places. It also allows lists to be given meaningful names, which can improve
8484 the readability of the configuration. For example, it is conventional to define
8485 a domain list called &'local_domains'& for all the domains that are handled
8486 locally on a host, using a configuration line such as
8487 .code
8488 domainlist local_domains = localhost:my.dom.example
8489 .endd
8490 Named lists are referenced by giving their name preceded by a plus sign, so,
8491 for example, a router that is intended to handle local domains would be
8492 configured with the line
8493 .code
8494 domains = +local_domains
8495 .endd
8496 The first router in a configuration is often one that handles all domains
8497 except the local ones, using a configuration with a negated item like this:
8498 .code
8499 dnslookup:
8500   driver = dnslookup
8501   domains = ! +local_domains
8502   transport = remote_smtp
8503   no_more
8504 .endd
8505 The four kinds of named list are created by configuration lines starting with
8506 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8507 respectively. Then there follows the name that you are defining, followed by an
8508 equals sign and the list itself. For example:
8509 .code
8510 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8511 addresslist bad_senders = cdb;/etc/badsenders
8512 .endd
8513 A named list may refer to other named lists:
8514 .code
8515 domainlist  dom1 = first.example : second.example
8516 domainlist  dom2 = +dom1 : third.example
8517 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8518 .endd
8519 &*Warning*&: If the last item in a referenced list is a negative one, the
8520 effect may not be what you intended, because the negation does not propagate
8521 out to the higher level. For example, consider:
8522 .code
8523 domainlist  dom1 = !a.b
8524 domainlist  dom2 = +dom1 : *.b
8525 .endd
8526 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8527 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8528 means it matches the second list as well. The effect is not the same as
8529 .code
8530 domainlist  dom2 = !a.b : *.b
8531 .endd
8532 where &'x.y'& does not match. It's best to avoid negation altogether in
8533 referenced lists if you can.
8534
8535 .cindex "hiding named list values"
8536 .cindex "named lists" "hiding value of"
8537 Some named list definitions may contain sensitive data, for example, passwords for
8538 accessing databases. To stop non-admin users from using the &%-bP%& command
8539 line option to read these values, you can precede the definition with the
8540 word &"hide"&. For example:
8541 .code
8542 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8543 .endd
8544
8545
8546 Named lists may have a performance advantage. When Exim is routing an
8547 address or checking an incoming message, it caches the result of tests on named
8548 lists. So, if you have a setting such as
8549 .code
8550 domains = +local_domains
8551 .endd
8552 on several of your routers
8553 or in several ACL statements,
8554 the actual test is done only for the first one. However, the caching works only
8555 if there are no expansions within the list itself or any sublists that it
8556 references. In other words, caching happens only for lists that are known to be
8557 the same each time they are referenced.
8558
8559 By default, there may be up to 16 named lists of each type. This limit can be
8560 extended by changing a compile-time variable. The use of domain and host lists
8561 is recommended for concepts such as local domains, relay domains, and relay
8562 hosts. The default configuration is set up like this.
8563
8564
8565
8566 .subsection "Named lists compared with macros" SECID78
8567 .cindex "list" "named compared with macro"
8568 .cindex "macro" "compared with named list"
8569 At first sight, named lists might seem to be no different from macros in the
8570 configuration file. However, macros are just textual substitutions. If you
8571 write
8572 .code
8573 ALIST = host1 : host2
8574 auth_advertise_hosts = !ALIST
8575 .endd
8576 it probably won't do what you want, because that is exactly the same as
8577 .code
8578 auth_advertise_hosts = !host1 : host2
8579 .endd
8580 Notice that the second host name is not negated. However, if you use a host
8581 list, and write
8582 .code
8583 hostlist alist = host1 : host2
8584 auth_advertise_hosts = ! +alist
8585 .endd
8586 the negation applies to the whole list, and so that is equivalent to
8587 .code
8588 auth_advertise_hosts = !host1 : !host2
8589 .endd
8590
8591
8592 .subsection "Named list caching" SECID79
8593 .cindex "list" "caching of named"
8594 .cindex "caching" "named lists"
8595 While processing a message, Exim caches the result of checking a named list if
8596 it is sure that the list is the same each time. In practice, this means that
8597 the cache operates only if the list contains no $ characters, which guarantees
8598 that it will not change when it is expanded. Sometimes, however, you may have
8599 an expanded list that you know will be the same each time within a given
8600 message. For example:
8601 .code
8602 domainlist special_domains = \
8603            ${lookup{$sender_host_address}cdb{/some/file}}
8604 .endd
8605 This provides a list of domains that depends only on the sending host's IP
8606 address. If this domain list is referenced a number of times (for example,
8607 in several ACL lines, or in several routers) the result of the check is not
8608 cached by default, because Exim does not know that it is going to be the
8609 same list each time.
8610
8611 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8612 cache the result anyway. For example:
8613 .code
8614 domainlist_cache special_domains = ${lookup{...
8615 .endd
8616 If you do this, you should be absolutely sure that caching is going to do
8617 the right thing in all cases. When in doubt, leave it out.
8618
8619
8620
8621 .section "Domain lists" "SECTdomainlist"
8622 .cindex "domain list" "patterns for"
8623 .cindex "list" "domain list"
8624 Domain lists contain patterns that are to be matched against a mail domain.
8625 The following types of item may appear in domain lists:
8626
8627 .ilist
8628 .cindex "primary host name"
8629 .cindex "host name" "matched in domain list"
8630 .oindex "&%primary_hostname%&"
8631 .cindex "domain list" "matching primary host name"
8632 .cindex "@ in a domain list"
8633 If a pattern consists of a single @ character, it matches the local host name,
8634 as set by the &%primary_hostname%& option (or defaulted). This makes it
8635 possible to use the same configuration file on several different hosts that
8636 differ only in their names.
8637
8638 The value for a match will be the primary host name.
8639
8640
8641 .next
8642 .cindex "@[] in a domain list"
8643 .cindex "domain list" "matching local IP interfaces"
8644 .cindex "domain literal"
8645 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8646 in square brackets (as in an email address that contains a domain literal), but
8647 only if that IP address is recognized as local for email routing purposes. The
8648 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8649 control which of a host's several IP addresses are treated as local.
8650 In today's Internet, the use of domain literals is controversial;
8651 see the &%allow_domain_literals%& main option.
8652
8653 The value for a match will be the string &`@[]`&.
8654
8655
8656 .next
8657 .cindex "@mx_any"
8658 .cindex "@mx_primary"
8659 .cindex "@mx_secondary"
8660 .cindex "domain list" "matching MX pointers to local host"
8661 If a pattern consists of the string &`@mx_any`& it matches any domain that
8662 has an MX record pointing to the local host or to any host that is listed in
8663 .oindex "&%hosts_treat_as_local%&"
8664 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8665 are similar, except that the first matches only when a primary MX target is the
8666 local host, and the second only when no primary MX target is the local host,
8667 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8668 preference value &-- there may of course be more than one of them.
8669
8670 The MX lookup that takes place when matching a pattern of this type is
8671 performed with the resolver options for widening names turned off. Thus, for
8672 example, a single-component domain will &'not'& be expanded by adding the
8673 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8674 options of the &(dnslookup)& router for a discussion of domain widening.
8675
8676 Sometimes you may want to ignore certain IP addresses when using one of these
8677 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8678 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8679 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8680 on a router). For example:
8681 .code
8682 domains = @mx_any/ignore=127.0.0.1
8683 .endd
8684 This example matches any domain that has an MX record pointing to one of
8685 the local host's IP addresses other than 127.0.0.1.
8686
8687 The list of IP addresses is in fact processed by the same code that processes
8688 host lists, so it may contain CIDR-coded network specifications and it may also
8689 contain negative items.
8690
8691 Because the list of IP addresses is a sublist within a domain list, you have to
8692 be careful about delimiters if there is more than one address. Like any other
8693 list, the default delimiter can be changed. Thus, you might have:
8694 .code
8695 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8696           an.other.domain : ...
8697 .endd
8698 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8699 involved, it is easiest to change the delimiter for the main list as well:
8700 .code
8701 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8702           an.other.domain ? ...
8703 .endd
8704 The value for a match will be the list element string (starting &`@mx_`&).
8705
8706
8707 .next
8708 .cindex "asterisk" "in domain list"
8709 .cindex "domain list" "asterisk in"
8710 .cindex "domain list" "matching &""ends with""&"
8711 If a pattern starts with an asterisk, the remaining characters of the pattern
8712 are compared with the terminating characters of the domain. The use of &"*"& in
8713 domain lists differs from its use in partial matching lookups. In a domain
8714 list, the character following the asterisk need not be a dot, whereas partial
8715 matching works only in terms of dot-separated components. For example, a domain
8716 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8717 &'cipher.key.ex'&.
8718
8719 The value for a match will be the list element string (starting with the asterisk).
8720 Additionally, &$0$& will be set to the matched string
8721 and &$1$& to the variable portion which the asterisk matched.
8722
8723 .next
8724 .cindex "regular expressions" "in domain list"
8725 .cindex "domain list" "matching regular expression"
8726 If a pattern starts with a circumflex character, it is treated as a regular
8727 expression, and matched against the domain using a regular expression matching
8728 function. The circumflex is treated as part of the regular expression.
8729 Email domains are case-independent, so this regular expression match is by
8730 default case-independent, but you can make it case-dependent by starting it
8731 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8732 are given in chapter &<<CHAPregexp>>&.
8733
8734 &*Warning*&: Because domain lists are expanded before being processed, you
8735 must escape any backslash and dollar characters in the regular expression, or
8736 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8737 it is not to be expanded (unless you really do want to build a regular
8738 expression by expansion, of course).
8739
8740 The value for a match will be the list element string (starting with the circumflex).
8741 Additionally, &$0$& will be set to the string matching the regular expression,
8742 and &$1$& (onwards) to any submatches identified by parentheses.
8743
8744
8745
8746 .next
8747 .cindex "lookup" "in domain list"
8748 .cindex "domain list" "matching by lookup"
8749 If a pattern starts with the name of a single-key lookup type followed by a
8750 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8751 must be a filename in a suitable format for the lookup type. For example, for
8752 &"cdb;"& it must be an absolute path:
8753 .code
8754 domains = cdb;/etc/mail/local_domains.cdb
8755 .endd
8756 The appropriate type of lookup is done on the file using the domain name as the
8757 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8758 only in whether or not the key is present in the file. However, when a lookup
8759 is used for the &%domains%& option on a router
8760 or a &%domains%& condition in an ACL statement, the value is preserved in the
8761 &$domain_data$& variable and can be referred to in other router options or
8762 other statements in the same ACL.
8763 .cindex "tainted data" "de-tainting"
8764 .cindex "de-tainting" "using ACL domains condition"
8765 The value will be untainted.
8766
8767 &*Note*&: If the data result of the lookup (as opposed to the key)
8768 is empty, then this empty value is stored in &$domain_data$&.
8769 The option to return the key for the lookup, as the value,
8770 may be what is wanted.
8771
8772
8773 .next
8774 Any of the single-key lookup type names may be preceded by
8775 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8776 .code
8777 domains = partial-dbm;/partial/domains
8778 .endd
8779 This causes partial matching logic to be invoked; a description of how this
8780 works is given in section &<<SECTpartiallookup>>&.
8781
8782 .next
8783 .cindex "asterisk" "in lookup type"
8784 Any of the single-key lookup types may be followed by an asterisk. This causes
8785 a default lookup for a key consisting of a single asterisk to be done if the
8786 original lookup fails. This is not a useful feature when using a domain list to
8787 select particular domains (because any domain would match), but it might have
8788 value if the result of the lookup is being used via the &$domain_data$&
8789 expansion variable.
8790
8791 .next
8792 If the pattern starts with the name of a query-style lookup type followed by a
8793 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8794 pattern must be an appropriate query for the lookup type, as described in
8795 chapter &<<CHAPfdlookup>>&. For example:
8796 .code
8797 hold_domains = mysql;select domain from holdlist \
8798   where domain = '${quote_mysql:$domain}';
8799 .endd
8800 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8801 example, it doesn't matter what field you select). Exim is interested only in
8802 whether or not the query succeeds. However, when a lookup is used for the
8803 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8804 variable and can be referred to in other options.
8805 .cindex "tainted data" "de-tainting"
8806 .cindex "de-tainting" "using router domains option"
8807 The value will be untainted.
8808
8809 .next
8810 If the pattern starts with the name of a lookup type
8811 of either kind (single-key or query-style) it may be
8812 followed by a comma and options,
8813 The options are lookup-type specific and consist of a comma-separated list.
8814 Each item starts with a tag and and equals "=" sign.
8815
8816 .next
8817 .cindex "domain list" "matching literal domain name"
8818 If none of the above cases apply, a caseless textual comparison is made
8819 between the pattern and the domain.
8820
8821 The value for a match will be the list element string.
8822 .cindex "tainted data" "de-tainting"
8823 Note that this is commonly untainted
8824 (depending on the way the list was created).
8825 Specifically, explicit text in the configuration file in not tainted.
8826 This is a useful way of obtaining an untainted equivalent to
8827 the domain, for later operations.
8828
8829 However if the list (including one-element lists)
8830 is created by expanding a variable containing tainted data,
8831 it is tainted and so will the match value be.
8832 .endlist
8833
8834
8835 Here is an example that uses several different kinds of pattern:
8836 .code
8837 domainlist funny_domains = \
8838   @ : \
8839   lib.unseen.edu : \
8840   *.foundation.fict.example : \
8841   \N^[1-2]\d{3}\.fict\.example$\N : \
8842   partial-dbm;/opt/data/penguin/book : \
8843   nis;domains.byname : \
8844   nisplus;[name=$domain,status=local],domains.org_dir
8845 .endd
8846 There are obvious processing trade-offs among the various matching modes. Using
8847 an asterisk is faster than a regular expression, and listing a few names
8848 explicitly probably is too. The use of a file or database lookup is expensive,
8849 but may be the only option if hundreds of names are required. Because the
8850 patterns are tested in order, it makes sense to put the most commonly matched
8851 patterns earlier.
8852
8853
8854
8855 .section "Host lists" "SECThostlist"
8856 .cindex "host list" "patterns in"
8857 .cindex "list" "host list"
8858 Host lists are used to control what remote hosts are allowed to do. For
8859 example, some hosts may be allowed to use the local host as a relay, and some
8860 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8861 two different ways, by name or by IP address. In a host list, some types of
8862 pattern are matched to a host name, and some are matched to an IP address.
8863 You need to be particularly careful with this when single-key lookups are
8864 involved, to ensure that the right value is being used as the key.
8865
8866
8867 .subsection "Special host list patterns" SECID80
8868 .cindex "empty item in hosts list"
8869 .cindex "host list" "empty string in"
8870 If a host list item is the empty string, it matches only when no remote host is
8871 involved. This is the case when a message is being received from a local
8872 process using SMTP on the standard input, that is, when a TCP/IP connection is
8873 not used.
8874
8875 .cindex "asterisk" "in host list"
8876 The special pattern &"*"& in a host list matches any host or no host. Neither
8877 the IP address nor the name is actually inspected.
8878
8879
8880
8881 .subsection "Host list patterns that match by IP address" SECThoslispatip
8882 .cindex "host list" "matching IP addresses"
8883 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8884 the incoming address actually appears in the IPv6 host as
8885 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8886 list, it is converted into a traditional IPv4 address first. (Not all operating
8887 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8888 concerns.)
8889
8890 The following types of pattern in a host list check the remote host by
8891 inspecting its IP address:
8892
8893 .ilist
8894 If the pattern is a plain domain name (not a regular expression, not starting
8895 with *, not a lookup of any kind), Exim calls the operating system function
8896 to find the associated IP address(es). Exim uses the newer
8897 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8898 This typically causes a forward DNS lookup of the name. The result is compared
8899 with the IP address of the subject host.
8900
8901 If there is a temporary problem (such as a DNS timeout) with the host name
8902 lookup, a temporary error occurs. For example, if the list is being used in an
8903 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8904 temporary SMTP error code. If no IP address can be found for the host name,
8905 what happens is described in section &<<SECTbehipnot>>& below.
8906
8907 .next
8908 .cindex "@ in a host list"
8909 If the pattern is &"@"&, the primary host name is substituted and used as a
8910 domain name, as just described.
8911
8912 .next
8913 If the pattern is an IP address, it is matched against the IP address of the
8914 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8915 IPv6 addresses can be given in colon-separated format, but the colons have to
8916 be doubled so as not to be taken as item separators when the default list
8917 separator is used. IPv6 addresses are recognized even when Exim is compiled
8918 without IPv6 support. This means that if they appear in a host list on an
8919 IPv4-only host, Exim will not treat them as host names. They are just addresses
8920 that can never match a client host.
8921
8922 .next
8923 .cindex "@[] in a host list"
8924 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8925 the local host. For example, if the local host is an IPv4 host with one
8926 interface address 10.45.23.56, these two ACL statements have the same effect:
8927 .code
8928 accept hosts = 127.0.0.1 : 10.45.23.56
8929 accept hosts = @[]
8930 .endd
8931 .next
8932 .cindex "CIDR notation"
8933 If the pattern is an IP address followed by a slash and a mask length, for
8934 example
8935 .code
8936 10.11.42.0/24
8937 .endd
8938 , it is matched against the IP address of the subject
8939 host under the given mask. This allows an entire network of hosts to be
8940 included (or excluded) by a single item. The mask uses CIDR notation; it
8941 specifies the number of address bits that must match, starting from the most
8942 significant end of the address.
8943
8944 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8945 of a range of addresses. It is the number of bits in the network portion of the
8946 address. The above example specifies a 24-bit netmask, so it matches all 256
8947 addresses in the 10.11.42.0 network. An item such as
8948 .code
8949 192.168.23.236/31
8950 .endd
8951 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8952 32 for an IPv4 address is the same as no mask at all; just a single address
8953 matches.
8954
8955 Here is another example which shows an IPv4 and an IPv6 network:
8956 .code
8957 recipient_unqualified_hosts = 192.168.0.0/16: \
8958                               3ffe::ffff::836f::::/48
8959 .endd
8960 The doubling of list separator characters applies only when these items
8961 appear inline in a host list. It is not required when indirecting via a file.
8962 For example:
8963 .code
8964 recipient_unqualified_hosts = /opt/exim/unqualnets
8965 .endd
8966 could make use of a file containing
8967 .code
8968 172.16.0.0/12
8969 3ffe:ffff:836f::/48
8970 .endd
8971 to have exactly the same effect as the previous example. When listing IPv6
8972 addresses inline, it is usually more convenient to use the facility for
8973 changing separator characters. This list contains the same two networks:
8974 .code
8975 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8976                                  3ffe:ffff:836f::/48
8977 .endd
8978 The separator is changed to semicolon by the leading &"<;"& at the start of the
8979 list.
8980 .endlist
8981
8982
8983
8984 .subsection "Host list patterns for single-key lookups by host address" &&&
8985          SECThoslispatsikey
8986 .cindex "host list" "lookup of IP address"
8987 When a host is to be identified by a single-key lookup of its complete IP
8988 address, the pattern takes this form:
8989 .display
8990 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8991 .endd
8992 For example:
8993 .code
8994 hosts_lookup = net-cdb;/hosts-by-ip.db
8995 .endd
8996 The text form of the IP address of the subject host is used as the lookup key.
8997 IPv6 addresses are converted to an unabbreviated form, using lower case
8998 letters, with dots as separators because colon is the key terminator in
8999 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9000 quoting the keys, but this is a facility that was added later.] The data
9001 returned by the lookup is not used.
9002
9003 .cindex "IP address" "masking"
9004 .cindex "host list" "masked IP address"
9005 Single-key lookups can also be performed using masked IP addresses, using
9006 patterns of this form:
9007 .display
9008 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9009 .endd
9010 For example:
9011 .code
9012 net24-dbm;/networks.db
9013 .endd
9014 The IP address of the subject host is masked using <&'number'&> as the mask
9015 length. A textual string is constructed from the masked value, followed by the
9016 mask, and this is used as the lookup key. For example, if the host's IP address
9017 is 192.168.34.6, the key that is looked up for the above example is
9018 &"192.168.34.0/24"&.
9019
9020 When an IPv6 address is converted to a string, dots are normally used instead
9021 of colons, so that keys in &(lsearch)& files need not contain colons (which
9022 terminate &(lsearch)& keys). This was implemented some time before the ability
9023 to quote keys was made available in &(lsearch)& files. However, the more
9024 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9025 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9026 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9027 converted using colons and not dots.
9028 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9029 addresses are always used.
9030 The latter are converted to IPv4 addresses, in dotted-quad form.
9031
9032 Ideally, it would be nice to tidy up this anomalous situation by changing to
9033 colons in all cases, given that quoting is now available for &(lsearch)&.
9034 However, this would be an incompatible change that might break some existing
9035 configurations.
9036
9037 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9038 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9039 the former case the key strings include the mask value, whereas in the latter
9040 case the IP address is used on its own.
9041
9042
9043
9044 .subsection "Host list patterns that match by host name" SECThoslispatnam
9045 .cindex "host" "lookup failures"
9046 .cindex "unknown host name"
9047 .cindex "host list" "matching host name"
9048 There are several types of pattern that require Exim to know the name of the
9049 remote host. These are either wildcard patterns or lookups by name. (If a
9050 complete hostname is given without any wildcarding, it is used to find an IP
9051 address to match against, as described in section &<<SECThoslispatip>>&
9052 above.)
9053
9054 If the remote host name is not already known when Exim encounters one of these
9055 patterns, it has to be found from the IP address.
9056 Although many sites on the Internet are conscientious about maintaining reverse
9057 DNS data for their hosts, there are also many that do not do this.
9058 Consequently, a name cannot always be found, and this may lead to unwanted
9059 effects. Take care when configuring host lists with wildcarded name patterns.
9060 Consider what will happen if a name cannot be found.
9061
9062 Because of the problems of determining host names from IP addresses, matching
9063 against host names is not as common as matching against IP addresses.
9064
9065 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9066 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9067 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9068 are done can be changed by setting the &%host_lookup_order%& option. For
9069 security, once Exim has found one or more names, it looks up the IP addresses
9070 for these names and compares them with the IP address that it started with.
9071 Only those names whose IP addresses match are accepted. Any other names are
9072 discarded. If no names are left, Exim behaves as if the host name cannot be
9073 found. In the most common case there is only one name and one IP address.
9074
9075 There are some options that control what happens if a host name cannot be
9076 found. These are described in section &<<SECTbehipnot>>& below.
9077
9078 .cindex "host" "alias for"
9079 .cindex "alias for host"
9080 As a result of aliasing, hosts may have more than one name. When processing any
9081 of the following types of pattern, all the host's names are checked:
9082
9083 .ilist
9084 .cindex "asterisk" "in host list"
9085 If a pattern starts with &"*"& the remainder of the item must match the end of
9086 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9087 &'.b.c'&. This special simple form is provided because this is a very common
9088 requirement. Other kinds of wildcarding require the use of a regular
9089 expression.
9090 .next
9091 .cindex "regular expressions" "in host list"
9092 .cindex "host list" "regular expression in"
9093 If the item starts with &"^"& it is taken to be a regular expression which is
9094 matched against the host name. Host names are case-independent, so this regular
9095 expression match is by default case-independent, but you can make it
9096 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9097 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9098 example,
9099 .code
9100 ^(a|b)\.c\.d$
9101 .endd
9102 is a regular expression that matches either of the two hosts &'a.c.d'& or
9103 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9104 that backslash and dollar characters are not misinterpreted as part of the
9105 string expansion. The simplest way to do this is to use &`\N`& to mark that
9106 part of the string as non-expandable. For example:
9107 .code
9108 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9109 .endd
9110 &*Warning*&: If you want to match a complete host name, you must include the
9111 &`$`& terminating metacharacter in the regular expression, as in the above
9112 example. Without it, a match at the start of the host name is all that is
9113 required.
9114 .endlist
9115
9116
9117
9118
9119 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9120 .cindex "host" "lookup failures, permanent"
9121 While processing a host list, Exim may need to look up an IP address from a
9122 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9123 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9124 behaviour when it fails to find the information it is seeking is the same.
9125
9126 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9127 apply to temporary DNS errors, whose handling is described in the next section.
9128
9129 .cindex "&`+include_unknown`&"
9130 .cindex "&`+ignore_unknown`&"
9131 Exim parses a host list from left to right. If it encounters a permanent
9132 lookup failure in any item in the host list before it has found a match,
9133 Exim treats it as a failure and the default behavior is as if the host
9134 does not match the list. This may not always be what you want to happen.
9135 To change Exim's behaviour, the special items &`+include_unknown`& or
9136 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9137 not recognized in an indirected file).
9138
9139 .ilist
9140 If any item that follows &`+include_unknown`& requires information that
9141 cannot found, Exim behaves as if the host does match the list. For example,
9142 .code
9143 host_reject_connection = +include_unknown:*.enemy.ex
9144 .endd
9145 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9146 any hosts whose name it cannot find.
9147
9148 .next
9149 If any item that follows &`+ignore_unknown`& requires information that cannot
9150 be found, Exim ignores that item and proceeds to the rest of the list. For
9151 example:
9152 .code
9153 accept hosts = +ignore_unknown : friend.example : \
9154                192.168.4.5
9155 .endd
9156 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9157 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9158 name can be found for 192.168.4.5, it is rejected.
9159 .endlist
9160
9161 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9162 list. The effect of each one lasts until the next, or until the end of the
9163 list.
9164
9165 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9166          SECTmixwilhos
9167 .cindex "host list" "mixing names and addresses in"
9168
9169 This section explains the host/ip processing logic with the same concepts
9170 as the previous section, but specifically addresses what happens when a
9171 wildcarded hostname is one of the items in the hostlist.
9172
9173 .ilist
9174 If you have name lookups or wildcarded host names and
9175 IP addresses in the same host list, you should normally put the IP
9176 addresses first. For example, in an ACL you could have:
9177 .code
9178 accept hosts = 10.9.8.7 : *.friend.example
9179 .endd
9180 The reason you normally would order it this way lies in the
9181 left-to-right way that Exim processes lists.  It can test IP addresses
9182 without doing any DNS lookups, but when it reaches an item that requires
9183 a host name, it fails if it cannot find a host name to compare with the
9184 pattern. If the above list is given in the opposite order, the
9185 &%accept%& statement fails for a host whose name cannot be found, even
9186 if its IP address is 10.9.8.7.
9187
9188 .next
9189 If you really do want to do the name check first, and still recognize the IP
9190 address, you can rewrite the ACL like this:
9191 .code
9192 accept hosts = *.friend.example
9193 accept hosts = 10.9.8.7
9194 .endd
9195 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9196 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9197 &`+ignore_unknown`&, which was discussed in depth in the first example in
9198 this section.
9199 .endlist
9200
9201
9202 .subsection "Temporary DNS errors when looking up host information" &&&
9203          SECTtemdnserr
9204 .cindex "host" "lookup failures, temporary"
9205 .cindex "&`+include_defer`&"
9206 .cindex "&`+ignore_defer`&"
9207 A temporary DNS lookup failure normally causes a defer action (except when
9208 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9209 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9210 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9211 section. These options should be used with care, probably only in non-critical
9212 host lists such as whitelists.
9213
9214
9215
9216 .subsection "Host list patterns for single-key lookups by host name" &&&
9217          SECThoslispatnamsk
9218 .cindex "unknown host name"
9219 .cindex "host list" "matching host name"
9220 If a pattern is of the form
9221 .display
9222 <&'single-key-search-type'&>;<&'search-data'&>
9223 .endd
9224 for example
9225 .code
9226 dbm;/host/accept/list
9227 .endd
9228 a single-key lookup is performed, using the host name as its key. If the
9229 lookup succeeds, the host matches the item. The actual data that is looked up
9230 is not used.
9231
9232 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9233 keys in the file, not IP addresses. If you want to do lookups based on IP
9234 addresses, you must precede the search type with &"net-"& (see section
9235 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9236 two items in the same list, one doing an address lookup and one doing a name
9237 lookup, both using the same file.
9238
9239
9240
9241 .subsection "Host list patterns for query-style lookups" SECID81
9242 If a pattern is of the form
9243 .display
9244 <&'query-style-search-type'&>;<&'query'&>
9245 .endd
9246 the query is obeyed, and if it succeeds, the host matches the item. The actual
9247 data that is looked up is not used. The variables &$sender_host_address$& and
9248 &$sender_host_name$& can be used in the query. For example:
9249 .code
9250 hosts_lookup = pgsql;\
9251   select ip from hostlist where ip='$sender_host_address'
9252 .endd
9253 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9254 can use the &%sg%& expansion item to change this if you need to. If you want to
9255 use masked IP addresses in database queries, you can use the &%mask%& expansion
9256 operator.
9257
9258 If the query contains a reference to &$sender_host_name$&, Exim automatically
9259 looks up the host name if it has not already done so. (See section
9260 &<<SECThoslispatnam>>& for comments on finding host names.)
9261
9262 Historical note: prior to release 4.30, Exim would always attempt to find a
9263 host name before running the query, unless the search type was preceded by
9264 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9265 still recognized for query-style lookups, but its presence or absence has no
9266 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9267 See section &<<SECThoslispatsikey>>&.)
9268
9269
9270
9271
9272
9273 .section "Address lists" "SECTaddresslist"
9274 .cindex "list" "address list"
9275 .cindex "address list" "empty item"
9276 .cindex "address list" "patterns"
9277 Address lists contain patterns that are matched against mail addresses. There
9278 is one special case to be considered: the sender address of a bounce message is
9279 always empty. You can test for this by providing an empty item in an address
9280 list. For example, you can set up a router to process bounce messages by
9281 using this option setting:
9282 .code
9283 senders = :
9284 .endd
9285 The presence of the colon creates an empty item. If you do not provide any
9286 data, the list is empty and matches nothing. The empty sender can also be
9287 detected by a regular expression that matches an empty string,
9288 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9289
9290 Non-empty items in an address list can be straightforward email addresses. For
9291 example:
9292 .code
9293 senders = jbc@askone.example : hs@anacreon.example
9294 .endd
9295 A certain amount of wildcarding is permitted. If a pattern contains an @
9296 character, but is not a regular expression and does not begin with a
9297 semicolon-terminated lookup type (described below), the local part of the
9298 subject address is compared with the local part of the pattern, which may start
9299 with an asterisk. If the local parts match, the domain is checked in exactly
9300 the same way as for a pattern in a domain list. For example, the domain can be
9301 wildcarded, refer to a named list, or be a lookup:
9302 .code
9303 deny senders = *@*.spamming.site:\
9304                *@+hostile_domains:\
9305                bozo@partial-lsearch;/list/of/dodgy/sites:\
9306                *@dbm;/bad/domains.db
9307 .endd
9308 .cindex "local part" "starting with !"
9309 .cindex "address list" "local part starting with !"
9310 If a local part that begins with an exclamation mark is required, it has to be
9311 specified using a regular expression, because otherwise the exclamation mark is
9312 treated as a sign of negation, as is standard in lists.
9313
9314 If a non-empty pattern that is not a regular expression or a lookup does not
9315 contain an @ character, it is matched against the domain part of the subject
9316 address. The only two formats that are recognized this way are a literal
9317 domain, or a domain pattern that starts with *. In both these cases, the effect
9318 is the same as if &`*@`& preceded the pattern. For example:
9319 .code
9320 deny senders = enemy.domain : *.enemy.domain
9321 .endd
9322
9323 The following kinds of more complicated address list pattern can match any
9324 address, including the empty address that is characteristic of bounce message
9325 senders:
9326
9327 .ilist
9328 .cindex "regular expressions" "in address list"
9329 .cindex "address list" "regular expression in"
9330 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9331 done against the complete address, with the pattern as the regular expression.
9332 You must take care that backslash and dollar characters are not misinterpreted
9333 as part of the string expansion. The simplest way to do this is to use &`\N`&
9334 to mark that part of the string as non-expandable. For example:
9335 .code
9336 deny senders = \N^.*this.*@example\.com$\N : \
9337                \N^\d{8}.+@spamhaus.example$\N : ...
9338 .endd
9339 The &`\N`& sequences are removed by the expansion, so these items do indeed
9340 start with &"^"& by the time they are being interpreted as address patterns.
9341
9342 .next
9343 .cindex "address list" "lookup for complete address"
9344 Complete addresses can be looked up by using a pattern that starts with a
9345 lookup type terminated by a semicolon, followed by the data for the lookup. For
9346 example:
9347 .code
9348 deny senders = cdb;/etc/blocked.senders : \
9349   mysql;select address from blocked where \
9350   address='${quote_mysql:$sender_address}'
9351 .endd
9352 Both query-style and single-key lookup types can be used. For a single-key
9353 lookup type, Exim uses the complete address as the key. However, empty keys are
9354 not supported for single-key lookups, so a match against the empty address
9355 always fails. This restriction does not apply to query-style lookups.
9356
9357 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9358 cannot be used, and is ignored if specified, with an entry being written to the
9359 panic log.
9360 .cindex "*@ with single-key lookup"
9361 However, you can configure lookup defaults, as described in section
9362 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9363 default. For example, with this lookup:
9364 .code
9365 accept senders = lsearch*@;/some/file
9366 .endd
9367 the file could contains lines like this:
9368 .code
9369 user1@domain1.example
9370 *@domain2.example
9371 .endd
9372 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9373 that are tried is:
9374 .code
9375 nimrod@jaeger.example
9376 *@jaeger.example
9377 *
9378 .endd
9379 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9380 would mean that every address matches, thus rendering the test useless.
9381
9382 &*Warning 2*&: Do not confuse these two kinds of item:
9383 .code
9384 deny recipients = dbm*@;/some/file
9385 deny recipients = *@dbm;/some/file
9386 .endd
9387 The first does a whole address lookup, with defaulting, as just described,
9388 because it starts with a lookup type. The second matches the local part and
9389 domain independently, as described in a bullet point below.
9390 .endlist
9391
9392
9393 The following kinds of address list pattern can match only non-empty addresses.
9394 If the subject address is empty, a match against any of these pattern types
9395 always fails.
9396
9397
9398 .ilist
9399 .cindex "@@ with single-key lookup"
9400 .cindex "address list" "@@ lookup type"
9401 .cindex "address list" "split local part and domain"
9402 If a pattern starts with &"@@"& followed by a single-key lookup item
9403 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9404 split into a local part and a domain. The domain is looked up in the file. If
9405 it is not found, there is no match. If it is found, the data that is looked up
9406 from the file is treated as a colon-separated list of local part patterns, each
9407 of which is matched against the subject local part in turn.
9408
9409 .cindex "asterisk" "in address list"
9410 The lookup may be a partial one, and/or one involving a search for a default
9411 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9412 patterns that are looked up can be regular expressions or begin with &"*"&, or
9413 even be further lookups. They may also be independently negated. For example,
9414 with
9415 .code
9416 deny senders = @@dbm;/etc/reject-by-domain
9417 .endd
9418 the data from which the DBM file is built could contain lines like
9419 .code
9420 baddomain.com:  !postmaster : *
9421 .endd
9422 to reject all senders except &%postmaster%& from that domain.
9423
9424 .cindex "local part" "starting with !"
9425 If a local part that actually begins with an exclamation mark is required, it
9426 has to be specified using a regular expression. In &(lsearch)& files, an entry
9427 may be split over several lines by indenting the second and subsequent lines,
9428 but the separating colon must still be included at line breaks. White space
9429 surrounding the colons is ignored. For example:
9430 .code
9431 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9432   spammer3 : spammer4
9433 .endd
9434 As in all colon-separated lists in Exim, a colon can be included in an item by
9435 doubling.
9436
9437 If the last item in the list starts with a right angle-bracket, the remainder
9438 of the item is taken as a new key to look up in order to obtain a continuation
9439 list of local parts. The new key can be any sequence of characters. Thus one
9440 might have entries like
9441 .code
9442 aol.com: spammer1 : spammer 2 : >*
9443 xyz.com: spammer3 : >*
9444 *:       ^\d{8}$
9445 .endd
9446 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9447 local parts for all domains, in addition to the specific local parts listed for
9448 each domain. Of course, using this feature costs another lookup each time a
9449 chain is followed, but the effort needed to maintain the data is reduced.
9450
9451 .cindex "loop" "in lookups"
9452 It is possible to construct loops using this facility, and in order to catch
9453 them, the chains may be no more than fifty items long.
9454
9455 .next
9456 The @@<&'lookup'&> style of item can also be used with a query-style
9457 lookup, but in this case, the chaining facility is not available. The lookup
9458 can only return a single list of local parts.
9459 .endlist
9460
9461 &*Warning*&: There is an important difference between the address list items
9462 in these two examples:
9463 .code
9464 senders = +my_list
9465 senders = *@+my_list
9466 .endd
9467 In the first one, &`my_list`& is a named address list, whereas in the second
9468 example it is a named domain list.
9469
9470
9471
9472
9473 .subsection "Case of letters in address lists" SECTcasletadd
9474 .cindex "case of local parts"
9475 .cindex "address list" "case forcing"
9476 .cindex "case forcing in address lists"
9477 Domains in email addresses are always handled caselessly, but for local parts
9478 case may be significant on some systems (see &%caseful_local_part%& for how
9479 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9480 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9481 blocking lists should be done in a case-independent manner. Since most address
9482 lists in Exim are used for this kind of control, Exim attempts to do this by
9483 default.
9484
9485 The domain portion of an address is always lowercased before matching it to an
9486 address list. The local part is lowercased by default, and any string
9487 comparisons that take place are done caselessly. This means that the data in
9488 the address list itself, in files included as plain filenames, and in any file
9489 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9490 keys in files that are looked up by a search type other than &(lsearch)& (which
9491 works caselessly) must be in lower case, because these lookups are not
9492 case-independent.
9493
9494 .cindex "&`+caseful`&"
9495 To allow for the possibility of caseful address list matching, if an item in
9496 an address list is the string &"+caseful"&, the original case of the local
9497 part is restored for any comparisons that follow, and string comparisons are no
9498 longer case-independent. This does not affect the domain, which remains in
9499 lower case. However, although independent matches on the domain alone are still
9500 performed caselessly, regular expressions that match against an entire address
9501 become case-sensitive after &"+caseful"& has been seen.
9502
9503
9504
9505 .section "Local part lists" "SECTlocparlis"
9506 .cindex "list" "local part list"
9507 .cindex "local part" "list"
9508 These behave in the same way as domain and host lists, with the following
9509 changes:
9510
9511 Case-sensitivity in local part lists is handled in the same way as for address
9512 lists, as just described. The &"+caseful"& item can be used if required. In a
9513 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9514 set false, the subject is lowercased and the matching is initially
9515 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9516 matching in the local part list, but not elsewhere in the router. If
9517 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9518 option is case-sensitive from the start.
9519
9520 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9521 comments are handled in the same way as address lists &-- they are recognized
9522 only if the # is preceded by white space or the start of the line.
9523 Otherwise, local part lists are matched in the same way as domain lists, except
9524 that the special items that refer to the local host (&`@`&, &`@[]`&,
9525 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9526 Refer to section &<<SECTdomainlist>>& for details of the other available item
9527 types.
9528 .ecindex IIDdohoadli
9529
9530
9531
9532
9533 . ////////////////////////////////////////////////////////////////////////////
9534 . ////////////////////////////////////////////////////////////////////////////
9535
9536 .chapter "String expansions" "CHAPexpand"
9537 .scindex IIDstrexp "expansion" "of strings"
9538 Many strings in Exim's runtime configuration are expanded before use. Some of
9539 them are expanded every time they are used; others are expanded only once.
9540
9541 When a string is being expanded it is copied verbatim from left to right except
9542 .cindex expansion "string concatenation"
9543 when a dollar or backslash character is encountered. A dollar specifies the
9544 start of a portion of the string that is interpreted and replaced as described
9545 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9546 escape character, as described in the following section.
9547
9548 Whether a string is expanded depends upon the context.  Usually this is solely
9549 dependent upon the option for which a value is sought; in this documentation,
9550 options for which string expansion is performed are marked with &dagger; after
9551 the data type.  ACL rules always expand strings.  A couple of expansion
9552 conditions do not expand some of the brace-delimited branches, for security
9553 reasons,
9554 .cindex "tainted data" expansion
9555 .cindex "tainted data" definition
9556 .cindex expansion "tainted data"
9557 and expansion of data deriving from the sender (&"tainted data"&)
9558 is not permitted (including acessing a file using a tainted name).
9559
9560 Common ways of obtaining untainted equivalents of variables with
9561 tainted values
9562 .cindex "tainted data" "de-tainting"
9563 come down to using the tainted value as a lookup key in a trusted database.
9564 This database could be the filesystem structure,
9565 or the password file,
9566 or accessed via a DBMS.
9567 Specific methods are indexed under &"de-tainting"&.
9568
9569
9570
9571 .section "Literal text in expanded strings" "SECTlittext"
9572 .cindex "expansion" "including literal text"
9573 An uninterpreted dollar can be included in an expanded string by putting a
9574 backslash in front of it. A backslash can be used to prevent any special
9575 character being treated specially in an expansion, including backslash itself.
9576 If the string appears in quotes in the configuration file, two backslashes are
9577 required because the quotes themselves cause interpretation of backslashes when
9578 the string is read in (see section &<<SECTstrings>>&).
9579
9580 .cindex "expansion" "non-expandable substrings"
9581 A portion of the string can specified as non-expandable by placing it between
9582 two occurrences of &`\N`&. This is particularly useful for protecting regular
9583 expressions, which often contain backslashes and dollar signs. For example:
9584 .code
9585 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9586 .endd
9587 On encountering the first &`\N`&, the expander copies subsequent characters
9588 without interpretation until it reaches the next &`\N`& or the end of the
9589 string.
9590
9591
9592
9593 .section "Character escape sequences in expanded strings" "SECID82"
9594 .cindex "expansion" "escape sequences"
9595 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9596 expanded string is recognized as an escape sequence for the character newline,
9597 carriage return, or tab, respectively. A backslash followed by up to three
9598 octal digits is recognized as an octal encoding for a single character, and a
9599 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9600 encoding.
9601
9602 These escape sequences are also recognized in quoted strings when they are read
9603 in. Their interpretation in expansions as well is useful for unquoted strings,
9604 and for other cases such as looked-up strings that are then expanded.
9605
9606
9607 .section "Testing string expansions" "SECID83"
9608 .cindex "expansion" "testing"
9609 .cindex "testing" "string expansion"
9610 .oindex "&%-be%&"
9611 Many expansions can be tested by calling Exim with the &%-be%& option. This
9612 takes the command arguments, or lines from the standard input if there are no
9613 arguments, runs them through the string expansion code, and writes the results
9614 to the standard output. Variables based on configuration values are set up, but
9615 since no message is being processed, variables such as &$local_part$& have no
9616 value. Nevertheless the &%-be%& option can be useful for checking out file and
9617 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9618 and &%nhash%&.
9619
9620 .new
9621 When reading lines from the standard input,
9622 macros can be defined and ACL variables can be set.
9623 For example:
9624 .code
9625 MY_MACRO = foo
9626 set acl_m_myvar = bar
9627 .endd
9628 Such macros and variables can then be used in later input lines.
9629 .wen
9630
9631 Exim gives up its root privilege when it is called with the &%-be%& option, and
9632 instead runs under the uid and gid it was called with, to prevent users from
9633 using &%-be%& for reading files to which they do not have access.
9634
9635 .oindex "&%-bem%&"
9636 If you want to test expansions that include variables whose values are taken
9637 from a message, there are two other options that can be used. The &%-bem%&
9638 option is like &%-be%& except that it is followed by a filename. The file is
9639 read as a message before doing the test expansions. For example:
9640 .code
9641 exim -bem /tmp/test.message '$h_subject:'
9642 .endd
9643 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9644 Exim message identifier. For example:
9645 .code
9646 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9647 .endd
9648 This loads the message from Exim's spool before doing the test expansions, and
9649 is therefore restricted to admin users.
9650
9651
9652 .section "Forced expansion failure" "SECTforexpfai"
9653 .cindex "expansion" "forced failure"
9654 A number of expansions that are described in the following section have
9655 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9656 (which are sometimes called &"curly brackets"&). Which of the two strings is
9657 used depends on some condition that is evaluated as part of the expansion. If,
9658 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9659 the entire string expansion fails in a way that can be detected by the code
9660 that requested the expansion. This is called &"forced expansion failure"&, and
9661 its consequences depend on the circumstances. In some cases it is no different
9662 from any other expansion failure, but in others a different action may be
9663 taken. Such variations are mentioned in the documentation of the option that is
9664 being expanded.
9665
9666
9667
9668
9669 .section "Expansion items" "SECTexpansionitems"
9670 The following items are recognized in expanded strings. White space may be used
9671 between sub-items that are keywords or substrings enclosed in braces inside an
9672 outer set of braces, to improve readability. &*Warning*&: Within braces,
9673 white space is significant.
9674
9675 .vlist
9676 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9677 .cindex "expansion" "variables"
9678 Substitute the contents of the named variable, for example:
9679 .code
9680 $local_part
9681 ${domain}
9682 .endd
9683 The second form can be used to separate the name from subsequent alphanumeric
9684 characters. This form (using braces) is available only for variables; it does
9685 &'not'& apply to message headers. The names of the variables are given in
9686 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9687 given, the expansion fails.
9688
9689 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9690 .cindex "expansion" "operators"
9691 The string is first itself expanded, and then the operation specified by
9692 <&'op'&> is applied to it. For example:
9693 .code
9694 ${lc:$local_part}
9695 .endd
9696 The string starts with the first character after the colon, which may be
9697 leading white space. A list of operators is given in section &<<SECTexpop>>&
9698 below. The operator notation is used for simple expansion items that have just
9699 one argument, because it reduces the number of braces and therefore makes the
9700 string easier to understand.
9701
9702 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9703 This item inserts &"basic"& header lines. It is described with the &%header%&
9704 expansion item below.
9705
9706
9707 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9708 .cindex "expansion" "calling an acl"
9709 .cindex "&%acl%&" "call from expansion"
9710 The name and zero to nine argument strings are first expanded separately.  The expanded
9711 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9712 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9713 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9714 and may use the variables; if another acl expansion is used the values
9715 are restored after it returns.  If the ACL sets
9716 a value using a "message =" modifier and returns accept or deny, the value becomes
9717 the result of the expansion.
9718 If no message is set and the ACL returns accept or deny
9719 the expansion result is an empty string.
9720 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9721
9722
9723 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9724 .cindex authentication "results header"
9725 .chindex Authentication-Results:
9726 .cindex authentication "expansion item"
9727 This item returns a string suitable for insertion as an
9728 &'Authentication-Results:'&
9729 header line.
9730 The given <&'authserv-id'&> is included in the result; typically this
9731 will be a domain name identifying the system performing the authentications.
9732 Methods that might be present in the result include:
9733 .code
9734 none
9735 iprev
9736 auth
9737 spf
9738 dkim
9739 .endd
9740
9741 Example use (as an ACL modifier):
9742 .code
9743       add_header = :at_start:${authresults {$primary_hostname}}
9744 .endd
9745 This is safe even if no authentication results are available
9746 .new
9747 and would generally be placed in the DATA ACL.
9748 .wen
9749
9750
9751 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9752        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9753 .cindex "expansion" "extracting certificate fields"
9754 .cindex "&%certextract%&" "certificate fields"
9755 .cindex "certificate" "extracting fields"
9756 The <&'certificate'&> must be a variable of type certificate.
9757 The field name is expanded and used to retrieve the relevant field from
9758 the certificate.  Supported fields are:
9759 .display
9760 &`version        `&
9761 &`serial_number  `&
9762 &`subject        `& RFC4514 DN
9763 &`issuer         `& RFC4514 DN
9764 &`notbefore      `& time
9765 &`notafter       `& time
9766 &`sig_algorithm  `&
9767 &`signature      `&
9768 &`subj_altname   `& tagged list
9769 &`ocsp_uri       `& list
9770 &`crl_uri        `& list
9771 .endd
9772 If the field is found,
9773 <&'string2'&> is expanded, and replaces the whole item;
9774 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9775 variable &$value$& contains the value that has been extracted. Afterwards, it
9776 is restored to any previous value it might have had.
9777
9778 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9779 key is not found. If {<&'string2'&>} is also omitted, the value that was
9780 extracted is used.
9781
9782 Some field names take optional modifiers, appended and separated by commas.
9783
9784 The field selectors marked as "RFC4514" above
9785 output a Distinguished Name string which is
9786 not quite
9787 parseable by Exim as a comma-separated tagged list
9788 (the exceptions being elements containing commas).
9789 RDN elements of a single type may be selected by
9790 a modifier of the type label; if so the expansion
9791 result is a list (newline-separated by default).
9792 The separator may be changed by another modifier of
9793 a right angle-bracket followed immediately by the new separator.
9794 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9795
9796 The field selectors marked as "time" above
9797 take an optional modifier of "int"
9798 for which the result is the number of seconds since epoch.
9799 Otherwise the result is a human-readable string
9800 in the timezone selected by the main "timezone" option.
9801
9802 The field selectors marked as "list" above return a list,
9803 newline-separated by default,
9804 (embedded separator characters in elements are doubled).
9805 The separator may be changed by a modifier of
9806 a right angle-bracket followed immediately by the new separator.
9807
9808 The field selectors marked as "tagged" above
9809 prefix each list element with a type string and an equals sign.
9810 Elements of only one type may be selected by a modifier
9811 which is one of "dns", "uri" or "mail";
9812 if so the element tags are omitted.
9813
9814 If not otherwise noted field values are presented in human-readable form.
9815
9816 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9817        {*&<&'arg'&>&*}...}*&"
9818 .cindex &%dlfunc%&
9819 This expansion dynamically loads and then calls a locally-written C function.
9820 This functionality is available only if Exim is compiled with
9821 .code
9822 EXPAND_DLFUNC=yes
9823 .endd
9824 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9825 object so that it doesn't reload the same object file in the same Exim process
9826 (but of course Exim does start new processes frequently).
9827
9828 There may be from zero to eight arguments to the function.
9829
9830 When compiling
9831 a local function that is to be called in this way,
9832 first &_DLFUNC_IMPL_& should be defined,
9833 and second &_local_scan.h_& should be included.
9834 The Exim variables and functions that are defined by that API
9835 are also available for dynamically loaded functions. The function itself
9836 must have the following type:
9837 .code
9838 int dlfunction(uschar **yield, int argc, uschar *argv[])
9839 .endd
9840 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9841 function should return one of the following values:
9842
9843 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9844 into the expanded string that is being built.
9845
9846 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9847 from &'yield'&, if it is set.
9848
9849 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9850 taken from &'yield'& if it is set.
9851
9852 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9853
9854 When compiling a function that is to be used in this way with gcc,
9855 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9856 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9857
9858
9859 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9860 .cindex "expansion" "extracting value from environment"
9861 .cindex "environment" "values from"
9862 The key is first expanded separately, and leading and trailing white space
9863 removed.
9864 This is then searched for as a name in the environment.
9865 If a variable is found then its value is placed in &$value$&
9866 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9867
9868 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9869 appear, for example:
9870 .code
9871 ${env{USER}{$value} fail }
9872 .endd
9873 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9874 {<&'string1'&>} must be present for &"fail"& to be recognized.
9875
9876 If {<&'string2'&>} is omitted an empty string is substituted on
9877 search failure.
9878 If {<&'string1'&>} is omitted the search result is substituted on
9879 search success.
9880
9881 The environment is adjusted by the &%keep_environment%& and
9882 &%add_environment%& main section options.
9883
9884
9885 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9886        {*&<&'string3'&>&*}}*&"
9887 .cindex "expansion" "extracting substrings by key"
9888 .cindex "&%extract%&" "substrings by key"
9889 The key and <&'string1'&> are first expanded separately. Leading and trailing
9890 white space is removed from the key (but not from any of the strings). The key
9891 must not be empty and must not consist entirely of digits.
9892 The expanded <&'string1'&> must be of the form:
9893 .display
9894 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9895 .endd
9896 .vindex "&$value$&"
9897 where the equals signs and spaces (but not both) are optional. If any of the
9898 values contain white space, they must be enclosed in double quotes, and any
9899 values that are enclosed in double quotes are subject to escape processing as
9900 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9901 for the value that corresponds to the key. The search is case-insensitive. If
9902 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9903 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9904 variable &$value$& contains the value that has been extracted. Afterwards, it
9905 is restored to any previous value it might have had.
9906
9907 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9908 key is not found. If {<&'string2'&>} is also omitted, the value that was
9909 extracted is used. Thus, for example, these two expansions are identical, and
9910 yield &"2001"&:
9911 .code
9912 ${extract{gid}{uid=1984 gid=2001}}
9913 ${extract{gid}{uid=1984 gid=2001}{$value}}
9914 .endd
9915 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9916 appear, for example:
9917 .code
9918 ${extract{Z}{A=... B=...}{$value} fail }
9919 .endd
9920 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9921 {<&'string2'&>} must be present for &"fail"& to be recognized.
9922
9923 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9924        {*&<&'string3'&>&*}}*&" &&&
9925        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9926        {*&<&'string3'&>&*}}*&"
9927 .cindex "expansion" "extracting from JSON object"
9928 .cindex JSON expansions
9929 The key and <&'string1'&> are first expanded separately. Leading and trailing
9930 white space is removed from the key (but not from any of the strings). The key
9931 must not be empty and must not consist entirely of digits.
9932 The expanded <&'string1'&> must be of the form:
9933 .display
9934 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9935 .endd
9936 .vindex "&$value$&"
9937 The braces, commas and colons, and the quoting of the member name are required;
9938 the spaces are optional.
9939 Matching of the key against the member names is done case-sensitively.
9940 For the &"json"& variant,
9941 if a returned value is a JSON string, it retains its leading and
9942 trailing quotes.
9943 For the &"jsons"& variant, which is intended for use with JSON strings, the
9944 leading and trailing quotes are removed from the returned value.
9945 . XXX should be a UTF-8 compare
9946
9947 The results of matching are handled as above.
9948
9949
9950 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9951         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9952 .cindex "expansion" "extracting substrings by number"
9953 .cindex "&%extract%&" "substrings by number"
9954 The <&'number'&> argument must consist entirely of decimal digits,
9955 apart from leading and trailing white space, which is ignored.
9956 This is what distinguishes this form of &%extract%& from the previous kind. It
9957 behaves in the same way, except that, instead of extracting a named field, it
9958 extracts from <&'string1'&> the field whose number is given as the first
9959 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9960 <&'string3'&> as before.
9961
9962 The fields in the string are separated by any one of the characters in the
9963 separator string. These may include space or tab characters.
9964 The first field is numbered one. If the number is negative, the fields are
9965 counted from the end of the string, with the rightmost one numbered -1. If the
9966 number given is zero, the entire string is returned. If the modulus of the
9967 number is greater than the number of fields in the string, the result is the
9968 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9969 provided. For example:
9970 .code
9971 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9972 .endd
9973 yields &"42"&, and
9974 .code
9975 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9976 .endd
9977 yields &"99"&. Two successive separators mean that the field between them is
9978 empty (for example, the fifth field above).
9979
9980
9981 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9982         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9983        "&*${extract jsons{*&<&'number'&>&*}}&&&
9984         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9985 .cindex "expansion" "extracting from JSON array"
9986 .cindex JSON expansions
9987 The <&'number'&> argument must consist entirely of decimal digits,
9988 apart from leading and trailing white space, which is ignored.
9989
9990 Field selection and result handling is as above;
9991 there is no choice of field separator.
9992 For the &"json"& variant,
9993 if a returned value is a JSON string, it retains its leading and
9994 trailing quotes.
9995 For the &"jsons"& variant, which is intended for use with JSON strings, the
9996 leading and trailing quotes are removed from the returned value.
9997
9998
9999 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10000 .cindex "list" "selecting by condition"
10001 .cindex "expansion" "selecting from list by condition"
10002 .vindex "&$item$&"
10003 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10004 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10005 For each item
10006 in this list, its value is placed in &$item$&, and then the condition is
10007 evaluated.
10008 .new
10009 Any modification of &$value$& by this evaluation is discarded.
10010 .wen
10011 If the condition is true, &$item$& is added to the output as an
10012 item in a new list; if the condition is false, the item is discarded. The
10013 separator used for the output list is the same as the one used for the
10014 input, but a separator setting is not included in the output. For example:
10015 .code
10016 ${filter{a:b:c}{!eq{$item}{b}}}
10017 .endd
10018 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10019 to what it was before.
10020 See also the &%map%& and &%reduce%& expansion items.
10021
10022
10023 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10024 .cindex "hash function" "textual"
10025 .cindex "expansion" "textual hash"
10026 This is a textual hashing function, and was the first to be implemented in
10027 early versions of Exim. In current releases, there are other hashing functions
10028 (numeric, MD5, and SHA-1), which are described below.
10029
10030 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10031 <&'n'&>. If you are using fixed values for these numbers, that is, if
10032 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10033 use the simpler operator notation that avoids some of the braces:
10034 .code
10035 ${hash_<n>_<m>:<string>}
10036 .endd
10037 The second number is optional (in both notations). If <&'n'&> is greater than
10038 or equal to the length of the string, the expansion item returns the string.
10039 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10040 function to the string. The new string consists of characters taken from the
10041 first <&'m'&> characters of the string
10042 .code
10043 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10044 .endd
10045 If <&'m'&> is not present the value 26 is used, so that only lower case
10046 letters appear. For example:
10047 .display
10048 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10049 &`$hash{5}{monty}}           `&   yields  &`monty`&
10050 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10051 .endd
10052
10053 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10054         &*$h_*&<&'header&~name'&>&*:*&" &&&
10055        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10056         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10057        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10058         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10059        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10060         &*$rh_*&<&'header&~name'&>&*:*&"
10061 .cindex "expansion" "header insertion"
10062 .vindex "&$header_$&"
10063 .vindex "&$bheader_$&"
10064 .vindex "&$lheader_$&"
10065 .vindex "&$rheader_$&"
10066 .cindex "header lines" "in expansion strings"
10067 .cindex "header lines" "character sets"
10068 .cindex "header lines" "decoding"
10069 Substitute the contents of the named message header line, for example
10070 .code
10071 $header_reply-to:
10072 .endd
10073 The newline that terminates a header line is not included in the expansion, but
10074 internal newlines (caused by splitting the header line over several physical
10075 lines) may be present.
10076
10077 The difference between the four pairs of expansions is in the way
10078 the data in the header line is interpreted.
10079
10080 .ilist
10081 .cindex "white space" "in header lines"
10082 &%rheader%& gives the original &"raw"& content of the header line, with no
10083 processing at all, and without the removal of leading and trailing white space.
10084
10085 .next
10086 .cindex "list" "of header lines"
10087 &%lheader%& gives a colon-separated list, one element per header when there
10088 are multiple headers with a given name.
10089 Any embedded colon characters within an element are doubled, so normal Exim
10090 list-processing facilities can be used.
10091 The terminating newline of each element is removed; in other respects
10092 the content is &"raw"&.
10093
10094 .next
10095 .cindex "base64 encoding" "in header lines"
10096 &%bheader%& removes leading and trailing white space, and then decodes base64
10097 or quoted-printable MIME &"words"& within the header text, but does no
10098 character set translation. If decoding of what looks superficially like a MIME
10099 &"word"& fails, the raw string is returned. If decoding
10100 .cindex "binary zero" "in header line"
10101 produces a binary zero character, it is replaced by a question mark &-- this is
10102 what Exim does for binary zeros that are actually received in header lines.
10103
10104 .next
10105 &%header%& tries to translate the string as decoded by &%bheader%& to a
10106 standard character set. This is an attempt to produce the same string as would
10107 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10108 returned. Translation is attempted only on operating systems that support the
10109 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10110 a system Makefile or in &_Local/Makefile_&.
10111 .endlist ilist
10112
10113 In a filter file, the target character set for &%header%& can be specified by a
10114 command of the following form:
10115 .code
10116 headers charset "UTF-8"
10117 .endd
10118 This command affects all references to &$h_$& (or &$header_$&) expansions in
10119 subsequently obeyed filter commands. In the absence of this command, the target
10120 character set in a filter is taken from the setting of the &%headers_charset%&
10121 option in the runtime configuration. The value of this option defaults to the
10122 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10123 ISO-8859-1.
10124
10125 Header names follow the syntax of RFC 2822, which states that they may contain
10126 any printing characters except space and colon. Consequently, curly brackets
10127 &'do not'& terminate header names, and should not be used to enclose them as
10128 if they were variables. Attempting to do so causes a syntax error.
10129
10130 Only header lines that are common to all copies of a message are visible to
10131 this mechanism. These are the original header lines that are received with the
10132 message, and any that are added by an ACL statement or by a system
10133 filter. Header lines that are added to a particular copy of a message by a
10134 router or transport are not accessible.
10135
10136 For incoming SMTP messages, no header lines are visible in
10137 ACLs that are obeyed before the data phase completes,
10138 because the header structure is not set up until the message is received.
10139 They are visible in DKIM, PRDR and DATA ACLs.
10140 Header lines that are added in a RCPT ACL (for example)
10141 are saved until the message's incoming header lines are available, at which
10142 point they are added.
10143 When any of the above ACLs are
10144 running, however, header lines added by earlier ACLs are visible.
10145
10146 Upper case and lower case letters are synonymous in header names. If the
10147 following character is white space, the terminating colon may be omitted, but
10148 this is not recommended, because you may then forget it when it is needed. When
10149 white space terminates the header name, this white space is included in the
10150 expanded string.  If the message does not contain the given header, the
10151 expansion item is replaced by an empty string. (See the &%def%& condition in
10152 section &<<SECTexpcond>>& for a means of testing for the existence of a
10153 header.)
10154
10155 If there is more than one header with the same name, they are all concatenated
10156 to form the substitution string, up to a maximum length of 64K. Unless
10157 &%rheader%& is being used, leading and trailing white space is removed from
10158 each header before concatenation, and a completely empty header is ignored. A
10159 newline character is then inserted between non-empty headers, but there is no
10160 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10161 those headers that contain lists of addresses, a comma is also inserted at the
10162 junctions between headers. This does not happen for the &%rheader%& expansion.
10163
10164 .cindex "tainted data" "message headers"
10165 When the headers are from an incoming message,
10166 the result of expanding any of these variables is tainted.
10167
10168
10169 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10170 .cindex "expansion" "hmac hashing"
10171 .cindex &%hmac%&
10172 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10173 shared secret and some text into a message authentication code, as specified in
10174 RFC 2104. This differs from &`${md5:secret_text...}`& or
10175 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10176 cryptographic hash, allowing for authentication that is not possible with MD5
10177 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10178 present. For example:
10179 .code
10180 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10181 .endd
10182 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10183 produces:
10184 .code
10185 dd97e3ba5d1a61b5006108f8c8252953
10186 .endd
10187 As an example of how this might be used, you might put in the main part of
10188 an Exim configuration:
10189 .code
10190 SPAMSCAN_SECRET=cohgheeLei2thahw
10191 .endd
10192 In a router or a transport you could then have:
10193 .code
10194 headers_add = \
10195   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10196   ${hmac{md5}{SPAMSCAN_SECRET}\
10197   {${primary_hostname},${message_exim_id},$h_message-id:}}
10198 .endd
10199 Then given a message, you can check where it was scanned by looking at the
10200 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10201 this header line is authentic by recomputing the authentication code from the
10202 host name, message ID and the &'Message-id:'& header line. This can be done
10203 using Exim's &%-be%& option, or by other means, for example, by using the
10204 &'hmac_md5_hex()'& function in Perl.
10205
10206
10207 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10208 .cindex "expansion" "conditional"
10209 .cindex "&%if%&, expansion item"
10210 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10211 item; otherwise <&'string2'&> is used. The available conditions are described
10212 in section &<<SECTexpcond>>& below. For example:
10213 .code
10214 ${if eq {$local_part}{postmaster} {yes}{no} }
10215 .endd
10216 The second string need not be present; if it is not and the condition is not
10217 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10218 be present instead of the second string (without any curly brackets). In this
10219 case, the expansion is forced to fail if the condition is not true (see section
10220 &<<SECTforexpfai>>&).
10221
10222 If both strings are omitted, the result is the string &`true`& if the condition
10223 is true, and the empty string if the condition is false. This makes it less
10224 cumbersome to write custom ACL and router conditions. For example, instead of
10225 .code
10226 condition = ${if >{$acl_m4}{3}{true}{false}}
10227 .endd
10228 you can use
10229 .code
10230 condition = ${if >{$acl_m4}{3}}
10231 .endd
10232
10233
10234
10235 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10236 .cindex expansion "imap folder"
10237 .cindex "&%imapfolder%& expansion item"
10238 This item converts a (possibly multilevel, or with non-ASCII characters)
10239 folder specification to a Maildir name for filesystem use.
10240 For information on internationalisation support see &<<SECTi18nMDA>>&.
10241
10242
10243
10244 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10245 .cindex "expansion" "string truncation"
10246 .cindex "&%length%& expansion item"
10247 The &%length%& item is used to extract the initial portion of a string. Both
10248 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10249 you are using a fixed value for the number, that is, if <&'string1'&> does not
10250 change when expanded, you can use the simpler operator notation that avoids
10251 some of the braces:
10252 .code
10253 ${length_<n>:<string>}
10254 .endd
10255 The result of this item is either the first <&'n'&> bytes or the whole
10256 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10257 &%strlen%&, which gives the length of a string.
10258 All measurement is done in bytes and is not UTF-8 aware.
10259
10260
10261 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10262         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10263 .cindex "expansion" "extracting list elements by number"
10264 .cindex "&%listextract%&" "extract list elements by number"
10265 .cindex "list" "extracting elements by number"
10266 The <&'number'&> argument must consist entirely of decimal digits,
10267 apart from an optional leading minus,
10268 and leading and trailing white space (which is ignored).
10269
10270 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10271 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10272
10273 The first field of the list is numbered one.
10274 If the number is negative, the fields are
10275 counted from the end of the list, with the rightmost one numbered -1.
10276 The numbered element of the list is extracted and placed in &$value$&,
10277 then <&'string2'&> is expanded as the result.
10278
10279 If the modulus of the
10280 number is zero or greater than the number of fields in the string,
10281 the result is the expansion of <&'string3'&>.
10282
10283 For example:
10284 .code
10285 ${listextract{2}{x:42:99}}
10286 .endd
10287 yields &"42"&, and
10288 .code
10289 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10290 .endd
10291 yields &"result: 42"&.
10292
10293 If {<&'string3'&>} is omitted, an empty string is used for string3.
10294 If {<&'string2'&>} is also omitted, the value that was
10295 extracted is used.
10296 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10297
10298
10299 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10300 .cindex quoting "for list"
10301 .cindex list quoting
10302 This item doubles any occurrence of the separator character
10303 in the given string.
10304 An empty string is replaced with a single space.
10305 This converts the string into a safe form for use as a list element,
10306 in a list using the given separator.
10307
10308
10309 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10310         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10311        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10312         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10313 .cindex "expansion" "lookup in"
10314 .cindex "file" "lookups"
10315 .cindex "lookup" "in expanded string"
10316 The two forms of lookup item specify data lookups in files and databases, as
10317 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10318 lookups, and the second is used for query-style lookups. The <&'key'&>,
10319 <&'file'&>, and <&'query'&> strings are expanded before use.
10320
10321 If there is any white space in a lookup item which is part of a filter command,
10322 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10323 other place where white space is significant, the lookup item must be enclosed
10324 in double quotes. The use of data lookups in users' filter files may be locked
10325 out by the system administrator.
10326
10327 .vindex "&$value$&"
10328 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10329 During its expansion, the variable &$value$& contains the data returned by the
10330 lookup. Afterwards it reverts to the value it had previously (at the outer
10331 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10332 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10333 string on failure. If <&'string2'&> is provided, it can itself be a nested
10334 lookup, thus providing a mechanism for looking up a default value when the
10335 original lookup fails.
10336
10337 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10338 data for the outer lookup while the parameters of the second lookup are
10339 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10340 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10341 appear, and in this case, if the lookup fails, the entire expansion is forced
10342 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10343 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10344 successful lookup, and nothing in the case of failure.
10345
10346 For single-key lookups, the string &"partial"& is permitted to precede the
10347 search type in order to do partial matching, and * or *@ may follow a search
10348 type to request default lookups if the key does not match (see sections
10349 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10350
10351 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10352 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10353 and non-wild parts of the key during the expansion of the replacement text.
10354 They return to their previous values at the end of the lookup item.
10355
10356 This example looks up the postmaster alias in the conventional alias file:
10357 .code
10358 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10359 .endd
10360 This example uses NIS+ to look up the full name of the user corresponding to
10361 the local part of an address, forcing the expansion to fail if it is not found:
10362 .code
10363 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10364   {$value}fail}
10365 .endd
10366
10367
10368 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10369 .cindex "expansion" "list creation"
10370 .vindex "&$item$&"
10371 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10372 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10373 For each item
10374 in this list, its value is place in &$item$&, and then <&'string2'&> is
10375 expanded and added to the output as an item in a new list. The separator used
10376 for the output list is the same as the one used for the input, but a separator
10377 setting is not included in the output. For example:
10378 .code
10379 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10380 .endd
10381 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10382 value of &$item$& is restored to what it was before. See also the &%filter%&
10383 and &%reduce%& expansion items.
10384
10385 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10386 .cindex "expansion" "numeric hash"
10387 .cindex "hash function" "numeric"
10388 The three strings are expanded; the first two must yield numbers. Call them
10389 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10390 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10391 can use the simpler operator notation that avoids some of the braces:
10392 .code
10393 ${nhash_<n>_<m>:<string>}
10394 .endd
10395 The second number is optional (in both notations). If there is only one number,
10396 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10397 processed by a div/mod hash function that returns two numbers, separated by a
10398 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10399 example,
10400 .code
10401 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10402 .endd
10403 returns the string &"6/33"&.
10404
10405
10406
10407 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10408 .cindex "Perl" "use in expanded string"
10409 .cindex "expansion" "calling Perl from"
10410 This item is available only if Exim has been built to include an embedded Perl
10411 interpreter. The subroutine name and the arguments are first separately
10412 expanded, and then the Perl subroutine is called with those arguments. No
10413 additional arguments need be given; the maximum number permitted, including the
10414 name of the subroutine, is nine.
10415
10416 The return value of the subroutine is inserted into the expanded string, unless
10417 the return value is &%undef%&. In that case, the entire expansion is
10418 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10419 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10420 in a scalar context, thus the return value is a scalar.  For example, if you
10421 return a Perl vector, the return value is the size of the vector,
10422 not its contents.
10423
10424 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10425 with the error message that was passed to &%die%&. More details of the embedded
10426 Perl facility are given in chapter &<<CHAPperl>>&.
10427
10428 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10429 out the use of this expansion item in filter files.
10430
10431
10432 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10433 .cindex "&%prvs%& expansion item"
10434 The first argument is a complete email address and the second is secret
10435 keystring. The third argument, specifying a key number, is optional. If absent,
10436 it defaults to 0. The result of the expansion is a prvs-signed email address,
10437 to be typically used with the &%return_path%& option on an &(smtp)& transport
10438 as part of a bounce address tag validation (BATV) scheme. For more discussion
10439 and an example, see section &<<SECTverifyPRVS>>&.
10440
10441 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10442         {*&<&'string'&>&*}}*&"
10443 .cindex "&%prvscheck%& expansion item"
10444 This expansion item is the complement of the &%prvs%& item. It is used for
10445 checking prvs-signed addresses. If the expansion of the first argument does not
10446 yield a syntactically valid prvs-signed address, the whole item expands to the
10447 empty string. When the first argument does expand to a syntactically valid
10448 prvs-signed address, the second argument is expanded, with the prvs-decoded
10449 version of the address and the key number extracted from the address in the
10450 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10451
10452 These two variables can be used in the expansion of the second argument to
10453 retrieve the secret. The validity of the prvs-signed address is then checked
10454 against the secret. The result is stored in the variable &$prvscheck_result$&,
10455 which is empty for failure or &"1"& for success.
10456
10457 The third argument is optional; if it is missing, it defaults to an empty
10458 string. This argument is now expanded. If the result is an empty string, the
10459 result of the expansion is the decoded version of the address. This is the case
10460 whether or not the signature was valid. Otherwise, the result of the expansion
10461 is the expansion of the third argument.
10462
10463 All three variables can be used in the expansion of the third argument.
10464 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10465 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10466
10467 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10468 .cindex "expansion" "inserting an entire file"
10469 .cindex "file" "inserting into expansion"
10470 .cindex "&%readfile%& expansion item"
10471 The filename and end-of-line (eol) string are first expanded separately. The file is
10472 then read, and its contents replace the entire item. All newline characters in
10473 the file are replaced by the end-of-line string if it is present. Otherwise,
10474 newlines are left in the string.
10475 String expansion is not applied to the contents of the file. If you want this,
10476 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10477 the string expansion fails.
10478
10479 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10480 locks out the use of this expansion item in filter files.
10481
10482
10483
10484 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10485         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10486 .cindex "expansion" "inserting from a socket"
10487 .cindex "socket, use of in expansion"
10488 .cindex "&%readsocket%& expansion item"
10489 This item inserts data from a Unix domain or TCP socket into the expanded
10490 string. The minimal way of using it uses just two arguments, as in these
10491 examples:
10492 .code
10493 ${readsocket{/socket/name}{request string}}
10494 ${readsocket{inet:some.host:1234}{request string}}
10495 .endd
10496 For a Unix domain socket, the first substring must be the path to the socket.
10497 For an Internet socket, the first substring must contain &`inet:`& followed by
10498 a host name or IP address, followed by a colon and a port, which can be a
10499 number or the name of a TCP port in &_/etc/services_&. An IP address may
10500 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10501 example:
10502 .code
10503 ${readsocket{inet:[::1]:1234}{request string}}
10504 .endd
10505 Only a single host name may be given, but if looking it up yields more than
10506 one IP address, they are each tried in turn until a connection is made. For
10507 both kinds of socket, Exim makes a connection, writes the request string
10508 (unless it is an empty string; no terminating NUL is ever sent)
10509 and reads from the socket until an end-of-file
10510 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10511 extend what can be done. Firstly, you can vary the timeout. For example:
10512 .code
10513 ${readsocket{/socket/name}{request string}{3s}}
10514 .endd
10515
10516 The third argument is a list of options, of which the first element is the timeout
10517 and must be present if any options are given.
10518 Further elements are options of form &'name=value'&.
10519 Example:
10520 .code
10521 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10522 .endd
10523
10524 The following option names are recognised:
10525 .ilist
10526 &*cache*&
10527 Defines if the result data can be cached for use by a later identical
10528 request in the same process.
10529 Values are &"yes"& or &"no"& (the default).
10530 If not, all cached results for this connection specification
10531 will be invalidated.
10532
10533 .next
10534 &*shutdown*&
10535 Defines whether or not a write-shutdown is done on the connection after
10536 sending the request. Values are &"yes"& (the default) or &"no"&
10537 (preferred, eg. by some webservers).
10538
10539 .next
10540 &*sni*&
10541 Controls the use of Server Name Identification on the connection.
10542 Any nonempty value will be the SNI sent; TLS will be forced.
10543
10544 .next
10545 &*tls*&
10546 Controls the use of TLS on the connection.
10547 Values are &"yes"& or &"no"& (the default).
10548 If it is enabled, a shutdown as described above is never done.
10549 .endlist
10550
10551
10552 A fourth argument allows you to change any newlines that are in the data
10553 that is read, in the same way as for &%readfile%& (see above). This example
10554 turns them into spaces:
10555 .code
10556 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10557 .endd
10558 As with all expansions, the substrings are expanded before the processing
10559 happens. Errors in these sub-expansions cause the expansion to fail. In
10560 addition, the following errors can occur:
10561
10562 .ilist
10563 Failure to create a socket file descriptor;
10564 .next
10565 Failure to connect the socket;
10566 .next
10567 Failure to write the request string;
10568 .next
10569 Timeout on reading from the socket.
10570 .endlist
10571
10572 By default, any of these errors causes the expansion to fail. However, if
10573 you supply a fifth substring, it is expanded and used when any of the above
10574 errors occurs. For example:
10575 .code
10576 ${readsocket{/socket/name}{request string}{3s}{\n}\
10577   {socket failure}}
10578 .endd
10579 You can test for the existence of a Unix domain socket by wrapping this
10580 expansion in &`${if exists`&, but there is a race condition between that test
10581 and the actual opening of the socket, so it is safer to use the fifth argument
10582 if you want to be absolutely sure of avoiding an expansion error for a
10583 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10584
10585 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10586 locks out the use of this expansion item in filter files.
10587
10588
10589 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10590 .cindex "expansion" "reducing a list to a scalar"
10591 .cindex "list" "reducing to a scalar"
10592 .vindex "&$value$&"
10593 .vindex "&$item$&"
10594 This operation reduces a list to a single, scalar string. After expansion,
10595 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10596 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10597 Then <&'string2'&> is expanded and
10598 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10599 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10600 them. The result of that expansion is assigned to &$value$& before the next
10601 iteration. When the end of the list is reached, the final value of &$value$& is
10602 added to the expansion output. The &%reduce%& expansion item can be used in a
10603 number of ways. For example, to add up a list of numbers:
10604 .code
10605 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10606 .endd
10607 The result of that expansion would be &`6`&. The maximum of a list of numbers
10608 can be found:
10609 .code
10610 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10611 .endd
10612 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10613 restored to what they were before. See also the &%filter%& and &%map%&
10614 expansion items.
10615
10616 . A bit of a special-case logic error in writing an expansion;
10617 . probably not worth including in the mainline of documentation.
10618 . If only we had footnotes (the html output variant is the problem).
10619 .
10620 . .new
10621 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10622 . and that condition modifies &$value$&,
10623 . then the string expansions dependent on the condition cannot use
10624 . the &$value$& of the reduce iteration.
10625 . .wen
10626
10627 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10628 This item inserts &"raw"& header lines. It is described with the &%header%&
10629 expansion item in section &<<SECTexpansionitems>>& above.
10630
10631 .vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10632         {*&<&'string2'&>&*}}*&"
10633 .cindex "expansion" "running a command"
10634 .cindex "&%run%& expansion item"
10635 This item runs an external command, as a subprocess.
10636 One option is supported after the word &'run'&, comma-separated
10637 and without whitespace.
10638
10639 If the option &'preexpand'& is not used,
10640 the command string is split into individual arguments by spaces
10641 and then each argument is expanded.
10642 Then the command is run
10643 in a separate process, but under the same uid and gid.  As in other command
10644 executions from Exim, a shell is not used by default. If the command requires
10645 a shell, you must explicitly code it.
10646 The command name may not be tainted, but the remaining arguments can be.
10647
10648 &*Note*&: if tainted arguments are used, they are supplied by a
10649 potential attacker;
10650 a careful assessment for security vulnerabilities should be done.
10651
10652 If the option &'preexpand'& is used,
10653 the command and its arguments are first expanded as one string. The result is
10654 split apart into individual arguments by spaces, and then the command is run
10655 as above.
10656 Since the arguments are split by spaces, when there is a variable expansion
10657 which has an empty result, it will cause the situation that the argument will
10658 simply be omitted when the program is actually executed by Exim. If the
10659 script/program requires a specific number of arguments and the expanded
10660 variable could possibly result in this empty expansion, the variable must be
10661 quoted. This is more difficult if the expanded variable itself could result
10662 in a string containing quotes, because it would interfere with the quotes
10663 around the command arguments. A possible guard against this is to wrap the
10664 variable in the &%sg%& operator to change any quote marks to some other
10665 character.
10666 Neither the command nor any argument may be tainted.
10667
10668 The standard input for the command exists, but is empty. The standard output
10669 and standard error are set to the same file descriptor.
10670 .cindex "return code" "from &%run%& expansion"
10671 .vindex "&$value$&"
10672 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10673 and replaces the entire item; during this expansion, the standard output/error
10674 from the command is in the variable &$value$&. If the command fails,
10675 <&'string2'&>, if present, is expanded and used. Once again, during the
10676 expansion, the standard output/error from the command is in the variable
10677 &$value$&.
10678
10679 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10680 can be the word &"fail"& (not in braces) to force expansion failure if the
10681 command does not succeed. If both strings are omitted, the result is contents
10682 of the standard output/error on success, and nothing on failure.
10683
10684 .vindex "&$run_in_acl$&"
10685 The standard output/error of the command is put in the variable &$value$&.
10686 In this ACL example, the output of a command is logged for the admin to
10687 troubleshoot:
10688 .code
10689 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10690       log_message  = Output of id: $value
10691 .endd
10692 If the command requires shell idioms, such as the > redirect operator, the
10693 shell must be invoked directly, such as with:
10694 .code
10695 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10696 .endd
10697 Note that &$value$& will not persist beyond the reception of a single message.
10698
10699 .vindex "&$runrc$&"
10700 The return code from the command is put in the variable &$runrc$&, and this
10701 remains set afterwards, so in a filter file you can do things like this:
10702 .code
10703 if "${run{x y z}{}}$runrc" is 1 then ...
10704   elif $runrc is 2 then ...
10705   ...
10706 endif
10707 .endd
10708 If execution of the command fails (for example, the command does not exist),
10709 the return code is 127 &-- the same code that shells use for non-existent
10710 commands.
10711
10712 &*Warning*&: In a router or transport, you cannot assume the order in which
10713 option values are expanded, except for those preconditions whose order of
10714 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10715 by the expansion of one option, and use it in another.
10716
10717 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10718 out the use of this expansion item in filter files.
10719
10720
10721 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10722 .cindex "expansion" "string substitution"
10723 .cindex "&%sg%& expansion item"
10724 This item works like Perl's substitution operator (s) with the global (/g)
10725 option; hence its name. However, unlike the Perl equivalent, Exim does not
10726 modify the subject string; instead it returns the modified string for insertion
10727 into the overall expansion. The item takes three arguments: the subject string,
10728 a regular expression, and a substitution string. For example:
10729 .code
10730 ${sg{abcdefabcdef}{abc}{xyz}}
10731 .endd
10732 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10733 if any $, } or \ characters are required in the regular expression or in the
10734 substitution string, they have to be escaped. For example:
10735 .code
10736 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10737 .endd
10738 yields &"defabc"&, and
10739 .code
10740 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10741 .endd
10742 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10743 the regular expression from string expansion.
10744
10745 The regular expression is compiled in 8-bit mode, working against bytes
10746 rather than any Unicode-aware character handling.
10747
10748
10749 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10750 .cindex sorting "a list"
10751 .cindex list sorting
10752 .cindex expansion "list sorting"
10753 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10754 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10755 The <&'comparator'&> argument is interpreted as the operator
10756 of a two-argument expansion condition.
10757 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10758 The comparison should return true when applied to two values
10759 if the first value should sort before the second value.
10760 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10761 the element being placed in &$item$&,
10762 to give values for comparison.
10763
10764 The item result is a sorted list,
10765 with the original list separator,
10766 of the list elements (in full) of the original.
10767
10768 Examples:
10769 .code
10770 ${sort{3:2:1:4}{<}{$item}}
10771 .endd
10772 sorts a list of numbers, and
10773 .code
10774 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10775 .endd
10776 will sort an MX lookup into priority order.
10777
10778
10779
10780 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10781 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10782
10783
10784
10785 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10786 .cindex "&%substr%& expansion item"
10787 .cindex "substring extraction"
10788 .cindex "expansion" "substring extraction"
10789 The three strings are expanded; the first two must yield numbers. Call them
10790 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10791 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10792 can use the simpler operator notation that avoids some of the braces:
10793 .code
10794 ${substr_<n>_<m>:<subject>}
10795 .endd
10796 The second number is optional (in both notations).
10797 If it is absent in the simpler format, the preceding underscore must also be
10798 omitted.
10799
10800 The &%substr%& item can be used to extract more general substrings than
10801 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10802 length required. For example
10803 .code
10804 ${substr{3}{2}{$local_part}}
10805 .endd
10806 If the starting offset is greater than the string length the result is the
10807 null string; if the length plus starting offset is greater than the string
10808 length, the result is the right-hand part of the string, starting from the
10809 given offset. The first byte (character) in the string has offset zero.
10810
10811 The &%substr%& expansion item can take negative offset values to count
10812 from the right-hand end of its operand. The last byte (character) is offset -1,
10813 the second-last is offset -2, and so on. Thus, for example,
10814 .code
10815 ${substr{-5}{2}{1234567}}
10816 .endd
10817 yields &"34"&. If the absolute value of a negative offset is greater than the
10818 length of the string, the substring starts at the beginning of the string, and
10819 the length is reduced by the amount of overshoot. Thus, for example,
10820 .code
10821 ${substr{-5}{2}{12}}
10822 .endd
10823 yields an empty string, but
10824 .code
10825 ${substr{-3}{2}{12}}
10826 .endd
10827 yields &"1"&.
10828
10829 When the second number is omitted from &%substr%&, the remainder of the string
10830 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10831 string preceding the offset point are taken. For example, an offset of -1 and
10832 no length, as in these semantically identical examples:
10833 .code
10834 ${substr_-1:abcde}
10835 ${substr{-1}{abcde}}
10836 .endd
10837 yields all but the last character of the string, that is, &"abcd"&.
10838
10839 All measurement is done in bytes and is not UTF-8 aware.
10840
10841
10842
10843 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10844         {*&<&'replacements'&>&*}}*&"
10845 .cindex "expansion" "character translation"
10846 .cindex "&%tr%& expansion item"
10847 This item does single-character (in bytes) translation on its subject string. The second
10848 argument is a list of characters to be translated in the subject string. Each
10849 matching character is replaced by the corresponding character from the
10850 replacement list. For example
10851 .code
10852 ${tr{abcdea}{ac}{13}}
10853 .endd
10854 yields &`1b3de1`&. If there are duplicates in the second character string, the
10855 last occurrence is used. If the third string is shorter than the second, its
10856 last character is replicated. However, if it is empty, no translation takes
10857 place.
10858
10859 All character handling is done in bytes and is not UTF-8 aware.
10860
10861 .endlist
10862
10863
10864
10865 .section "Expansion operators" "SECTexpop"
10866 .cindex "expansion" "operators"
10867 For expansion items that perform transformations on a single argument string,
10868 the &"operator"& notation is used because it is simpler and uses fewer braces.
10869 The substring is first expanded before the operation is applied to it. The
10870 following operations can be performed:
10871
10872 .vlist
10873 .vitem &*${address:*&<&'string'&>&*}*&
10874 .cindex "expansion" "RFC 2822 address handling"
10875 .cindex "&%address%& expansion item"
10876 The string is interpreted as an RFC 2822 address, as it might appear in a
10877 header line, and the effective address is extracted from it. If the string does
10878 not parse successfully, the result is empty.
10879
10880 The parsing correctly handles SMTPUTF8 Unicode in the string.
10881
10882
10883 .vitem &*${addresses:*&<&'string'&>&*}*&
10884 .cindex "expansion" "RFC 2822 address handling"
10885 .cindex "&%addresses%& expansion item"
10886 The string (after expansion) is interpreted as a list of addresses in RFC
10887 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10888 operative address (&'local-part@domain'&) is extracted from each item, and the
10889 result of the expansion is a colon-separated list, with appropriate
10890 doubling of colons should any happen to be present in the email addresses.
10891 Syntactically invalid RFC2822 address items are omitted from the output.
10892
10893 It is possible to specify a character other than colon for the output
10894 separator by starting the string with > followed by the new separator
10895 character. For example:
10896 .code
10897 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10898 .endd
10899 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10900 first, so if the expanded string starts with >, it may change the output
10901 separator unintentionally. This can be avoided by setting the output
10902 separator explicitly:
10903 .code
10904 ${addresses:>:$h_from:}
10905 .endd
10906
10907 Compare the &%address%& (singular)
10908 expansion item, which extracts the working address from a single RFC2822
10909 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10910 processing lists.
10911
10912 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10913 a strict interpretation of header line formatting.  Exim parses the bare,
10914 unquoted portion of an email address and if it finds a comma, treats it as an
10915 email address separator. For the example header line:
10916 .code
10917 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10918 .endd
10919 The first example below demonstrates that Q-encoded email addresses are parsed
10920 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10921 It does not see the comma because it's still encoded as "=2C".  The second
10922 example below is passed the contents of &`$header_from:`&, meaning it gets
10923 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10924 The third example shows that the presence of a comma is skipped when it is
10925 quoted.  The fourth example shows SMTPUTF8 handling.
10926 .code
10927 # exim -be '${addresses:From: \
10928 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10929 user@example.com
10930 # exim -be '${addresses:From: Last, First <user@example.com>}'
10931 Last:user@example.com
10932 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10933 user@example.com
10934 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10935 フィリップ@example.jp
10936 .endd
10937
10938 .vitem &*${base32:*&<&'digits'&>&*}*&
10939 .cindex "&%base32%& expansion item"
10940 .cindex "expansion" "conversion to base 32"
10941 The string must consist entirely of decimal digits. The number is converted to
10942 base 32 and output as a (empty, for zero) string of characters.
10943 Only lowercase letters are used.
10944
10945 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10946 .cindex "&%base32d%& expansion item"
10947 .cindex "expansion" "conversion to base 32"
10948 The string must consist entirely of base-32 digits.
10949 The number is converted to decimal and output as a string.
10950
10951 .vitem &*${base62:*&<&'digits'&>&*}*&
10952 .cindex "&%base62%& expansion item"
10953 .cindex "expansion" "conversion to base 62"
10954 The string must consist entirely of decimal digits. The number is converted to
10955 base 62 and output as a string of six characters, including leading zeros. In
10956 the few operating environments where Exim uses base 36 instead of base 62 for
10957 its message identifiers (because those systems do not have case-sensitive
10958 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10959 to be absolutely clear: this is &'not'& base64 encoding.
10960
10961 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10962 .cindex "&%base62d%& expansion item"
10963 .cindex "expansion" "conversion to base 62"
10964 The string must consist entirely of base-62 digits, or, in operating
10965 environments where Exim uses base 36 instead of base 62 for its message
10966 identifiers, base-36 digits. The number is converted to decimal and output as a
10967 string.
10968
10969 .vitem &*${base64:*&<&'string'&>&*}*&
10970 .cindex "expansion" "base64 encoding"
10971 .cindex "base64 encoding" "in string expansion"
10972 .cindex "&%base64%& expansion item"
10973 .cindex certificate "base64 of DER"
10974 This operator converts a string into one that is base64 encoded.
10975
10976 If the string is a single variable of type certificate,
10977 returns the base64 encoding of the DER form of the certificate.
10978
10979
10980 .vitem &*${base64d:*&<&'string'&>&*}*&
10981 .cindex "expansion" "base64 decoding"
10982 .cindex "base64 decoding" "in string expansion"
10983 .cindex "&%base64d%& expansion item"
10984 This operator converts a base64-encoded string into the un-coded form.
10985
10986
10987 .vitem &*${domain:*&<&'string'&>&*}*&
10988 .cindex "domain" "extraction"
10989 .cindex "expansion" "domain extraction"
10990 The string is interpreted as an RFC 2822 address and the domain is extracted
10991 from it. If the string does not parse successfully, the result is empty.
10992
10993
10994 .vitem &*${escape:*&<&'string'&>&*}*&
10995 .cindex "expansion" "escaping non-printing characters"
10996 .cindex "&%escape%& expansion item"
10997 If the string contains any non-printing characters, they are converted to
10998 escape sequences starting with a backslash. Whether characters with the most
10999 significant bit set (so-called &"8-bit characters"&) count as printing or not
11000 is controlled by the &%print_topbitchars%& option.
11001
11002 .vitem &*${escape8bit:*&<&'string'&>&*}*&
11003 .cindex "expansion" "escaping 8-bit characters"
11004 .cindex "&%escape8bit%& expansion item"
11005 If the string contains any characters with the most significant bit set,
11006 they are converted to escape sequences starting with a backslash.
11007 Backslashes and DEL characters are also converted.
11008
11009
11010 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
11011 .cindex "expansion" "expression evaluation"
11012 .cindex "expansion" "arithmetic expression"
11013 .cindex "&%eval%& expansion item"
11014 These items supports simple arithmetic and bitwise logical operations in
11015 expansion strings. The string (after expansion) must be a conventional
11016 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11017 logical operators, and parentheses. All operations are carried out using
11018 integer arithmetic. The operator priorities are as follows (the same as in the
11019 C programming language):
11020 .table2 70pt 300pt
11021 .irow &'highest:'& "not (~), negate (-)"
11022 .irow ""   "multiply (*), divide (/), remainder (%)"
11023 .irow ""   "plus (+), minus (-)"
11024 .irow ""   "shift-left (<<), shift-right (>>)"
11025 .irow ""   "and (&&)"
11026 .irow ""   "xor (^)"
11027 .irow &'lowest:'&  "or (|)"
11028 .endtable
11029 Binary operators with the same priority are evaluated from left to right. White
11030 space is permitted before or after operators.
11031
11032 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11033 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11034 decimal, even if they start with a leading zero; hexadecimal numbers are not
11035 permitted. This can be useful when processing numbers extracted from dates or
11036 times, which often do have leading zeros.
11037
11038 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11039 or 1024*1024*1024,
11040 respectively. Negative numbers are supported. The result of the computation is
11041 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11042
11043 .display
11044 &`${eval:1+1}            `&  yields 2
11045 &`${eval:1+2*3}          `&  yields 7
11046 &`${eval:(1+2)*3}        `&  yields 9
11047 &`${eval:2+42%5}         `&  yields 4
11048 &`${eval:0xc&amp;5}          `&  yields 4
11049 &`${eval:0xc|5}          `&  yields 13
11050 &`${eval:0xc^5}          `&  yields 9
11051 &`${eval:0xc>>1}         `&  yields 6
11052 &`${eval:0xc<<1}         `&  yields 24
11053 &`${eval:~255&amp;0x1234}    `&  yields 4608
11054 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11055 .endd
11056
11057 As a more realistic example, in an ACL you might have
11058 .code
11059 deny   condition =                    \
11060          ${if and {                   \
11061            {>{$rcpt_count}{10}}       \
11062            {                          \
11063            <                          \
11064              {$recipients_count}      \
11065              {${eval:$rcpt_count/2}}  \
11066            }                          \
11067          }{yes}{no}}
11068        message = Too many bad recipients
11069 .endd
11070 The condition is true if there have been more than 10 RCPT commands and
11071 fewer than half of them have resulted in a valid recipient.
11072
11073
11074 .vitem &*${expand:*&<&'string'&>&*}*&
11075 .cindex "expansion" "re-expansion of substring"
11076 The &%expand%& operator causes a string to be expanded for a second time. For
11077 example,
11078 .code
11079 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11080 .endd
11081 first looks up a string in a file while expanding the operand for &%expand%&,
11082 and then re-expands what it has found.
11083
11084
11085 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11086 .cindex "Unicode"
11087 .cindex "UTF-8" "conversion from"
11088 .cindex "expansion" "UTF-8 conversion"
11089 .cindex "&%from_utf8%& expansion item"
11090 The world is slowly moving towards Unicode, although there are no standards for
11091 email yet. However, other applications (including some databases) are starting
11092 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11093 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11094 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11095 the result is an undefined sequence of bytes.
11096
11097 Unicode code points with values less than 256 are compatible with ASCII and
11098 ISO-8859-1 (also known as Latin-1).
11099 For example, character 169 is the copyright symbol in both cases, though the
11100 way it is encoded is different. In UTF-8, more than one byte is needed for
11101 characters with code values greater than 127, whereas ISO-8859-1 is a
11102 single-byte encoding (but thereby limited to 256 characters). This makes
11103 translation from UTF-8 to ISO-8859-1 straightforward.
11104
11105
11106 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11107 .cindex "hash function" "textual"
11108 .cindex "expansion" "textual hash"
11109 The &%hash%& operator is a simpler interface to the hashing function that can
11110 be used when the two parameters are fixed numbers (as opposed to strings that
11111 change when expanded). The effect is the same as
11112 .code
11113 ${hash{<n>}{<m>}{<string>}}
11114 .endd
11115 See the description of the general &%hash%& item above for details. The
11116 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11117
11118
11119
11120 .new
11121 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11122 .cindex header "wrapping operator"
11123 .cindex expansion "header wrapping"
11124 This operator line-wraps its argument in a way useful for headers.
11125 The &'cols'& value gives the column number to wrap after,
11126 the &'limit'& gives a limit number of result characters to truncate at.
11127 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11128 the defaults are 80 and 998.
11129 Wrapping will be inserted at a space if possible before the
11130 column number is reached.
11131 Whitespace at a chosen wrap point is removed.
11132 A line-wrap consists of a newline followed by a tab,
11133 and the tab is counted as 8 columns.
11134 .wen
11135
11136
11137
11138 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11139 .cindex "base64 encoding" "conversion from hex"
11140 .cindex "expansion" "hex to base64"
11141 .cindex "&%hex2b64%& expansion item"
11142 This operator converts a hex string into one that is base64 encoded. This can
11143 be useful for processing the output of the various hashing functions.
11144
11145
11146
11147 .vitem &*${hexquote:*&<&'string'&>&*}*&
11148 .cindex "quoting" "hex-encoded unprintable characters"
11149 .cindex "&%hexquote%& expansion item"
11150 This operator converts non-printable characters in a string into a hex
11151 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11152 as is, and other byte values are converted to &`\xNN`&, for example, a
11153 byte value 127 is converted to &`\x7f`&.
11154
11155
11156 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11157 .cindex "&%ipv6denorm%& expansion item"
11158 .cindex "IP address" normalisation
11159 This expands an IPv6 address to a full eight-element colon-separated set
11160 of hex digits including leading zeroes.
11161 A trailing ipv4-style dotted-decimal set is converted to hex.
11162 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11163
11164 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11165 .cindex "&%ipv6norm%& expansion item"
11166 .cindex "IP address" normalisation
11167 .cindex "IP address" "canonical form"
11168 This converts an IPv6 address to canonical form.
11169 Leading zeroes of groups are omitted, and the longest
11170 set of zero-valued groups is replaced with a double colon.
11171 A trailing ipv4-style dotted-decimal set is converted to hex.
11172 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11173
11174
11175 .vitem &*${lc:*&<&'string'&>&*}*&
11176 .cindex "case forcing in strings"
11177 .cindex "string" "case forcing"
11178 .cindex "lower casing"
11179 .cindex "expansion" "case forcing"
11180 .cindex "&%lc%& expansion item"
11181 This forces the letters in the string into lower-case, for example:
11182 .code
11183 ${lc:$local_part}
11184 .endd
11185 Case is defined per the system C locale.
11186
11187 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11188 .cindex "expansion" "string truncation"
11189 .cindex "&%length%& expansion item"
11190 The &%length%& operator is a simpler interface to the &%length%& function that
11191 can be used when the parameter is a fixed number (as opposed to a string that
11192 changes when expanded). The effect is the same as
11193 .code
11194 ${length{<number>}{<string>}}
11195 .endd
11196 See the description of the general &%length%& item above for details. Note that
11197 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11198 when &%length%& is used as an operator.
11199 All measurement is done in bytes and is not UTF-8 aware.
11200
11201
11202 .vitem &*${listcount:*&<&'string'&>&*}*&
11203 .cindex "expansion" "list item count"
11204 .cindex "list" "item count"
11205 .cindex "list" "count of items"
11206 .cindex "&%listcount%& expansion item"
11207 The string is interpreted as a list and the number of items is returned.
11208
11209
11210 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11211 .cindex "expansion" "named list"
11212 .cindex "&%listnamed%& expansion item"
11213 The name is interpreted as a named list and the content of the list is returned,
11214 expanding any referenced lists, re-quoting as needed for colon-separation.
11215 If the optional type is given it must be one of "a", "d", "h" or "l"
11216 and selects address-, domain-, host- or localpart- lists to search among respectively.
11217 Otherwise all types are searched in an undefined order and the first
11218 matching list is returned.
11219 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11220 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11221
11222
11223 .vitem &*${local_part:*&<&'string'&>&*}*&
11224 .cindex "expansion" "local part extraction"
11225 .cindex "&%local_part%& expansion item"
11226 The string is interpreted as an RFC 2822 address and the local part is
11227 extracted from it. If the string does not parse successfully, the result is
11228 empty.
11229 The parsing correctly handles SMTPUTF8 Unicode in the string.
11230
11231
11232 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11233        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11234 .cindex "masked IP address"
11235 .cindex "IP address" "masking"
11236 .cindex "CIDR notation"
11237 .cindex "expansion" "IP address masking"
11238 .cindex "&%mask%& expansion item"
11239 If the form of the string to be operated on is not an IP address followed by a
11240 slash and an integer (that is, a network address in CIDR notation), the
11241 expansion fails. Otherwise, this operator converts the IP address to binary,
11242 masks off the least significant bits according to the bit count, and converts
11243 the result back to text, with mask appended. For example,
11244 .code
11245 ${mask:10.111.131.206/28}
11246 .endd
11247 returns the string &"10.111.131.192/28"&.
11248
11249 Since this operation is expected to
11250 be mostly used for looking up masked addresses in files, the
11251 normal
11252 result for an IPv6
11253 address uses dots to separate components instead of colons, because colon
11254 terminates a key string in lsearch files. So, for example,
11255 .code
11256 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11257 .endd
11258 returns the string
11259 .code
11260 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11261 .endd
11262 If the optional form &*mask_n*& is used, IPv6 address result are instead
11263 returned in normailsed form, using colons and with zero-compression.
11264 Letters in IPv6 addresses are always output in lower case.
11265
11266
11267 .vitem &*${md5:*&<&'string'&>&*}*&
11268 .cindex "MD5 hash"
11269 .cindex "expansion" "MD5 hash"
11270 .cindex certificate fingerprint
11271 .cindex "&%md5%& expansion item"
11272 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11273 as a 32-digit hexadecimal number, in which any letters are in lower case.
11274
11275 If the string is a single variable of type certificate,
11276 returns the MD5 hash fingerprint of the certificate.
11277
11278
11279 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11280 .cindex "expansion" "numeric hash"
11281 .cindex "hash function" "numeric"
11282 The &%nhash%& operator is a simpler interface to the numeric hashing function
11283 that can be used when the two parameters are fixed numbers (as opposed to
11284 strings that change when expanded). The effect is the same as
11285 .code
11286 ${nhash{<n>}{<m>}{<string>}}
11287 .endd
11288 See the description of the general &%nhash%& item above for details.
11289
11290
11291 .vitem &*${quote:*&<&'string'&>&*}*&
11292 .cindex "quoting" "in string expansions"
11293 .cindex "expansion" "quoting"
11294 .cindex "&%quote%& expansion item"
11295 The &%quote%& operator puts its argument into double quotes if it
11296 is an empty string or
11297 contains anything other than letters, digits, underscores, dots, and hyphens.
11298 Any occurrences of double quotes and backslashes are escaped with a backslash.
11299 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11300 respectively For example,
11301 .code
11302 ${quote:ab"*"cd}
11303 .endd
11304 becomes
11305 .code
11306 "ab\"*\"cd"
11307 .endd
11308 The place where this is useful is when the argument is a substitution from a
11309 variable or a message header.
11310
11311 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11312 .cindex "&%quote_local_part%& expansion item"
11313 This operator is like &%quote%&, except that it quotes the string only if
11314 required to do so by the rules of RFC 2822 for quoting local parts. For
11315 example, a plus sign would not cause quoting (but it would for &%quote%&).
11316 If you are creating a new email address from the contents of &$local_part$&
11317 (or any other unknown data), you should always use this operator.
11318
11319 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11320 will likely use the quoting form.
11321 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11322
11323
11324 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11325 .cindex "quoting" "lookup-specific"
11326 This operator applies lookup-specific quoting rules to the string. Each
11327 query-style lookup type has its own quoting rules which are described with
11328 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11329 .code
11330 ${quote_ldap:two * two}
11331 .endd
11332 returns
11333 .code
11334 two%20%5C2A%20two
11335 .endd
11336 For single-key lookup types, no quoting is ever necessary and this operator
11337 yields an unchanged string.
11338
11339
11340 .vitem &*${randint:*&<&'n'&>&*}*&
11341 .cindex "random number"
11342 This operator returns a somewhat random number which is less than the
11343 supplied number and is at least 0.  The quality of this randomness depends
11344 on how Exim was built; the values are not suitable for keying material.
11345 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11346 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11347 for versions of GnuTLS with that function.
11348 Otherwise, the implementation may be arc4random(), random() seeded by
11349 srandomdev() or srandom(), or a custom implementation even weaker than
11350 random().
11351
11352
11353 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11354 .cindex "expansion" "IP address"
11355 This operator reverses an IP address; for IPv4 addresses, the result is in
11356 dotted-quad decimal form, while for IPv6 addresses the result is in
11357 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11358 for DNS.  For example,
11359 .code
11360 ${reverse_ip:192.0.2.4}
11361 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11362 .endd
11363 returns
11364 .code
11365 4.2.0.192
11366 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
11367 .endd
11368
11369
11370 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11371 .cindex "expansion" "RFC 2047"
11372 .cindex "RFC 2047" "expansion operator"
11373 .cindex "&%rfc2047%& expansion item"
11374 This operator encodes text according to the rules of RFC 2047. This is an
11375 encoding that is used in header lines to encode non-ASCII characters. It is
11376 assumed that the input string is in the encoding specified by the
11377 &%headers_charset%& option, which gets its default at build time. If the string
11378 contains only characters in the range 33&--126, and no instances of the
11379 characters
11380 .code
11381 ? = ( ) < > @ , ; : \ " . [ ] _
11382 .endd
11383 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11384 string, using as many &"encoded words"& as necessary to encode all the
11385 characters.
11386
11387
11388 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11389 .cindex "expansion" "RFC 2047"
11390 .cindex "RFC 2047" "decoding"
11391 .cindex "&%rfc2047d%& expansion item"
11392 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11393 bytes are replaced by question marks. Characters are converted into the
11394 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11395 not recognized unless &%check_rfc2047_length%& is set false.
11396
11397 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11398 access a header line, RFC 2047 decoding is done automatically. You do not need
11399 to use this operator as well.
11400
11401
11402
11403 .vitem &*${rxquote:*&<&'string'&>&*}*&
11404 .cindex "quoting" "in regular expressions"
11405 .cindex "regular expressions" "quoting"
11406 .cindex "&%rxquote%& expansion item"
11407 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11408 characters in its argument. This is useful when substituting the values of
11409 variables or headers inside regular expressions.
11410
11411
11412 .vitem &*${sha1:*&<&'string'&>&*}*&
11413 .cindex "SHA-1 hash"
11414 .cindex "expansion" "SHA-1 hashing"
11415 .cindex certificate fingerprint
11416 .cindex "&%sha1%& expansion item"
11417 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11418 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11419
11420 If the string is a single variable of type certificate,
11421 returns the SHA-1 hash fingerprint of the certificate.
11422
11423
11424 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11425        &*${sha2:*&<&'string'&>&*}*& &&&
11426        &*${sha2_<n>:*&<&'string'&>&*}*&
11427 .cindex "SHA-256 hash"
11428 .cindex "SHA-2 hash"
11429 .cindex certificate fingerprint
11430 .cindex "expansion" "SHA-256 hashing"
11431 .cindex "&%sha256%& expansion item"
11432 .cindex "&%sha2%& expansion item"
11433 The &%sha256%& operator computes the SHA-256 hash value of the string
11434 and returns
11435 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11436
11437 If the string is a single variable of type certificate,
11438 returns the SHA-256 hash fingerprint of the certificate.
11439
11440 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11441 (except for certificates, which are not supported).
11442 Finally, if an underbar
11443 and a number is appended it specifies the output length, selecting a
11444 member of the SHA-2 family of hash functions.
11445 Values of 256, 384 and 512 are accepted, with 256 being the default.
11446
11447
11448 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11449        &*${sha3_<n>:*&<&'string'&>&*}*&
11450 .cindex "SHA3 hash"
11451 .cindex "expansion" "SHA3 hashing"
11452 .cindex "&%sha3%& expansion item"
11453 The &%sha3%& operator computes the SHA3-256 hash value of the string
11454 and returns
11455 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11456
11457 If a number is appended, separated by an underbar, it specifies
11458 the output length.  Values of 224, 256, 384 and 512 are accepted;
11459 with 256 being the default.
11460
11461 The &%sha3%& expansion item is only supported if Exim has been
11462 compiled with GnuTLS 3.5.0 or later,
11463 or OpenSSL 1.1.1 or later.
11464 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11465
11466
11467 .vitem &*${stat:*&<&'string'&>&*}*&
11468 .cindex "expansion" "statting a file"
11469 .cindex "file" "extracting characteristics"
11470 .cindex "&%stat%& expansion item"
11471 The string, after expansion, must be a file path. A call to the &[stat()]&
11472 function is made for this path. If &[stat()]& fails, an error occurs and the
11473 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11474 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11475 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11476 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11477 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11478 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11479 can extract individual fields using the &%extract%& expansion item.
11480
11481 The use of the &%stat%& expansion in users' filter files can be locked out by
11482 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11483 systems for files larger than 2GB.
11484
11485 .vitem &*${str2b64:*&<&'string'&>&*}*&
11486 .cindex "&%str2b64%& expansion item"
11487 Now deprecated, a synonym for the &%base64%& expansion operator.
11488
11489
11490
11491 .vitem &*${strlen:*&<&'string'&>&*}*&
11492 .cindex "expansion" "string length"
11493 .cindex "string" "length in expansion"
11494 .cindex "&%strlen%& expansion item"
11495 The item is replaced by the length of the expanded string, expressed as a
11496 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11497 All measurement is done in bytes and is not UTF-8 aware.
11498
11499
11500 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11501 .cindex "&%substr%& expansion item"
11502 .cindex "substring extraction"
11503 .cindex "expansion" "substring expansion"
11504 The &%substr%& operator is a simpler interface to the &%substr%& function that
11505 can be used when the two parameters are fixed numbers (as opposed to strings
11506 that change when expanded). The effect is the same as
11507 .code
11508 ${substr{<start>}{<length>}{<string>}}
11509 .endd
11510 See the description of the general &%substr%& item above for details. The
11511 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11512 All measurement is done in bytes and is not UTF-8 aware.
11513
11514 .vitem &*${time_eval:*&<&'string'&>&*}*&
11515 .cindex "&%time_eval%& expansion item"
11516 .cindex "time interval" "decoding"
11517 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11518 seconds.
11519
11520 .vitem &*${time_interval:*&<&'string'&>&*}*&
11521 .cindex "&%time_interval%& expansion item"
11522 .cindex "time interval" "formatting"
11523 The argument (after sub-expansion) must be a sequence of decimal digits that
11524 represents an interval of time as a number of seconds. It is converted into a
11525 number of larger units and output in Exim's normal time format, for example,
11526 &`1w3d4h2m6s`&.
11527
11528 .vitem &*${uc:*&<&'string'&>&*}*&
11529 .cindex "case forcing in strings"
11530 .cindex "string" "case forcing"
11531 .cindex "upper casing"
11532 .cindex "expansion" "case forcing"
11533 .cindex "&%uc%& expansion item"
11534 This forces the letters in the string into upper-case.
11535 Case is defined per the system C locale.
11536
11537 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11538 .cindex "correction of invalid utf-8 sequences in strings"
11539 .cindex "utf-8" "utf-8 sequences"
11540 .cindex "incorrect utf-8"
11541 .cindex "expansion" "utf-8 forcing"
11542 .cindex "&%utf8clean%& expansion item"
11543 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11544 In versions of Exim before 4.92, this did not correctly do so for a truncated
11545 final codepoint's encoding, and the character would be silently dropped.
11546 If you must handle detection of this scenario across both sets of Exim behavior,
11547 the complexity will depend upon the task.
11548 For instance, to detect if the first character is multibyte and a 1-byte
11549 extraction can be successfully used as a path component (as is common for
11550 dividing up delivery folders), you might use:
11551 .code
11552 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11553 .endd
11554 (which will false-positive if the first character of the local part is a
11555 literal question mark).
11556
11557 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11558        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11559        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11560        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11561 .cindex expansion UTF-8
11562 .cindex UTF-8 expansion
11563 .cindex EAI
11564 .cindex internationalisation
11565 .cindex "&%utf8_domain_to_alabel%& expansion item"
11566 .cindex "&%utf8_domain_from_alabel%& expansion item"
11567 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11568 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11569 These convert EAI mail name components between UTF-8 and a-label forms.
11570 For information on internationalisation support see &<<SECTi18nMTA>>&.
11571 .endlist
11572
11573
11574
11575
11576
11577
11578 .section "Expansion conditions" "SECTexpcond"
11579 .scindex IIDexpcond "expansion" "conditions"
11580 The following conditions are available for testing by the &%${if%& construct
11581 while expanding strings:
11582
11583 .vlist
11584 .vitem &*!*&<&'condition'&>
11585 .cindex "expansion" "negating a condition"
11586 .cindex "negation" "in expansion condition"
11587 Preceding any condition with an exclamation mark negates the result of the
11588 condition.
11589
11590 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11591 .cindex "numeric comparison"
11592 .cindex "expansion" "numeric comparison"
11593 There are a number of symbolic operators for doing numeric comparisons. They
11594 are:
11595 .itable none 0 0 2 10* left 90* left
11596 .irow "=   " "equal"
11597 .irow "==  " "equal"
11598 .irow ">   " "greater"
11599 .irow ">=  " "greater or equal"
11600 .irow "<   " "less"
11601 .irow "<=  " "less or equal"
11602 .endtable
11603 For example:
11604 .code
11605 ${if >{$message_size}{10M} ...
11606 .endd
11607 Note that the general negation operator provides for inequality testing. The
11608 two strings must take the form of optionally signed decimal integers,
11609 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11610 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11611 As a special case, the numerical value of an empty string is taken as
11612 zero.
11613
11614 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11615 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11616 10M, not if 10M is larger than &$message_size$&.
11617
11618
11619 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11620         {*&<&'arg2'&>&*}...}*&
11621 .cindex "expansion" "calling an acl"
11622 .cindex "&%acl%&" "expansion condition"
11623 The name and zero to nine argument strings are first expanded separately.  The expanded
11624 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11625 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11626 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11627 and may use the variables; if another acl expansion is used the values
11628 are restored after it returns.  If the ACL sets
11629 a value using a "message =" modifier the variable $value becomes
11630 the result of the expansion, otherwise it is empty.
11631 If the ACL returns accept the condition is true; if deny, false.
11632 If the ACL returns defer the result is a forced-fail.
11633
11634 .vitem &*bool&~{*&<&'string'&>&*}*&
11635 .cindex "expansion" "boolean parsing"
11636 .cindex "&%bool%& expansion condition"
11637 This condition turns a string holding a true or false representation into
11638 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11639 (case-insensitively); also integer numbers map to true if non-zero,
11640 false if zero.
11641 An empty string is treated as false.
11642 Leading and trailing whitespace is ignored;
11643 thus a string consisting only of whitespace is false.
11644 All other string values will result in expansion failure.
11645
11646 When combined with ACL variables, this expansion condition will let you
11647 make decisions in one place and act on those decisions in another place.
11648 For example:
11649 .code
11650 ${if bool{$acl_m_privileged_sender} ...
11651 .endd
11652
11653
11654 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11655 .cindex "expansion" "boolean parsing"
11656 .cindex "&%bool_lax%& expansion condition"
11657 Like &%bool%&, this condition turns a string into a boolean state.  But
11658 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11659 loose definition that the Router &%condition%& option uses.  The empty string
11660 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11661 true.  Leading and trailing whitespace is ignored.
11662
11663 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11664
11665 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11666 .cindex "expansion" "encrypted comparison"
11667 .cindex "encrypted strings, comparing"
11668 .cindex "&%crypteq%& expansion condition"
11669 This condition is included in the Exim binary if it is built to support any
11670 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11671 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11672 included in the binary.
11673
11674 The &%crypteq%& condition has two arguments. The first is encrypted and
11675 compared against the second, which is already encrypted. The second string may
11676 be in the LDAP form for storing encrypted strings, which starts with the
11677 encryption type in curly brackets, followed by the data. If the second string
11678 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11679 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11680 Typically this will be a field from a password file. An example of an encrypted
11681 string in LDAP form is:
11682 .code
11683 {md5}CY9rzUYh03PK3k6DJie09g==
11684 .endd
11685 If such a string appears directly in an expansion, the curly brackets have to
11686 be quoted, because they are part of the expansion syntax. For example:
11687 .code
11688 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11689 .endd
11690 The following encryption types (whose names are matched case-independently) are
11691 supported:
11692
11693 .ilist
11694 .cindex "MD5 hash"
11695 .cindex "base64 encoding" "in encrypted password"
11696 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11697 printable characters to compare with the remainder of the second string. If the
11698 length of the comparison string is 24, Exim assumes that it is base64 encoded
11699 (as in the above example). If the length is 32, Exim assumes that it is a
11700 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11701 comparison fails.
11702
11703 .next
11704 .cindex "SHA-1 hash"
11705 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11706 printable characters to compare with the remainder of the second string. If the
11707 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11708 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11709 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11710
11711 .next
11712 .cindex "&[crypt()]&"
11713 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11714 only the first eight characters of the password. However, in modern operating
11715 systems this is no longer true, and in many cases the entire password is used,
11716 whatever its length.
11717
11718 .next
11719 .cindex "&[crypt16()]&"
11720 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11721 use up to 16 characters of the password in some operating systems. Again, in
11722 modern operating systems, more characters may be used.
11723 .endlist
11724 Exim has its own version of &[crypt16()]&, which is just a double call to
11725 &[crypt()]&. For operating systems that have their own version, setting
11726 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11727 operating system version instead of its own. This option is set by default in
11728 the OS-dependent &_Makefile_& for those operating systems that are known to
11729 support &[crypt16()]&.
11730
11731 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11732 it was not using the same algorithm as some operating systems' versions. It
11733 turns out that as well as &[crypt16()]& there is a function called
11734 &[bigcrypt()]& in some operating systems. This may or may not use the same
11735 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11736
11737 However, since there is now a move away from the traditional &[crypt()]&
11738 functions towards using SHA1 and other algorithms, tidying up this area of
11739 Exim is seen as very low priority.
11740
11741 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11742 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11743 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11744 default is &`{crypt}`&. Whatever the default, you can always use either
11745 function by specifying it explicitly in curly brackets.
11746
11747 .vitem &*def:*&<&'variable&~name'&>
11748 .cindex "expansion" "checking for empty variable"
11749 .cindex "&%def%& expansion condition"
11750 The &%def%& condition must be followed by the name of one of the expansion
11751 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11752 variable does not contain the empty string. For example:
11753 .code
11754 ${if def:sender_ident {from $sender_ident}}
11755 .endd
11756 Note that the variable name is given without a leading &%$%& character. If the
11757 variable does not exist, the expansion fails.
11758
11759 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11760         &~&*def:h_*&<&'header&~name'&>&*:*&"
11761 .cindex "expansion" "checking header line existence"
11762 This condition is true if a message is being processed and the named header
11763 exists in the message. For example,
11764 .code
11765 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11766 .endd
11767 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11768 the header name must be terminated by a colon if white space does not follow.
11769
11770 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11771        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11772 .cindex "string" "comparison"
11773 .cindex "expansion" "string comparison"
11774 .cindex "&%eq%& expansion condition"
11775 .cindex "&%eqi%& expansion condition"
11776 The two substrings are first expanded. The condition is true if the two
11777 resulting strings are identical. For &%eq%& the comparison includes the case of
11778 letters, whereas for &%eqi%& the comparison is case-independent, where
11779 case is defined per the system C locale.
11780
11781 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11782 .cindex "expansion" "file existence test"
11783 .cindex "file" "existence test"
11784 .cindex "&%exists%&, expansion condition"
11785 The substring is first expanded and then interpreted as an absolute path. The
11786 condition is true if the named file (or directory) exists. The existence test
11787 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11788 users' filter files may be locked out by the system administrator.
11789
11790 &*Note:*& Testing a path using this condition is not a sufficient way of
11791 de-tainting it.
11792 Consider using a dsearch lookup.
11793
11794 .vitem &*first_delivery*&
11795 .cindex "delivery" "first"
11796 .cindex "first delivery"
11797 .cindex "expansion" "first delivery test"
11798 .cindex "&%first_delivery%& expansion condition"
11799 .cindex retry condition
11800 This condition, which has no data, is true during a message's first delivery
11801 attempt. It is false during any subsequent delivery attempts.
11802
11803
11804 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11805        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11806 .cindex "list" "iterative conditions"
11807 .cindex "expansion" "&*forall*& condition"
11808 .cindex "expansion" "&*forany*& condition"
11809 .vindex "&$item$&"
11810 These conditions iterate over a list. The first argument is expanded to form
11811 the list. By default, the list separator is a colon, but it can be changed by
11812 the normal method (&<<SECTlistsepchange>>&).
11813 The second argument is interpreted as a condition that is to
11814 be applied to each item in the list in turn. During the interpretation of the
11815 condition, the current list item is placed in a variable called &$item$&.
11816 .ilist
11817 For &*forany*&, interpretation stops if the condition is true for any item, and
11818 the result of the whole condition is true. If the condition is false for all
11819 items in the list, the overall condition is false.
11820 .next
11821 For &*forall*&, interpretation stops if the condition is false for any item,
11822 and the result of the whole condition is false. If the condition is true for
11823 all items in the list, the overall condition is true.
11824 .endlist
11825 Note that negation of &*forany*& means that the condition must be false for all
11826 items for the overall condition to succeed, and negation of &*forall*& means
11827 that the condition must be false for at least one item.
11828
11829 Example:
11830 .code
11831 ${if forany{$recipients_list}{match{$item}{^user3@}}{yes}{no}}
11832 .endd
11833 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11834 being processed, to enable these expansion items to be nested.
11835
11836 To scan a named list, expand it with the &*listnamed*& operator.
11837
11838 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11839        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11840        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11841        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11842 .cindex JSON "iterative conditions"
11843 .cindex JSON expansions
11844 .cindex expansion "&*forall_json*& condition"
11845 .cindex expansion "&*forany_json*& condition"
11846 .cindex expansion "&*forall_jsons*& condition"
11847 .cindex expansion "&*forany_jsons*& condition"
11848 As for the above, except that the first argument must, after expansion,
11849 be a JSON array.
11850 The array separator is not changeable.
11851 For the &"jsons"& variants the elements are expected to be JSON strings
11852 and have their quotes removed before the evaluation of the condition.
11853
11854
11855
11856 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11857        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11858 .cindex "string" "comparison"
11859 .cindex "expansion" "string comparison"
11860 .cindex "&%ge%& expansion condition"
11861 .cindex "&%gei%& expansion condition"
11862 The two substrings are first expanded. The condition is true if the first
11863 string is lexically greater than or equal to the second string. For &%ge%& the
11864 comparison includes the case of letters, whereas for &%gei%& the comparison is
11865 case-independent.
11866 Case and collation order are defined per the system C locale.
11867
11868 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11869        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11870 .cindex "string" "comparison"
11871 .cindex "expansion" "string comparison"
11872 .cindex "&%gt%& expansion condition"
11873 .cindex "&%gti%& expansion condition"
11874 The two substrings are first expanded. The condition is true if the first
11875 string is lexically greater than the second string. For &%gt%& the comparison
11876 includes the case of letters, whereas for &%gti%& the comparison is
11877 case-independent.
11878 Case and collation order are defined per the system C locale.
11879
11880
11881 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11882 SRS decode.  See SECT &<<SECTSRS>>& for details.
11883
11884
11885 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11886        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11887 .cindex "string" "comparison"
11888 .cindex "list" "iterative conditions"
11889 Both strings are expanded; the second string is treated as a list of simple
11890 strings; if the first string is a member of the second, then the condition
11891 is true.
11892 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11893
11894 These are simpler to use versions of the more powerful &*forany*& condition.
11895 Examples, and the &*forany*& equivalents:
11896 .code
11897 ${if inlist{needle}{foo:needle:bar}}
11898   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11899 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11900   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11901 .endd
11902
11903 The variable &$value$& will be set for a successful match and can be
11904 used in the success clause of an &%if%& expansion item using the condition.
11905 .cindex "tainted data" "de-tainting"
11906 .cindex "de-tainting" "using an inlist expansion condition"
11907 It will have the same taint status as the list; expansions such as
11908 .code
11909 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11910 .endd
11911 can be used for de-tainting.
11912 Any previous &$value$& is restored after the if.
11913
11914
11915 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11916        &*isip4&~{*&<&'string'&>&*}*& &&&
11917        &*isip6&~{*&<&'string'&>&*}*&
11918 .cindex "IP address" "testing string format"
11919 .cindex "string" "testing for IP address"
11920 .cindex "&%isip%& expansion condition"
11921 .cindex "&%isip4%& expansion condition"
11922 .cindex "&%isip6%& expansion condition"
11923 The substring is first expanded, and then tested to see if it has the form of
11924 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11925 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11926
11927 For an IPv4 address, the test is for four dot-separated components, each of
11928 which consists of from one to three digits. For an IPv6 address, up to eight
11929 colon-separated components are permitted, each containing from one to four
11930 hexadecimal digits. There may be fewer than eight components if an empty
11931 component (adjacent colons) is present. Only one empty component is permitted.
11932
11933 &*Note*&: The checks used to be just on the form of the address; actual numerical
11934 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11935 check.
11936 This is no longer the case.
11937
11938 The main use of these tests is to distinguish between IP addresses and
11939 host names, or between IPv4 and IPv6 addresses. For example, you could use
11940 .code
11941 ${if isip4{$sender_host_address}...
11942 .endd
11943 to test which IP version an incoming SMTP connection is using.
11944
11945 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11946 .cindex "LDAP" "use for authentication"
11947 .cindex "expansion" "LDAP authentication test"
11948 .cindex "&%ldapauth%& expansion condition"
11949 This condition supports user authentication using LDAP. See section
11950 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11951 queries. For this use, the query must contain a user name and password. The
11952 query itself is not used, and can be empty. The condition is true if the
11953 password is not empty, and the user name and password are accepted by the LDAP
11954 server. An empty password is rejected without calling LDAP because LDAP binds
11955 with an empty password are considered anonymous regardless of the username, and
11956 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11957 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11958 this can be used.
11959
11960
11961 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11962        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11963 .cindex "string" "comparison"
11964 .cindex "expansion" "string comparison"
11965 .cindex "&%le%& expansion condition"
11966 .cindex "&%lei%& expansion condition"
11967 The two substrings are first expanded. The condition is true if the first
11968 string is lexically less than or equal to the second string. For &%le%& the
11969 comparison includes the case of letters, whereas for &%lei%& the comparison is
11970 case-independent.
11971 Case and collation order are defined per the system C locale.
11972
11973 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11974        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11975 .cindex "string" "comparison"
11976 .cindex "expansion" "string comparison"
11977 .cindex "&%lt%& expansion condition"
11978 .cindex "&%lti%& expansion condition"
11979 The two substrings are first expanded. The condition is true if the first
11980 string is lexically less than the second string. For &%lt%& the comparison
11981 includes the case of letters, whereas for &%lti%& the comparison is
11982 case-independent.
11983 Case and collation order are defined per the system C locale.
11984
11985
11986 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11987 .cindex "expansion" "regular expression comparison"
11988 .cindex "regular expressions" "match in expanded string"
11989 .cindex "&%match%& expansion condition"
11990 The two substrings are first expanded. The second is then treated as a regular
11991 expression and applied to the first. Because of the pre-expansion, if the
11992 regular expression contains dollar, or backslash characters, they must be
11993 escaped. Care must also be taken if the regular expression contains braces
11994 (curly brackets). A closing brace must be escaped so that it is not taken as a
11995 premature termination of <&'string2'&>. The easiest approach is to use the
11996 &`\N`& feature to disable expansion of the regular expression.
11997 For example,
11998 .code
11999 ${if match {$local_part}{\N^\d{3}\N} ...
12000 .endd
12001 If the whole expansion string is in double quotes, further escaping of
12002 backslashes is also required.
12003
12004 The condition is true if the regular expression match succeeds.
12005 The regular expression is not required to begin with a circumflex
12006 metacharacter, but if there is no circumflex, the expression is not anchored,
12007 and it may match anywhere in the subject, not just at the start. If you want
12008 the pattern to match at the end of the subject, you must include the &`$`&
12009 metacharacter at an appropriate point.
12010 All character handling is done in bytes and is not UTF-8 aware,
12011 but we might change this in a future Exim release.
12012
12013 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
12014 At the start of an &%if%& expansion the values of the numeric variable
12015 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
12016 succeeds causes them to be reset to the substrings of that condition and they
12017 will have these values during the expansion of the success string. At the end
12018 of the &%if%& expansion, the previous values are restored. After testing a
12019 combination of conditions using &%or%&, the subsequent values of the numeric
12020 variables are those of the condition that succeeded.
12021
12022 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12023 .cindex "&%match_address%& expansion condition"
12024 See &*match_local_part*&.
12025
12026 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12027 .cindex "&%match_domain%& expansion condition"
12028 See &*match_local_part*&.
12029
12030 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12031 .cindex "&%match_ip%& expansion condition"
12032 This condition matches an IP address to a list of IP address patterns. It must
12033 be followed by two argument strings. The first (after expansion) must be an IP
12034 address or an empty string. The second (not expanded) is a restricted host
12035 list that can match only an IP address, not a host name. For example:
12036 .code
12037 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12038 .endd
12039 The specific types of host list item that are permitted in the list are:
12040
12041 .ilist
12042 An IP address, optionally with a CIDR mask.
12043 .next
12044 A single asterisk, which matches any IP address.
12045 .next
12046 An empty item, which matches only if the IP address is empty. This could be
12047 useful for testing for a locally submitted message or one from specific hosts
12048 in a single test such as
12049 . ==== As this is a nested list, any displays it contains must be indented
12050 . ==== as otherwise they are too far to the left. This comment applies to
12051 . ==== the use of xmlto plus fop. There's no problem when formatting with
12052 . ==== sdop, with or without the extra indent.
12053 .code
12054   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12055 .endd
12056 where the first item in the list is the empty string.
12057 .next
12058 The item @[] matches any of the local host's interface addresses.
12059 .next
12060 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12061 even if &`net-`& is not specified. There is never any attempt to turn the IP
12062 address into a host name. The most common type of linear search for
12063 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12064 masks. For example:
12065 .code
12066   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12067 .endd
12068 It is of course possible to use other kinds of lookup, and in such a case, you
12069 do need to specify the &`net-`& prefix if you want to specify a specific
12070 address mask, for example:
12071 .code
12072   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12073 .endd
12074 However, unless you are combining a &%match_ip%& condition with others, it is
12075 just as easy to use the fact that a lookup is itself a condition, and write:
12076 .code
12077   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12078 .endd
12079 .endlist ilist
12080
12081 Note that <&'string2'&> is not itself subject to string expansion, unless
12082 Exim was built with the EXPAND_LISTMATCH_RHS option.
12083
12084 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12085
12086 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12087 .cindex "domain list" "in expansion condition"
12088 .cindex "address list" "in expansion condition"
12089 .cindex "local part" "list, in expansion condition"
12090 .cindex "&%match_local_part%& expansion condition"
12091 This condition, together with &%match_address%& and &%match_domain%&, make it
12092 possible to test domain, address, and local part lists within expansions. Each
12093 condition requires two arguments: an item and a list to match. A trivial
12094 example is:
12095 .code
12096 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12097 .endd
12098 In each case, the second argument may contain any of the allowable items for a
12099 list of the appropriate type. Also, because the second argument
12100 is a standard form of list, it is possible to refer to a named list.
12101 Thus, you can use conditions like this:
12102 .code
12103 ${if match_domain{$domain}{+local_domains}{...
12104 .endd
12105 .cindex "&`+caseful`&"
12106 For address lists, the matching starts off caselessly, but the &`+caseful`&
12107 item can be used, as in all address lists, to cause subsequent items to
12108 have their local parts matched casefully. Domains are always matched
12109 caselessly.
12110
12111 The variable &$value$& will be set for a successful match and can be
12112 used in the success clause of an &%if%& expansion item using the condition.
12113 .cindex "tainted data" "de-tainting"
12114 .cindex "de-tainting" "using a match_local_part expansion condition"
12115 It will have the same taint status as the list; expansions such as
12116 .code
12117 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12118 .endd
12119 can be used for de-tainting.
12120 Any previous &$value$& is restored after the if.
12121
12122 Note that <&'string2'&> is not itself subject to string expansion, unless
12123 Exim was built with the EXPAND_LISTMATCH_RHS option.
12124
12125 &*Note*&: Host lists are &'not'& supported in this way. This is because
12126 hosts have two identities: a name and an IP address, and it is not clear
12127 how to specify cleanly how such a test would work. However, IP addresses can be
12128 matched using &%match_ip%&.
12129
12130 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12131 .cindex "PAM authentication"
12132 .cindex "AUTH" "with PAM"
12133 .cindex "Solaris" "PAM support"
12134 .cindex "expansion" "PAM authentication test"
12135 .cindex "&%pam%& expansion condition"
12136 &'Pluggable Authentication Modules'&
12137 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12138 available in Solaris
12139 and in some GNU/Linux distributions.
12140 The Exim support, which is intended for use in conjunction with
12141 the SMTP AUTH command, is available only if Exim is compiled with
12142 .code
12143 SUPPORT_PAM=yes
12144 .endd
12145 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12146 in some releases of GNU/Linux &%-ldl%& is also needed.
12147
12148 The argument string is first expanded, and the result must be a
12149 colon-separated list of strings. Leading and trailing white space is ignored.
12150 The PAM module is initialized with the service name &"exim"& and the user name
12151 taken from the first item in the colon-separated data string (<&'string1'&>).
12152 The remaining items in the data string are passed over in response to requests
12153 from the authentication function. In the simple case there will only be one
12154 request, for a password, so the data consists of just two strings.
12155
12156 There can be problems if any of the strings are permitted to contain colon
12157 characters. In the usual way, these have to be doubled to avoid being taken as
12158 separators.
12159 The &%listquote%& expansion item can be used for this.
12160 For example, the configuration
12161 of a LOGIN authenticator might contain this setting:
12162 .code
12163 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12164 .endd
12165 In some operating systems, PAM authentication can be done only from a process
12166 running as root. Since Exim is running as the Exim user when receiving
12167 messages, this means that PAM cannot be used directly in those systems.
12168 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12169
12170
12171 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12172 .cindex "&'pwcheck'& daemon"
12173 .cindex "Cyrus"
12174 .cindex "expansion" "&'pwcheck'& authentication test"
12175 .cindex "&%pwcheck%& expansion condition"
12176 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12177 This is one way of making it possible for passwords to be checked by a process
12178 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12179 deprecated. Its replacement is &'saslauthd'& (see below).
12180
12181 The pwcheck support is not included in Exim by default. You need to specify
12182 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12183 building Exim. For example:
12184 .code
12185 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12186 .endd
12187 You do not need to install the full Cyrus software suite in order to use
12188 the pwcheck daemon. You can compile and install just the daemon alone
12189 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12190 access to the &_/var/pwcheck_& directory.
12191
12192 The &%pwcheck%& condition takes one argument, which must be the user name and
12193 password, separated by a colon. For example, in a LOGIN authenticator
12194 configuration, you might have this:
12195 .code
12196 server_condition = ${if pwcheck{$auth1:$auth2}}
12197 .endd
12198 Again, for a PLAIN authenticator configuration, this would be:
12199 .code
12200 server_condition = ${if pwcheck{$auth2:$auth3}}
12201 .endd
12202 .vitem &*queue_running*&
12203 .cindex "queue runner" "detecting when delivering from"
12204 .cindex "expansion" "queue runner test"
12205 .cindex "&%queue_running%& expansion condition"
12206 This condition, which has no data, is true during delivery attempts that are
12207 initiated by queue runner processes, and false otherwise.
12208
12209
12210 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12211 .cindex "Radius"
12212 .cindex "expansion" "Radius authentication"
12213 .cindex "&%radius%& expansion condition"
12214 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12215 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12216 the Radius client configuration file in order to build Exim with Radius
12217 support.
12218
12219 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12220 library, using the original API. If you are using release 0.4.0 or later of
12221 this library, you need to set
12222 .code
12223 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12224 .endd
12225 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12226 &%libradius%& library that comes with FreeBSD. To do this, set
12227 .code
12228 RADIUS_LIB_TYPE=RADLIB
12229 .endd
12230 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12231 You may also have to supply a suitable setting in EXTRALIBS so that the
12232 Radius library can be found when Exim is linked.
12233
12234 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12235 Radius client library, which calls the Radius server. The condition is true if
12236 the authentication is successful. For example:
12237 .code
12238 server_condition = ${if radius{<arguments>}}
12239 .endd
12240
12241
12242 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12243         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12244 .cindex "&'saslauthd'& daemon"
12245 .cindex "Cyrus"
12246 .cindex "expansion" "&'saslauthd'& authentication test"
12247 .cindex "&%saslauthd%& expansion condition"
12248 This condition supports user authentication using the Cyrus &'saslauthd'&
12249 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12250 Using this daemon is one way of making it possible for passwords to be checked
12251 by a process that is not running as root.
12252
12253 The saslauthd support is not included in Exim by default. You need to specify
12254 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12255 building Exim. For example:
12256 .code
12257 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12258 .endd
12259 You do not need to install the full Cyrus software suite in order to use
12260 the saslauthd daemon. You can compile and install just the daemon alone
12261 from the Cyrus SASL library.
12262
12263 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12264 two are mandatory. For example:
12265 .code
12266 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12267 .endd
12268 The service and the realm are optional (which is why the arguments are enclosed
12269 in their own set of braces). For details of the meaning of the service and
12270 realm, and how to run the daemon, consult the Cyrus documentation.
12271 .endlist vlist
12272
12273
12274
12275 .section "Combining expansion conditions" "SECID84"
12276 .cindex "expansion" "combining conditions"
12277 Several conditions can be tested at once by combining them using the &%and%&
12278 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12279 conditions on their own, and precede their lists of sub-conditions. Each
12280 sub-condition must be enclosed in braces within the overall braces that contain
12281 the list. No repetition of &%if%& is used.
12282
12283
12284 .vlist
12285 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12286 .cindex "&""or""& expansion condition"
12287 .cindex "expansion" "&""or""& of conditions"
12288 The sub-conditions are evaluated from left to right. The condition is true if
12289 any one of the sub-conditions is true.
12290 For example,
12291 .code
12292 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12293 .endd
12294 When a true sub-condition is found, the following ones are parsed but not
12295 evaluated. If there are several &"match"& sub-conditions the values of the
12296 numeric variables afterwards are taken from the first one that succeeds.
12297
12298 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12299 .cindex "&""and""& expansion condition"
12300 .cindex "expansion" "&""and""& of conditions"
12301 The sub-conditions are evaluated from left to right. The condition is true if
12302 all of the sub-conditions are true. If there are several &"match"&
12303 sub-conditions, the values of the numeric variables afterwards are taken from
12304 the last one. When a false sub-condition is found, the following ones are
12305 parsed but not evaluated.
12306 .endlist
12307 .ecindex IIDexpcond
12308
12309
12310
12311
12312 .section "Expansion variables" "SECTexpvar"
12313 .cindex "expansion" "variables, list of"
12314 This section contains an alphabetical list of all the expansion variables. Some
12315 of them are available only when Exim is compiled with specific options such as
12316 support for TLS or the content scanning extension.
12317 .cindex "tainted data"
12318 Variables marked as &'tainted'& are likely to carry data supplied by
12319 a potential attacker.
12320 Variables without such marking may also, depending on how their
12321 values are created.
12322 Such variables should not be further expanded,
12323 used as filenames
12324 or used as command-line arguments for external commands.
12325
12326 .vlist
12327 .vitem "&$0$&, &$1$&, etc"
12328 .cindex "numerical variables (&$1$& &$2$& etc)"
12329 When a &%match%& expansion condition succeeds, these variables contain the
12330 captured substrings identified by the regular expression during subsequent
12331 processing of the success string of the containing &%if%& expansion item.
12332 In the expansion condition case
12333 they do not retain their values afterwards; in fact, their previous
12334 values are restored at the end of processing an &%if%& item. The numerical
12335 variables may also be set externally by some other matching process which
12336 precedes the expansion of the string. For example, the commands available in
12337 Exim filter files include an &%if%& command with its own regular expression
12338 matching condition.
12339 If the subject string was tainted then any captured substring will also be.
12340
12341 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12342 Within an acl condition, expansion condition or expansion item
12343 any arguments are copied to these variables,
12344 any unused variables being made empty.
12345
12346 .vitem "&$acl_c...$&"
12347 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12348 can be given any name that starts with &$acl_c$& and is at least six characters
12349 long, but the sixth character must be either a digit or an underscore. For
12350 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12351 variables persist throughout the lifetime of an SMTP connection. They can be
12352 used to pass information between ACLs and between different invocations of the
12353 same ACL. When a message is received, the values of these variables are saved
12354 with the message, and can be accessed by filters, routers, and transports
12355 during subsequent delivery.
12356
12357 .vitem "&$acl_m...$&"
12358 These variables are like the &$acl_c...$& variables, except that their values
12359 are reset after a message has been received. Thus, if several messages are
12360 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12361 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12362 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12363 message is received, the values of these variables are saved with the message,
12364 and can be accessed by filters, routers, and transports during subsequent
12365 delivery.
12366
12367 .vitem &$acl_narg$&
12368 Within an acl condition, expansion condition or expansion item
12369 this variable has the number of arguments.
12370
12371 .vitem &$acl_verify_message$&
12372 .vindex "&$acl_verify_message$&"
12373 After an address verification has failed, this variable contains the failure
12374 message. It retains its value for use in subsequent modifiers of the verb.
12375 The message can be preserved by coding like this:
12376 .code
12377 warn !verify = sender
12378      set acl_m0 = $acl_verify_message
12379 .endd
12380 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12381 &%log_message%& modifiers, to include information about the verification
12382 failure.
12383 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12384
12385 .vitem &$address_data$&
12386 .vindex "&$address_data$&"
12387 This variable is set by means of the &%address_data%& option in routers. The
12388 value then remains with the address while it is processed by subsequent routers
12389 and eventually a transport. If the transport is handling multiple addresses,
12390 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12391 for more details. &*Note*&: The contents of &$address_data$& are visible in
12392 user filter files.
12393
12394 If &$address_data$& is set when the routers are called from an ACL to verify
12395 a recipient address, the final value is still in the variable for subsequent
12396 conditions and modifiers of the ACL statement. If routing the address caused it
12397 to be redirected to just one address, the child address is also routed as part
12398 of the verification, and in this case the final value of &$address_data$& is
12399 from the child's routing.
12400
12401 If &$address_data$& is set when the routers are called from an ACL to verify a
12402 sender address, the final value is also preserved, but this time in
12403 &$sender_address_data$&, to distinguish it from data from a recipient
12404 address.
12405
12406 In both cases (recipient and sender verification), the value does not persist
12407 after the end of the current ACL statement. If you want to preserve
12408 these values for longer, you can save them in ACL variables.
12409
12410 .vitem &$address_file$&
12411 .vindex "&$address_file$&"
12412 When, as a result of aliasing, forwarding, or filtering, a message is directed
12413 to a specific file, this variable holds the name of the file when the transport
12414 is running. At other times, the variable is empty. For example, using the
12415 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12416 .code
12417 /home/r2d2/savemail
12418 .endd
12419 then when the &(address_file)& transport is running, &$address_file$&
12420 contains the text string &`/home/r2d2/savemail`&.
12421 .cindex "Sieve filter" "value of &$address_file$&"
12422 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12423 then up to the transport configuration to generate an appropriate absolute path
12424 to the relevant file.
12425
12426 .vitem &$address_pipe$&
12427 .vindex "&$address_pipe$&"
12428 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12429 this variable holds the pipe command when the transport is running.
12430
12431 .vitem "&$auth1$& &-- &$auth4$&"
12432 .vindex "&$auth1$&, &$auth2$&, etc"
12433 These variables are used in SMTP authenticators (see chapters
12434 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12435
12436 .vitem &$authenticated_id$&
12437 .cindex "authentication" "id"
12438 .vindex "&$authenticated_id$&"
12439 When a server successfully authenticates a client it may be configured to
12440 preserve some of the authentication information in the variable
12441 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12442 user/password authenticator configuration might preserve the user name for use
12443 in the routers. Note that this is not the same information that is saved in
12444 &$sender_host_authenticated$&.
12445
12446 When a message is submitted locally (that is, not over a TCP connection)
12447 the value of &$authenticated_id$& is normally the login name of the calling
12448 process. However, a trusted user can override this by means of the &%-oMai%&
12449 command line option.
12450 This second case also sets up information used by the
12451 &$authresults$& expansion item.
12452
12453 .vitem &$authenticated_fail_id$&
12454 .cindex "authentication" "fail" "id"
12455 .vindex "&$authenticated_fail_id$&"
12456 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12457 will contain the failed authentication id. If more than one authentication
12458 id is attempted, it will contain only the last one. The variable is
12459 available for processing in the ACL's, generally the quit or notquit ACL.
12460 A message to a local recipient could still be accepted without requiring
12461 authentication, which means this variable could also be visible in all of
12462 the ACL's as well.
12463
12464
12465 .tvar &$authenticated_sender$&
12466 .cindex "sender" "authenticated"
12467 .cindex "authentication" "sender"
12468 .cindex "AUTH" "on MAIL command"
12469 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12470 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12471 described in section &<<SECTauthparamail>>&. Unless the data is the string
12472 &"<>"&, it is set as the authenticated sender of the message, and the value is
12473 available during delivery in the &$authenticated_sender$& variable. If the
12474 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12475
12476 .vindex "&$qualify_domain$&"
12477 When a message is submitted locally (that is, not over a TCP connection), the
12478 value of &$authenticated_sender$& is an address constructed from the login
12479 name of the calling process and &$qualify_domain$&, except that a trusted user
12480 can override this by means of the &%-oMas%& command line option.
12481
12482
12483 .vitem &$authentication_failed$&
12484 .cindex "authentication" "failure"
12485 .vindex "&$authentication_failed$&"
12486 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12487 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12488 possible to distinguish between &"did not try to authenticate"&
12489 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12490 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12491 is empty and &$authentication_failed$& is set to &"1"&).
12492 Failure includes cancellation of a authentication attempt,
12493 and any negative response to an AUTH command,
12494 (including, for example, an attempt to use an undefined mechanism).
12495
12496 .vitem &$av_failed$&
12497 .cindex "content scanning" "AV scanner failure"
12498 This variable is available when Exim is compiled with the content-scanning
12499 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12500 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12501 the ACL malware condition.
12502
12503 .vitem &$body_linecount$&
12504 .cindex "message body" "line count"
12505 .cindex "body of message" "line count"
12506 .vindex "&$body_linecount$&"
12507 When a message is being received or delivered, this variable contains the
12508 number of lines in the message's body. See also &$message_linecount$&.
12509
12510 .vitem &$body_zerocount$&
12511 .cindex "message body" "binary zero count"
12512 .cindex "body of message" "binary zero count"
12513 .cindex "binary zero" "in message body"
12514 .vindex "&$body_zerocount$&"
12515 When a message is being received or delivered, this variable contains the
12516 number of binary zero bytes (ASCII NULs) in the message's body.
12517
12518 .vitem &$bounce_recipient$&
12519 .vindex "&$bounce_recipient$&"
12520 This is set to the recipient address of a bounce message while Exim is creating
12521 it. It is useful if a customized bounce message text file is in use (see
12522 chapter &<<CHAPemsgcust>>&).
12523
12524 .vitem &$bounce_return_size_limit$&
12525 .vindex "&$bounce_return_size_limit$&"
12526 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12527 up to a multiple of 1000. It is useful when a customized error message text
12528 file is in use (see chapter &<<CHAPemsgcust>>&).
12529
12530 .vitem &$caller_gid$&
12531 .cindex "gid (group id)" "caller"
12532 .vindex "&$caller_gid$&"
12533 The real group id under which the process that called Exim was running. This is
12534 not the same as the group id of the originator of a message (see
12535 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12536 incarnation normally contains the Exim gid.
12537
12538 .vitem &$caller_uid$&
12539 .cindex "uid (user id)" "caller"
12540 .vindex "&$caller_uid$&"
12541 The real user id under which the process that called Exim was running. This is
12542 not the same as the user id of the originator of a message (see
12543 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12544 incarnation normally contains the Exim uid.
12545
12546 .vitem &$callout_address$&
12547 .vindex "&$callout_address$&"
12548 After a callout for verification, spamd or malware daemon service, the
12549 address that was connected to.
12550
12551 .vitem &$compile_number$&
12552 .vindex "&$compile_number$&"
12553 The building process for Exim keeps a count of the number
12554 of times it has been compiled. This serves to distinguish different
12555 compilations of the same version of Exim.
12556
12557 .vitem &$config_dir$&
12558 .vindex "&$config_dir$&"
12559 The directory name of the main configuration file. That is, the content of
12560 &$config_file$& with the last component stripped. The value does not
12561 contain the trailing slash. If &$config_file$& does not contain a slash,
12562 &$config_dir$& is ".".
12563
12564 .vitem &$config_file$&
12565 .vindex "&$config_file$&"
12566 The name of the main configuration file Exim is using.
12567
12568 .vitem &$dkim_verify_status$&
12569 Results of DKIM verification.
12570 For details see section &<<SECDKIMVFY>>&.
12571
12572 .vitem &$dkim_cur_signer$& &&&
12573        &$dkim_verify_reason$& &&&
12574        &$dkim_domain$& &&&
12575        &$dkim_identity$& &&&
12576        &$dkim_selector$& &&&
12577        &$dkim_algo$& &&&
12578        &$dkim_canon_body$& &&&
12579        &$dkim_canon_headers$& &&&
12580        &$dkim_copiedheaders$& &&&
12581        &$dkim_bodylength$& &&&
12582        &$dkim_created$& &&&
12583        &$dkim_expires$& &&&
12584        &$dkim_headernames$& &&&
12585        &$dkim_key_testing$& &&&
12586        &$dkim_key_nosubdomains$& &&&
12587        &$dkim_key_srvtype$& &&&
12588        &$dkim_key_granularity$& &&&
12589        &$dkim_key_notes$& &&&
12590        &$dkim_key_length$&
12591 These variables are only available within the DKIM ACL.
12592 For details see section &<<SECDKIMVFY>>&.
12593
12594 .vitem &$dkim_signers$&
12595 .vindex &$dkim_signers$&
12596 When a message has been received this variable contains
12597 a colon-separated list of signer domains and identities for the message.
12598 For details see section &<<SECDKIMVFY>>&.
12599
12600 .vitem &$dmarc_domain_policy$& &&&
12601        &$dmarc_status$& &&&
12602        &$dmarc_status_text$& &&&
12603        &$dmarc_used_domains$&
12604 Results of DMARC verification.
12605 For details see section &<<SECDMARC>>&.
12606
12607 .vitem &$dnslist_domain$& &&&
12608        &$dnslist_matched$& &&&
12609        &$dnslist_text$& &&&
12610        &$dnslist_value$&
12611 .vindex "&$dnslist_domain$&"
12612 .vindex "&$dnslist_matched$&"
12613 .vindex "&$dnslist_text$&"
12614 .vindex "&$dnslist_value$&"
12615 .cindex "black list (DNS)"
12616 When a DNS (black) list lookup succeeds, these variables are set to contain
12617 the following data from the lookup: the list's domain name, the key that was
12618 looked up, the contents of any associated TXT record, and the value from the
12619 main A record. See section &<<SECID204>>& for more details.
12620
12621 .tvar &$domain$&
12622 When an address is being routed, or delivered on its own, this variable
12623 contains the domain. Uppercase letters in the domain are converted into lower
12624 case for &$domain$&.
12625
12626 Global address rewriting happens when a message is received, so the value of
12627 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12628 is set during user filtering, but not during system filtering, because a
12629 message may have many recipients and the system filter is called just once.
12630
12631 When more than one address is being delivered at once (for example, several
12632 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12633 have the same domain. Transports can be restricted to handling only one domain
12634 at a time if the value of &$domain$& is required at transport time &-- this is
12635 the default for local transports. For further details of the environment in
12636 which local transports are run, see chapter &<<CHAPenvironment>>&.
12637
12638 .oindex "&%delay_warning_condition%&"
12639 At the end of a delivery, if all deferred addresses have the same domain, it is
12640 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12641
12642 The &$domain$& variable is also used in some other circumstances:
12643
12644 .ilist
12645 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12646 the recipient address. The domain of the &'sender'& address is in
12647 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12648 normally set during the running of the MAIL ACL. However, if the sender address
12649 is verified with a callout during the MAIL ACL, the sender domain is placed in
12650 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12651 the &(smtp)& transport.
12652
12653 .next
12654 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12655 &$domain$& contains the domain portion of the address that is being rewritten;
12656 it can be used in the expansion of the replacement address, for example, to
12657 rewrite domains by file lookup.
12658
12659 .next
12660 With one important exception, whenever a domain list is being scanned,
12661 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12662 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12663 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12664 that, in a RCPT ACL, the sender domain list can be dependent on the
12665 recipient domain (which is what is in &$domain$& at this time).
12666
12667 .next
12668 .cindex "ETRN" "value of &$domain$&"
12669 .oindex "&%smtp_etrn_command%&"
12670 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12671 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12672 .endlist
12673
12674 .cindex "tainted data"
12675 If the origin of the data is an incoming message,
12676 the result of expanding this variable is tainted and may not
12677 be further expanded or used as a filename.
12678 When an untainted version is needed, one should be obtained from
12679 looking up the value in a local (therefore trusted) database.
12680 Often &$domain_data$& is usable in this role.
12681
12682
12683 .vitem &$domain_data$&
12684 .vindex "&$domain_data$&"
12685 When the &%domains%& condition on a router
12686 or an ACL
12687 matches a domain
12688 against a list, the match value is copied to &$domain_data$&.
12689 This is an enhancement over previous versions of Exim, when it only
12690 applied to the data read by a lookup.
12691 For details on match values see section &<<SECTlistresults>>& et. al.
12692
12693 If the router routes the
12694 address to a transport, the value is available in that transport. If the
12695 transport is handling multiple addresses, the value from the first address is
12696 used.
12697
12698 &$domain_data$& set in an ACL is available during
12699 the rest of the ACL statement.
12700
12701 .vitem &$exim_gid$&
12702 .vindex "&$exim_gid$&"
12703 This variable contains the numerical value of the Exim group id.
12704
12705 .vitem &$exim_path$&
12706 .vindex "&$exim_path$&"
12707 This variable contains the path to the Exim binary.
12708
12709 .vitem &$exim_uid$&
12710 .vindex "&$exim_uid$&"
12711 This variable contains the numerical value of the Exim user id.
12712
12713 .vitem &$exim_version$&
12714 .vindex "&$exim_version$&"
12715 This variable contains the version string of the Exim build.
12716 The first character is a major version number, currently 4.
12717 Then after a dot, the next group of digits is a minor version number.
12718 There may be other characters following the minor version.
12719 This value may be overridden by the &%exim_version%& main config option.
12720
12721 .vitem &$header_$&<&'name'&>
12722 .tmark
12723 This is not strictly an expansion variable. It is expansion syntax for
12724 inserting the message header line with the given name. Note that the name must
12725 be terminated by colon or white space, because it may contain a wide variety of
12726 characters. Note also that braces must &'not'& be used.
12727 See the full description in section &<<SECTexpansionitems>>& above.
12728
12729 .vitem &$headers_added$&
12730 .vindex "&$headers_added$&"
12731 Within an ACL this variable contains the headers added so far by
12732 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12733 The headers are a newline-separated list.
12734
12735 .vitem &$home$&
12736 .vindex "&$home$&"
12737 When the &%check_local_user%& option is set for a router, the user's home
12738 directory is placed in &$home$& when the check succeeds. In particular, this
12739 means it is set during the running of users' filter files. A router may also
12740 explicitly set a home directory for use by a transport; this can be overridden
12741 by a setting on the transport itself.
12742
12743 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12744 of the environment variable HOME, which is subject to the
12745 &%keep_environment%& and &%add_environment%& main config options.
12746
12747 .vitem &$host$&
12748 .vindex "&$host$&"
12749 If a router assigns an address to a transport (any transport), and passes a
12750 list of hosts with the address, the value of &$host$& when the transport starts
12751 to run is the name of the first host on the list. Note that this applies both
12752 to local and remote transports.
12753
12754 .cindex "transport" "filter"
12755 .cindex "filter" "transport filter"
12756 For the &(smtp)& transport, if there is more than one host, the value of
12757 &$host$& changes as the transport works its way through the list. In
12758 particular, when the &(smtp)& transport is expanding its options for encryption
12759 using TLS, or for specifying a transport filter (see chapter
12760 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12761 is connected.
12762
12763 When used in the client part of an authenticator configuration (see chapter
12764 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12765 client is connected.
12766
12767
12768 .vitem &$host_address$&
12769 .vindex "&$host_address$&"
12770 This variable is set to the remote host's IP address whenever &$host$& is set
12771 for a remote connection. It is also set to the IP address that is being checked
12772 when the &%ignore_target_hosts%& option is being processed.
12773
12774 .vitem &$host_data$&
12775 .vindex "&$host_data$&"
12776 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12777 result of the lookup is made available in the &$host_data$& variable. This
12778 allows you, for example, to do things like this:
12779 .code
12780 deny  hosts = net-lsearch;/some/file
12781       message = $host_data
12782 .endd
12783
12784 .vitem &$host_lookup_deferred$&
12785 .cindex "host name" "lookup, failure of"
12786 .vindex "&$host_lookup_deferred$&"
12787 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12788 message comes from a remote host and there is an attempt to look up the host's
12789 name from its IP address, and the attempt is not successful, one of these
12790 variables is set to &"1"&.
12791
12792 .ilist
12793 If the lookup receives a definite negative response (for example, a DNS lookup
12794 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12795
12796 .next
12797 If there is any kind of problem during the lookup, such that Exim cannot
12798 tell whether or not the host name is defined (for example, a timeout for a DNS
12799 lookup), &$host_lookup_deferred$& is set to &"1"&.
12800 .endlist ilist
12801
12802 Looking up a host's name from its IP address consists of more than just a
12803 single reverse lookup. Exim checks that a forward lookup of at least one of the
12804 names it receives from a reverse lookup yields the original IP address. If this
12805 is not the case, Exim does not accept the looked up name(s), and
12806 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12807 IP address (for example, the existence of a PTR record in the DNS) is not
12808 sufficient on its own for the success of a host name lookup. If the reverse
12809 lookup succeeds, but there is a lookup problem such as a timeout when checking
12810 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12811 &"1"&. See also &$sender_host_name$&.
12812
12813 .cindex authentication "expansion item"
12814 Performing these checks sets up information used by the
12815 &%authresults%& expansion item.
12816
12817
12818 .vitem &$host_lookup_failed$&
12819 .vindex "&$host_lookup_failed$&"
12820 See &$host_lookup_deferred$&.
12821
12822 .vitem &$host_port$&
12823 .vindex "&$host_port$&"
12824 This variable is set to the remote host's TCP port whenever &$host$& is set
12825 for an outbound connection.
12826
12827 .vitem &$initial_cwd$&
12828 .vindex "&$initial_cwd$&
12829 This variable contains the full path name of the initial working
12830 directory of the current Exim process. This may differ from the current
12831 working directory, as Exim changes this to "/" during early startup, and
12832 to &$spool_directory$& later.
12833
12834 .vitem &$inode$&
12835 .vindex "&$inode$&"
12836 The only time this variable is set is while expanding the &%directory_file%&
12837 option in the &(appendfile)& transport. The variable contains the inode number
12838 of the temporary file which is about to be renamed. It can be used to construct
12839 a unique name for the file.
12840
12841 .vitem &$interface_address$& &&&
12842        &$interface_port$&
12843 .vindex "&$interface_address$&"
12844 .vindex "&$interface_port$&"
12845 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12846
12847 .vitem &$item$&
12848 .vindex "&$item$&"
12849 This variable is used during the expansion of &*forall*& and &*forany*&
12850 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12851 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12852 empty.
12853
12854 .vitem &$ldap_dn$&
12855 .vindex "&$ldap_dn$&"
12856 This variable, which is available only when Exim is compiled with LDAP support,
12857 contains the DN from the last entry in the most recently successful LDAP
12858 lookup.
12859
12860 .vitem &$load_average$&
12861 .vindex "&$load_average$&"
12862 This variable contains the system load average, multiplied by 1000 so that it
12863 is an integer. For example, if the load average is 0.21, the value of the
12864 variable is 210. The value is recomputed every time the variable is referenced.
12865
12866 .tvar &$local_part$&
12867 When an address is being routed, or delivered on its own, this
12868 variable contains the local part. When a number of addresses are being
12869 delivered together (for example, multiple RCPT commands in an SMTP
12870 session), &$local_part$& is not set.
12871
12872 Global address rewriting happens when a message is received, so the value of
12873 &$local_part$& during routing and delivery is the value after rewriting.
12874 &$local_part$& is set during user filtering, but not during system filtering,
12875 because a message may have many recipients and the system filter is called just
12876 once.
12877
12878 .cindex "tainted data"
12879 If the origin of the data is an incoming message,
12880 the result of expanding this variable is tainted and
12881 may not be further expanded or used as a filename.
12882
12883 &*Warning*&: the content of this variable is usually provided by a potential
12884 attacker.
12885 Consider carefully the implications of using it unvalidated as a name
12886 for file access.
12887 This presents issues for users' &_.forward_& and filter files.
12888 For traditional full user accounts, use &%check_local_users%& and the
12889 &$local_part_data$& variable rather than this one.
12890 For virtual users, store a suitable pathname component in the database
12891 which is used for account name validation, and use that retrieved value
12892 rather than this variable.
12893 Often &$local_part_data$& is usable in this role.
12894 If needed, use a router &%address_data%& or &%set%& option for
12895 the retrieved data.
12896
12897 When a message is being delivered to a file, pipe, or autoreply transport as a
12898 result of aliasing or forwarding, &$local_part$& is set to the local part of
12899 the parent address, not to the filename or command (see &$address_file$& and
12900 &$address_pipe$&).
12901
12902 When an ACL is running for a RCPT command, &$local_part$& contains the
12903 local part of the recipient address.
12904
12905 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12906 &$local_part$& contains the local part of the address that is being rewritten;
12907 it can be used in the expansion of the replacement address, for example.
12908
12909 In all cases, all quoting is removed from the local part. For example, for both
12910 the addresses
12911 .code
12912 "abc:xyz"@test.example
12913 abc\:xyz@test.example
12914 .endd
12915 the value of &$local_part$& is
12916 .code
12917 abc:xyz
12918 .endd
12919 If you use &$local_part$& to create another address, you should always wrap it
12920 inside a quoting operator. For example, in a &(redirect)& router you could
12921 have:
12922 .code
12923 data = ${quote_local_part:$local_part}@new.domain.example
12924 .endd
12925 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12926 to process local parts in a case-dependent manner in a router, you can set the
12927 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12928
12929 .vitem &$local_part_data$&
12930 .vindex "&$local_part_data$&"
12931 When the &%local_parts%& condition on a router or ACL
12932 matches a local part list
12933 the match value is copied to &$local_part_data$&.
12934 This is an enhancement over previous versions of Exim, when it only
12935 applied to the data read by a lookup.
12936 For details on match values see section &<<SECTlistresults>>& et. al.
12937
12938 The &%check_local_user%& router option also sets this variable.
12939
12940 .vindex &$local_part_prefix$& &&&
12941         &$local_part_prefix_v$& &&&
12942         &$local_part_suffix$& &&&
12943         &$local_part_suffix_v$&
12944 .cindex affix variables
12945 If a local part prefix or suffix has been recognized, it is not included in the
12946 value of &$local_part$& during routing and subsequent delivery. The values of
12947 any prefix or suffix are in &$local_part_prefix$& and
12948 &$local_part_suffix$&, respectively.
12949 .cindex "tainted data"
12950 If the specification did not include a wildcard then
12951 the affix variable value is not tainted.
12952
12953 If the affix specification included a wildcard then the portion of
12954 the affix matched by the wildcard is in
12955 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12956 and both the whole and varying values are tainted.
12957
12958 .vitem &$local_scan_data$&
12959 .vindex "&$local_scan_data$&"
12960 This variable contains the text returned by the &[local_scan()]& function when
12961 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12962
12963 .vitem &$local_user_gid$&
12964 .vindex "&$local_user_gid$&"
12965 See &$local_user_uid$&.
12966
12967 .vitem &$local_user_uid$&
12968 .vindex "&$local_user_uid$&"
12969 This variable and &$local_user_gid$& are set to the uid and gid after the
12970 &%check_local_user%& router precondition succeeds. This means that their values
12971 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12972 and &%condition%&), for the &%address_data%& expansion, and for any
12973 router-specific expansions. At all other times, the values in these variables
12974 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12975
12976 .vitem &$localhost_number$&
12977 .vindex "&$localhost_number$&"
12978 This contains the expanded value of the
12979 &%localhost_number%& option. The expansion happens after the main options have
12980 been read.
12981
12982 .vitem &$log_inodes$&
12983 .vindex "&$log_inodes$&"
12984 The number of free inodes in the disk partition where Exim's
12985 log files are being written. The value is recalculated whenever the variable is
12986 referenced. If the relevant file system does not have the concept of inodes,
12987 the value of is -1. See also the &%check_log_inodes%& option.
12988
12989 .vitem &$log_space$&
12990 .vindex "&$log_space$&"
12991 The amount of free space (as a number of kilobytes) in the disk
12992 partition where Exim's log files are being written. The value is recalculated
12993 whenever the variable is referenced. If the operating system does not have the
12994 ability to find the amount of free space (only true for experimental systems),
12995 the space value is -1. See also the &%check_log_space%& option.
12996
12997
12998 .vitem &$lookup_dnssec_authenticated$&
12999 .vindex "&$lookup_dnssec_authenticated$&"
13000 This variable is set after a DNS lookup done by
13001 a dnsdb lookup expansion, dnslookup router or smtp transport.
13002 .cindex "DNS" "DNSSEC"
13003 It will be empty if &(DNSSEC)& was not requested,
13004 &"no"& if the result was not labelled as authenticated data
13005 and &"yes"& if it was.
13006 Results that are labelled as authoritative answer that match
13007 the &%dns_trust_aa%& configuration variable count also
13008 as authenticated data.
13009
13010 .vitem &$mailstore_basename$&
13011 .vindex "&$mailstore_basename$&"
13012 This variable is set only when doing deliveries in &"mailstore"& format in the
13013 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
13014 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
13015 contains the basename of the files that are being written, that is, the name
13016 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
13017 variable is empty.
13018
13019 .vitem &$malware_name$&
13020 .vindex "&$malware_name$&"
13021 This variable is available when Exim is compiled with the
13022 content-scanning extension. It is set to the name of the virus that was found
13023 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13024
13025 .vitem &$max_received_linelength$&
13026 .vindex "&$max_received_linelength$&"
13027 .cindex "maximum" "line length"
13028 .cindex "line length" "maximum"
13029 This variable contains the number of bytes in the longest line that was
13030 received as part of the message, not counting the line termination
13031 character(s).
13032 It is not valid if the &%spool_wireformat%& option is used.
13033
13034 .vitem &$message_age$&
13035 .cindex "message" "age of"
13036 .vindex "&$message_age$&"
13037 This variable is set at the start of a delivery attempt to contain the number
13038 of seconds since the message was received. It does not change during a single
13039 delivery attempt.
13040
13041 .tvar &$message_body$&
13042 .cindex "body of message" "expansion variable"
13043 .cindex "message body" "in expansion"
13044 .cindex "binary zero" "in message body"
13045 .oindex "&%message_body_visible%&"
13046 This variable contains the initial portion of a message's body while it is
13047 being delivered, and is intended mainly for use in filter files. The maximum
13048 number of characters of the body that are put into the variable is set by the
13049 &%message_body_visible%& configuration option; the default is 500.
13050
13051 .oindex "&%message_body_newlines%&"
13052 By default, newlines are converted into spaces in &$message_body$&, to make it
13053 easier to search for phrases that might be split over a line break. However,
13054 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13055 zeros are always converted into spaces.
13056
13057 .tvar &$message_body_end$&
13058 .cindex "body of message" "expansion variable"
13059 .cindex "message body" "in expansion"
13060 This variable contains the final portion of a message's
13061 body while it is being delivered. The format and maximum size are as for
13062 &$message_body$&.
13063
13064 .vitem &$message_body_size$&
13065 .cindex "body of message" "size"
13066 .cindex "message body" "size"
13067 .vindex "&$message_body_size$&"
13068 When a message is being delivered, this variable contains the size of the body
13069 in bytes. The count starts from the character after the blank line that
13070 separates the body from the header. Newlines are included in the count. See
13071 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13072
13073 If the spool file is wireformat
13074 (see the &%spool_wireformat%& main option)
13075 the CRLF line-terminators are included in the count.
13076
13077 .vitem &$message_exim_id$&
13078 .vindex "&$message_exim_id$&"
13079 When a message is being received or delivered, this variable contains the
13080 unique message id that is generated and used by Exim to identify the message.
13081 An id is not created for a message until after its header has been successfully
13082 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13083 line; it is the local id that Exim assigns to the message, for example:
13084 &`1BXTIK-0001yO-VA`&.
13085
13086 .tvar &$message_headers$&
13087 This variable contains a concatenation of all the header lines when a message
13088 is being processed, except for lines added by routers or transports. The header
13089 lines are separated by newline characters. Their contents are decoded in the
13090 same way as a header line that is inserted by &%bheader%&.
13091
13092 .tvar &$message_headers_raw$&
13093 This variable is like &$message_headers$& except that no processing of the
13094 contents of header lines is done.
13095
13096 .vitem &$message_id$&
13097 This is an old name for &$message_exim_id$&. It is now deprecated.
13098
13099 .vitem &$message_linecount$&
13100 .vindex "&$message_linecount$&"
13101 This variable contains the total number of lines in the header and body of the
13102 message. Compare &$body_linecount$&, which is the count for the body only.
13103 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13104 number of lines received. Before delivery happens (that is, before filters,
13105 routers, and transports run) the count is increased to include the
13106 &'Received:'& header line that Exim standardly adds, and also any other header
13107 lines that are added by ACLs. The blank line that separates the message header
13108 from the body is not counted.
13109
13110 As with the special case of &$message_size$&, during the expansion of the
13111 appendfile transport's maildir_tag option in maildir format, the value of
13112 &$message_linecount$& is the precise size of the number of newlines in the
13113 file that has been written (minus one for the blank line between the
13114 header and the body).
13115
13116 Here is an example of the use of this variable in a DATA ACL:
13117 .code
13118 deny condition = \
13119       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13120      message   = Too many lines in message header
13121 .endd
13122 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13123 message has not yet been received.
13124
13125 This variable is not valid if the &%spool_wireformat%& option is used.
13126
13127 .vitem &$message_size$&
13128 .cindex "size" "of message"
13129 .cindex "message" "size"
13130 .vindex "&$message_size$&"
13131 When a message is being processed, this variable contains its size in bytes. In
13132 most cases, the size includes those headers that were received with the
13133 message, but not those (such as &'Envelope-to:'&) that are added to individual
13134 deliveries as they are written. However, there is one special case: during the
13135 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13136 doing a delivery in maildir format, the value of &$message_size$& is the
13137 precise size of the file that has been written. See also
13138 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13139
13140 .cindex "RCPT" "value of &$message_size$&"
13141 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13142 contains the size supplied on the MAIL command, or -1 if no size was given. The
13143 value may not, of course, be truthful.
13144
13145 .vitem &$mime_anomaly_level$& &&&
13146        &$mime_anomaly_text$& &&&
13147        &$mime_boundary$& &&&
13148        &$mime_charset$& &&&
13149        &$mime_content_description$& &&&
13150        &$mime_content_disposition$& &&&
13151        &$mime_content_id$& &&&
13152        &$mime_content_size$& &&&
13153        &$mime_content_transfer_encoding$& &&&
13154        &$mime_content_type$& &&&
13155        &$mime_decoded_filename$& &&&
13156        &$mime_filename$& &&&
13157        &$mime_is_coverletter$& &&&
13158        &$mime_is_multipart$& &&&
13159        &$mime_is_rfc822$& &&&
13160        &$mime_part_count$&
13161 A number of variables whose names start with &$mime$& are
13162 available when Exim is compiled with the content-scanning extension. For
13163 details, see section &<<SECTscanmimepart>>&.
13164
13165 .vitem "&$n0$& &-- &$n9$&"
13166 These variables are counters that can be incremented by means
13167 of the &%add%& command in filter files.
13168
13169 .tvar &$original_domain$&
13170 .vindex "&$domain$&"
13171 When a top-level address is being processed for delivery, this contains the
13172 same value as &$domain$&. However, if a &"child"& address (for example,
13173 generated by an alias, forward, or filter file) is being processed, this
13174 variable contains the domain of the original address (lower cased). This
13175 differs from &$parent_domain$& only when there is more than one level of
13176 aliasing or forwarding. When more than one address is being delivered in a
13177 single transport run, &$original_domain$& is not set.
13178
13179 If a new address is created by means of a &%deliver%& command in a system
13180 filter, it is set up with an artificial &"parent"& address. This has the local
13181 part &'system-filter'& and the default qualify domain.
13182
13183 .tvar &$original_local_part$&
13184 .vindex "&$local_part$&"
13185 When a top-level address is being processed for delivery, this contains the
13186 same value as &$local_part$&, unless a prefix or suffix was removed from the
13187 local part, because &$original_local_part$& always contains the full local
13188 part. When a &"child"& address (for example, generated by an alias, forward, or
13189 filter file) is being processed, this variable contains the full local part of
13190 the original address.
13191
13192 If the router that did the redirection processed the local part
13193 case-insensitively, the value in &$original_local_part$& is in lower case.
13194 This variable differs from &$parent_local_part$& only when there is more than
13195 one level of aliasing or forwarding. When more than one address is being
13196 delivered in a single transport run, &$original_local_part$& is not set.
13197
13198 If a new address is created by means of a &%deliver%& command in a system
13199 filter, it is set up with an artificial &"parent"& address. This has the local
13200 part &'system-filter'& and the default qualify domain.
13201
13202 .vitem &$originator_gid$&
13203 .cindex "gid (group id)" "of originating user"
13204 .cindex "sender" "gid"
13205 .vindex "&$caller_gid$&"
13206 .vindex "&$originator_gid$&"
13207 This variable contains the value of &$caller_gid$& that was set when the
13208 message was received. For messages received via the command line, this is the
13209 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13210 normally the gid of the Exim user.
13211
13212 .vitem &$originator_uid$&
13213 .cindex "uid (user id)" "of originating user"
13214 .cindex "sender" "uid"
13215 .vindex "&$caller_uid$&"
13216 .vindex "&$originator_uid$&"
13217 The value of &$caller_uid$& that was set when the message was received. For
13218 messages received via the command line, this is the uid of the sending user.
13219 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13220 user.
13221
13222 .tvar &$parent_domain$&
13223 This variable is similar to &$original_domain$& (see
13224 above), except that it refers to the immediately preceding parent address.
13225
13226 .tvar &$parent_local_part$&
13227 This variable is similar to &$original_local_part$&
13228 (see above), except that it refers to the immediately preceding parent address.
13229
13230 .vitem &$pid$&
13231 .cindex "pid (process id)" "of current process"
13232 .vindex "&$pid$&"
13233 This variable contains the current process id.
13234
13235 .vitem &$pipe_addresses$&
13236 .cindex "filter" "transport filter"
13237 .cindex "transport" "filter"
13238 .vindex "&$pipe_addresses$&"
13239 This is not an expansion variable, but is mentioned here because the string
13240 &`$pipe_addresses`& is handled specially in the command specification for the
13241 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13242 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13243 It cannot be used in general expansion strings, and provokes an &"unknown
13244 variable"& error if encountered.
13245 &*Note*&: This value permits data supplied by a potential attacker to
13246 be used in the command for a &(pipe)& transport.
13247 Such configurations should be carefully assessed for security vulnerbilities.
13248
13249 .vitem &$primary_hostname$&
13250 .vindex "&$primary_hostname$&"
13251 This variable contains the value set by &%primary_hostname%& in the
13252 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13253 a single-component name, Exim calls &[gethostbyname()]& (or
13254 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13255 qualified host name. See also &$smtp_active_hostname$&.
13256
13257
13258 .vitem &$proxy_external_address$& &&&
13259        &$proxy_external_port$& &&&
13260        &$proxy_local_address$& &&&
13261        &$proxy_local_port$& &&&
13262        &$proxy_session$&
13263 These variables are only available when built with Proxy Protocol
13264 or SOCKS5 support.
13265 For details see chapter &<<SECTproxyInbound>>&.
13266
13267 .vitem &$prdr_requested$&
13268 .cindex "PRDR" "variable for"
13269 This variable is set to &"yes"& if PRDR was requested by the client for the
13270 current message, otherwise &"no"&.
13271
13272 .vitem &$prvscheck_address$& &&&
13273        &$prvscheck_keynum$& &&&
13274        &$prvscheck_result$&
13275 These variables are used in conjunction with the &%prvscheck%& expansion item,
13276 which is described in sections &<<SECTexpansionitems>>& and
13277 &<<SECTverifyPRVS>>&.
13278
13279 .vitem &$qualify_domain$&
13280 .vindex "&$qualify_domain$&"
13281 The value set for the &%qualify_domain%& option in the configuration file.
13282
13283 .vitem &$qualify_recipient$&
13284 .vindex "&$qualify_recipient$&"
13285 The value set for the &%qualify_recipient%& option in the configuration file,
13286 or if not set, the value of &$qualify_domain$&.
13287
13288 .vitem &$queue_name$&
13289 .vindex &$queue_name$&
13290 .cindex "named queues" variable
13291 .cindex queues named
13292 The name of the spool queue in use; empty for the default queue.
13293
13294 .vitem &$queue_size$&
13295 .vindex "&$queue_size$&"
13296 .cindex "queue" "size of"
13297 .cindex "spool" "number of messages"
13298 This variable contains the number of messages queued.
13299 It is evaluated on demand, but no more often than once every minute.
13300 If there is no daemon notifier socket open, the value will be
13301 an empty string.
13302
13303 .vitem &$r_...$&
13304 .vindex &$r_...$&
13305 .cindex router variables
13306 Values can be placed in these variables by the &%set%& option of a router.
13307 They can be given any name that starts with &$r_$&.
13308 The values persist for the address being handled through subsequent routers
13309 and the eventual transport.
13310
13311 .vitem &$rcpt_count$&
13312 .vindex "&$rcpt_count$&"
13313 When a message is being received by SMTP, this variable contains the number of
13314 RCPT commands received for the current message. If this variable is used in a
13315 RCPT ACL, its value includes the current command.
13316
13317 .vitem &$rcpt_defer_count$&
13318 .vindex "&$rcpt_defer_count$&"
13319 .cindex "4&'xx'& responses" "count of"
13320 When a message is being received by SMTP, this variable contains the number of
13321 RCPT commands in the current message that have previously been rejected with a
13322 temporary (4&'xx'&) response.
13323
13324 .vitem &$rcpt_fail_count$&
13325 .vindex "&$rcpt_fail_count$&"
13326 When a message is being received by SMTP, this variable contains the number of
13327 RCPT commands in the current message that have previously been rejected with a
13328 permanent (5&'xx'&) response.
13329
13330 .vitem &$received_count$&
13331 .vindex "&$received_count$&"
13332 This variable contains the number of &'Received:'& header lines in the message,
13333 including the one added by Exim (so its value is always greater than zero). It
13334 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13335 delivering.
13336
13337 .tvar &$received_for$&
13338 If there is only a single recipient address in an incoming message, this
13339 variable contains that address when the &'Received:'& header line is being
13340 built. The value is copied after recipient rewriting has happened, but before
13341 the &[local_scan()]& function is run.
13342
13343 .vitem &$received_ip_address$& &&&
13344        &$received_port$&
13345 .vindex "&$received_ip_address$&"
13346 .vindex "&$received_port$&"
13347 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13348 variables are set to the address and port on the local IP interface.
13349 (The remote IP address and port are in
13350 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13351 the port value is -1 unless it has been set using the &%-oMi%& command line
13352 option.
13353
13354 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13355 could be used, for example, to make the filename for a TLS certificate depend
13356 on which interface and/or port is being used for the incoming connection. The
13357 values of &$received_ip_address$& and &$received_port$& are saved with any
13358 messages that are received, thus making these variables available at delivery
13359 time.
13360 For outbound connections see &$sending_ip_address$&.
13361
13362 .vitem &$received_protocol$&
13363 .vindex "&$received_protocol$&"
13364 When a message is being processed, this variable contains the name of the
13365 protocol by which it was received. Most of the names used by Exim are defined
13366 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13367 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13368 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13369 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13370 connection and the client was successfully authenticated.
13371
13372 Exim uses the protocol name &"smtps"& for the case when encryption is
13373 automatically set up on connection without the use of STARTTLS (see
13374 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13375 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13376 where the client initially uses EHLO, sets up an encrypted connection using
13377 STARTTLS, and then uses HELO afterwards.
13378
13379 The &%-oMr%& option provides a way of specifying a custom protocol name for
13380 messages that are injected locally by trusted callers. This is commonly used to
13381 identify messages that are being re-injected after some kind of scanning.
13382
13383 .vitem &$received_time$&
13384 .vindex "&$received_time$&"
13385 This variable contains the date and time when the current message was received,
13386 as a number of seconds since the start of the Unix epoch.
13387
13388 .vitem &$recipient_data$&
13389 .vindex "&$recipient_data$&"
13390 This variable is set after an indexing lookup success in an ACL &%recipients%&
13391 condition. It contains the data from the lookup, and the value remains set
13392 until the next &%recipients%& test. Thus, you can do things like this:
13393 .display
13394 &`require recipients  = cdb*@;/some/file`&
13395 &`deny    `&&'some further test involving'& &`$recipient_data`&
13396 .endd
13397 &*Warning*&: This variable is set only when a lookup is used as an indexing
13398 method in the address list, using the semicolon syntax as in the example above.
13399 The variable is not set for a lookup that is used as part of the string
13400 expansion that all such lists undergo before being interpreted.
13401
13402 .vitem &$recipient_verify_failure$&
13403 .vindex "&$recipient_verify_failure$&"
13404 In an ACL, when a recipient verification fails, this variable contains
13405 information about the failure. It is set to one of the following words:
13406
13407 .ilist
13408 &"qualify"&: The address was unqualified (no domain), and the message
13409 was neither local nor came from an exempted host.
13410
13411 .next
13412 &"route"&: Routing failed.
13413
13414 .next
13415 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13416 or before the MAIL command (that is, on initial connection, HELO, or
13417 MAIL).
13418
13419 .next
13420 &"recipient"&: The RCPT command in a callout was rejected.
13421 .next
13422
13423 &"postmaster"&: The postmaster check in a callout was rejected.
13424 .endlist
13425
13426 The main use of this variable is expected to be to distinguish between
13427 rejections of MAIL and rejections of RCPT.
13428
13429 .tvar &$recipients$&
13430 .new
13431 .tvar &$recipients_list$&
13432 These variables both contain the envelope recipients for a message.
13433
13434 The first uses a comma and a space separate the addresses in the replacement text.
13435 &*Note*&: an address can legitimately contain a comma;
13436 this variable is not intended for further processing.
13437
13438 The second is a proper Exim list; colon-separated.
13439 .wen
13440
13441 However, the variables
13442 are not generally available, to prevent exposure of Bcc recipients in
13443 unprivileged users' filter files. You can use either of them  only in these
13444 cases:
13445
13446 .olist
13447 In a system filter file.
13448 .next
13449 In the ACLs associated with the DATA command and with non-SMTP messages, that
13450 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13451 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13452 &%acl_not_smtp_mime%&.
13453 .next
13454 From within a &[local_scan()]& function.
13455 .endlist
13456
13457
13458 .vitem &$recipients_count$&
13459 .vindex "&$recipients_count$&"
13460 When a message is being processed, this variable contains the number of
13461 envelope recipients that came with the message. Duplicates are not excluded
13462 from the count. While a message is being received over SMTP, the number
13463 increases for each accepted recipient. It can be referenced in an ACL.
13464
13465
13466 .vitem &$regex_match_string$&
13467 .vindex "&$regex_match_string$&"
13468 This variable is set to contain the matching regular expression after a
13469 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13470
13471 .vitem "&$regex1$&, &$regex2$&, etc"
13472 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13473 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13474 these variables contain the
13475 captured substrings identified by the regular expression.
13476 If the subject string was tainted then so will any captured substring.
13477
13478
13479 .tvar &$reply_address$&
13480 When a message is being processed, this variable contains the contents of the
13481 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13482 contents of the &'From:'& header line. Apart from the removal of leading
13483 white space, the value is not processed in any way. In particular, no RFC 2047
13484 decoding or character code translation takes place.
13485
13486 .vitem &$return_path$&
13487 .vindex "&$return_path$&"
13488 When a message is being delivered, this variable contains the return path &--
13489 the sender field that will be sent as part of the envelope. It is not enclosed
13490 in <> characters. At the start of routing an address, &$return_path$& has the
13491 same value as &$sender_address$&, but if, for example, an incoming message to a
13492 mailing list has been expanded by a router which specifies a different address
13493 for bounce messages, &$return_path$& subsequently contains the new bounce
13494 address, whereas &$sender_address$& always contains the original sender address
13495 that was received with the message. In other words, &$sender_address$& contains
13496 the incoming envelope sender, and &$return_path$& contains the outgoing
13497 envelope sender.
13498
13499 .vitem &$return_size_limit$&
13500 .vindex "&$return_size_limit$&"
13501 This is an obsolete name for &$bounce_return_size_limit$&.
13502
13503 .vitem &$router_name$&
13504 .cindex "router" "name"
13505 .cindex "name" "of router"
13506 .vindex "&$router_name$&"
13507 During the running of a router, or a transport called,
13508 this variable contains the router name.
13509
13510 .vitem &$runrc$&
13511 .cindex "return code" "from &%run%& expansion"
13512 .vindex "&$runrc$&"
13513 This variable contains the return code from a command that is run by the
13514 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13515 assume the order in which option values are expanded, except for those
13516 preconditions whose order of testing is documented. Therefore, you cannot
13517 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13518 another.
13519
13520 .vitem &$self_hostname$&
13521 .oindex "&%self%&" "value of host name"
13522 .vindex "&$self_hostname$&"
13523 When an address is routed to a supposedly remote host that turns out to be the
13524 local host, what happens is controlled by the &%self%& generic router option.
13525 One of its values causes the address to be passed to another router. When this
13526 happens, &$self_hostname$& is set to the name of the local host that the
13527 original router encountered. In other circumstances its contents are null.
13528
13529 .tvar &$sender_address$&
13530 When a message is being processed, this variable contains the sender's address
13531 that was received in the message's envelope. The case of letters in the address
13532 is retained, in both the local part and the domain. For bounce messages, the
13533 value of this variable is the empty string. See also &$return_path$&.
13534
13535 .vitem &$sender_address_data$&
13536 .vindex "&$address_data$&"
13537 .vindex "&$sender_address_data$&"
13538 If &$address_data$& is set when the routers are called from an ACL to verify a
13539 sender address, the final value is preserved in &$sender_address_data$&, to
13540 distinguish it from data from a recipient address. The value does not persist
13541 after the end of the current ACL statement. If you want to preserve it for
13542 longer, you can save it in an ACL variable.
13543
13544 .tvar &$sender_address_domain$&
13545 The domain portion of &$sender_address$&.
13546
13547 .tvar &$sender_address_local_part$&
13548 The local part portion of &$sender_address$&.
13549
13550 .vitem &$sender_data$&
13551 .vindex "&$sender_data$&"
13552 This variable is set after a lookup success in an ACL &%senders%& condition or
13553 in a router &%senders%& option. It contains the data from the lookup, and the
13554 value remains set until the next &%senders%& test. Thus, you can do things like
13555 this:
13556 .display
13557 &`require senders      = cdb*@;/some/file`&
13558 &`deny    `&&'some further test involving'& &`$sender_data`&
13559 .endd
13560 &*Warning*&: This variable is set only when a lookup is used as an indexing
13561 method in the address list, using the semicolon syntax as in the example above.
13562 The variable is not set for a lookup that is used as part of the string
13563 expansion that all such lists undergo before being interpreted.
13564
13565 .vitem &$sender_fullhost$&
13566 .vindex "&$sender_fullhost$&"
13567 When a message is received from a remote host, this variable contains the host
13568 name and IP address in a single string. It ends with the IP address in square
13569 brackets, followed by a colon and a port number if the logging of ports is
13570 enabled. The format of the rest of the string depends on whether the host
13571 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13572 looking up its IP address. (Looking up the IP address can be forced by the
13573 &%host_lookup%& option, independent of verification.) A plain host name at the
13574 start of the string is a verified host name; if this is not present,
13575 verification either failed or was not requested. A host name in parentheses is
13576 the argument of a HELO or EHLO command. This is omitted if it is identical to
13577 the verified host name or to the host's IP address in square brackets.
13578
13579 .vitem &$sender_helo_dnssec$&
13580 .vindex "&$sender_helo_dnssec$&"
13581 This boolean variable is true if a successful HELO verification was
13582 .cindex "DNS" "DNSSEC"
13583 done using DNS information the resolver library stated was authenticated data.
13584
13585 .tvar &$sender_helo_name$&
13586 When a message is received from a remote host that has issued a HELO or EHLO
13587 command, the argument of that command is placed in this variable. It is also
13588 set if HELO or EHLO is used when a message is received using SMTP locally via
13589 the &%-bs%& or &%-bS%& options.
13590
13591 .vitem &$sender_host_address$&
13592 .vindex "&$sender_host_address$&"
13593 When a message is received from a remote host using SMTP,
13594 this variable contains that
13595 host's IP address. For locally non-SMTP submitted messages, it is empty.
13596
13597 .vitem &$sender_host_authenticated$&
13598 .vindex "&$sender_host_authenticated$&"
13599 This variable contains the name (not the public name) of the authenticator
13600 driver that successfully authenticated the client from which the message was
13601 received. It is empty if there was no successful authentication. See also
13602 &$authenticated_id$&.
13603
13604 .vitem &$sender_host_dnssec$&
13605 .vindex "&$sender_host_dnssec$&"
13606 If an attempt to populate &$sender_host_name$& has been made
13607 (by reference, &%hosts_lookup%& or
13608 otherwise) then this boolean will have been set true if, and only if, the
13609 resolver library states that both
13610 the reverse and forward DNS were authenticated data.  At all
13611 other times, this variable is false.
13612
13613 .cindex "DNS" "DNSSEC"
13614 It is likely that you will need to coerce DNSSEC support on in the resolver
13615 library, by setting:
13616 .code
13617 dns_dnssec_ok = 1
13618 .endd
13619
13620 In addition, on Linux with glibc 2.31 or newer the resolver library will
13621 default to stripping out a successful validation status.
13622 This will break a previously working Exim installation.
13623 Provided that you do trust the resolver (ie, is on localhost) you can tell
13624 glibc to pass through any successful validation with a new option in
13625 &_/etc/resolv.conf_&:
13626 .code
13627 options trust-ad
13628 .endd
13629
13630 Exim does not perform DNSSEC validation itself, instead leaving that to a
13631 validating resolver (e.g. unbound, or bind with suitable configuration).
13632
13633 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13634 mechanism in the list, then this variable will be false.
13635
13636 This requires that your system resolver library support EDNS0 (and that
13637 DNSSEC flags exist in the system headers).  If the resolver silently drops
13638 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13639 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13640
13641
13642 .tvar &$sender_host_name$&
13643 When a message is received from a remote host, this variable contains the
13644 host's name as obtained by looking up its IP address. For messages received by
13645 other means, this variable is empty.
13646
13647 .vindex "&$host_lookup_failed$&"
13648 If the host name has not previously been looked up, a reference to
13649 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13650 A looked up name is accepted only if it leads back to the original IP address
13651 via a forward lookup. If either the reverse or the forward lookup fails to find
13652 any data, or if the forward lookup does not yield the original IP address,
13653 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13654
13655 .vindex "&$host_lookup_deferred$&"
13656 However, if either of the lookups cannot be completed (for example, there is a
13657 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13658 &$host_lookup_failed$& remains set to &"0"&.
13659
13660 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13661 host name again if there is a subsequent reference to &$sender_host_name$&
13662 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13663 is set to &"1"&.
13664
13665 Exim does not automatically look up every calling host's name. If you want
13666 maximum efficiency, you should arrange your configuration so that it avoids
13667 these lookups altogether. The lookup happens only if one or more of the
13668 following are true:
13669
13670 .ilist
13671 A string containing &$sender_host_name$& is expanded.
13672 .next
13673 The calling host matches the list in &%host_lookup%&. In the default
13674 configuration, this option is set to *, so it must be changed if lookups are
13675 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13676 .next
13677 Exim needs the host name in order to test an item in a host list. The items
13678 that require this are described in sections &<<SECThoslispatnam>>& and
13679 &<<SECThoslispatnamsk>>&.
13680 .next
13681 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13682 In this case, the host name is required to compare with the name quoted in any
13683 EHLO or HELO commands that the client issues.
13684 .next
13685 The remote host issues a EHLO or HELO command that quotes one of the
13686 domains in &%helo_lookup_domains%&. The default value of this option is
13687 . ==== As this is a nested list, any displays it contains must be indented
13688 . ==== as otherwise they are too far to the left.
13689 .code
13690   helo_lookup_domains = @ : @[]
13691 .endd
13692 which causes a lookup if a remote host (incorrectly) gives the server's name or
13693 IP address in an EHLO or HELO command.
13694 .endlist
13695
13696
13697 .vitem &$sender_host_port$&
13698 .vindex "&$sender_host_port$&"
13699 When a message is received from a remote host, this variable contains the port
13700 number that was used on the remote host.
13701
13702 .vitem &$sender_ident$&
13703 .vindex "&$sender_ident$&"
13704 When a message is received from a remote host, this variable contains the
13705 identification received in response to an RFC 1413 request. When a message has
13706 been received locally, this variable contains the login name of the user that
13707 called Exim.
13708
13709 .vitem &$sender_rate_$&&'xxx'&
13710 A number of variables whose names begin &$sender_rate_$& are set as part of the
13711 &%ratelimit%& ACL condition. Details are given in section
13712 &<<SECTratelimiting>>&.
13713
13714 .vitem &$sender_rcvhost$&
13715 .cindex "DNS" "reverse lookup"
13716 .cindex "reverse DNS lookup"
13717 .vindex "&$sender_rcvhost$&"
13718 This is provided specifically for use in &'Received:'& headers. It starts with
13719 either the verified host name (as obtained from a reverse DNS lookup) or, if
13720 there is no verified host name, the IP address in square brackets. After that
13721 there may be text in parentheses. When the first item is a verified host name,
13722 the first thing in the parentheses is the IP address in square brackets,
13723 followed by a colon and a port number if port logging is enabled. When the
13724 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13725 the parentheses.
13726
13727 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13728 was used and its argument was not identical to the real host name or IP
13729 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13730 all three items are present in the parentheses, a newline and tab are inserted
13731 into the string, to improve the formatting of the &'Received:'& header.
13732
13733 .vitem &$sender_verify_failure$&
13734 .vindex "&$sender_verify_failure$&"
13735 In an ACL, when a sender verification fails, this variable contains information
13736 about the failure. The details are the same as for
13737 &$recipient_verify_failure$&.
13738
13739 .vitem &$sending_ip_address$&
13740 .vindex "&$sending_ip_address$&"
13741 This variable is set whenever an outgoing SMTP connection to another host has
13742 been set up. It contains the IP address of the local interface that is being
13743 used. This is useful if a host that has more than one IP address wants to take
13744 on different personalities depending on which one is being used. For incoming
13745 connections, see &$received_ip_address$&.
13746
13747 .vitem &$sending_port$&
13748 .vindex "&$sending_port$&"
13749 This variable is set whenever an outgoing SMTP connection to another host has
13750 been set up. It contains the local port that is being used. For incoming
13751 connections, see &$received_port$&.
13752
13753 .vitem &$smtp_active_hostname$&
13754 .vindex "&$smtp_active_hostname$&"
13755 During an incoming SMTP session, this variable contains the value of the active
13756 host name, as specified by the &%smtp_active_hostname%& option. The value of
13757 &$smtp_active_hostname$& is saved with any message that is received, so its
13758 value can be consulted during routing and delivery.
13759
13760 .tvar &$smtp_command$&
13761 During the processing of an incoming SMTP command, this variable contains the
13762 entire command. This makes it possible to distinguish between HELO and EHLO in
13763 the HELO ACL, and also to distinguish between commands such as these:
13764 .code
13765 MAIL FROM:<>
13766 MAIL FROM: <>
13767 .endd
13768 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13769 command, the address in &$smtp_command$& is the original address before any
13770 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13771 the address after SMTP-time rewriting.
13772
13773 .tvar &$smtp_command_argument$&
13774 .cindex "SMTP" "command, argument for"
13775 While an ACL is running to check an SMTP command, this variable contains the
13776 argument, that is, the text that follows the command name, with leading white
13777 space removed. Following the introduction of &$smtp_command$&, this variable is
13778 somewhat redundant, but is retained for backwards compatibility.
13779
13780 .vitem &$smtp_command_history$&
13781 .cindex SMTP "command history"
13782 .vindex "&$smtp_command_history$&"
13783 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13784 received, in time-order left to right.  Only a limited number of commands
13785 are remembered.
13786
13787 .vitem &$smtp_count_at_connection_start$&
13788 .vindex "&$smtp_count_at_connection_start$&"
13789 This variable is set greater than zero only in processes spawned by the Exim
13790 daemon for handling incoming SMTP connections. The name is deliberately long,
13791 in order to emphasize what the contents are. When the daemon accepts a new
13792 connection, it increments this variable. A copy of the variable is passed to
13793 the child process that handles the connection, but its value is fixed, and
13794 never changes. It is only an approximation of how many incoming connections
13795 there actually are, because many other connections may come and go while a
13796 single connection is being processed. When a child process terminates, the
13797 daemon decrements its copy of the variable.
13798
13799 .vitem &$smtp_notquit_reason$&
13800 .vindex "&$smtp_notquit_reason$&"
13801 When the not-QUIT ACL is running, this variable is set to a string
13802 that indicates the reason for the termination of the SMTP connection.
13803
13804 .vitem "&$sn0$& &-- &$sn9$&"
13805 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13806 that were current at the end of the system filter file. This allows a system
13807 filter file to set values that can be tested in users' filter files. For
13808 example, a system filter could set a value indicating how likely it is that a
13809 message is junk mail.
13810
13811 .vitem &$spam_score$& &&&
13812        &$spam_score_int$& &&&
13813        &$spam_bar$& &&&
13814        &$spam_report$& &&&
13815        &$spam_action$&
13816 A number of variables whose names start with &$spam$& are available when Exim
13817 is compiled with the content-scanning extension. For details, see section
13818 &<<SECTscanspamass>>&.
13819
13820 .vitem &$spf_header_comment$& &&&
13821        &$spf_received$& &&&
13822        &$spf_result$& &&&
13823        &$spf_result_guessed$& &&&
13824        &$spf_smtp_comment$&
13825 These variables are only available if Exim is built with SPF support.
13826 For details see section &<<SECSPF>>&.
13827
13828 .vitem &$spool_directory$&
13829 .vindex "&$spool_directory$&"
13830 The name of Exim's spool directory.
13831
13832 .vitem &$spool_inodes$&
13833 .vindex "&$spool_inodes$&"
13834 The number of free inodes in the disk partition where Exim's spool files are
13835 being written. The value is recalculated whenever the variable is referenced.
13836 If the relevant file system does not have the concept of inodes, the value of
13837 is -1. See also the &%check_spool_inodes%& option.
13838
13839 .vitem &$spool_space$&
13840 .vindex "&$spool_space$&"
13841 The amount of free space (as a number of kilobytes) in the disk partition where
13842 Exim's spool files are being written. The value is recalculated whenever the
13843 variable is referenced. If the operating system does not have the ability to
13844 find the amount of free space (only true for experimental systems), the space
13845 value is -1. For example, to check in an ACL that there is at least 50
13846 megabytes free on the spool, you could write:
13847 .code
13848 condition = ${if > {$spool_space}{50000}}
13849 .endd
13850 See also the &%check_spool_space%& option.
13851
13852
13853 .vitem &$thisaddress$&
13854 .vindex "&$thisaddress$&"
13855 This variable is set only during the processing of the &%foranyaddress%&
13856 command in a filter file. Its use is explained in the description of that
13857 command, which can be found in the separate document entitled &'Exim's
13858 interfaces to mail filtering'&.
13859
13860 .vitem &$tls_in_bits$&
13861 .vindex "&$tls_in_bits$&"
13862 Contains an approximation of the TLS cipher's bit-strength
13863 on the inbound connection; the meaning of
13864 this depends upon the TLS implementation used.
13865 If TLS has not been negotiated, the value will be 0.
13866 The value of this is automatically fed into the Cyrus SASL authenticator
13867 when acting as a server, to specify the "external SSF" (a SASL term).
13868
13869 The deprecated &$tls_bits$& variable refers to the inbound side
13870 except when used in the context of an outbound SMTP delivery, when it refers to
13871 the outbound.
13872
13873 .vitem &$tls_out_bits$&
13874 .vindex "&$tls_out_bits$&"
13875 Contains an approximation of the TLS cipher's bit-strength
13876 on an outbound SMTP connection; the meaning of
13877 this depends upon the TLS implementation used.
13878 If TLS has not been negotiated, the value will be 0.
13879
13880 .vitem &$tls_in_ourcert$&
13881 .vindex "&$tls_in_ourcert$&"
13882 .cindex certificate variables
13883 This variable refers to the certificate presented to the peer of an
13884 inbound connection when the message was received.
13885 It is only useful as the argument of a
13886 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13887 or a &%def%& condition.
13888
13889 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13890 when a list of more than one
13891 file is used for &%tls_certificate%&, this variable is not reliable.
13892 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13893
13894 .vitem &$tls_in_peercert$&
13895 .vindex "&$tls_in_peercert$&"
13896 This variable refers to the certificate presented by the peer of an
13897 inbound connection when the message was received.
13898 It is only useful as the argument of a
13899 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13900 or a &%def%& condition.
13901 If certificate verification fails it may refer to a failing chain element
13902 which is not the leaf.
13903
13904 .vitem &$tls_out_ourcert$&
13905 .vindex "&$tls_out_ourcert$&"
13906 This variable refers to the certificate presented to the peer of an
13907 outbound connection.  It is only useful as the argument of a
13908 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13909 or a &%def%& condition.
13910
13911 .vitem &$tls_out_peercert$&
13912 .vindex "&$tls_out_peercert$&"
13913 This variable refers to the certificate presented by the peer of an
13914 outbound connection.  It is only useful as the argument of a
13915 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13916 or a &%def%& condition.
13917 If certificate verification fails it may refer to a failing chain element
13918 which is not the leaf.
13919
13920 .vitem &$tls_in_certificate_verified$&
13921 .vindex "&$tls_in_certificate_verified$&"
13922 This variable is set to &"1"& if a TLS certificate was verified when the
13923 message was received, and &"0"& otherwise.
13924
13925 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13926 except when used in the context of an outbound SMTP delivery, when it refers to
13927 the outbound.
13928
13929 .vitem &$tls_out_certificate_verified$&
13930 .vindex "&$tls_out_certificate_verified$&"
13931 This variable is set to &"1"& if a TLS certificate was verified when an
13932 outbound SMTP connection was made,
13933 and &"0"& otherwise.
13934
13935 .vitem &$tls_in_cipher$&
13936 .vindex "&$tls_in_cipher$&"
13937 .vindex "&$tls_cipher$&"
13938 When a message is received from a remote host over an encrypted SMTP
13939 connection, this variable is set to the cipher suite that was negotiated, for
13940 example DES-CBC3-SHA. In other circumstances, in particular, for message
13941 received over unencrypted connections, the variable is empty. Testing
13942 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13943 non-encrypted connections during ACL processing.
13944
13945 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13946 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13947 becomes the same as &$tls_out_cipher$&.
13948
13949 .vitem &$tls_in_cipher_std$&
13950 .vindex "&$tls_in_cipher_std$&"
13951 As above, but returning the RFC standard name for the cipher suite.
13952
13953 .vitem &$tls_out_cipher$&
13954 .vindex "&$tls_out_cipher$&"
13955 This variable is
13956 cleared before any outgoing SMTP connection is made,
13957 and then set to the outgoing cipher suite if one is negotiated. See chapter
13958 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13959 details of the &(smtp)& transport.
13960
13961 .vitem &$tls_out_cipher_std$&
13962 .vindex "&$tls_out_cipher_std$&"
13963 As above, but returning the RFC standard name for the cipher suite.
13964
13965 .vitem &$tls_out_dane$&
13966 .vindex &$tls_out_dane$&
13967 DANE active status.  See section &<<SECDANE>>&.
13968
13969 .vitem &$tls_in_ocsp$&
13970 .vindex "&$tls_in_ocsp$&"
13971 When a message is received from a remote client connection
13972 the result of any OCSP request from the client is encoded in this variable:
13973 .code
13974 0 OCSP proof was not requested (default value)
13975 1 No response to request
13976 2 Response not verified
13977 3 Verification failed
13978 4 Verification succeeded
13979 .endd
13980
13981 .vitem &$tls_out_ocsp$&
13982 .vindex "&$tls_out_ocsp$&"
13983 When a message is sent to a remote host connection
13984 the result of any OCSP request made is encoded in this variable.
13985 See &$tls_in_ocsp$& for values.
13986
13987 .vitem &$tls_in_peerdn$&
13988 .vindex "&$tls_in_peerdn$&"
13989 .vindex "&$tls_peerdn$&"
13990 .cindex certificate "extracting fields"
13991 When a message is received from a remote host over an encrypted SMTP
13992 connection, and Exim is configured to request a certificate from the client,
13993 the value of the Distinguished Name of the certificate is made available in the
13994 &$tls_in_peerdn$& during subsequent processing.
13995 If certificate verification fails it may refer to a failing chain element
13996 which is not the leaf.
13997
13998 The deprecated &$tls_peerdn$& variable refers to the inbound side
13999 except when used in the context of an outbound SMTP delivery, when it refers to
14000 the outbound.
14001
14002 .vitem &$tls_out_peerdn$&
14003 .vindex "&$tls_out_peerdn$&"
14004 When a message is being delivered to a remote host over an encrypted SMTP
14005 connection, and Exim is configured to request a certificate from the server,
14006 the value of the Distinguished Name of the certificate is made available in the
14007 &$tls_out_peerdn$& during subsequent processing.
14008 If certificate verification fails it may refer to a failing chain element
14009 which is not the leaf.
14010
14011
14012 .vitem &$tls_in_resumption$& &&&
14013        &$tls_out_resumption$&
14014 .vindex &$tls_in_resumption$&
14015 .vindex &$tls_out_resumption$&
14016 .cindex TLS resumption
14017 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
14018
14019
14020 .tvar &$tls_in_sni$&
14021 .vindex "&$tls_sni$&"
14022 .cindex "TLS" "Server Name Indication"
14023 .cindex "TLS" SNI
14024 .cindex SNI "observability on server"
14025 When a TLS session is being established, if the client sends the Server
14026 Name Indication extension, the value will be placed in this variable.
14027 If the variable appears in &%tls_certificate%& then this option and
14028 some others, described in &<<SECTtlssni>>&,
14029 will be re-expanded early in the TLS session, to permit
14030 a different certificate to be presented (and optionally a different key to be
14031 used) to the client, based upon the value of the SNI extension.
14032
14033 The deprecated &$tls_sni$& variable refers to the inbound side
14034 except when used in the context of an outbound SMTP delivery, when it refers to
14035 the outbound.
14036
14037 .vitem &$tls_out_sni$&
14038 .vindex "&$tls_out_sni$&"
14039 .cindex "TLS" "Server Name Indication"
14040 .cindex "TLS" SNI
14041 .cindex SNI "observability in client"
14042 During outbound
14043 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14044 the transport.
14045
14046 .vitem &$tls_out_tlsa_usage$&
14047 .vindex &$tls_out_tlsa_usage$&
14048 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14049
14050 .vitem &$tls_in_ver$&
14051 .vindex "&$tls_in_ver$&"
14052 When a message is received from a remote host over an encrypted SMTP connection
14053 this variable is set to the protocol version, eg &'TLS1.2'&.
14054
14055 .vitem &$tls_out_ver$&
14056 .vindex "&$tls_out_ver$&"
14057 When a message is being delivered to a remote host over an encrypted SMTP connection
14058 this variable is set to the protocol version.
14059
14060
14061 .vitem &$tod_bsdinbox$&
14062 .vindex "&$tod_bsdinbox$&"
14063 The time of day and the date, in the format required for BSD-style mailbox
14064 files, for example: Thu Oct 17 17:14:09 1995.
14065
14066 .vitem &$tod_epoch$&
14067 .vindex "&$tod_epoch$&"
14068 The time and date as a number of seconds since the start of the Unix epoch.
14069
14070 .vitem &$tod_epoch_l$&
14071 .vindex "&$tod_epoch_l$&"
14072 The time and date as a number of microseconds since the start of the Unix epoch.
14073
14074 .vitem &$tod_full$&
14075 .vindex "&$tod_full$&"
14076 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14077 +0100. The timezone is always given as a numerical offset from UTC, with
14078 positive values used for timezones that are ahead (east) of UTC, and negative
14079 values for those that are behind (west).
14080
14081 .vitem &$tod_log$&
14082 .vindex "&$tod_log$&"
14083 The time and date in the format used for writing Exim's log files, for example:
14084 1995-10-12 15:32:29, but without a timezone.
14085
14086 .vitem &$tod_logfile$&
14087 .vindex "&$tod_logfile$&"
14088 This variable contains the date in the format yyyymmdd. This is the format that
14089 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14090 flag.
14091
14092 .vitem &$tod_zone$&
14093 .vindex "&$tod_zone$&"
14094 This variable contains the numerical value of the local timezone, for example:
14095 -0500.
14096
14097 .vitem &$tod_zulu$&
14098 .vindex "&$tod_zulu$&"
14099 This variable contains the UTC date and time in &"Zulu"& format, as specified
14100 by ISO 8601, for example: 20030221154023Z.
14101
14102 .vitem &$transport_name$&
14103 .cindex "transport" "name"
14104 .cindex "name" "of transport"
14105 .vindex "&$transport_name$&"
14106 During the running of a transport, this variable contains its name.
14107
14108 .vitem &$value$&
14109 .vindex "&$value$&"
14110 This variable contains the result of an expansion lookup, extraction operation,
14111 or external command, as described above. It is also used during a
14112 &*reduce*& expansion.
14113
14114 .vitem &$verify_mode$&
14115 .vindex "&$verify_mode$&"
14116 While a router or transport is being run in verify mode or for cutthrough delivery,
14117 contains "S" for sender-verification or "R" for recipient-verification.
14118 Otherwise, empty.
14119
14120 .vitem &$version_number$&
14121 .vindex "&$version_number$&"
14122 The version number of Exim. Same as &$exim_version$&, may be overridden
14123 by the &%exim_version%& main config option.
14124
14125 .vitem &$warn_message_delay$&
14126 .vindex "&$warn_message_delay$&"
14127 This variable is set only during the creation of a message warning about a
14128 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14129
14130 .vitem &$warn_message_recipients$&
14131 .vindex "&$warn_message_recipients$&"
14132 This variable is set only during the creation of a message warning about a
14133 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14134 .endlist
14135 .ecindex IIDstrexp
14136
14137
14138
14139 . ////////////////////////////////////////////////////////////////////////////
14140 . ////////////////////////////////////////////////////////////////////////////
14141
14142 .chapter "Embedded Perl" "CHAPperl"
14143 .scindex IIDperl "Perl" "calling from Exim"
14144 Exim can be built to include an embedded Perl interpreter. When this is done,
14145 Perl subroutines can be called as part of the string expansion process. To make
14146 use of the Perl support, you need version 5.004 or later of Perl installed on
14147 your system. To include the embedded interpreter in the Exim binary, include
14148 the line
14149 .code
14150 EXIM_PERL = perl.o
14151 .endd
14152 in your &_Local/Makefile_& and then build Exim in the normal way.
14153
14154
14155 .section "Setting up so Perl can be used" "SECID85"
14156 .oindex "&%perl_startup%&"
14157 Access to Perl subroutines is via a global configuration option called
14158 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14159 no &%perl_startup%& option in the Exim configuration file then no Perl
14160 interpreter is started and there is almost no overhead for Exim (since none of
14161 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14162 option then the associated value is taken to be Perl code which is executed in
14163 a newly created Perl interpreter.
14164
14165 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14166 need backslashes before any characters to escape special meanings. The option
14167 should usually be something like
14168 .code
14169 perl_startup = do '/etc/exim.pl'
14170 .endd
14171 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14172 use from Exim. Exim can be configured either to start up a Perl interpreter as
14173 soon as it is entered, or to wait until the first time it is needed. Starting
14174 the interpreter at the beginning ensures that it is done while Exim still has
14175 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14176 fact used in a particular run. Also, note that this does not mean that Exim is
14177 necessarily running as root when Perl is called at a later time. By default,
14178 the interpreter is started only when it is needed, but this can be changed in
14179 two ways:
14180
14181 .ilist
14182 .oindex "&%perl_at_start%&"
14183 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14184 a startup when Exim is entered.
14185 .next
14186 The command line option &%-ps%& also requests a startup when Exim is entered,
14187 overriding the setting of &%perl_at_start%&.
14188 .endlist
14189
14190 There is also a command line option &%-pd%& (for delay) which suppresses the
14191 initial startup, even if &%perl_at_start%& is set.
14192
14193 .ilist
14194 .oindex "&%perl_taintmode%&"
14195 .cindex "Perl" "taintmode"
14196 To provide more security executing Perl code via the embedded Perl
14197 interpreter, the &%perl_taintmode%& option can be set. This enables the
14198 taint mode of the Perl interpreter. You are encouraged to set this
14199 option to a true value. To avoid breaking existing installations, it
14200 defaults to false.
14201
14202 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14203
14204
14205 .section "Calling Perl subroutines" "SECID86"
14206 When the configuration file includes a &%perl_startup%& option you can make use
14207 of the string expansion item to call the Perl subroutines that are defined
14208 by the &%perl_startup%& code. The operator is used in any of the following
14209 forms:
14210 .code
14211 ${perl{foo}}
14212 ${perl{foo}{argument}}
14213 ${perl{foo}{argument1}{argument2} ... }
14214 .endd
14215 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14216 arguments may be passed. Passing more than this results in an expansion failure
14217 with an error message of the form
14218 .code
14219 Too many arguments passed to Perl subroutine "foo" (max is 8)
14220 .endd
14221 The return value of the Perl subroutine is evaluated in a scalar context before
14222 it is passed back to Exim to be inserted into the expanded string. If the
14223 return value is &'undef'&, the expansion is forced to fail in the same way as
14224 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14225 by obeying Perl's &%die%& function, the expansion fails with the error message
14226 that was passed to &%die%&.
14227
14228
14229 .section "Calling Exim functions from Perl" "SECID87"
14230 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14231 is available to call back into Exim's string expansion function. For example,
14232 the Perl code
14233 .code
14234 my $lp = Exim::expand_string('$local_part');
14235 .endd
14236 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14237 Note those are single quotes and not double quotes to protect against
14238 &$local_part$& being interpolated as a Perl variable.
14239
14240 If the string expansion is forced to fail by a &"fail"& item, the result of
14241 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14242 expansion string, the Perl call from the original expansion string fails with
14243 an appropriate error message, in the same way as if &%die%& were used.
14244
14245 .cindex "debugging" "from embedded Perl"
14246 .cindex "log" "writing from embedded Perl"
14247 Two other Exim functions are available for use from within Perl code.
14248 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14249 debugging is enabled. If you want a newline at the end, you must supply it.
14250 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14251 timestamp. In this case, you should not supply a terminating newline.
14252
14253
14254 .section "Use of standard output and error by Perl" "SECID88"
14255 .cindex "Perl" "standard output and error"
14256 You should not write to the standard error or output streams from within your
14257 Perl code, as it is not defined how these are set up. In versions of Exim
14258 before 4.50, it is possible for the standard output or error to refer to the
14259 SMTP connection during message reception via the daemon. Writing to this stream
14260 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14261 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14262 avoided, but the output is lost.
14263
14264 .cindex "Perl" "use of &%warn%&"
14265 The Perl &%warn%& statement writes to the standard error stream by default.
14266 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14267 you have no control. When Exim starts up the Perl interpreter, it arranges for
14268 output from the &%warn%& statement to be written to the Exim main log. You can
14269 change this by including appropriate Perl magic somewhere in your Perl code.
14270 For example, to discard &%warn%& output completely, you need this:
14271 .code
14272 $SIG{__WARN__} = sub { };
14273 .endd
14274 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14275 example, the code for the subroutine is empty, so it does nothing, but you can
14276 include any Perl code that you like. The text of the &%warn%& message is passed
14277 as the first subroutine argument.
14278 .ecindex IIDperl
14279
14280
14281 . ////////////////////////////////////////////////////////////////////////////
14282 . ////////////////////////////////////////////////////////////////////////////
14283
14284 .chapter "Starting the daemon and the use of network interfaces" &&&
14285          "CHAPinterfaces" &&&
14286          "Starting the daemon"
14287 .cindex "daemon" "starting"
14288 .cindex "interface" "listening"
14289 .cindex "network interface"
14290 .cindex "interface" "network"
14291 .cindex "IP address" "for listening"
14292 .cindex "daemon" "listening IP addresses"
14293 .cindex "TCP/IP" "setting listening interfaces"
14294 .cindex "TCP/IP" "setting listening ports"
14295 A host that is connected to a TCP/IP network may have one or more physical
14296 hardware network interfaces. Each of these interfaces may be configured as one
14297 or more &"logical"& interfaces, which are the entities that a program actually
14298 works with. Each of these logical interfaces is associated with an IP address.
14299 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14300 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14301 knowledge about the host's interfaces for use in three different circumstances:
14302
14303 .olist
14304 When a listening daemon is started, Exim needs to know which interfaces
14305 and ports to listen on.
14306 .next
14307 When Exim is routing an address, it needs to know which IP addresses
14308 are associated with local interfaces. This is required for the correct
14309 processing of MX lists by removing the local host and others with the
14310 same or higher priority values. Also, Exim needs to detect cases
14311 when an address is routed to an IP address that in fact belongs to the
14312 local host. Unless the &%self%& router option or the &%allow_localhost%&
14313 option of the smtp transport is set (as appropriate), this is treated
14314 as an error situation.
14315 .next
14316 When Exim connects to a remote host, it may need to know which interface to use
14317 for the outgoing connection.
14318 .endlist
14319
14320
14321 Exim's default behaviour is likely to be appropriate in the vast majority
14322 of cases. If your host has only one interface, and you want all its IP
14323 addresses to be treated in the same way, and you are using only the
14324 standard SMTP port, you should not need to take any special action. The
14325 rest of this chapter does not apply to you.
14326
14327 In a more complicated situation you may want to listen only on certain
14328 interfaces, or on different ports, and for this reason there are a number of
14329 options that can be used to influence Exim's behaviour. The rest of this
14330 chapter describes how they operate.
14331
14332 When a message is received over TCP/IP, the interface and port that were
14333 actually used are set in &$received_ip_address$& and &$received_port$&.
14334
14335
14336
14337 .section "Starting a listening daemon" "SECID89"
14338 When a listening daemon is started (by means of the &%-bd%& command line
14339 option), the interfaces and ports on which it listens are controlled by the
14340 following options:
14341
14342 .ilist
14343 &%daemon_smtp_ports%& contains a list of default ports
14344 or service names.
14345 (For backward compatibility, this option can also be specified in the singular.)
14346 .next
14347 &%local_interfaces%& contains list of interface IP addresses on which to
14348 listen. Each item may optionally also specify a port.
14349 .endlist
14350
14351 The default list separator in both cases is a colon, but this can be changed as
14352 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14353 it is usually best to change the separator to avoid having to double all the
14354 colons. For example:
14355 .code
14356 local_interfaces = <; 127.0.0.1 ; \
14357                       192.168.23.65 ; \
14358                       ::1 ; \
14359                       3ffe:ffff:836f::fe86:a061
14360 .endd
14361 There are two different formats for specifying a port along with an IP address
14362 in &%local_interfaces%&:
14363
14364 .olist
14365 The port is added onto the address with a dot separator. For example, to listen
14366 on port 1234 on two different IP addresses:
14367 .code
14368 local_interfaces = <; 192.168.23.65.1234 ; \
14369                       3ffe:ffff:836f::fe86:a061.1234
14370 .endd
14371 .next
14372 The IP address is enclosed in square brackets, and the port is added
14373 with a colon separator, for example:
14374 .code
14375 local_interfaces = <; [192.168.23.65]:1234 ; \
14376                       [3ffe:ffff:836f::fe86:a061]:1234
14377 .endd
14378 .endlist
14379
14380 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14381 default setting contains just one port:
14382 .code
14383 daemon_smtp_ports = smtp
14384 .endd
14385 If more than one port is listed, each interface that does not have its own port
14386 specified listens on all of them. Ports that are listed in
14387 &%daemon_smtp_ports%& can be identified either by name (defined in
14388 &_/etc/services_&) or by number. However, when ports are given with individual
14389 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14390
14391
14392
14393 .section "Special IP listening addresses" "SECID90"
14394 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14395 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14396 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14397 instead of setting up separate listening sockets for each interface. The
14398 default value of &%local_interfaces%& is
14399 .code
14400 local_interfaces = 0.0.0.0
14401 .endd
14402 when Exim is built without IPv6 support; otherwise it is:
14403 .code
14404 local_interfaces = <; ::0 ; 0.0.0.0
14405 .endd
14406 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14407
14408
14409
14410 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14411 The &%-oX%& command line option can be used to override the values of
14412 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14413 instance. Another way of doing this would be to use macros and the &%-D%&
14414 option. However, &%-oX%& can be used by any admin user, whereas modification of
14415 the runtime configuration by &%-D%& is allowed only when the caller is root or
14416 exim.
14417
14418 The value of &%-oX%& is a list of items. The default colon separator can be
14419 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14420 If there are any items that do not
14421 contain dots or colons (that is, are not IP addresses), the value of
14422 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14423 items that do contain dots or colons, the value of &%local_interfaces%& is
14424 replaced by those items. Thus, for example,
14425 .code
14426 -oX 1225
14427 .endd
14428 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14429 whereas
14430 .code
14431 -oX 192.168.34.5.1125
14432 .endd
14433 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14434 (However, since &%local_interfaces%& now contains no items without ports, the
14435 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14436
14437
14438
14439 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14440 .cindex "submissions protocol"
14441 .cindex "ssmtp protocol"
14442 .cindex "smtps protocol"
14443 .cindex "SMTP" "ssmtp protocol"
14444 .cindex "SMTP" "smtps protocol"
14445 Exim supports the use of TLS-on-connect, used by mail clients in the
14446 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14447 For some years, IETF Standards Track documents only blessed the
14448 STARTTLS-based Submission service (port 587) while common practice was to support
14449 the same feature set on port 465, but using TLS-on-connect.
14450 If your installation needs to provide service to mail clients
14451 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14452 the 465 TCP ports.
14453
14454 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14455 service names, connections to those ports must first establish TLS, before
14456 proceeding to the application layer use of the SMTP protocol.
14457
14458 The common use of this option is expected to be
14459 .code
14460 tls_on_connect_ports = 465
14461 .endd
14462 per RFC 8314.
14463 There is also a command line option &%-tls-on-connect%&, which forces all ports
14464 to behave in this way when a daemon is started.
14465
14466 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14467 daemon to listen on those ports. You must still specify them in
14468 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14469 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14470 connections via the daemon.)
14471
14472
14473
14474
14475 .section "IPv6 address scopes" "SECID92"
14476 .cindex "IPv6" "address scopes"
14477 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14478 can, in principle, have the same link-local IPv6 address on different
14479 interfaces. Thus, additional information is needed, over and above the IP
14480 address, to distinguish individual interfaces. A convention of using a
14481 percent sign followed by something (often the interface name) has been
14482 adopted in some cases, leading to addresses like this:
14483 .code
14484 fe80::202:b3ff:fe03:45c1%eth0
14485 .endd
14486 To accommodate this usage, a percent sign followed by an arbitrary string is
14487 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14488 to convert a textual IPv6 address for actual use. This function recognizes the
14489 percent convention in operating systems that support it, and it processes the
14490 address appropriately. Unfortunately, some older libraries have problems with
14491 &[getaddrinfo()]&. If
14492 .code
14493 IPV6_USE_INET_PTON=yes
14494 .endd
14495 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14496 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14497 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14498 function.) Of course, this means that the additional functionality of
14499 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14500
14501 .section "Disabling IPv6" "SECID93"
14502 .cindex "IPv6" "disabling"
14503 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14504 run on a host whose kernel does not support IPv6. The binary will fall back to
14505 using IPv4, but it may waste resources looking up AAAA records, and trying to
14506 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14507 .oindex "&%disable_ipv6%&"
14508 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14509 activities take place. AAAA records are never looked up, and any IPv6 addresses
14510 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14511 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14512 to handle IPv6 literal addresses.
14513
14514 On the other hand, when IPv6 is in use, there may be times when you want to
14515 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14516 option to globally suppress the lookup of AAAA records for specified domains,
14517 and you can use the &%ignore_target_hosts%& generic router option to ignore
14518 IPv6 addresses in an individual router.
14519
14520
14521
14522 .section "Examples of starting a listening daemon" "SECID94"
14523 The default case in an IPv6 environment is
14524 .code
14525 daemon_smtp_ports = smtp
14526 local_interfaces = <; ::0 ; 0.0.0.0
14527 .endd
14528 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14529 Either one or two sockets may be used, depending on the characteristics of
14530 the TCP/IP stack. (This is complicated and messy; for more information,
14531 read the comments in the &_daemon.c_& source file.)
14532
14533 To specify listening on ports 25 and 26 on all interfaces:
14534 .code
14535 daemon_smtp_ports = 25 : 26
14536 .endd
14537 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14538 .code
14539 local_interfaces = <; ::0.25     ; ::0.26 \
14540                       0.0.0.0.25 ; 0.0.0.0.26
14541 .endd
14542 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14543 IPv4 loopback address only:
14544 .code
14545 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14546 .endd
14547 To specify listening on the default port on specific interfaces only:
14548 .code
14549 local_interfaces = 10.0.0.67 : 192.168.34.67
14550 .endd
14551 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14552
14553
14554
14555 .section "Recognizing the local host" "SECTreclocipadd"
14556 The &%local_interfaces%& option is also used when Exim needs to determine
14557 whether or not an IP address refers to the local host. That is, the IP
14558 addresses of all the interfaces on which a daemon is listening are always
14559 treated as local.
14560
14561 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14562 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14563 available interfaces from the operating system, and extracts the relevant
14564 (that is, IPv4 or IPv6) addresses to use for checking.
14565
14566 Some systems set up large numbers of virtual interfaces in order to provide
14567 many virtual web servers. In this situation, you may want to listen for
14568 email on only a few of the available interfaces, but nevertheless treat all
14569 interfaces as local when routing. You can do this by setting
14570 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14571 &"all"& wildcard values. These addresses are recognized as local, but are not
14572 used for listening. Consider this example:
14573 .code
14574 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14575                       192.168.53.235 ; \
14576                       3ffe:2101:12:1:a00:20ff:fe86:a061
14577
14578 extra_local_interfaces = <; ::0 ; 0.0.0.0
14579 .endd
14580 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14581 address, but all available interface addresses are treated as local when
14582 Exim is routing.
14583
14584 In some environments the local host name may be in an MX list, but with an IP
14585 address that is not assigned to any local interface. In other cases it may be
14586 desirable to treat other host names as if they referred to the local host. Both
14587 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14588 This contains host names rather than IP addresses. When a host is referenced
14589 during routing, either via an MX record or directly, it is treated as the local
14590 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14591 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14592
14593
14594
14595 .section "Delivering to a remote host" "SECID95"
14596 Delivery to a remote host is handled by the smtp transport. By default, it
14597 allows the system's TCP/IP functions to choose which interface to use (if
14598 there is more than one) when connecting to a remote host. However, the
14599 &%interface%& option can be set to specify which interface is used. See the
14600 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14601 details.
14602
14603
14604
14605
14606 . ////////////////////////////////////////////////////////////////////////////
14607 . ////////////////////////////////////////////////////////////////////////////
14608
14609 .chapter "Main configuration" "CHAPmainconfig"
14610 .scindex IIDconfima "configuration file" "main section"
14611 .scindex IIDmaiconf "main configuration"
14612 The first part of the runtime configuration file contains three types of item:
14613
14614 .ilist
14615 Macro definitions: These lines start with an upper case letter. See section
14616 &<<SECTmacrodefs>>& for details of macro processing.
14617 .next
14618 Named list definitions: These lines start with one of the words &"domainlist"&,
14619 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14620 section &<<SECTnamedlists>>&.
14621 .next
14622 Main configuration settings: Each setting occupies one line of the file
14623 (with possible continuations). If any setting is preceded by the word
14624 &"hide"&, the &%-bP%& command line option displays its value to admin users
14625 only. See section &<<SECTcos>>& for a description of the syntax of these option
14626 settings.
14627 .endlist
14628
14629 This chapter specifies all the main configuration options, along with their
14630 types and default values. For ease of finding a particular option, they appear
14631 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14632 are now so many options, they are first listed briefly in functional groups, as
14633 an aid to finding the name of the option you are looking for. Some options are
14634 listed in more than one group.
14635
14636 .section "Miscellaneous" "SECID96"
14637 .table2
14638 .row &%add_environment%&             "environment variables"
14639 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14640 .row &%debug_store%&                 "do extra internal checks"
14641 .row &%disable_ipv6%&                "do no IPv6 processing"
14642 .row &%keep_environment%&            "environment variables"
14643 .row &%keep_malformed%&              "for broken files &-- should not happen"
14644 .row &%localhost_number%&            "for unique message ids in clusters"
14645 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14646 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14647 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14648 .row &%print_topbitchars%&           "top-bit characters are printing"
14649 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14650 .row &%timezone%&                    "force time zone"
14651 .endtable
14652
14653
14654 .section "Exim parameters" "SECID97"
14655 .table2
14656 .row &%exim_group%&                  "override compiled-in value"
14657 .row &%exim_path%&                   "override compiled-in value"
14658 .row &%exim_user%&                   "override compiled-in value"
14659 .row &%primary_hostname%&            "default from &[uname()]&"
14660 .row &%split_spool_directory%&       "use multiple directories"
14661 .row &%spool_directory%&             "override compiled-in value"
14662 .endtable
14663
14664
14665
14666 .section "Privilege controls" "SECID98"
14667 .table2
14668 .row &%admin_groups%&                "groups that are Exim admin users"
14669 .row &%commandline_checks_require_admin%& "require admin for various checks"
14670 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14671 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14672 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14673 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14674 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14675 .row &%never_users%&                 "do not run deliveries as these"
14676 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14677 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14678 .row &%trusted_groups%&              "groups that are trusted"
14679 .row &%trusted_users%&               "users that are trusted"
14680 .endtable
14681
14682
14683
14684 .section "Logging" "SECID99"
14685 .table2
14686 .row &%event_action%&                "custom logging"
14687 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14688 .row &%log_file_path%&               "override compiled-in value"
14689 .row &%log_selector%&                "set/unset optional logging"
14690 .row &%log_timezone%&                "add timezone to log lines"
14691 .row &%message_logs%&                "create per-message logs"
14692 .row &%preserve_message_logs%&       "after message completion"
14693 .row &%panic_coredump%&              "request coredump on fatal errors"
14694 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14695 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14696 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14697 .row &%syslog_facility%&             "set syslog &""facility""& field"
14698 .row &%syslog_pid%&                  "pid in syslog lines"
14699 .row &%syslog_processname%&          "set syslog &""ident""& field"
14700 .row &%syslog_timestamp%&            "timestamp syslog lines"
14701 .row &%write_rejectlog%&             "control use of message log"
14702 .endtable
14703
14704
14705
14706 .section "Frozen messages" "SECID100"
14707 .table2
14708 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14709 .row &%freeze_tell%&                 "send message when freezing"
14710 .row &%move_frozen_messages%&        "to another directory"
14711 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14712 .endtable
14713
14714
14715
14716 .section "Data lookups" "SECID101"
14717 .table2
14718 .row &%ibase_servers%&               "InterBase servers"
14719 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14720 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14721 .row &%ldap_cert_file%&              "client cert file for LDAP"
14722 .row &%ldap_cert_key%&               "client key file for LDAP"
14723 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14724 .row &%ldap_default_servers%&        "used if no server in query"
14725 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14726 .row &%ldap_start_tls%&              "require TLS within LDAP"
14727 .row &%ldap_version%&                "set protocol version"
14728 .row &%lookup_open_max%&             "lookup files held open"
14729 .row &%mysql_servers%&               "default MySQL servers"
14730 .row &%oracle_servers%&              "Oracle servers"
14731 .row &%pgsql_servers%&               "default PostgreSQL servers"
14732 .row &%sqlite_lock_timeout%&         "as it says"
14733 .endtable
14734
14735
14736
14737 .section "Message ids" "SECID102"
14738 .table2
14739 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14740 .row &%message_id_header_text%&      "ditto"
14741 .endtable
14742
14743
14744
14745 .section "Embedded Perl Startup" "SECID103"
14746 .table2
14747 .row &%perl_at_start%&               "always start the interpreter"
14748 .row &%perl_startup%&                "code to obey when starting Perl"
14749 .row &%perl_taintmode%&              "enable taint mode in Perl"
14750 .endtable
14751
14752
14753
14754 .section "Daemon" "SECID104"
14755 .table2
14756 .row &%daemon_smtp_ports%&           "default ports"
14757 .row &%daemon_startup_retries%&      "number of times to retry"
14758 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14759 .row &%extra_local_interfaces%&      "not necessarily listened on"
14760 .row &%local_interfaces%&            "on which to listen, with optional ports"
14761 .row &%notifier_socket%&             "override compiled-in value"
14762 .row &%pid_file_path%&               "override compiled-in value"
14763 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14764 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14765 .endtable
14766
14767
14768
14769 .section "Resource control" "SECID105"
14770 .table2
14771 .row &%check_log_inodes%&            "before accepting a message"
14772 .row &%check_log_space%&             "before accepting a message"
14773 .row &%check_spool_inodes%&          "before accepting a message"
14774 .row &%check_spool_space%&           "before accepting a message"
14775 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14776 .row &%queue_only_load%&             "queue incoming if load high"
14777 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14778 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14779 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14780 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14781 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14782 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14783 .row &%smtp_accept_max_per_connection%& "messages per connection"
14784 .row &%smtp_accept_max_per_host%&    "connections from one host"
14785 .row &%smtp_accept_queue%&           "queue mail if more connections"
14786 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14787                                            connection"
14788 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14789 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14790 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14791 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14792 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14793 .endtable
14794
14795
14796
14797 .section "Policy controls" "SECID106"
14798 .table2
14799 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14800 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14801 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14802 .row &%acl_smtp_auth%&               "ACL for AUTH"
14803 .row &%acl_smtp_connect%&            "ACL for connection"
14804 .row &%acl_smtp_data%&               "ACL for DATA"
14805 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14806 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14807 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14808 .row &%acl_smtp_expn%&               "ACL for EXPN"
14809 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14810 .row &%acl_smtp_mail%&               "ACL for MAIL"
14811 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14812 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14813 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14814 .row &%acl_smtp_predata%&            "ACL for start of data"
14815 .row &%acl_smtp_quit%&               "ACL for QUIT"
14816 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14817 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14818 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14819 .row &%av_scanner%&                  "specify virus scanner"
14820 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14821                                       words""&"
14822 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14823 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14824 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14825 .row &%header_maxsize%&              "total size of message header"
14826 .row &%header_line_maxsize%&         "individual header line limit"
14827 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14828 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14829 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14830 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14831 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14832 .row &%host_lookup%&                 "host name looked up for these hosts"
14833 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14834 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14835 .row &%host_reject_connection%&      "reject connection from these hosts"
14836 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14837 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14838 .row &%message_size_limit%&          "for all messages"
14839 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14840 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14841 .row &%spamd_address%&               "set interface to SpamAssassin"
14842 .row &%strict_acl_vars%&             "object to unset ACL variables"
14843 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14844 .endtable
14845
14846
14847
14848 .section "Callout cache" "SECID107"
14849 .table2
14850 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14851                                          item"
14852 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14853                                          item"
14854 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14855 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14856 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14857 .endtable
14858
14859
14860
14861 .section "TLS" "SECID108"
14862 .table2
14863 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14864 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14865 .row &%hosts_require_alpn%&          "mandatory ALPN"
14866 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14867 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14868 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14869 .row &%tls_alpn%&                    "acceptable protocol names"
14870 .row &%tls_certificate%&             "location of server certificate"
14871 .row &%tls_crl%&                     "certificate revocation list"
14872 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14873 .row &%tls_dhparam%&                 "DH parameters for server"
14874 .row &%tls_eccurve%&                 "EC curve selection for server"
14875 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14876 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14877 .row &%tls_privatekey%&              "location of server private key"
14878 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14879 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14880 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14881 .row &%tls_verify_certificates%&     "expected client certificates"
14882 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14883 .endtable
14884
14885
14886
14887 .section "Local user handling" "SECID109"
14888 .table2
14889 .row &%finduser_retries%&            "useful in NIS environments"
14890 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14891 .row &%gecos_pattern%&               "ditto"
14892 .row &%max_username_length%&         "for systems that truncate"
14893 .row &%unknown_login%&               "used when no login name found"
14894 .row &%unknown_username%&            "ditto"
14895 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14896 .row &%uucp_from_sender%&            "ditto"
14897 .endtable
14898
14899
14900
14901 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14902 .table2
14903 .row &%header_maxsize%&              "total size of message header"
14904 .row &%header_line_maxsize%&         "individual header line limit"
14905 .row &%message_size_limit%&          "applies to all messages"
14906 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14907 .row &%received_header_text%&        "expanded to make &'Received:'&"
14908 .row &%received_headers_max%&        "for mail loop detection"
14909 .row &%recipients_max%&              "limit per message"
14910 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14911 .endtable
14912
14913
14914
14915
14916 .section "Non-SMTP incoming messages" "SECID111"
14917 .table2
14918 .row &%receive_timeout%&             "for non-SMTP messages"
14919 .endtable
14920
14921
14922
14923
14924
14925 .section "Incoming SMTP messages" "SECID112"
14926 See also the &'Policy controls'& section above.
14927
14928 .table2
14929 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14930 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14931 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14932 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14933 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14934 .row &%dmarc_history_file%&          "DMARC results log"
14935 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14936 .row &%host_lookup%&                 "host name looked up for these hosts"
14937 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14938 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14939 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14940 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14941 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14942 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14943 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14944 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14945 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14946 .row &%smtp_accept_max_per_connection%& "messages per connection"
14947 .row &%smtp_accept_max_per_host%&    "connections from one host"
14948 .row &%smtp_accept_queue%&           "queue mail if more connections"
14949 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14950                                            connection"
14951 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14952 .row &%smtp_active_hostname%&        "host name to use in messages"
14953 .row &%smtp_banner%&                 "text for welcome banner"
14954 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14955 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14956 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14957 .row &%smtp_etrn_command%&           "what to run for ETRN"
14958 .row &%smtp_etrn_serialize%&         "only one at once"
14959 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14960 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14961 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14962 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14963 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14964 .row &%smtp_receive_timeout%&        "per command or data line"
14965 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14966 .row &%smtp_return_error_details%&   "give detail on rejections"
14967 .endtable
14968
14969
14970
14971 .section "SMTP extensions" "SECID113"
14972 .table2
14973 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14974 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14975 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14976 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14977 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14978 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14979 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14980 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14981 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14982 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14983 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14984 .endtable
14985
14986
14987
14988 .section "Processing messages" "SECID114"
14989 .table2
14990 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14991 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14992 .row &%allow_utf8_domains%&          "in addresses"
14993 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14994                                       words""&"
14995 .row &%delivery_date_remove%&        "from incoming messages"
14996 .row &%envelope_to_remove%&          "from incoming messages"
14997 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14998 .row &%headers_charset%&             "default for translations"
14999 .row &%qualify_domain%&              "default for senders"
15000 .row &%qualify_recipient%&           "default for recipients"
15001 .row &%return_path_remove%&          "from incoming messages"
15002 .row &%strip_excess_angle_brackets%& "in addresses"
15003 .row &%strip_trailing_dot%&          "at end of addresses"
15004 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
15005 .endtable
15006
15007
15008
15009 .section "System filter" "SECID115"
15010 .table2
15011 .row &%system_filter%&               "locate system filter"
15012 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
15013                                             directory"
15014 .row &%system_filter_file_transport%& "transport for delivery to a file"
15015 .row &%system_filter_group%&         "group for filter running"
15016 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
15017 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
15018 .row &%system_filter_user%&          "user for filter running"
15019 .endtable
15020
15021
15022
15023 .section "Routing and delivery" "SECID116"
15024 .table2
15025 .row &%disable_ipv6%&                "do no IPv6 processing"
15026 .row &%dns_again_means_nonexist%&    "for broken domains"
15027 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15028 .row &%dns_dnssec_ok%&               "parameter for resolver"
15029 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15030 .row &%dns_retrans%&                 "parameter for resolver"
15031 .row &%dns_retry%&                   "parameter for resolver"
15032 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15033 .row &%dns_use_edns0%&               "parameter for resolver"
15034 .row &%hold_domains%&                "hold delivery for these domains"
15035 .row &%local_interfaces%&            "for routing checks"
15036 .row &%queue_domains%&               "no immediate delivery for these"
15037 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15038 .row &%queue_only%&                  "no immediate delivery at all"
15039 .row &%queue_only_file%&             "no immediate delivery if file exists"
15040 .row &%queue_only_load%&             "no immediate delivery if load is high"
15041 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15042 .row &%queue_only_override%&         "allow command line to override"
15043 .row &%queue_run_in_order%&          "order of arrival"
15044 .row &%queue_run_max%&               "of simultaneous queue runners"
15045 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15046 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15047 .row &%remote_sort_domains%&         "order of remote deliveries"
15048 .row &%retry_data_expire%&           "timeout for retry data"
15049 .row &%retry_interval_max%&          "safety net for retry rules"
15050 .endtable
15051
15052
15053
15054 .section "Bounce and warning messages" "SECID117"
15055 .table2
15056 .row &%bounce_message_file%&         "content of bounce"
15057 .row &%bounce_message_text%&         "content of bounce"
15058 .row &%bounce_return_body%&          "include body if returning message"
15059 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15060 .row &%bounce_return_message%&       "include original message in bounce"
15061 .row &%bounce_return_size_limit%&    "limit on returned message"
15062 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15063 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15064 .row &%errors_copy%&                 "copy bounce messages"
15065 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15066 .row &%delay_warning%&               "time schedule"
15067 .row &%delay_warning_condition%&     "condition for warning messages"
15068 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15069 .row &%smtp_return_error_details%&   "give detail on rejections"
15070 .row &%warn_message_file%&           "content of warning message"
15071 .endtable
15072
15073
15074
15075 .section "Alphabetical list of main options" "SECTalomo"
15076 Those options that undergo string expansion before use are marked with
15077 &dagger;.
15078
15079 .option accept_8bitmime main boolean true
15080 .cindex "8BITMIME"
15081 .cindex "8-bit characters"
15082 .cindex "log" "selectors"
15083 .cindex "log" "8BITMIME"
15084 .cindex "ESMTP extensions" 8BITMIME
15085 This option causes Exim to send 8BITMIME in its response to an SMTP
15086 EHLO command, and to accept the BODY= parameter on MAIL commands.
15087 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15088 takes no steps to do anything special with messages received by this route.
15089
15090 Historically Exim kept this option off by default, but the maintainers
15091 feel that in today's Internet, this causes more problems than it solves.
15092 It now defaults to true.
15093 A more detailed analysis of the issues is provided by Dan Bernstein:
15094 .display
15095 &url(https://cr.yp.to/smtp/8bitmime.html)
15096 .endd
15097
15098 To log received 8BITMIME status use
15099 .code
15100 log_selector = +8bitmime
15101 .endd
15102
15103 .option acl_not_smtp main string&!! unset
15104 .cindex "&ACL;" "for non-SMTP messages"
15105 .cindex "non-SMTP messages" "ACLs for"
15106 This option defines the ACL that is run when a non-SMTP message has been
15107 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15108 further details.
15109
15110 .option acl_not_smtp_mime main string&!! unset
15111 This option defines the ACL that is run for individual MIME parts of non-SMTP
15112 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15113 SMTP messages.
15114
15115 .option acl_not_smtp_start main string&!! unset
15116 .cindex "&ACL;" "at start of non-SMTP message"
15117 .cindex "non-SMTP messages" "ACLs for"
15118 This option defines the ACL that is run before Exim starts reading a
15119 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15120
15121 .option acl_smtp_auth main string&!! unset
15122 .cindex "&ACL;" "setting up for SMTP commands"
15123 .cindex "AUTH" "ACL for"
15124 This option defines the ACL that is run when an SMTP AUTH command is
15125 received. See chapter &<<CHAPACL>>& for further details.
15126
15127 .option acl_smtp_connect main string&!! unset
15128 .cindex "&ACL;" "on SMTP connection"
15129 This option defines the ACL that is run when an SMTP connection is received.
15130 See chapter &<<CHAPACL>>& for further details.
15131
15132 .option acl_smtp_data main string&!! unset
15133 .cindex "DATA" "ACL for"
15134 This option defines the ACL that is run after an SMTP DATA command has been
15135 processed and the message itself has been received, but before the final
15136 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15137
15138 .option acl_smtp_data_prdr main string&!! accept
15139 .cindex "PRDR" "ACL for"
15140 .cindex "DATA" "PRDR ACL for"
15141 .cindex "&ACL;" "PRDR-related"
15142 .cindex "&ACL;" "per-user data processing"
15143 This option defines the ACL that,
15144 if the PRDR feature has been negotiated,
15145 is run for each recipient after an SMTP DATA command has been
15146 processed and the message itself has been received, but before the
15147 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15148
15149 .option acl_smtp_dkim main string&!! unset
15150 .cindex DKIM "ACL for"
15151 This option defines the ACL that is run for each DKIM signature
15152 (by default, or as specified in the dkim_verify_signers option)
15153 of a received message.
15154 See section &<<SECDKIMVFY>>& for further details.
15155
15156 .option acl_smtp_etrn main string&!! unset
15157 .cindex "ETRN" "ACL for"
15158 This option defines the ACL that is run when an SMTP ETRN command is
15159 received. See chapter &<<CHAPACL>>& for further details.
15160
15161 .option acl_smtp_expn main string&!! unset
15162 .cindex "EXPN" "ACL for"
15163 This option defines the ACL that is run when an SMTP EXPN command is
15164 received. See chapter &<<CHAPACL>>& for further details.
15165
15166 .option acl_smtp_helo main string&!! unset
15167 .cindex "EHLO" "ACL for"
15168 .cindex "HELO" "ACL for"
15169 This option defines the ACL that is run when an SMTP EHLO or HELO
15170 command is received. See chapter &<<CHAPACL>>& for further details.
15171
15172
15173 .option acl_smtp_mail main string&!! unset
15174 .cindex "MAIL" "ACL for"
15175 This option defines the ACL that is run when an SMTP MAIL command is
15176 received. See chapter &<<CHAPACL>>& for further details.
15177
15178 .option acl_smtp_mailauth main string&!! unset
15179 .cindex "AUTH" "on MAIL command"
15180 This option defines the ACL that is run when there is an AUTH parameter on
15181 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15182 &<<CHAPSMTPAUTH>>& for details of authentication.
15183
15184 .option acl_smtp_mime main string&!! unset
15185 .cindex "MIME content scanning" "ACL for"
15186 This option is available when Exim is built with the content-scanning
15187 extension. It defines the ACL that is run for each MIME part in a message. See
15188 section &<<SECTscanmimepart>>& for details.
15189
15190 .option acl_smtp_notquit main string&!! unset
15191 .cindex "not-QUIT, ACL for"
15192 This option defines the ACL that is run when an SMTP session
15193 ends without a QUIT command being received.
15194 See chapter &<<CHAPACL>>& for further details.
15195
15196 .option acl_smtp_predata main string&!! unset
15197 This option defines the ACL that is run when an SMTP DATA command is
15198 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15199 further details.
15200
15201 .option acl_smtp_quit main string&!! unset
15202 .cindex "QUIT, ACL for"
15203 This option defines the ACL that is run when an SMTP QUIT command is
15204 received. See chapter &<<CHAPACL>>& for further details.
15205
15206 .option acl_smtp_rcpt main string&!! unset
15207 .cindex "RCPT" "ACL for"
15208 This option defines the ACL that is run when an SMTP RCPT command is
15209 received. See chapter &<<CHAPACL>>& for further details.
15210
15211 .option acl_smtp_starttls main string&!! unset
15212 .cindex "STARTTLS, ACL for"
15213 This option defines the ACL that is run when an SMTP STARTTLS command is
15214 received. See chapter &<<CHAPACL>>& for further details.
15215
15216 .option acl_smtp_vrfy main string&!! unset
15217 .cindex "VRFY" "ACL for"
15218 This option defines the ACL that is run when an SMTP VRFY command is
15219 received. See chapter &<<CHAPACL>>& for further details.
15220
15221 .option add_environment main "string list" empty
15222 .cindex "environment" "set values"
15223 This option adds individual environment variables that the
15224 currently linked libraries and programs in child processes may use.
15225 Each list element should be of the form &"name=value"&.
15226
15227 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15228
15229 .option admin_groups main "string list&!!" unset
15230 .cindex "admin user"
15231 This option is expanded just once, at the start of Exim's processing. If the
15232 current group or any of the supplementary groups of an Exim caller is in this
15233 colon-separated list, the caller has admin privileges. If all your system
15234 programmers are in a specific group, for example, you can give them all Exim
15235 admin privileges by putting that group in &%admin_groups%&. However, this does
15236 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15237 To permit this, you have to add individuals to the Exim group.
15238
15239 .option allow_domain_literals main boolean false
15240 .cindex "domain literal"
15241 If this option is set, the RFC 2822 domain literal format is permitted in
15242 email addresses. The option is not set by default, because the domain literal
15243 format is not normally required these days, and few people know about it. It
15244 has, however, been exploited by mail abusers.
15245
15246 Unfortunately, it seems that some DNS black list maintainers are using this
15247 format to report black listing to postmasters. If you want to accept messages
15248 addressed to your hosts by IP address, you need to set
15249 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15250 domains (defined in the named domain list &%local_domains%& in the default
15251 configuration). This &"magic string"& matches the domain literal form of all
15252 the local host's IP addresses.
15253
15254 .option allow_mx_to_ip main boolean false
15255 .cindex "MX record" "pointing to IP address"
15256 It appears that more and more DNS zone administrators are breaking the rules
15257 and putting domain names that look like IP addresses on the right hand side of
15258 MX records. Exim follows the rules and rejects this, giving an error message
15259 that explains the misconfiguration. However, some other MTAs support this
15260 practice, so to avoid &"Why can't Exim do this?"& complaints,
15261 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15262 recommended, except when you have no other choice.
15263
15264 .option allow_utf8_domains main boolean false
15265 .cindex "domain" "UTF-8 characters in"
15266 .cindex "UTF-8" "in domain name"
15267 Lots of discussion is going on about internationalized domain names. One
15268 camp is strongly in favour of just using UTF-8 characters, and it seems
15269 that at least two other MTAs permit this.
15270 This option allows Exim users to experiment if they wish.
15271
15272 If it is set true, Exim's domain parsing function allows valid
15273 UTF-8 multicharacters to appear in domain name components, in addition to
15274 letters, digits, and hyphens.
15275
15276 If Exim is built with internationalization support
15277 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15278 this option can be left as default.
15279 Without that,
15280 if you want to look up such domain names in the DNS, you must also
15281 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15282 suitable setting is:
15283 .code
15284 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15285   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15286 .endd
15287 Alternatively, you can just disable this feature by setting
15288 .code
15289 dns_check_names_pattern =
15290 .endd
15291 That is, set the option to an empty string so that no check is done.
15292
15293
15294 .option auth_advertise_hosts main "host list&!!" *
15295 .cindex "authentication" "advertising"
15296 .cindex "AUTH" "advertising"
15297 .cindex "ESMTP extensions" AUTH
15298 If any server authentication mechanisms are configured, Exim advertises them in
15299 response to an EHLO command only if the calling host matches this list.
15300 Otherwise, Exim does not advertise AUTH.
15301 Exim does not accept AUTH commands from clients to which it has not
15302 advertised the availability of AUTH. The advertising of individual
15303 authentication mechanisms can be controlled by the use of the
15304 &%server_advertise_condition%& generic authenticator option on the individual
15305 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15306
15307 Certain mail clients (for example, Netscape) require the user to provide a name
15308 and password for authentication if AUTH is advertised, even though it may
15309 not be needed (the host may accept messages from hosts on its local LAN without
15310 authentication, for example). The &%auth_advertise_hosts%& option can be used
15311 to make these clients more friendly by excluding them from the set of hosts to
15312 which Exim advertises AUTH.
15313
15314 .cindex "AUTH" "advertising when encrypted"
15315 If you want to advertise the availability of AUTH only when the connection
15316 is encrypted using TLS, you can make use of the fact that the value of this
15317 option is expanded, with a setting like this:
15318 .code
15319 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15320 .endd
15321 .vindex "&$tls_in_cipher$&"
15322 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15323 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15324 expansion is *, which matches all hosts.
15325
15326
15327 .option auto_thaw main time 0s
15328 .cindex "thawing messages"
15329 .cindex "unfreezing messages"
15330 If this option is set to a time greater than zero, a queue runner will try a
15331 new delivery attempt on any frozen message, other than a bounce message, if
15332 this much time has passed since it was frozen. This may result in the message
15333 being re-frozen if nothing has changed since the last attempt. It is a way of
15334 saying &"keep on trying, even though there are big problems"&.
15335
15336 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15337 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15338 thought to be very useful any more, and its use should probably be avoided.
15339
15340
15341 .option av_scanner main string "see below"
15342 This option is available if Exim is built with the content-scanning extension.
15343 It specifies which anti-virus scanner to use. The default value is:
15344 .code
15345 sophie:/var/run/sophie
15346 .endd
15347 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15348 before use. See section &<<SECTscanvirus>>& for further details.
15349
15350
15351 .option bi_command main string unset
15352 .oindex "&%-bi%&"
15353 This option supplies the name of a command that is run when Exim is called with
15354 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15355 just the command name, it is not a complete command line. If an argument is
15356 required, it must come from the &%-oA%& command line option.
15357
15358
15359 .option bounce_message_file main string&!! unset
15360 .cindex "bounce message" "customizing"
15361 .cindex "customizing" "bounce message"
15362 This option defines a template file containing paragraphs of text to be used
15363 for constructing bounce messages.  Details of the file's contents are given in
15364 chapter &<<CHAPemsgcust>>&.
15365 .cindex bounce_message_file "tainted data"
15366 The option is expanded to give the file path, which must be
15367 absolute and untainted.
15368 See also &%warn_message_file%&.
15369
15370
15371 .option bounce_message_text main string unset
15372 When this option is set, its contents are included in the default bounce
15373 message immediately after &"This message was created automatically by mail
15374 delivery software."& It is not used if &%bounce_message_file%& is set.
15375
15376 .option bounce_return_body main boolean true
15377 .cindex "bounce message" "including body"
15378 This option controls whether the body of an incoming message is included in a
15379 bounce message when &%bounce_return_message%& is true. The default setting
15380 causes the entire message, both header and body, to be returned (subject to the
15381 value of &%bounce_return_size_limit%&). If this option is false, only the
15382 message header is included. In the case of a non-SMTP message containing an
15383 error that is detected during reception, only those header lines preceding the
15384 point at which the error was detected are returned.
15385 .cindex "bounce message" "including original"
15386
15387 .option bounce_return_linesize_limit main integer 998
15388 .cindex "size" "of bounce lines, limit"
15389 .cindex "bounce message" "line length limit"
15390 .cindex "limit" "bounce message line length"
15391 This option sets a limit in bytes on the line length of messages
15392 that are returned to senders due to delivery problems,
15393 when &%bounce_return_message%& is true.
15394 The default value corresponds to RFC limits.
15395 If the message being returned has lines longer than this value it is
15396 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15397
15398 The option also applies to bounces returned when an error is detected
15399 during reception of a message.
15400 In this case lines from the original are truncated.
15401
15402 The option does not apply to messages generated by an &(autoreply)& transport.
15403
15404
15405 .option bounce_return_message main boolean true
15406 If this option is set false, none of the original message is included in
15407 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15408 &%bounce_return_body%&.
15409
15410
15411 .option bounce_return_size_limit main integer 100K
15412 .cindex "size" "of bounce, limit"
15413 .cindex "bounce message" "size limit"
15414 .cindex "limit" "bounce message size"
15415 This option sets a limit in bytes on the size of messages that are returned to
15416 senders as part of bounce messages when &%bounce_return_message%& is true. The
15417 limit should be less than the value of the global &%message_size_limit%& and of
15418 any &%message_size_limit%& settings on transports, to allow for the bounce text
15419 that Exim generates. If this option is set to zero there is no limit.
15420
15421 When the body of any message that is to be included in a bounce message is
15422 greater than the limit, it is truncated, and a comment pointing this out is
15423 added at the top. The actual cutoff may be greater than the value given, owing
15424 to the use of buffering for transferring the message in chunks (typically 8K in
15425 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15426 messages.
15427
15428 .option bounce_sender_authentication main string unset
15429 .cindex "bounce message" "sender authentication"
15430 .cindex "authentication" "bounce message"
15431 .cindex "AUTH" "on bounce message"
15432 This option provides an authenticated sender address that is sent with any
15433 bounce messages generated by Exim that are sent over an authenticated SMTP
15434 connection. A typical setting might be:
15435 .code
15436 bounce_sender_authentication = mailer-daemon@my.domain.example
15437 .endd
15438 which would cause bounce messages to be sent using the SMTP command:
15439 .code
15440 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15441 .endd
15442 The value of &%bounce_sender_authentication%& must always be a complete email
15443 address.
15444
15445 .option callout_domain_negative_expire main time 3h
15446 .cindex "caching" "callout timeouts"
15447 .cindex "callout" "caching timeouts"
15448 This option specifies the expiry time for negative callout cache data for a
15449 domain. See section &<<SECTcallver>>& for details of callout verification, and
15450 section &<<SECTcallvercache>>& for details of the caching.
15451
15452
15453 .option callout_domain_positive_expire main time 7d
15454 This option specifies the expiry time for positive callout cache data for a
15455 domain. See section &<<SECTcallver>>& for details of callout verification, and
15456 section &<<SECTcallvercache>>& for details of the caching.
15457
15458
15459 .option callout_negative_expire main time 2h
15460 This option specifies the expiry time for negative callout cache data for an
15461 address. See section &<<SECTcallver>>& for details of callout verification, and
15462 section &<<SECTcallvercache>>& for details of the caching.
15463
15464
15465 .option callout_positive_expire main time 24h
15466 This option specifies the expiry time for positive callout cache data for an
15467 address. See section &<<SECTcallver>>& for details of callout verification, and
15468 section &<<SECTcallvercache>>& for details of the caching.
15469
15470
15471 .option callout_random_local_part main string&!! "see below"
15472 This option defines the &"random"& local part that can be used as part of
15473 callout verification. The default value is
15474 .code
15475 $primary_hostname-$tod_epoch-testing
15476 .endd
15477 See section &<<CALLaddparcall>>& for details of how this value is used.
15478
15479
15480 .options check_log_inodes main integer 100 &&&
15481          check_log_space main integer 10M
15482 See &%check_spool_space%& below.
15483
15484 .oindex "&%check_rfc2047_length%&"
15485 .cindex "RFC 2047" "disabling length check"
15486 .option check_rfc2047_length main boolean true
15487 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15488 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15489 word; strings to be encoded that exceed this length are supposed to use
15490 multiple encoded words. By default, Exim does not recognize encoded words that
15491 exceed the maximum length. However, it seems that some software, in violation
15492 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15493 set false, Exim recognizes encoded words of any length.
15494
15495
15496 .options check_spool_inodes main integer 100 &&&
15497          check_spool_space main integer 10M
15498 .cindex "checking disk space"
15499 .cindex "disk space, checking"
15500 .cindex "spool directory" "checking space"
15501 The four &%check_...%& options allow for checking of disk resources before a
15502 message is accepted.
15503
15504 .vindex "&$log_inodes$&"
15505 .vindex "&$log_space$&"
15506 .vindex "&$spool_inodes$&"
15507 .vindex "&$spool_space$&"
15508 When any of these options are nonzero, they apply to all incoming messages. If you
15509 want to apply different checks to different kinds of message, you can do so by
15510 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15511 &$spool_space$& in an ACL with appropriate additional conditions.
15512
15513
15514 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15515 either value is greater than zero, for example:
15516 .code
15517 check_spool_space = 100M
15518 check_spool_inodes = 100
15519 .endd
15520 The spool partition is the one that contains the directory defined by
15521 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15522 transit.
15523
15524 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15525 files are written if either is greater than zero. These should be set only if
15526 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15527
15528 If there is less space or fewer inodes than requested, Exim refuses to accept
15529 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15530 error response to the MAIL command. If ESMTP is in use and there was a
15531 SIZE parameter on the MAIL command, its value is added to the
15532 &%check_spool_space%& value, and the check is performed even if
15533 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15534
15535 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15536 number of kilobytes (though specified in bytes).
15537 If a non-multiple of 1024 is specified, it is rounded up.
15538
15539 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15540 failure a message is written to stderr and Exim exits with a non-zero code, as
15541 it obviously cannot send an error message of any kind.
15542
15543 There is a slight performance penalty for these checks.
15544 Versions of Exim preceding 4.88 had these disabled by default;
15545 high-rate installations confident they will never run out of resources
15546 may wish to deliberately disable them.
15547
15548 .option chunking_advertise_hosts main "host list&!!" *
15549 .cindex CHUNKING advertisement
15550 .cindex "RFC 3030" "CHUNKING"
15551 .cindex "ESMTP extensions" CHUNKING
15552 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15553 these hosts.
15554 Hosts may use the BDAT command as an alternate to DATA.
15555
15556 .option commandline_checks_require_admin main boolean &`false`&
15557 .cindex "restricting access to features"
15558 This option restricts various basic checking features to require an
15559 administrative user.
15560 This affects most of the &%-b*%& options, such as &%-be%&.
15561
15562 .option debug_store main boolean &`false`&
15563 .cindex debugging "memory corruption"
15564 .cindex memory debugging
15565 This option, when true, enables extra checking in Exim's internal memory
15566 management.  For use when a memory corruption issue is being investigated,
15567 it should normally be left as default.
15568
15569 .option daemon_smtp_ports main string &`smtp`&
15570 .cindex "port" "for daemon"
15571 .cindex "TCP/IP" "setting listening ports"
15572 This option specifies one or more default SMTP ports on which the Exim daemon
15573 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15574 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15575
15576 .options daemon_startup_retries main integer 9 &&&
15577          daemon_startup_sleep main time 30s
15578 .cindex "daemon startup, retrying"
15579 These options control the retrying done by
15580 the daemon at startup when it cannot immediately bind a listening socket
15581 (typically because the socket is already in use): &%daemon_startup_retries%&
15582 defines the number of retries after the first failure, and
15583 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15584
15585 .option delay_warning main "time list" 24h
15586 .cindex "warning of delay"
15587 .cindex "delay warning, specifying"
15588 .cindex "queue" "delay warning"
15589 When a message is delayed, Exim sends a warning message to the sender at
15590 intervals specified by this option. The data is a colon-separated list of times
15591 after which to send warning messages. If the value of the option is an empty
15592 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15593 message has been in the queue for longer than the last time, the last interval
15594 between the times is used to compute subsequent warning times. For example,
15595 with
15596 .code
15597 delay_warning = 4h:8h:24h
15598 .endd
15599 the first message is sent after 4 hours, the second after 8 hours, and
15600 the third one after 24 hours. After that, messages are sent every 16 hours,
15601 because that is the interval between the last two times on the list. If you set
15602 just one time, it specifies the repeat interval. For example, with:
15603 .code
15604 delay_warning = 6h
15605 .endd
15606 messages are repeated every six hours. To stop warnings after a given time, set
15607 a very large time at the end of the list. For example:
15608 .code
15609 delay_warning = 2h:12h:99d
15610 .endd
15611 Note that the option is only evaluated at the time a delivery attempt fails,
15612 which depends on retry and queue-runner configuration.
15613 Typically retries will be configured more frequently than warning messages.
15614
15615 .option delay_warning_condition main string&!! "see below"
15616 .vindex "&$domain$&"
15617 The string is expanded at the time a warning message might be sent. If all the
15618 deferred addresses have the same domain, it is set in &$domain$& during the
15619 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15620 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15621 &"false"& (the comparison being done caselessly) then the warning message is
15622 not sent. The default is:
15623 .code
15624 delay_warning_condition = ${if or {\
15625   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15626   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15627   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15628   } {no}{yes}}
15629 .endd
15630 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15631 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15632 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15633 &"auto-replied"& in an &'Auto-Submitted:'& header.
15634
15635 .option deliver_drop_privilege main boolean false
15636 .cindex "unprivileged delivery"
15637 .cindex "delivery" "unprivileged"
15638 If this option is set true, Exim drops its root privilege at the start of a
15639 delivery process, and runs as the Exim user throughout. This severely restricts
15640 the kinds of local delivery that are possible, but is viable in certain types
15641 of configuration. There is a discussion about the use of root privilege in
15642 chapter &<<CHAPsecurity>>&.
15643
15644 .option deliver_queue_load_max main fixed-point unset
15645 .cindex "load average"
15646 .cindex "queue runner" "abandoning"
15647 When this option is set, a queue run is abandoned if the system load average
15648 becomes greater than the value of the option. The option has no effect on
15649 ancient operating systems on which Exim cannot determine the load average.
15650 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15651
15652
15653 .option delivery_date_remove main boolean true
15654 .cindex "&'Delivery-date:'& header line"
15655 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15656 message when it is delivered, in exactly the same way as &'Return-path:'& is
15657 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15658 should not be present in incoming messages, and this option causes them to be
15659 removed at the time the message is received, to avoid any problems that might
15660 occur when a delivered message is subsequently sent on to some other recipient.
15661
15662 .option disable_fsync main boolean false
15663 .cindex "&[fsync()]&, disabling"
15664 This option is available only if Exim was built with the compile-time option
15665 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15666 a runtime configuration generates an &"unknown option"& error. You should not
15667 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15668 really, really, really understand what you are doing. &'No pre-compiled
15669 distributions of Exim should ever make this option available.'&
15670
15671 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15672 updated files' data to be written to disc before continuing. Unexpected events
15673 such as crashes and power outages may cause data to be lost or scrambled.
15674 Here be Dragons. &*Beware.*&
15675
15676
15677 .option disable_ipv6 main boolean false
15678 .cindex "IPv6" "disabling"
15679 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15680 activities take place. AAAA records are never looked up, and any IPv6 addresses
15681 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15682 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15683 to handle IPv6 literal addresses.
15684
15685
15686 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15687 .cindex DKIM "selecting signature algorithms"
15688 This option gives a list of hash types which are acceptable in signatures,
15689 and an order of processing.
15690 Signatures with algorithms not in the list will be ignored.
15691
15692 Acceptable values include:
15693 .code
15694 sha1
15695 sha256
15696 sha512
15697 .endd
15698
15699 Note that the acceptance of sha1 violates RFC 8301.
15700
15701 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15702 This option gives a list of key types which are acceptable in signatures,
15703 and an order of processing.
15704 Signatures with algorithms not in the list will be ignored.
15705
15706
15707 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15708 This option gives a list of key sizes which are acceptable in signatures.
15709 The list is keyed by the algorithm type for the key; the values are in bits.
15710 Signatures with keys smaller than given by this option will fail verification.
15711
15712 The default enforces the RFC 8301 minimum key size for RSA signatures.
15713
15714 .option dkim_verify_minimal main boolean false
15715 If set to true, verification of signatures will terminate after the
15716 first success.
15717
15718 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15719 .cindex DKIM "controlling calls to the ACL"
15720 This option gives a list of DKIM domains for which the DKIM ACL is run.
15721 It is expanded after the message is received; by default it runs
15722 the ACL once for each signature in the message.
15723 See section &<<SECDKIMVFY>>&.
15724
15725
15726 .option dmarc_forensic_sender main string&!! unset
15727 .option dmarc_history_file main string unset
15728 .option dmarc_tld_file main string unset
15729 .cindex DMARC "main section options"
15730 These options control DMARC processing.
15731 See section &<<SECDMARC>>& for details.
15732
15733
15734 .option dns_again_means_nonexist main "domain list&!!" unset
15735 .cindex "DNS" "&""try again""& response; overriding"
15736 DNS lookups give a &"try again"& response for the DNS errors
15737 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15738 keep trying to deliver a message, or to give repeated temporary errors to
15739 incoming mail. Sometimes the effect is caused by a badly set up name server and
15740 may persist for a long time. If a domain which exhibits this problem matches
15741 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15742 This option should be used with care. You can make it apply to reverse lookups
15743 by a setting such as this:
15744 .code
15745 dns_again_means_nonexist = *.in-addr.arpa
15746 .endd
15747 This option applies to all DNS lookups that Exim does,
15748 .new
15749 except for TLSA lookups (where knowing about such failures
15750 is security-relevant).
15751 .wen
15752 It also applies when the
15753 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15754 since these are most likely to be caused by DNS lookup problems. The
15755 &(dnslookup)& router has some options of its own for controlling what happens
15756 when lookups for MX or SRV records give temporary errors. These more specific
15757 options are applied after this global option.
15758
15759 .option dns_check_names_pattern main string "see below"
15760 .cindex "DNS" "pre-check of name syntax"
15761 When this option is set to a non-empty string, it causes Exim to check domain
15762 names for characters that are not allowed in host names before handing them to
15763 the DNS resolver, because some resolvers give temporary errors for names that
15764 contain unusual characters. If a domain name contains any unwanted characters,
15765 a &"not found"& result is forced, and the resolver is not called. The check is
15766 done by matching the domain name against a regular expression, which is the
15767 value of this option. The default pattern is
15768 .code
15769 dns_check_names_pattern = \
15770   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15771 .endd
15772 which permits only letters, digits, slashes, and hyphens in components, but
15773 they must start and end with a letter or digit. Slashes are not, in fact,
15774 permitted in host names, but they are found in certain NS records (which can be
15775 accessed in Exim by using a &%dnsdb%& lookup). If you set
15776 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15777 empty string.
15778
15779 .option dns_csa_search_limit main integer 5
15780 This option controls the depth of parental searching for CSA SRV records in the
15781 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15782
15783 .option dns_csa_use_reverse main boolean true
15784 This option controls whether or not an IP address, given as a CSA domain, is
15785 reversed and looked up in the reverse DNS, as described in more detail in
15786 section &<<SECTverifyCSA>>&.
15787
15788 .option dns_cname_loops main integer 1
15789 .cindex DNS "CNAME following"
15790 This option controls the following of CNAME chains, needed if the resolver does
15791 not do it internally.
15792 As of 2018 most should, and the default can be left.
15793 If you have an ancient one, a value of 10 is likely needed.
15794
15795 The default value of one CNAME-follow is needed
15796 thanks to the observed return for an MX request,
15797 given no MX presence but a CNAME to an A, of the CNAME.
15798
15799
15800 .option dns_dnssec_ok main integer -1
15801 .cindex "DNS" "resolver options"
15802 .cindex "DNS" "DNSSEC"
15803 If this option is set to a non-negative number then Exim will initialise the
15804 DNS resolver library to either use or not use DNSSEC, overriding the system
15805 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15806
15807 If the resolver library does not support DNSSEC then this option has no effect.
15808
15809 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15810 will default to stripping out a successful validation status.
15811 This will break a previously working Exim installation.
15812 Provided that you do trust the resolver (ie, is on localhost) you can tell
15813 glibc to pass through any successful validation with a new option in
15814 &_/etc/resolv.conf_&:
15815 .code
15816 options trust-ad
15817 .endd
15818
15819
15820 .option dns_ipv4_lookup main "domain list&!!" unset
15821 .cindex "IPv6" "DNS lookup for AAAA records"
15822 .cindex "DNS" "IPv6 lookup for AAAA records"
15823 .cindex DNS "IPv6 disabling"
15824 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15825 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15826 (A records) when trying to find IP addresses for hosts, unless the host's
15827 domain matches this list.
15828
15829 This is a fudge to help with name servers that give big delays or otherwise do
15830 not work for the AAAA record type. In due course, when the world's name
15831 servers have all been upgraded, there should be no need for this option.
15832 Note that all lookups, including those done for verification, are affected;
15833 this will result in verify failure for IPv6 connections or ones using names
15834 only valid for IPv6 addresses.
15835
15836
15837 .option dns_retrans main time 0s
15838 .cindex "DNS" "resolver options"
15839 .cindex timeout "dns lookup"
15840 .cindex "DNS" timeout
15841 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15842 retransmission and retry parameters for DNS lookups. Values of zero (the
15843 defaults) leave the system default settings unchanged. The first value is the
15844 time between retries, and the second is the number of retries. It isn't
15845 totally clear exactly how these settings affect the total time a DNS lookup may
15846 take. I haven't found any documentation about timeouts on DNS lookups; these
15847 parameter values are available in the external resolver interface structure,
15848 but nowhere does it seem to describe how they are used or what you might want
15849 to set in them.
15850 See also the &%slow_lookup_log%& option.
15851
15852
15853 .option dns_retry main integer 0
15854 See &%dns_retrans%& above.
15855
15856
15857 .option dns_trust_aa main "domain list&!!" unset
15858 .cindex "DNS" "resolver options"
15859 .cindex "DNS" "DNSSEC"
15860 If this option is set then lookup results marked with the AA bit
15861 (Authoritative Answer) are trusted the same way as if they were
15862 DNSSEC-verified. The authority section's name of the answer must
15863 match with this expanded domain list.
15864
15865 Use this option only if you talk directly to a resolver that is
15866 authoritative for some zones and does not set the AD (Authentic Data)
15867 bit in the answer. Some DNS servers may have an configuration option to
15868 mark the answers from their own zones as verified (they set the AD bit).
15869 Others do not have this option. It is considered as poor practice using
15870 a resolver that is an authoritative server for some zones.
15871
15872 Use this option only if you really have to (e.g. if you want
15873 to use DANE for remote delivery to a server that is listed in the DNS
15874 zones that your resolver is authoritative for).
15875
15876 If the DNS answer packet has the AA bit set and contains resource record
15877 in the answer section, the name of the first NS record appearing in the
15878 authority section is compared against the list. If the answer packet is
15879 authoritative but the answer section is empty, the name of the first SOA
15880 record in the authoritative section is used instead.
15881
15882 .cindex "DNS" "resolver options"
15883 .option dns_use_edns0 main integer -1
15884 .cindex "DNS" "resolver options"
15885 .cindex "DNS" "EDNS0"
15886 .cindex "DNS" "OpenBSD
15887 If this option is set to a non-negative number then Exim will initialise the
15888 DNS resolver library to either use or not use EDNS0 extensions, overriding
15889 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15890 on.
15891
15892 If the resolver library does not support EDNS0 then this option has no effect.
15893
15894 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15895 means that DNSSEC will not work with Exim on that platform either, unless Exim
15896 is linked against an alternative DNS client library.
15897
15898
15899 .option drop_cr main boolean false
15900 This is an obsolete option that is now a no-op. It used to affect the way Exim
15901 handled CR and LF characters in incoming messages. What happens now is
15902 described in section &<<SECTlineendings>>&.
15903
15904 .option dsn_advertise_hosts main "host list&!!" unset
15905 .cindex "bounce messages" "success"
15906 .cindex "DSN" "success"
15907 .cindex "Delivery Status Notification" "success"
15908 .cindex "ESMTP extensions" DSN
15909 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15910 and accepted from, these hosts.
15911 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15912 and RET and ENVID options on MAIL FROM commands.
15913 A NOTIFY=SUCCESS option requests success-DSN messages.
15914 A NOTIFY= option with no argument requests that no delay or failure DSNs
15915 are sent.
15916 &*Note*&: Supplying success-DSN messages has been criticised
15917 on privacy grounds; it can leak details of internal forwarding.
15918
15919 .option dsn_from main "string&!!" "see below"
15920 .cindex "&'From:'& header line" "in bounces"
15921 .cindex "bounce messages" "&'From:'& line, specifying"
15922 This option can be used to vary the contents of &'From:'& header lines in
15923 bounces and other automatically generated messages (&"Delivery Status
15924 Notifications"& &-- hence the name of the option). The default setting is:
15925 .code
15926 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15927 .endd
15928 The value is expanded every time it is needed. If the expansion fails, a
15929 panic is logged, and the default value is used.
15930
15931 .option envelope_to_remove main boolean true
15932 .cindex "&'Envelope-to:'& header line"
15933 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15934 message when it is delivered, in exactly the same way as &'Return-path:'& is
15935 handled. &'Envelope-to:'& records the original recipient address from the
15936 message's envelope that caused the delivery to happen. Such headers should not
15937 be present in incoming messages, and this option causes them to be removed at
15938 the time the message is received, to avoid any problems that might occur when a
15939 delivered message is subsequently sent on to some other recipient.
15940
15941
15942 .option errors_copy main "string list&!!" unset
15943 .cindex "bounce message" "copy to other address"
15944 .cindex "copy of bounce message"
15945 Setting this option causes Exim to send bcc copies of bounce messages that it
15946 generates to other addresses. &*Note*&: This does not apply to bounce messages
15947 coming from elsewhere. The value of the option is a colon-separated list of
15948 items. Each item consists of a pattern, terminated by white space, followed by
15949 a comma-separated list of email addresses. If a pattern contains spaces, it
15950 must be enclosed in double quotes.
15951
15952 Each pattern is processed in the same way as a single item in an address list
15953 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15954 the bounce message, the message is copied to the addresses on the list. The
15955 items are scanned in order, and once a matching one is found, no further items
15956 are examined. For example:
15957 .code
15958 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15959               rqps@mydomain   hostmaster@mydomain.example,\
15960                               postmaster@mydomain.example
15961 .endd
15962 .vindex "&$domain$&"
15963 .vindex "&$local_part$&"
15964 The address list is expanded before use. The expansion variables &$local_part$&
15965 and &$domain$& are set from the original recipient of the error message, and if
15966 there was any wildcard matching in the pattern, the expansion
15967 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15968 variables &$0$&, &$1$&, etc. are set in the normal way.
15969
15970
15971 .option errors_reply_to main string unset
15972 .cindex "bounce message" "&'Reply-to:'& in"
15973 By default, Exim's bounce and delivery warning messages contain the header line
15974 .display
15975 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15976 .endd
15977 .oindex &%quota_warn_message%&
15978 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15979 A warning message that is generated by the &%quota_warn_message%& option in an
15980 &(appendfile)& transport may contain its own &'From:'& header line that
15981 overrides the default.
15982
15983 Experience shows that people reply to bounce messages. If the
15984 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15985 and warning messages. For example:
15986 .code
15987 errors_reply_to = postmaster@my.domain.example
15988 .endd
15989 The value of the option is not expanded. It must specify a valid RFC 2822
15990 address. However, if a warning message that is generated by the
15991 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15992 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15993 not used.
15994
15995
15996 .option event_action main string&!! unset
15997 .cindex events
15998 This option declares a string to be expanded for Exim's events mechanism.
15999 For details see chapter &<<CHAPevents>>&.
16000
16001
16002 .option exim_group main string "compile-time configured"
16003 .cindex "gid (group id)" "Exim's own"
16004 .cindex "Exim group"
16005 This option changes the gid under which Exim runs when it gives up root
16006 privilege. The default value is compiled into the binary. The value of this
16007 option is used only when &%exim_user%& is also set. Unless it consists entirely
16008 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
16009 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
16010 security issues.
16011
16012
16013 .option exim_path main string "see below"
16014 .cindex "Exim binary, path name"
16015 This option specifies the path name of the Exim binary, which is used when Exim
16016 needs to re-exec itself. The default is set up to point to the file &'exim'& in
16017 the directory configured at compile time by the BIN_DIRECTORY setting. It
16018 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16019 other place.
16020 &*Warning*&: Do not use a macro to define the value of this option, because
16021 you will break those Exim utilities that scan the configuration file to find
16022 where the binary is. (They then use the &%-bP%& option to extract option
16023 settings such as the value of &%spool_directory%&.)
16024
16025
16026 .option exim_user main string "compile-time configured"
16027 .cindex "uid (user id)" "Exim's own"
16028 .cindex "Exim user"
16029 This option changes the uid under which Exim runs when it gives up root
16030 privilege. The default value is compiled into the binary. Ownership of the run
16031 time configuration file and the use of the &%-C%& and &%-D%& command line
16032 options is checked against the values in the binary, not what is set here.
16033
16034 Unless it consists entirely of digits, the string is looked up using
16035 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16036 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16037 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16038
16039
16040 .option exim_version main string "current version"
16041 .cindex "Exim version"
16042 .cindex customizing "version number"
16043 .cindex "version number of Exim" override
16044 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16045 various places.  Use with care; this may fool stupid security scanners.
16046
16047
16048 .option extra_local_interfaces main "string list" unset
16049 This option defines network interfaces that are to be considered local when
16050 routing, but which are not used for listening by the daemon. See section
16051 &<<SECTreclocipadd>>& for details.
16052
16053
16054 . Allow this long option name to split; give it unsplit as a fifth argument
16055 . for the automatic .oindex that is generated by .option.
16056
16057 .option "extract_addresses_remove_arguments" main boolean true &&&
16058          extract_addresses_remove_arguments
16059 .oindex "&%-t%&"
16060 .cindex "command line" "addresses with &%-t%&"
16061 .cindex "Sendmail compatibility" "&%-t%& option"
16062 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16063 are present on the command line when the &%-t%& option is used to build an
16064 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16065 line addresses are removed from the recipients list. This is also how Smail
16066 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16067 command line addresses are added to those obtained from the header lines. When
16068 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16069 argument headers. If it is set false, Exim adds rather than removes argument
16070 addresses.
16071
16072
16073 .option finduser_retries main integer 0
16074 .cindex "NIS, retrying user lookups"
16075 On systems running NIS or other schemes in which user and group information is
16076 distributed from a remote system, there can be times when &[getpwnam()]& and
16077 related functions fail, even when given valid data, because things time out.
16078 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16079 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16080 many extra times to find a user or a group, waiting for one second between
16081 retries.
16082
16083 .cindex "&_/etc/passwd_&" "multiple reading of"
16084 You should not set this option greater than zero if your user information is in
16085 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16086 search the file multiple times for non-existent users, and also cause delay.
16087
16088
16089
16090 .option freeze_tell main "string list, comma separated" unset
16091 .cindex "freezing messages" "sending a message when freezing"
16092 .cindex "frozen messages" "sending a message when freezing"
16093 On encountering certain errors, or when configured to do so in a system filter,
16094 ACL, or special router, Exim freezes a message. This means that no further
16095 delivery attempts take place until an administrator thaws the message, or the
16096 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16097 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16098 warning message whenever it freezes something, unless the message it is
16099 freezing is a locally-generated bounce message. (Without this exception there
16100 is the possibility of looping.) The warning message is sent to the addresses
16101 supplied as the comma-separated value of this option. If several of the
16102 message's addresses cause freezing, only a single message is sent. If the
16103 freezing was automatic, the reason(s) for freezing can be found in the message
16104 log. If you configure freezing in a filter or ACL, you must arrange for any
16105 logging that you require.
16106
16107
16108 .options gecos_name main string&!! unset &&&
16109          gecos_pattern main string unset
16110 .cindex "HP-UX"
16111 .cindex "&""gecos""& field, parsing"
16112 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16113 password file to hold other information in addition to users' real names. Exim
16114 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16115 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16116 of the field are used unchanged, except that, if an ampersand is encountered,
16117 it is replaced by the user's login name with the first character forced to
16118 upper case, since this is a convention that is observed on many systems.
16119
16120 When these options are set, &%gecos_pattern%& is treated as a regular
16121 expression that is to be applied to the field (again with && replaced by the
16122 login name), and if it matches, &%gecos_name%& is expanded and used as the
16123 user's name.
16124
16125 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16126 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16127 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16128 name terminates at the first comma, the following can be used:
16129 .code
16130 gecos_pattern = ([^,]*)
16131 gecos_name = $1
16132 .endd
16133
16134
16135 .option gnutls_compat_mode main boolean unset
16136 This option controls whether GnuTLS is used in compatibility mode in an Exim
16137 server. This reduces security slightly, but improves interworking with older
16138 implementations of TLS.
16139
16140
16141 .option gnutls_allow_auto_pkcs11 main boolean unset
16142 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16143 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16144
16145 See
16146 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16147 for documentation.
16148
16149
16150
16151 .option headers_charset main string "see below"
16152 This option sets a default character set for translating from encoded MIME
16153 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16154 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16155 ultimate default is ISO-8859-1. For more details see the description of header
16156 insertions in section &<<SECTexpansionitems>>&.
16157
16158
16159
16160 .option header_maxsize main integer "see below"
16161 .cindex "header section" "maximum size of"
16162 .cindex "limit" "size of message header section"
16163 This option controls the overall maximum size of a message's header
16164 section. The default is the value of HEADER_MAXSIZE in
16165 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16166 sections are rejected.
16167
16168
16169 .option header_line_maxsize main integer 0
16170 .cindex "header lines" "maximum size of"
16171 .cindex "limit" "size of one header line"
16172 This option limits the length of any individual header line in a message, after
16173 all the continuations have been joined together. Messages with individual
16174 header lines that are longer than the limit are rejected. The default value of
16175 zero means &"no limit"&.
16176
16177
16178
16179
16180 .option helo_accept_junk_hosts main "host list&!!" unset
16181 .cindex "HELO" "accepting junk data"
16182 .cindex "EHLO" "accepting junk data"
16183 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16184 mail, and gives an error response for invalid data. Unfortunately, there are
16185 some SMTP clients that send syntactic junk. They can be accommodated by setting
16186 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16187 if you want to do semantic checking.
16188 See also &%helo_allow_chars%& for a way of extending the permitted character
16189 set.
16190
16191
16192 .option helo_allow_chars main string unset
16193 .cindex "HELO" "underscores in"
16194 .cindex "EHLO" "underscores in"
16195 .cindex "underscore in EHLO/HELO"
16196 This option can be set to a string of rogue characters that are permitted in
16197 all EHLO and HELO names in addition to the standard letters, digits,
16198 hyphens, and dots. If you really must allow underscores, you can set
16199 .code
16200 helo_allow_chars = _
16201 .endd
16202 Note that the value is one string, not a list.
16203
16204
16205 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16206 .cindex "HELO" "forcing reverse lookup"
16207 .cindex "EHLO" "forcing reverse lookup"
16208 If the domain given by a client in a HELO or EHLO command matches this
16209 list, a reverse lookup is done in order to establish the host's true name. The
16210 default forces a lookup if the client host gives the server's name or any of
16211 its IP addresses (in brackets), something that broken clients have been seen to
16212 do.
16213
16214
16215 .option helo_try_verify_hosts main "host list&!!" unset
16216 .cindex "HELO verifying" "optional"
16217 .cindex "EHLO" "verifying, optional"
16218 By default, Exim just checks the syntax of HELO and EHLO commands (see
16219 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16220 to do more extensive checking of the data supplied by these commands. The ACL
16221 condition &`verify = helo`& is provided to make this possible.
16222 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16223 to force the check to occur. From release 4.53 onwards, this is no longer
16224 necessary. If the check has not been done before &`verify = helo`& is
16225 encountered, it is done at that time. Consequently, this option is obsolete.
16226 Its specification is retained here for backwards compatibility.
16227
16228 When an EHLO or HELO command is received, if the calling host matches
16229 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16230 EHLO command either:
16231
16232 .ilist
16233 is an IP literal matching the calling address of the host, or
16234 .next
16235 .cindex "DNS" "reverse lookup"
16236 .cindex "reverse DNS lookup"
16237 matches the host name that Exim obtains by doing a reverse lookup of the
16238 calling host address, or
16239 .next
16240 when looked up in DNS yields the calling host address.
16241 .endlist
16242
16243 However, the EHLO or HELO command is not rejected if any of the checks
16244 fail. Processing continues, but the result of the check is remembered, and can
16245 be detected later in an ACL by the &`verify = helo`& condition.
16246
16247 If DNS was used for successful verification, the variable
16248 .cindex "DNS" "DNSSEC"
16249 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16250
16251 .option helo_verify_hosts main "host list&!!" unset
16252 .cindex "HELO verifying" "mandatory"
16253 .cindex "EHLO" "verifying, mandatory"
16254 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16255 backwards compatibility. For hosts that match this option, Exim checks the host
16256 name given in the HELO or EHLO in the same way as for
16257 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16258 rejected with a 550 error, and entries are written to the main and reject logs.
16259 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16260 error.
16261
16262 .option hold_domains main "domain list&!!" unset
16263 .cindex "domain" "delaying delivery"
16264 .cindex "delivery" "delaying certain domains"
16265 This option allows mail for particular domains to be held in the queue
16266 manually. The option is overridden if a message delivery is forced with the
16267 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16268 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16269 item in &%hold_domains%&, no routing or delivery for that address is done, and
16270 it is deferred every time the message is looked at.
16271
16272 This option is intended as a temporary operational measure for delaying the
16273 delivery of mail while some problem is being sorted out, or some new
16274 configuration tested. If you just want to delay the processing of some
16275 domains until a queue run occurs, you should use &%queue_domains%& or
16276 &%queue_smtp_domains%&, not &%hold_domains%&.
16277
16278 A setting of &%hold_domains%& does not override Exim's code for removing
16279 messages from the queue if they have been there longer than the longest retry
16280 time in any retry rule. If you want to hold messages for longer than the normal
16281 retry times, insert a dummy retry rule with a long retry time.
16282
16283
16284 .option host_lookup main "host list&!!" unset
16285 .cindex "host name" "lookup, forcing"
16286 Exim does not look up the name of a calling host from its IP address unless it
16287 is required to compare against some host list, or the host matches
16288 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16289 option (which normally contains IP addresses rather than host names). The
16290 default configuration file contains
16291 .code
16292 host_lookup = *
16293 .endd
16294 which causes a lookup to happen for all hosts. If the expense of these lookups
16295 is felt to be too great, the setting can be changed or removed.
16296
16297 After a successful reverse lookup, Exim does a forward lookup on the name it
16298 has obtained, to verify that it yields the IP address that it started with. If
16299 this check fails, Exim behaves as if the name lookup failed.
16300
16301 .vindex "&$host_lookup_failed$&"
16302 .vindex "&$sender_host_name$&"
16303 After any kind of failure, the host name (in &$sender_host_name$&) remains
16304 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16305 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16306 &`verify = reverse_host_lookup`& in ACLs.
16307
16308
16309 .option host_lookup_order main "string list" &`bydns:byaddr`&
16310 This option specifies the order of different lookup methods when Exim is trying
16311 to find a host name from an IP address. The default is to do a DNS lookup
16312 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16313 if that fails. You can change the order of these lookups, or omit one entirely,
16314 if you want.
16315
16316 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16317 multiple PTR records in the DNS and the IP address is not listed in
16318 &_/etc/hosts_&. Different operating systems give different results in this
16319 case. That is why the default tries a DNS lookup first.
16320
16321
16322
16323 .option host_reject_connection main "host list&!!" unset
16324 .cindex "host" "rejecting connections from"
16325 If this option is set, incoming SMTP calls from the hosts listed are rejected
16326 as soon as the connection is made.
16327 This option is obsolete, and retained only for backward compatibility, because
16328 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16329 connections immediately.
16330
16331 .new
16332 If the connection is on a TLS-on-connect port then the TCP connection is
16333 just dropped.  Otherwise, an SMTP error is sent first.
16334 .wen
16335
16336 The ability to give an immediate rejection (either by this option or using an
16337 ACL) is provided for use in unusual cases. Many hosts will just try again,
16338 sometimes without much delay. Normally, it is better to use an ACL to reject
16339 incoming messages at a later stage, such as after RCPT commands. See
16340 chapter &<<CHAPACL>>&.
16341
16342
16343 .option hosts_connection_nolog main "host list&!!" unset
16344 .cindex "host" "not logging connections from"
16345 This option defines a list of hosts for which connection logging does not
16346 happen, even though the &%smtp_connection%& log selector is set. For example,
16347 you might want not to log SMTP connections from local processes, or from
16348 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16349 the daemon; you should therefore strive to restrict its value to a short inline
16350 list of IP addresses and networks. To disable logging SMTP connections from
16351 local processes, you must create a host list with an empty item. For example:
16352 .code
16353 hosts_connection_nolog = :
16354 .endd
16355 .new
16356 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16357 lines, as may commonly be produced by a monitoring system.
16358 .wen
16359
16360
16361 .option hosts_require_alpn main "host list&!!" unset
16362 .cindex ALPN "require negotiation in server"
16363 .cindex TLS ALPN
16364 .cindex TLS "Application Layer Protocol Names"
16365 If the TLS library supports ALPN
16366 then a successful negotiation of ALPN will be required for any client
16367 matching the list, for TLS to be used.
16368 See also the &%tls_alpn%& option.
16369
16370 &*Note*&: prevention of fallback to in-clear connection is not
16371 managed by this option, and should be done separately.
16372
16373
16374 .option hosts_require_helo main "host list&!!" *
16375 .cindex "HELO/EHLO" requiring
16376 Exim will require an accepted HELO or EHLO command from a host matching
16377 this list, before accepting a MAIL command.
16378
16379
16380 .option hosts_proxy main "host list&!!" unset
16381 .cindex proxy "proxy protocol"
16382 This option enables use of Proxy Protocol proxies for incoming
16383 connections.  For details see section &<<SECTproxyInbound>>&.
16384
16385
16386 .option hosts_treat_as_local main "domain list&!!" unset
16387 .cindex "local host" "domains treated as"
16388 .cindex "host" "treated as local"
16389 If this option is set, any host names that match the domain list are treated as
16390 if they were the local host when Exim is scanning host lists obtained from MX
16391 records
16392 or other sources. Note that the value of this option is a domain list, not a
16393 host list, because it is always used to check host names, not IP addresses.
16394
16395 This option also applies when Exim is matching the special items
16396 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16397 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16398 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16399 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16400 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16401 interfaces and recognizing the local host.
16402
16403
16404 .option ibase_servers main "string list" unset
16405 .cindex "InterBase" "server list"
16406 This option provides a list of InterBase servers and associated connection data,
16407 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16408 The option is available only if Exim has been built with InterBase support.
16409
16410
16411
16412 .option ignore_bounce_errors_after main time 10w
16413 .cindex "bounce message" "discarding"
16414 .cindex "discarding bounce message"
16415 This option affects the processing of bounce messages that cannot be delivered,
16416 that is, those that suffer a permanent delivery failure. (Bounce messages that
16417 suffer temporary delivery failures are of course retried in the usual way.)
16418
16419 After a permanent delivery failure, bounce messages are frozen,
16420 because there is no sender to whom they can be returned. When a frozen bounce
16421 message has been in the queue for more than the given time, it is unfrozen at
16422 the next queue run, and a further delivery is attempted. If delivery fails
16423 again, the bounce message is discarded. This makes it possible to keep failed
16424 bounce messages around for a shorter time than the normal maximum retry time
16425 for frozen messages. For example,
16426 .code
16427 ignore_bounce_errors_after = 12h
16428 .endd
16429 retries failed bounce message deliveries after 12 hours, discarding any further
16430 failures. If the value of this option is set to a zero time period, bounce
16431 failures are discarded immediately. Setting a very long time (as in the default
16432 value) has the effect of disabling this option. For ways of automatically
16433 dealing with other kinds of frozen message, see &%auto_thaw%& and
16434 &%timeout_frozen_after%&.
16435
16436
16437 .options ignore_fromline_hosts main "host list&!!" unset &&&
16438          ignore_fromline_local main boolean false
16439 .cindex "&""From""& line"
16440 .cindex "UUCP" "&""From""& line"
16441 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16442 the headers of a message. By default this is treated as the start of the
16443 message's body, which means that any following headers are not recognized as
16444 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16445 match those hosts that insist on sending it. If the sender is actually a local
16446 process rather than a remote host, and is using &%-bs%& to inject the messages,
16447 &%ignore_fromline_local%& must be set to achieve this effect.
16448
16449
16450
16451 .option keep_environment main "string list" unset
16452 .cindex "environment" "values from"
16453 This option contains a string list of environment variables to keep.
16454 You have to trust these variables or you have to be sure that
16455 these variables do not impose any security risk. Keep in mind that
16456 during the startup phase Exim is running with an effective UID 0 in most
16457 installations. As the default value is an empty list, the default
16458 environment for using libraries, running embedded Perl code, or running
16459 external binaries is empty, and does not not even contain PATH or HOME.
16460
16461 Actually the list is interpreted as a list of patterns
16462 (&<<SECTlistexpand>>&), except that it is not expanded first.
16463
16464 WARNING: Macro substitution is still done first, so having a macro
16465 FOO and having FOO_HOME in your &%keep_environment%& option may have
16466 unexpected results. You may work around this using a regular expression
16467 that does not match the macro name: ^[F]OO_HOME$.
16468
16469 Current versions of Exim issue a warning during startup if you do not mention
16470 &%keep_environment%& in your runtime configuration file and if your
16471 current environment is not empty. Future versions may not issue that warning
16472 anymore.
16473
16474 See the &%add_environment%& main config option for a way to set
16475 environment variables to a fixed value.  The environment for &(pipe)&
16476 transports is handled separately, see section &<<SECTpipeenv>>& for
16477 details.
16478
16479
16480 .option keep_malformed main time 4d
16481 This option specifies the length of time to keep messages whose spool files
16482 have been corrupted in some way. This should, of course, never happen. At the
16483 next attempt to deliver such a message, it gets removed. The incident is
16484 logged.
16485
16486
16487 .option ldap_ca_cert_dir main string unset
16488 .cindex "LDAP", "TLS CA certificate directory"
16489 .cindex certificate "directory for LDAP"
16490 This option indicates which directory contains CA certificates for verifying
16491 a TLS certificate presented by an LDAP server.
16492 While Exim does not provide a default value, your SSL library may.
16493 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16494 and constrained to be a directory.
16495
16496
16497 .option ldap_ca_cert_file main string unset
16498 .cindex "LDAP", "TLS CA certificate file"
16499 .cindex certificate "file for LDAP"
16500 This option indicates which file contains CA certificates for verifying
16501 a TLS certificate presented by an LDAP server.
16502 While Exim does not provide a default value, your SSL library may.
16503 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16504 and constrained to be a file.
16505
16506
16507 .option ldap_cert_file main string unset
16508 .cindex "LDAP" "TLS client certificate file"
16509 .cindex certificate "file for LDAP"
16510 This option indicates which file contains an TLS client certificate which
16511 Exim should present to the LDAP server during TLS negotiation.
16512 Should be used together with &%ldap_cert_key%&.
16513
16514
16515 .option ldap_cert_key main string unset
16516 .cindex "LDAP" "TLS client key file"
16517 .cindex certificate "key for LDAP"
16518 This option indicates which file contains the secret/private key to use
16519 to prove identity to the LDAP server during TLS negotiation.
16520 Should be used together with &%ldap_cert_file%&, which contains the
16521 identity to be proven.
16522
16523
16524 .option ldap_cipher_suite main string unset
16525 .cindex "LDAP" "TLS cipher suite"
16526 This controls the TLS cipher-suite negotiation during TLS negotiation with
16527 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16528 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16529
16530
16531 .option ldap_default_servers main "string list" unset
16532 .cindex "LDAP" "default servers"
16533 This option provides a list of LDAP servers which are tried in turn when an
16534 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16535 details of LDAP queries. This option is available only when Exim has been built
16536 with LDAP support.
16537
16538
16539 .option ldap_require_cert main string unset.
16540 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16541 This should be one of the values "hard", "demand", "allow", "try" or "never".
16542 A value other than one of these is interpreted as "never".
16543 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16544 Although Exim does not set a default, the LDAP library probably defaults
16545 to hard/demand.
16546
16547
16548 .option ldap_start_tls main boolean false
16549 .cindex "LDAP" "whether or not to negotiate TLS"
16550 If set, Exim will attempt to negotiate TLS with the LDAP server when
16551 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16552 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16553 of SSL-on-connect.
16554 In the event of failure to negotiate TLS, the action taken is controlled
16555 by &%ldap_require_cert%&.
16556 This option is ignored for &`ldapi`& connections.
16557
16558
16559 .option ldap_version main integer unset
16560 .cindex "LDAP" "protocol version, forcing"
16561 This option can be used to force Exim to set a specific protocol version for
16562 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16563 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16564 the LDAP headers; otherwise it is 2. This option is available only when Exim
16565 has been built with LDAP support.
16566
16567
16568
16569 .option local_from_check main boolean true
16570 .cindex "&'Sender:'& header line" "disabling addition of"
16571 .cindex "&'From:'& header line" "disabling checking of"
16572 When a message is submitted locally (that is, not over a TCP/IP connection) by
16573 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16574 checks that the &'From:'& header line matches the login of the calling user and
16575 the domain specified by &%qualify_domain%&.
16576
16577 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16578 locally submitted message is automatically qualified by Exim, unless the
16579 &%-bnq%& command line option is used.
16580
16581 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16582 on the local part. If the &'From:'& header line does not match, Exim adds a
16583 &'Sender:'& header with an address constructed from the calling user's login
16584 and the default qualify domain.
16585
16586 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16587 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16588 &'Sender:'& header lines supplied by untrusted users, you must also set
16589 &%local_sender_retain%& to be true.
16590
16591 .cindex "envelope from"
16592 .cindex "envelope sender"
16593 These options affect only the header lines in the message. The envelope sender
16594 is still forced to be the login id at the qualify domain unless
16595 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16596
16597 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16598 request similar header line checking. See section &<<SECTthesenhea>>&, which
16599 has more details about &'Sender:'& processing.
16600
16601
16602
16603
16604 .options local_from_prefix main string unset &&&
16605          local_from_suffix main string unset
16606 When Exim checks the &'From:'& header line of locally submitted messages for
16607 matching the login id (see &%local_from_check%& above), it can be configured to
16608 ignore certain prefixes and suffixes in the local part of the address. This is
16609 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16610 appropriate lists, in the same form as the &%local_part_prefix%& and
16611 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16612 example, if
16613 .code
16614 local_from_prefix = *-
16615 .endd
16616 is set, a &'From:'& line containing
16617 .code
16618 From: anything-user@your.domain.example
16619 .endd
16620 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16621 matches the actual sender address that is constructed from the login name and
16622 qualify domain.
16623
16624
16625 .option local_interfaces main "string list" "see below"
16626 This option controls which network interfaces are used by the daemon for
16627 listening; they are also used to identify the local host when routing. Chapter
16628 &<<CHAPinterfaces>>& contains a full description of this option and the related
16629 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16630 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16631 &%local_interfaces%& is
16632 .code
16633 local_interfaces = 0.0.0.0
16634 .endd
16635 when Exim is built without IPv6 support; otherwise it is
16636 .code
16637 local_interfaces = <; ::0 ; 0.0.0.0
16638 .endd
16639
16640 .option local_scan_timeout main time 5m
16641 .cindex "timeout" "for &[local_scan()]& function"
16642 .cindex "&[local_scan()]& function" "timeout"
16643 This timeout applies to the &[local_scan()]& function (see chapter
16644 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16645 the incoming message is rejected with a temporary error if it is an SMTP
16646 message. For a non-SMTP message, the message is dropped and Exim ends with a
16647 non-zero code. The incident is logged on the main and reject logs.
16648
16649
16650
16651 .option local_sender_retain main boolean false
16652 .cindex "&'Sender:'& header line" "retaining from local submission"
16653 When a message is submitted locally (that is, not over a TCP/IP connection) by
16654 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16655 do not want this to happen, you must set &%local_sender_retain%&, and you must
16656 also set &%local_from_check%& to be false (Exim will complain if you do not).
16657 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16658 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16659
16660
16661
16662
16663 .option localhost_number main string&!! unset
16664 .cindex "host" "locally unique number for"
16665 .cindex "message ids" "with multiple hosts"
16666 .vindex "&$localhost_number$&"
16667 Exim's message ids are normally unique only within the local host. If
16668 uniqueness among a set of hosts is required, each host must set a different
16669 value for the &%localhost_number%& option. The string is expanded immediately
16670 after reading the configuration file (so that a number can be computed from the
16671 host name, for example) and the result of the expansion must be a number in the
16672 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16673 systems). This is available in subsequent string expansions via the variable
16674 &$localhost_number$&. When &%localhost_number is set%&, the final two
16675 characters of the message id, instead of just being a fractional part of the
16676 time, are computed from the time and the local host number as described in
16677 section &<<SECTmessiden>>&.
16678
16679
16680
16681 .option log_file_path main "string list&!!" "set at compile time"
16682 .cindex "log" "file path for"
16683 This option sets the path which is used to determine the names of Exim's log
16684 files, or indicates that logging is to be to syslog, or both. It is expanded
16685 when Exim is entered, so it can, for example, contain a reference to the host
16686 name. If no specific path is set for the log files at compile or runtime,
16687 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16688 they are written in a sub-directory called &_log_& in Exim's spool directory.
16689 A path must start with a slash.
16690 To send to syslog, use the word &"syslog"&.
16691 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16692 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16693 used. If this string is fixed at your installation (contains no expansion
16694 variables) it is recommended that you do not set this option in the
16695 configuration file, but instead supply the path using LOG_FILE_PATH in
16696 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16697 early on &-- in particular, failure to read the configuration file.
16698
16699
16700 .option log_selector main string unset
16701 .cindex "log" "selectors"
16702 This option can be used to reduce or increase the number of things that Exim
16703 writes to its log files. Its argument is made up of names preceded by plus or
16704 minus characters. For example:
16705 .code
16706 log_selector = +arguments -retry_defer
16707 .endd
16708 A list of possible names and what they control is given in the chapter on
16709 logging, in section &<<SECTlogselector>>&.
16710
16711
16712 .option log_timezone main boolean false
16713 .cindex "log" "timezone for entries"
16714 .vindex "&$tod_log$&"
16715 .vindex "&$tod_zone$&"
16716 By default, the timestamps on log lines are in local time without the
16717 timezone. This means that if your timezone changes twice a year, the timestamps
16718 in log lines are ambiguous for an hour when the clocks go back. One way of
16719 avoiding this problem is to set the timezone to UTC. An alternative is to set
16720 &%log_timezone%& true. This turns on the addition of the timezone offset to
16721 timestamps in log lines. Turning on this option can add quite a lot to the size
16722 of log files because each line is extended by 6 characters. Note that the
16723 &$tod_log$& variable contains the log timestamp without the zone, but there is
16724 another variable called &$tod_zone$& that contains just the timezone offset.
16725
16726
16727 .option lookup_open_max main integer 25
16728 .cindex "too many open files"
16729 .cindex "open files, too many"
16730 .cindex "file" "too many open"
16731 .cindex "lookup" "maximum open files"
16732 .cindex "limit" "open files for lookups"
16733 This option limits the number of simultaneously open files for single-key
16734 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16735 Exim normally keeps these files open during routing, because often the same
16736 file is required several times. If the limit is reached, Exim closes the least
16737 recently used file. Note that if you are using the &'ndbm'& library, it
16738 actually opens two files for each logical DBM database, though it still counts
16739 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16740 open files"& errors with NDBM, you need to reduce the value of
16741 &%lookup_open_max%&.
16742
16743
16744 .option max_username_length main integer 0
16745 .cindex "length of login name"
16746 .cindex "user name" "maximum length"
16747 .cindex "limit" "user name length"
16748 Some operating systems are broken in that they truncate long arguments to
16749 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16750 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16751 an argument that is longer behaves as if &[getpwnam()]& failed.
16752
16753
16754 .option message_body_newlines main bool false
16755 .cindex "message body" "newlines in variables"
16756 .cindex "newline" "in message body variables"
16757 .vindex "&$message_body$&"
16758 .vindex "&$message_body_end$&"
16759 By default, newlines in the message body are replaced by spaces when setting
16760 the &$message_body$& and &$message_body_end$& expansion variables. If this
16761 option is set true, this no longer happens.
16762
16763
16764 .option message_body_visible main integer 500
16765 .cindex "body of message" "visible size"
16766 .cindex "message body" "visible size"
16767 .vindex "&$message_body$&"
16768 .vindex "&$message_body_end$&"
16769 This option specifies how much of a message's body is to be included in the
16770 &$message_body$& and &$message_body_end$& expansion variables.
16771
16772
16773 .option message_id_header_domain main string&!! unset
16774 .cindex "&'Message-ID:'& header line"
16775 If this option is set, the string is expanded and used as the right hand side
16776 (domain) of the &'Message-ID:'& header that Exim creates if a
16777 locally-originated incoming message does not have one. &"Locally-originated"&
16778 means &"not received over TCP/IP."&
16779 Otherwise, the primary host name is used.
16780 Only letters, digits, dot and hyphen are accepted; any other characters are
16781 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16782 empty string, the option is ignored.
16783
16784
16785 .option message_id_header_text main string&!! unset
16786 If this variable is set, the string is expanded and used to augment the text of
16787 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16788 message does not have one. The text of this header is required by RFC 2822 to
16789 take the form of an address. By default, Exim uses its internal message id as
16790 the local part, and the primary host name as the domain. If this option is set,
16791 it is expanded, and provided the expansion is not forced to fail, and does not
16792 yield an empty string, the result is inserted into the header immediately
16793 before the @, separated from the internal message id by a dot. Any characters
16794 that are illegal in an address are automatically converted into hyphens. This
16795 means that variables such as &$tod_log$& can be used, because the spaces and
16796 colons will become hyphens.
16797
16798
16799 .option message_logs main boolean true
16800 .cindex "message logs" "disabling"
16801 .cindex "log" "message log; disabling"
16802 If this option is turned off, per-message log files are not created in the
16803 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16804 Exim, by reducing the number of files involved in handling a message from a
16805 minimum of four (header spool file, body spool file, delivery journal, and
16806 per-message log) to three. The other major I/O activity is Exim's main log,
16807 which is not affected by this option.
16808
16809
16810 .option message_size_limit main string&!! 50M
16811 .cindex "message" "size limit"
16812 .cindex "limit" "message size"
16813 .cindex "size" "of message, limit"
16814 This option limits the maximum size of message that Exim will process. The
16815 value is expanded for each incoming connection so, for example, it can be made
16816 to depend on the IP address of the remote host for messages arriving via
16817 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16818 optionally followed by K or M.
16819
16820 .cindex "SIZE" "ESMTP extension, advertising"
16821 .cindex "ESMTP extensions" SIZE
16822 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16823 service extension keyword.
16824
16825 &*Note*&: This limit cannot be made to depend on a message's sender or any
16826 other properties of an individual message, because it has to be advertised in
16827 the server's response to EHLO. String expansion failure causes a temporary
16828 error. A value of zero means no limit, but its use is not recommended. See also
16829 &%bounce_return_size_limit%&.
16830
16831 Incoming SMTP messages are failed with a 552 error if the limit is
16832 exceeded; locally-generated messages either get a stderr message or a delivery
16833 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16834 an oversized message is logged in both the main and the reject logs. See also
16835 the generic transport option &%message_size_limit%&, which limits the size of
16836 message that an individual transport can process.
16837
16838 If you use a virus-scanner and set this option to to a value larger than the
16839 maximum size that your virus-scanner is configured to support, you may get
16840 failures triggered by large mails.  The right size to configure for the
16841 virus-scanner depends upon what data is passed and the options in use but it's
16842 probably safest to just set it to a little larger than this value.  E.g., with a
16843 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16844 some problems may result.
16845
16846 A value of 0 will disable size limit checking; Exim will still advertise the
16847 SIZE extension in an EHLO response, but without a limit, so as to permit
16848 SMTP clients to still indicate the message size along with the MAIL verb.
16849
16850
16851 .option move_frozen_messages main boolean false
16852 .cindex "frozen messages" "moving"
16853 This option, which is available only if Exim has been built with the setting
16854 .code
16855 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16856 .endd
16857 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16858 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16859 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16860 standard utilities for handling such moved messages, and they do not show up in
16861 lists generated by &%-bp%& or by the Exim monitor.
16862
16863
16864 .option mua_wrapper main boolean false
16865 Setting this option true causes Exim to run in a very restrictive mode in which
16866 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16867 contains a full description of this facility.
16868
16869
16870
16871 .option mysql_servers main "string list" unset
16872 .cindex "MySQL" "server list"
16873 This option provides a list of MySQL servers and associated connection data, to
16874 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16875 option is available only if Exim has been built with MySQL support.
16876
16877
16878 .option never_users main "string list&!!" unset
16879 This option is expanded just once, at the start of Exim's processing. Local
16880 message deliveries are normally run in processes that are setuid to the
16881 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16882 It is usually desirable to prevent any deliveries from running as root, as a
16883 safety precaution.
16884
16885 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16886 list of users that must not be used for local deliveries. This list is fixed in
16887 the binary and cannot be overridden by the configuration file. By default, it
16888 contains just the single user name &"root"&. The &%never_users%& runtime option
16889 can be used to add more users to the fixed list.
16890
16891 If a message is to be delivered as one of the users on the fixed list or the
16892 &%never_users%& list, an error occurs, and delivery is deferred. A common
16893 example is
16894 .code
16895 never_users = root:daemon:bin
16896 .endd
16897 Including root is redundant if it is also on the fixed list, but it does no
16898 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16899 transport driver.
16900
16901
16902 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16903 This option gives the name for a unix-domain socket on which the daemon
16904 listens for work and information-requests.
16905 Only installations running multiple daemons sharing a spool directory
16906 should need to modify the default.
16907
16908 The option is expanded before use.
16909 If the platform supports Linux-style abstract socket names, the result
16910 is used with a nul byte prefixed.
16911 Otherwise,
16912 it should be a full path name and use a directory accessible
16913 to Exim.
16914
16915 If this option is set as empty,
16916 or the command line &%-oY%& option is used, or
16917 the command line uses a &%-oX%& option and does not use &%-oP%&,
16918 then a notifier socket is not created.
16919
16920
16921 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16922 .cindex "OpenSSL "compatibility options"
16923 This option allows an administrator to adjust the SSL options applied
16924 by OpenSSL to connections.  It is given as a space-separated list of items,
16925 each one to be +added or -subtracted from the current value.
16926
16927 This option is only available if Exim is built against OpenSSL.  The values
16928 available for this option vary according to the age of your OpenSSL install.
16929 The &"all"& value controls a subset of flags which are available, typically
16930 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16931 list the values known on your system and Exim should support all the
16932 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16933 names lose the leading &"SSL_OP_"& and are lower-cased.
16934
16935 Note that adjusting the options can have severe impact upon the security of
16936 SSL as used by Exim.  It is possible to disable safety checks and shoot
16937 yourself in the foot in various unpleasant ways.  This option should not be
16938 adjusted lightly.  An unrecognised item will be detected at startup, by
16939 invoking Exim with the &%-bV%& flag.
16940
16941 The option affects Exim operating both as a server and as a client.
16942
16943 Historical note: prior to release 4.80, Exim defaulted this value to
16944 "+dont_insert_empty_fragments", which may still be needed for compatibility
16945 with some clients, but which lowers security by increasing exposure to
16946 some now infamous attacks.
16947
16948 Examples:
16949 .code
16950 # Make both old MS and old Eudora happy:
16951 openssl_options = -all +microsoft_big_sslv3_buffer \
16952                        +dont_insert_empty_fragments
16953
16954 # Disable older protocol versions:
16955 openssl_options = +no_sslv2 +no_sslv3
16956 .endd
16957
16958 Possible options may include:
16959 .ilist
16960 &`all`&
16961 .next
16962 &`allow_unsafe_legacy_renegotiation`&
16963 .next
16964 &`cipher_server_preference`&
16965 .next
16966 &`dont_insert_empty_fragments`&
16967 .next
16968 &`ephemeral_rsa`&
16969 .next
16970 &`legacy_server_connect`&
16971 .next
16972 &`microsoft_big_sslv3_buffer`&
16973 .next
16974 &`microsoft_sess_id_bug`&
16975 .next
16976 &`msie_sslv2_rsa_padding`&
16977 .next
16978 &`netscape_challenge_bug`&
16979 .next
16980 &`netscape_reuse_cipher_change_bug`&
16981 .next
16982 &`no_compression`&
16983 .next
16984 &`no_session_resumption_on_renegotiation`&
16985 .next
16986 &`no_sslv2`&
16987 .next
16988 &`no_sslv3`&
16989 .next
16990 &`no_ticket`&
16991 .next
16992 &`no_tlsv1`&
16993 .next
16994 &`no_tlsv1_1`&
16995 .next
16996 &`no_tlsv1_2`&
16997 .next
16998 &`safari_ecdhe_ecdsa_bug`&
16999 .next
17000 &`single_dh_use`&
17001 .next
17002 &`single_ecdh_use`&
17003 .next
17004 &`ssleay_080_client_dh_bug`&
17005 .next
17006 &`sslref2_reuse_cert_type_bug`&
17007 .next
17008 &`tls_block_padding_bug`&
17009 .next
17010 &`tls_d5_bug`&
17011 .next
17012 &`tls_rollback_bug`&
17013 .endlist
17014
17015 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
17016 all clients connecting using the MacOS SecureTransport TLS facility prior
17017 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17018 to negotiate TLS then this option value might help, provided that your OpenSSL
17019 release is new enough to contain this work-around.  This may be a situation
17020 where you have to upgrade OpenSSL to get buggy clients working.
17021
17022
17023 .option oracle_servers main "string list" unset
17024 .cindex "Oracle" "server list"
17025 This option provides a list of Oracle servers and associated connection data,
17026 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17027 The option is available only if Exim has been built with Oracle support.
17028
17029
17030 .new
17031 .option panic_coredump main boolean false
17032 This option is rarely needed but can help for some debugging investigations.
17033 If set, when an internal error is detected by Exim which is sufficient
17034 to terminate the process
17035 (all such are logged in the paniclog)
17036 then a coredump is requested.
17037
17038 Note that most systems require additional administrative configuration
17039 to permit write a core file for a setuid program, which is Exim's
17040 common installed configuration.
17041 .wen
17042
17043 .option percent_hack_domains main "domain list&!!" unset
17044 .cindex "&""percent hack""&"
17045 .cindex "source routing" "in email address"
17046 .cindex "address" "source-routed"
17047 The &"percent hack"& is the convention whereby a local part containing a
17048 percent sign is re-interpreted as a new email address, with the percent
17049 replaced by @. This is sometimes called &"source routing"&, though that term is
17050 also applied to RFC 2822 addresses that begin with an @ character. If this
17051 option is set, Exim implements the percent facility for those domains listed,
17052 but no others. This happens before an incoming SMTP address is tested against
17053 an ACL.
17054
17055 &*Warning*&: The &"percent hack"& has often been abused by people who are
17056 trying to get round relaying restrictions. For this reason, it is best avoided
17057 if at all possible. Unfortunately, a number of less security-conscious MTAs
17058 implement it unconditionally. If you are running Exim on a gateway host, and
17059 routing mail through to internal MTAs without processing the local parts, it is
17060 a good idea to reject recipient addresses with percent characters in their
17061 local parts. Exim's default configuration does this.
17062
17063
17064 .options perl_at_start main boolean false &&&
17065          perl_startup main string unset
17066 .cindex "Perl"
17067 These options are available only when Exim is built with an embedded Perl
17068 interpreter. See chapter &<<CHAPperl>>& for details of their use.
17069
17070 .option perl_taintmode main boolean false
17071 .cindex "Perl"
17072 This option enables the taint mode of the embedded Perl interpreter.
17073
17074
17075 .option pgsql_servers main "string list" unset
17076 .cindex "PostgreSQL lookup type" "server list"
17077 This option provides a list of PostgreSQL servers and associated connection
17078 data, to be used in conjunction with &(pgsql)& lookups (see section
17079 &<<SECID72>>&). The option is available only if Exim has been built with
17080 PostgreSQL support.
17081
17082
17083 .option pid_file_path main string&!! "set at compile time"
17084 .cindex "daemon" "pid file path"
17085 .cindex "pid file, path for"
17086 This option sets the name of the file to which the Exim daemon writes its
17087 process id. The string is expanded, so it can contain, for example, references
17088 to the host name:
17089 .code
17090 pid_file_path = /var/log/$primary_hostname/exim.pid
17091 .endd
17092 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17093 spool directory.
17094 The value set by the option can be overridden by the &%-oP%& command line
17095 option. A pid file is not written if a &"non-standard"& daemon is run by means
17096 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17097
17098
17099 .option pipelining_advertise_hosts main "host list&!!" *
17100 .cindex "PIPELINING" "suppressing advertising"
17101 .cindex "ESMTP extensions" PIPELINING
17102 This option can be used to suppress the advertisement of the SMTP
17103 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17104 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17105 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17106 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17107 that clients will use it; &"out of order"& commands that are &"expected"& do
17108 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17109
17110 .option pipelining_connect_advertise_hosts main "host list&!!" *
17111 .cindex "pipelining" "early connection"
17112 .cindex "pipelining" PIPECONNECT
17113 .cindex "ESMTP extensions" PIPECONNECT
17114 If Exim is built without the DISABLE_PIPE_CONNECT build option
17115 this option controls which hosts the facility is advertised to
17116 and from which pipeline early-connection (before MAIL) SMTP
17117 commands are acceptable.
17118 When used, the pipelining saves on roundtrip times.
17119
17120 See also the &%hosts_pipe_connect%& smtp transport option.
17121
17122 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17123 it permits the client to pipeline
17124 TCP connection and hello command (inclear phase),
17125 or TLS-establishment and hello command (encrypted phase),
17126 on later connections to the same host.
17127
17128
17129 .option prdr_enable main boolean false
17130 .cindex "PRDR" "enabling on server"
17131 .cindex "ESMTP extensions" PRDR
17132 This option can be used to enable the Per-Recipient Data Response extension
17133 to SMTP, defined by Eric Hall.
17134 If the option is set, PRDR is advertised by Exim when operating as a server.
17135 If the client requests PRDR, and more than one recipient, for a message
17136 an additional ACL is called for each recipient after the message content
17137 is received.  See section &<<SECTPRDRACL>>&.
17138
17139 .option preserve_message_logs main boolean false
17140 .cindex "message logs" "preserving"
17141 If this option is set, message log files are not deleted when messages are
17142 completed. Instead, they are moved to a sub-directory of the spool directory
17143 called &_msglog.OLD_&, where they remain available for statistical or debugging
17144 purposes. This is a dangerous option to set on systems with any appreciable
17145 volume of mail. Use with care!
17146
17147
17148 .option primary_hostname main string "see below"
17149 .cindex "name" "of local host"
17150 .cindex "host" "name of local"
17151 .cindex "local host" "name of"
17152 .vindex "&$primary_hostname$&"
17153 This specifies the name of the current host. It is used in the default EHLO or
17154 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17155 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17156 The value is also used by default in some SMTP response messages from an Exim
17157 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17158
17159 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17160 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17161 contains only one component, Exim passes it to &[gethostbyname()]& (or
17162 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17163 version. The variable &$primary_hostname$& contains the host name, whether set
17164 explicitly by this option, or defaulted.
17165
17166
17167 .option print_topbitchars main boolean false
17168 .cindex "printing characters"
17169 .cindex "8-bit characters"
17170 By default, Exim considers only those characters whose codes lie in the range
17171 32&--126 to be printing characters. In a number of circumstances (for example,
17172 when writing log entries) non-printing characters are converted into escape
17173 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17174 is set, code values of 128 and above are also considered to be printing
17175 characters.
17176
17177 This option also affects the header syntax checks performed by the
17178 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17179 the user's full name when constructing From: and Sender: addresses (as
17180 described in section &<<SECTconstr>>&). Setting this option can cause
17181 Exim to generate eight bit message headers that do not conform to the
17182 standards.
17183
17184
17185 .option process_log_path main string unset
17186 .cindex "process log path"
17187 .cindex "log" "process log"
17188 .cindex "&'exiwhat'&"
17189 This option sets the name of the file to which an Exim process writes its
17190 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17191 utility script. If this option is unset, the file called &_exim-process.info_&
17192 in Exim's spool directory is used. The ability to specify the name explicitly
17193 can be useful in environments where two different Exims are running, using
17194 different spool directories.
17195
17196
17197 .option prod_requires_admin main boolean true
17198 .cindex "restricting access to features"
17199 .oindex "&%-M%&"
17200 .oindex "&%-R%&"
17201 .oindex "&%-q%&"
17202 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17203 admin user unless &%prod_requires_admin%& is set false. See also
17204 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17205
17206
17207 .option proxy_protocol_timeout main time 3s
17208 .cindex proxy "proxy protocol"
17209 This option sets the timeout for proxy protocol negotiation.
17210 For details see section &<<SECTproxyInbound>>&.
17211
17212
17213 .option qualify_domain main string "see below"
17214 .cindex "domain" "for qualifying addresses"
17215 .cindex "address" "qualification"
17216 This option specifies the domain name that is added to any envelope sender
17217 addresses that do not have a domain qualification. It also applies to
17218 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17219 are accepted by default only for locally-generated messages. Qualification is
17220 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17221 locally-generated messages, unless the &%-bnq%& command line option is used.
17222
17223 Messages from external sources must always contain fully qualified addresses,
17224 unless the sending host matches &%sender_unqualified_hosts%& or
17225 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17226 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17227 necessary. Internally, Exim always works with fully qualified envelope
17228 addresses. If &%qualify_domain%& is not set, it defaults to the
17229 &%primary_hostname%& value.
17230
17231
17232 .option qualify_recipient main string "see below"
17233 This option allows you to specify a different domain for qualifying recipient
17234 addresses to the one that is used for senders. See &%qualify_domain%& above.
17235
17236
17237
17238 .option queue_domains main "domain list&!!" unset
17239 .cindex "domain" "specifying non-immediate delivery"
17240 .cindex "queueing incoming messages"
17241 .cindex "message" "queueing certain domains"
17242 This option lists domains for which immediate delivery is not required.
17243 A delivery process is started whenever a message is received, but only those
17244 domains that do not match are processed. All other deliveries wait until the
17245 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17246
17247
17248 .option queue_fast_ramp main boolean true
17249 .cindex "queue runner" "two phase"
17250 .cindex "queue" "double scanning"
17251 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17252 command line, may start parallel delivery processes during their first
17253 phase.  This will be done when a threshold number of messages have been
17254 routed for a single host.
17255
17256
17257 .option queue_list_requires_admin main boolean true
17258 .cindex "restricting access to features"
17259 .oindex "&%-bp%&"
17260 The &%-bp%& command-line option, which lists the messages that are on the
17261 queue, requires the caller to be an admin user unless
17262 &%queue_list_requires_admin%& is set false.
17263 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17264
17265
17266 .option queue_only main boolean false
17267 .cindex "queueing incoming messages"
17268 .cindex "message" "queueing unconditionally"
17269 If &%queue_only%& is set, a delivery process is not automatically started
17270 whenever a message is received. Instead, the message waits in the queue for the
17271 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17272 delivered immediately when certain conditions (such as heavy load) occur.
17273
17274 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17275 and &%-odi%& command line options override &%queue_only%& unless
17276 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17277 &%queue_only_load%&, and &%smtp_accept_queue%&.
17278
17279
17280 .option queue_only_file main "string list" unset
17281 .cindex "queueing incoming messages"
17282 .cindex "message" "queueing by file existence"
17283 This option can be set to a colon-separated list of absolute path names, each
17284 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17285 it tests for the existence of each listed path using a call to &[stat()]&. For
17286 each path that exists, the corresponding queueing option is set.
17287 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17288 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17289 .code
17290 queue_only_file = smtp/some/file
17291 .endd
17292 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17293 &_/some/file_& exists.
17294
17295
17296 .option queue_only_load main fixed-point unset
17297 .cindex "load average"
17298 .cindex "queueing incoming messages"
17299 .cindex "message" "queueing by load"
17300 If the system load average is higher than this value, incoming messages from
17301 all sources are queued, and no automatic deliveries are started. If this
17302 happens during local or remote SMTP input, all subsequent messages received on
17303 the same SMTP connection are queued by default, whatever happens to the load in
17304 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17305 false.
17306
17307 Deliveries will subsequently be performed by queue runner processes. This
17308 option has no effect on ancient operating systems on which Exim cannot
17309 determine the load average. See also &%deliver_queue_load_max%& and
17310 &%smtp_load_reserve%&.
17311
17312
17313 .option queue_only_load_latch main boolean true
17314 .cindex "load average" "re-evaluating per message"
17315 When this option is true (the default), once one message has been queued
17316 because the load average is higher than the value set by &%queue_only_load%&,
17317 all subsequent messages received on the same SMTP connection are also queued.
17318 This is a deliberate choice; even though the load average may fall below the
17319 threshold, it doesn't seem right to deliver later messages on the same
17320 connection when not delivering earlier ones. However, there are special
17321 circumstances such as very long-lived connections from scanning appliances
17322 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17323 should be set false. This causes the value of the load average to be
17324 re-evaluated for each message.
17325
17326
17327 .option queue_only_override main boolean true
17328 .cindex "queueing incoming messages"
17329 When this option is true, the &%-od%&&'x'& command line options override the
17330 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17331 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17332 to override; they are accepted, but ignored.
17333
17334
17335 .option queue_run_in_order main boolean false
17336 .cindex "queue runner" "processing messages in order"
17337 If this option is set, queue runs happen in order of message arrival instead of
17338 in an arbitrary order. For this to happen, a complete list of the entire queue
17339 must be set up before the deliveries start. When the queue is all held in a
17340 single directory (the default), a single list is created for both the ordered
17341 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17342 single list is not created when &%queue_run_in_order%& is false. In this case,
17343 the sub-directories are processed one at a time (in a random order), and this
17344 avoids setting up one huge list for the whole queue. Thus, setting
17345 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17346 when the queue is large, because of the extra work in setting up the single,
17347 large list. In most situations, &%queue_run_in_order%& should not be set.
17348
17349
17350
17351 .option queue_run_max main integer&!! 5
17352 .cindex "queue runner" "maximum number of"
17353 This controls the maximum number of queue runner processes that an Exim daemon
17354 can run simultaneously. This does not mean that it starts them all at once,
17355 but rather that if the maximum number are still running when the time comes to
17356 start another one, it refrains from starting another one. This can happen with
17357 very large queues and/or very sluggish deliveries. This option does not,
17358 however, interlock with other processes, so additional queue runners can be
17359 started by other means, or by killing and restarting the daemon.
17360
17361 Setting this option to zero does not suppress queue runs; rather, it disables
17362 the limit, allowing any number of simultaneous queue runner processes to be
17363 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17364 the daemon's command line.
17365
17366 .cindex queues named
17367 .cindex "named queues" "resource limit"
17368 To set limits for different named queues use
17369 an expansion depending on the &$queue_name$& variable.
17370
17371 .option queue_smtp_domains main "domain list&!!" unset
17372 .cindex "queueing incoming messages"
17373 .cindex "message" "queueing remote deliveries"
17374 .cindex "first pass routing"
17375 When this option is set, a delivery process is started whenever a message is
17376 received, routing is performed, and local deliveries take place.
17377 However, if any SMTP deliveries are required for domains that match
17378 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17379 message waits in the queue for the next queue run. Since routing of the message
17380 has taken place, Exim knows to which remote hosts it must be delivered, and so
17381 when the queue run happens, multiple messages for the same host are delivered
17382 over a single SMTP connection. The &%-odqs%& command line option causes all
17383 SMTP deliveries to be queued in this way, and is equivalent to setting
17384 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17385 &%queue_domains%&.
17386
17387
17388 .option receive_timeout main time 0s
17389 .cindex "timeout" "for non-SMTP input"
17390 This option sets the timeout for accepting a non-SMTP message, that is, the
17391 maximum time that Exim waits when reading a message on the standard input. If
17392 the value is zero, it will wait forever. This setting is overridden by the
17393 &%-or%& command line option. The timeout for incoming SMTP messages is
17394 controlled by &%smtp_receive_timeout%&.
17395
17396 .option received_header_text main string&!! "see below"
17397 .cindex "customizing" "&'Received:'& header"
17398 .cindex "&'Received:'& header line" "customizing"
17399 This string defines the contents of the &'Received:'& message header that is
17400 added to each message, except for the timestamp, which is automatically added
17401 on at the end (preceded by a semicolon). The string is expanded each time it is
17402 used. If the expansion yields an empty string, no &'Received:'& header line is
17403 added to the message. Otherwise, the string should start with the text
17404 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17405 header lines.
17406 The default setting is:
17407
17408 .code
17409 received_header_text = Received: \
17410   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17411     {${if def:sender_ident \
17412       {from ${quote_local_part:$sender_ident} }}\
17413         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17414   by $primary_hostname \
17415   ${if def:received_protocol {with $received_protocol }}\
17416   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17417   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17418   (Exim $version_number)\n\t\
17419   ${if def:sender_address \
17420   {(envelope-from <$sender_address>)\n\t}}\
17421   id $message_exim_id\
17422   ${if def:received_for {\n\tfor $received_for}}
17423 .endd
17424
17425 The references to the TLS version and cipher are
17426 omitted when Exim is built without TLS
17427 support. The use of conditional expansions ensures that this works for both
17428 locally generated messages and messages received from remote hosts, giving
17429 header lines such as the following:
17430 .code
17431 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17432 by marley.carol.example with esmtp (Exim 4.00)
17433 (envelope-from <bob@carol.example>)
17434 id 16IOWa-00019l-00
17435 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17436 Received: by scrooge.carol.example with local (Exim 4.00)
17437 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17438 .endd
17439 Until the body of the message has been received, the timestamp is the time when
17440 the message started to be received. Once the body has arrived, and all policy
17441 checks have taken place, the timestamp is updated to the time at which the
17442 message was accepted.
17443
17444
17445 .option received_headers_max main integer 30
17446 .cindex "loop" "prevention"
17447 .cindex "mail loop prevention"
17448 .cindex "&'Received:'& header line" "counting"
17449 When a message is to be delivered, the number of &'Received:'& headers is
17450 counted, and if it is greater than this parameter, a mail loop is assumed to
17451 have occurred, the delivery is abandoned, and an error message is generated.
17452 This applies to both local and remote deliveries.
17453
17454
17455 .option recipient_unqualified_hosts main "host list&!!" unset
17456 .cindex "unqualified addresses"
17457 .cindex "host" "unqualified addresses from"
17458 This option lists those hosts from which Exim is prepared to accept unqualified
17459 recipient addresses in message envelopes. The addresses are made fully
17460 qualified by the addition of the &%qualify_recipient%& value. This option also
17461 affects message header lines. Exim does not reject unqualified recipient
17462 addresses in headers, but it qualifies them only if the message came from a
17463 host that matches &%recipient_unqualified_hosts%&,
17464 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17465 option was not set.
17466
17467
17468 .option recipients_max main integer 50000
17469 .cindex "limit" "number of recipients"
17470 .cindex "recipient" "maximum number"
17471 If this option is set greater than zero, it specifies the maximum number of
17472 original recipients for any message. Additional recipients that are generated
17473 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17474 all recipients over the limit; earlier recipients are delivered as normal.
17475 Non-SMTP messages with too many recipients are failed, and no deliveries are
17476 done.
17477
17478 .cindex "RCPT" "maximum number of incoming"
17479 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17480 RCPT commands in a single message.
17481
17482
17483 .option recipients_max_reject main boolean false
17484 If this option is set true, Exim rejects SMTP messages containing too many
17485 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17486 error to the eventual DATA command. Otherwise (the default) it gives a 452
17487 error to the surplus RCPT commands and accepts the message on behalf of the
17488 initial set of recipients. The remote server should then re-send the message
17489 for the remaining recipients at a later time.
17490
17491
17492 .option remote_max_parallel main integer 4
17493 .cindex "delivery" "parallelism for remote"
17494 This option controls parallel delivery of one message to a number of remote
17495 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17496 does all the remote deliveries for a message one by one. Otherwise, if a single
17497 message has to be delivered to more than one remote host, or if several copies
17498 have to be sent to the same remote host, up to &%remote_max_parallel%&
17499 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17500 deliveries are required, the maximum number of processes are started, and as
17501 each one finishes, another is begun. The order of starting processes is the
17502 same as if sequential delivery were being done, and can be controlled by the
17503 &%remote_sort_domains%& option. If parallel delivery takes place while running
17504 with debugging turned on, the debugging output from each delivery process is
17505 tagged with its process id.
17506
17507 This option controls only the maximum number of parallel deliveries for one
17508 message in one Exim delivery process. Because Exim has no central queue
17509 manager, there is no way of controlling the total number of simultaneous
17510 deliveries if the configuration allows a delivery attempt as soon as a message
17511 is received.
17512
17513 See also the &%max_parallel%& generic transport option,
17514 and the &%serialize_hosts%& smtp transport option.
17515
17516 .cindex "number of deliveries"
17517 .cindex "delivery" "maximum number of"
17518 If you want to control the total number of deliveries on the system, you
17519 need to set the &%queue_only%& option. This ensures that all incoming messages
17520 are added to the queue without starting a delivery process. Then set up an Exim
17521 daemon to start queue runner processes at appropriate intervals (probably
17522 fairly often, for example, every minute), and limit the total number of queue
17523 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17524 delivers only one message at a time, the maximum number of deliveries that can
17525 then take place at once is &%queue_run_max%& multiplied by
17526 &%remote_max_parallel%&.
17527
17528 If it is purely remote deliveries you want to control, use
17529 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17530 doing the SMTP routing before queueing, so that several messages for the same
17531 host will eventually get delivered down the same connection.
17532
17533
17534 .option remote_sort_domains main "domain list&!!" unset
17535 .cindex "sorting remote deliveries"
17536 .cindex "delivery" "sorting remote"
17537 When there are a number of remote deliveries for a message, they are sorted by
17538 domain into the order given by this list. For example,
17539 .code
17540 remote_sort_domains = *.cam.ac.uk:*.uk
17541 .endd
17542 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17543 then to those in the &%uk%& domain, then to any others.
17544
17545
17546 .option retry_data_expire main time 7d
17547 .cindex "hints database" "data expiry"
17548 This option sets a &"use before"& time on retry information in Exim's hints
17549 database. Any older retry data is ignored. This means that, for example, once a
17550 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17551 past failures.
17552
17553
17554 .option retry_interval_max main time 24h
17555 .cindex "retry" "limit on interval"
17556 .cindex "limit" "on retry interval"
17557 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17558 intervals between delivery attempts for messages that cannot be delivered
17559 straight away. This option sets an overall limit to the length of time between
17560 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17561 the default value.
17562
17563
17564 .option return_path_remove main boolean true
17565 .cindex "&'Return-path:'& header line" "removing"
17566 RFC 2821, section 4.4, states that an SMTP server must insert a
17567 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17568 The &'Return-path:'& header preserves the sender address as received in the
17569 MAIL command. This description implies that this header should not be present
17570 in an incoming message. If &%return_path_remove%& is true, any existing
17571 &'Return-path:'& headers are removed from messages at the time they are
17572 received. Exim's transports have options for adding &'Return-path:'& headers at
17573 the time of delivery. They are normally used only for final local deliveries.
17574
17575
17576 .option return_size_limit main integer 100K
17577 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17578
17579
17580 .option rfc1413_hosts main "host list&!!" @[]
17581 .cindex "RFC 1413"
17582 .cindex "host" "for RFC 1413 calls"
17583 RFC 1413 identification calls are made to any client host which matches
17584 an item in the list.
17585 The default value specifies just this host, being any local interface
17586 for the system.
17587
17588 .option rfc1413_query_timeout main time 0s
17589 .cindex "RFC 1413" "query timeout"
17590 .cindex "timeout" "for RFC 1413 call"
17591 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17592 no RFC 1413 calls are ever made.
17593
17594
17595 .option sender_unqualified_hosts main "host list&!!" unset
17596 .cindex "unqualified addresses"
17597 .cindex "host" "unqualified addresses from"
17598 This option lists those hosts from which Exim is prepared to accept unqualified
17599 sender addresses. The addresses are made fully qualified by the addition of
17600 &%qualify_domain%&. This option also affects message header lines. Exim does
17601 not reject unqualified addresses in headers that contain sender addresses, but
17602 it qualifies them only if the message came from a host that matches
17603 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17604 using TCP/IP), and the &%-bnq%& option was not set.
17605
17606
17607 .option slow_lookup_log main integer 0
17608 .cindex "logging" "slow lookups"
17609 .cindex "dns" "logging slow lookups"
17610 This option controls logging of slow lookups.
17611 If the value is nonzero it is taken as a number of milliseconds
17612 and lookups taking longer than this are logged.
17613 Currently this applies only to DNS lookups.
17614
17615
17616
17617 .option smtp_accept_keepalive main boolean true
17618 .cindex "keepalive" "on incoming connection"
17619 This option controls the setting of the SO_KEEPALIVE option on incoming
17620 TCP/IP socket connections. When set, it causes the kernel to probe idle
17621 connections periodically, by sending packets with &"old"& sequence numbers. The
17622 other end of the connection should send an acknowledgment if the connection is
17623 still okay or a reset if the connection has been aborted. The reason for doing
17624 this is that it has the beneficial effect of freeing up certain types of
17625 connection that can get stuck when the remote host is disconnected without
17626 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17627 hours to detect unreachable hosts.
17628
17629
17630
17631 .option smtp_accept_max main integer 20
17632 .cindex "limit" "incoming SMTP connections"
17633 .cindex "SMTP" "incoming connection count"
17634 .cindex "inetd"
17635 This option specifies the maximum number of simultaneous incoming SMTP calls
17636 that Exim will accept. It applies only to the listening daemon; there is no
17637 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17638 value is set to zero, no limit is applied. However, it is required to be
17639 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17640 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17641
17642 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17643 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17644 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17645 and &%smtp_load_reserve%& are then checked before accepting the connection.
17646
17647
17648 .option smtp_accept_max_nonmail main integer 10
17649 .cindex "limit" "non-mail SMTP commands"
17650 .cindex "SMTP" "limiting non-mail commands"
17651 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17652 the connection if there are too many. This option defines &"too many"&. The
17653 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17654 client looping sending EHLO, for example. The check is applied only if the
17655 client host matches &%smtp_accept_max_nonmail_hosts%&.
17656
17657 When a new message is expected, one occurrence of RSET is not counted. This
17658 allows a client to send one RSET between messages (this is not necessary,
17659 but some clients do it). Exim also allows one uncounted occurrence of HELO
17660 or EHLO, and one occurrence of STARTTLS between messages. After
17661 starting up a TLS session, another EHLO is expected, and so it too is not
17662 counted. The first occurrence of AUTH in a connection, or immediately
17663 following STARTTLS is not counted. Otherwise, all commands other than
17664 MAIL, RCPT, DATA, and QUIT are counted.
17665
17666
17667 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17668 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17669 check by setting this option. The default value makes it apply to all hosts. By
17670 changing the value, you can exclude any badly-behaved hosts that you have to
17671 live with.
17672
17673
17674 . Allow this long option name to split; give it unsplit as a fifth argument
17675 . for the automatic .oindex that is generated by .option.
17676 . We insert " &~&~" which is both pretty nasty visually and results in
17677 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17678 . zero-width-space, which would be nicer visually and results in (at least)
17679 . html that Firefox will split on when it's forced to reflow (rather than
17680 . inserting a horizontal scrollbar).  However, the text is still not
17681 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17682 . the option name to split.
17683
17684 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17685          smtp_accept_max_per_connection
17686 .cindex "SMTP" "limiting incoming message count"
17687 .cindex "limit" "messages per SMTP connection"
17688 The value of this option limits the number of MAIL commands that Exim is
17689 prepared to accept over a single SMTP connection, whether or not each command
17690 results in the transfer of a message. After the limit is reached, a 421
17691 response is given to subsequent MAIL commands. This limit is a safety
17692 precaution against a client that goes mad (incidents of this type have been
17693 seen).
17694 The option is expanded after the HELO or EHLO is received
17695 and may depend on values available at that time.
17696 An empty or zero value after expansion removes the limit.
17697
17698
17699 .option smtp_accept_max_per_host main string&!! unset
17700 .cindex "limit" "SMTP connections from one host"
17701 .cindex "host" "limiting SMTP connections from"
17702 This option restricts the number of simultaneous IP connections from a single
17703 host (strictly, from a single IP address) to the Exim daemon. The option is
17704 expanded, to enable different limits to be applied to different hosts by
17705 reference to &$sender_host_address$&. Once the limit is reached, additional
17706 connection attempts from the same host are rejected with error code 421. This
17707 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17708 of zero imposes no limit. If this option is set greater than zero, it is
17709 required that &%smtp_accept_max%& be non-zero.
17710
17711 &*Warning*&: When setting this option you should not use any expansion
17712 constructions that take an appreciable amount of time. The expansion and test
17713 happen in the main daemon loop, in order to reject additional connections
17714 without forking additional processes (otherwise a denial-of-service attack
17715 could cause a vast number or processes to be created). While the daemon is
17716 doing this processing, it cannot accept any other incoming connections.
17717
17718
17719
17720 .option smtp_accept_queue main integer 0
17721 .cindex "SMTP" "incoming connection count"
17722 .cindex "queueing incoming messages"
17723 .cindex "message" "queueing by SMTP connection count"
17724 If the number of simultaneous incoming SMTP connections being handled via the
17725 listening daemon exceeds this value, messages received by SMTP are just placed
17726 in the queue; no delivery processes are started automatically. The count is
17727 fixed at the start of an SMTP connection. It cannot be updated in the
17728 subprocess that receives messages, and so the queueing or not queueing applies
17729 to all messages received in the same connection.
17730
17731 A value of zero implies no limit, and clearly any non-zero value is useful only
17732 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17733 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17734 various &%-od%&&'x'& command line options.
17735
17736
17737 . See the comment on smtp_accept_max_per_connection
17738
17739 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17740          smtp_accept_queue_per_connection
17741 .cindex "queueing incoming messages"
17742 .cindex "message" "queueing by message count"
17743 This option limits the number of delivery processes that Exim starts
17744 automatically when receiving messages via SMTP, whether via the daemon or by
17745 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17746 and the number of messages received in a single SMTP session exceeds this
17747 number, subsequent messages are placed in the queue, but no delivery processes
17748 are started. This helps to limit the number of Exim processes when a server
17749 restarts after downtime and there is a lot of mail waiting for it on other
17750 systems. On large systems, the default should probably be increased, and on
17751 dial-in client systems it should probably be set to zero (that is, disabled).
17752
17753
17754 .option smtp_accept_reserve main integer 0
17755 .cindex "SMTP" "incoming call count"
17756 .cindex "host" "reserved"
17757 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17758 number of SMTP connections that are reserved for connections from the hosts
17759 that are specified in &%smtp_reserve_hosts%&. The value set in
17760 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17761 restricted to this number of connections; the option specifies a minimum number
17762 of connection slots for them, not a maximum. It is a guarantee that this group
17763 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17764 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17765 individual host.
17766
17767 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17768 set to 5, once there are 45 active connections (from any hosts), new
17769 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17770 provided the other criteria for acceptance are met.
17771
17772
17773 .option smtp_active_hostname main string&!! unset
17774 .cindex "host" "name in SMTP responses"
17775 .cindex "SMTP" "host name in responses"
17776 .vindex "&$primary_hostname$&"
17777 This option is provided for multi-homed servers that want to masquerade as
17778 several different hosts. At the start of an incoming SMTP connection, its value
17779 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17780 responses. For example, it is used as domain name in the response to an
17781 incoming HELO or EHLO command.
17782
17783 .vindex "&$smtp_active_hostname$&"
17784 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17785 is saved with any messages that are received. It is therefore available for use
17786 in routers and transports when the message is later delivered.
17787
17788 If this option is unset, or if its expansion is forced to fail, or if the
17789 expansion results in an empty string, the value of &$primary_hostname$& is
17790 used. Other expansion failures cause a message to be written to the main and
17791 panic logs, and the SMTP command receives a temporary error. Typically, the
17792 value of &%smtp_active_hostname%& depends on the incoming interface address.
17793 For example:
17794 .code
17795 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17796   {cox.mydomain}{box.mydomain}}
17797 .endd
17798
17799 Although &$smtp_active_hostname$& is primarily concerned with incoming
17800 messages, it is also used as the default for HELO commands in callout
17801 verification if there is no remote transport from which to obtain a
17802 &%helo_data%& value.
17803
17804 .option smtp_backlog_monitor main integer 0
17805 .cindex "connection backlog" monitoring
17806 If this option is set to greater than zero, and the backlog of available
17807 TCP connections on a socket listening for SMTP is larger than it, a line
17808 is logged giving the value and the socket address and port.
17809 The value is retrived jsut before an accept call.
17810 This facility is only available on Linux.
17811
17812 .option smtp_banner main string&!! "see below"
17813 .cindex "SMTP" "welcome banner"
17814 .cindex "banner for SMTP"
17815 .cindex "welcome banner for SMTP"
17816 .cindex "customizing" "SMTP banner"
17817 If a connect ACL does not supply a message,
17818 this string (which is expanded every time it is used) is output as the initial
17819 positive response to an SMTP connection. The default setting is:
17820 .code
17821 smtp_banner = $smtp_active_hostname ESMTP Exim \
17822   $version_number $tod_full
17823 .endd
17824 .new
17825 Failure to expand the string causes a panic error;
17826 a forced fail just closes the connection.
17827 .wen
17828 If you want to create a
17829 multiline response to the initial SMTP connection, use &"\n"& in the string at
17830 appropriate points, but not at the end. Note that the 220 code is not included
17831 in this string. Exim adds it automatically (several times in the case of a
17832 multiline response).
17833
17834
17835 .option smtp_check_spool_space main boolean true
17836 .cindex "checking disk space"
17837 .cindex "disk space, checking"
17838 .cindex "spool directory" "checking space"
17839 When this option is set, if an incoming SMTP session encounters the SIZE
17840 option on a MAIL command, it checks that there is enough space in the
17841 spool directory's partition to accept a message of that size, while still
17842 leaving free the amount specified by &%check_spool_space%& (even if that value
17843 is zero). If there isn't enough space, a temporary error code is returned.
17844
17845
17846 .option smtp_connect_backlog main integer 20
17847 .cindex "connection backlog" "set maximum"
17848 .cindex "SMTP" "connection backlog"
17849 .cindex "backlog of connections"
17850 This option specifies a maximum number of waiting SMTP connections. Exim passes
17851 this value to the TCP/IP system when it sets up its listener. Once this number
17852 of connections are waiting for the daemon's attention, subsequent connection
17853 attempts are refused at the TCP/IP level. At least, that is what the manuals
17854 say; in some circumstances such connection attempts have been observed to time
17855 out instead. For large systems it is probably a good idea to increase the
17856 value (to 50, say). It also gives some protection against denial-of-service
17857 attacks by SYN flooding.
17858
17859
17860 .option smtp_enforce_sync main boolean true
17861 .cindex "SMTP" "synchronization checking"
17862 .cindex "synchronization checking in SMTP"
17863 The SMTP protocol specification requires the client to wait for a response from
17864 the server at certain points in the dialogue. Without PIPELINING these
17865 synchronization points are after every command; with PIPELINING they are
17866 fewer, but they still exist.
17867
17868 Some spamming sites send out a complete set of SMTP commands without waiting
17869 for any response. Exim protects against this by rejecting a message if the
17870 client has sent further input when it should not have. The error response &"554
17871 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17872 for this error cannot be perfect because of transmission delays (unexpected
17873 input may be on its way but not yet received when Exim checks). However, it
17874 does detect many instances.
17875
17876 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17877 If you want to disable the check selectively (for example, only for certain
17878 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17879 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17880
17881
17882
17883 .option smtp_etrn_command main string&!! unset
17884 .cindex "ETRN" "command to be run"
17885 .cindex "ESMTP extensions" ETRN
17886 .vindex "&$domain$&"
17887 If this option is set, the given command is run whenever an SMTP ETRN
17888 command is received from a host that is permitted to issue such commands (see
17889 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17890 are independently expanded. The expansion variable &$domain$& is set to the
17891 argument of the ETRN command, and no syntax checking is done on it. For
17892 example:
17893 .code
17894 smtp_etrn_command = /etc/etrn_command $domain \
17895                     $sender_host_address
17896 .endd
17897 If the option is not set, the argument for the ETRN command must
17898 be a &'#'& followed by an address string.
17899 In this case an &'exim -R <string>'& command is used;
17900 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17901
17902 A new process is created to run the command, but Exim does not wait for it to
17903 complete. Consequently, its status cannot be checked. If the command cannot be
17904 run, a line is written to the panic log, but the ETRN caller still receives
17905 a 250 success response. Exim is normally running under its own uid when
17906 receiving SMTP, so it is not possible for it to change the uid before running
17907 the command.
17908
17909
17910 .option smtp_etrn_serialize main boolean true
17911 .cindex "ETRN" "serializing"
17912 When this option is set, it prevents the simultaneous execution of more than
17913 one identical command as a result of ETRN in an SMTP connection. See
17914 section &<<SECTETRN>>& for details.
17915
17916
17917 .option smtp_load_reserve main fixed-point unset
17918 .cindex "load average"
17919 If the system load average ever gets higher than this, incoming SMTP calls are
17920 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17921 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17922 the load is over the limit. The option has no effect on ancient operating
17923 systems on which Exim cannot determine the load average. See also
17924 &%deliver_queue_load_max%& and &%queue_only_load%&.
17925
17926
17927
17928 .option smtp_max_synprot_errors main integer 3
17929 .cindex "SMTP" "limiting syntax and protocol errors"
17930 .cindex "limit" "SMTP syntax and protocol errors"
17931 Exim rejects SMTP commands that contain syntax or protocol errors. In
17932 particular, a syntactically invalid email address, as in this command:
17933 .code
17934 RCPT TO:<abc xyz@a.b.c>
17935 .endd
17936 causes immediate rejection of the command, before any other tests are done.
17937 (The ACL cannot be run if there is no valid address to set up for it.) An
17938 example of a protocol error is receiving RCPT before MAIL. If there are
17939 too many syntax or protocol errors in one SMTP session, the connection is
17940 dropped. The limit is set by this option.
17941
17942 .cindex "PIPELINING" "expected errors"
17943 When the PIPELINING extension to SMTP is in use, some protocol errors are
17944 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17945 Exim assumes that PIPELINING will be used if it advertises it (see
17946 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17947 not count towards the limit.
17948
17949
17950
17951 .option smtp_max_unknown_commands main integer 3
17952 .cindex "SMTP" "limiting unknown commands"
17953 .cindex "limit" "unknown SMTP commands"
17954 If there are too many unrecognized commands in an incoming SMTP session, an
17955 Exim server drops the connection. This is a defence against some kinds of abuse
17956 that subvert web
17957 clients
17958 into making connections to SMTP ports; in these circumstances, a number of
17959 non-SMTP command lines are sent first.
17960
17961
17962
17963 .options smtp_ratelimit_hosts main "host list&!!" unset &&&
17964          smtp_ratelimit_mail main string unset &&&
17965          smtp_ratelimit_rcpt main string unset
17966 .cindex "SMTP" "rate limiting"
17967 .cindex "limit" "rate of message arrival"
17968 .cindex "RCPT" "rate limiting"
17969 Some sites find it helpful to be able to limit the rate at which certain hosts
17970 can send them messages, and the rate at which an individual message can specify
17971 recipients.
17972
17973 Exim has two rate-limiting facilities. This section describes the older
17974 facility, which can limit rates within a single connection. The newer
17975 &%ratelimit%& ACL condition can limit rates across all connections. See section
17976 &<<SECTratelimiting>>& for details of the newer facility.
17977
17978 When a host matches &%smtp_ratelimit_hosts%&, the values of
17979 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17980 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17981 respectively. Each option, if set, must contain a set of four comma-separated
17982 values:
17983
17984 .ilist
17985 A threshold, before which there is no rate limiting.
17986 .next
17987 An initial time delay. Unlike other times in Exim, numbers with decimal
17988 fractional parts are allowed here.
17989 .next
17990 A factor by which to increase the delay each time.
17991 .next
17992 A maximum value for the delay. This should normally be less than 5 minutes,
17993 because after that time, the client is liable to timeout the SMTP command.
17994 .endlist
17995
17996 For example, these settings have been used successfully at the site which
17997 first suggested this feature, for controlling mail from their customers:
17998 .code
17999 smtp_ratelimit_mail = 2,0.5s,1.05,4m
18000 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
18001 .endd
18002 The first setting specifies delays that are applied to MAIL commands after
18003 two have been received over a single connection. The initial delay is 0.5
18004 seconds, increasing by a factor of 1.05 each time. The second setting applies
18005 delays to RCPT commands when more than four occur in a single message.
18006
18007
18008
18009 .option smtp_receive_timeout main time&!! 5m
18010 .cindex "timeout" "for SMTP input"
18011 .cindex "SMTP" "input timeout"
18012 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
18013 input, including batch SMTP. If a line of input (either an SMTP command or a
18014 data line) is not received within this time, the SMTP connection is dropped and
18015 the message is abandoned.
18016 A line is written to the log containing one of the following messages:
18017 .code
18018 SMTP command timeout on connection from...
18019 SMTP data timeout on connection from...
18020 .endd
18021 The former means that Exim was expecting to read an SMTP command; the latter
18022 means that it was in the DATA phase, reading the contents of a message.
18023
18024 If the first character of the option is a &"$"& the option is
18025 expanded before use and may depend on
18026 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18027
18028
18029 .oindex "&%-os%&"
18030 The value set by this option can be overridden by the
18031 &%-os%& command-line option. A setting of zero time disables the timeout, but
18032 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18033 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18034 timeout is controlled by &%receive_timeout%& and &%-or%&.
18035
18036
18037 .option smtp_reserve_hosts main "host list&!!" unset
18038 This option defines hosts for which SMTP connections are reserved; see
18039 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18040
18041
18042 .option smtp_return_error_details main boolean false
18043 .cindex "SMTP" "details policy failures"
18044 .cindex "policy control" "rejection, returning details"
18045 In the default state, Exim uses bland messages such as
18046 &"Administrative prohibition"& when it rejects SMTP commands for policy
18047 reasons. Many sysadmins like this because it gives away little information
18048 to spammers. However, some other sysadmins who are applying strict checking
18049 policies want to give out much fuller information about failures. Setting
18050 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18051 example, instead of &"Administrative prohibition"&, it might give:
18052 .code
18053 550-Rejected after DATA: '>' missing at end of address:
18054 550 failing address in "From" header is: <user@dom.ain
18055 .endd
18056
18057
18058 .option smtputf8_advertise_hosts main "host list&!!" *
18059 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18060 .cindex "ESMTP extensions" SMTPUTF8
18061 When Exim is built with support for internationalised mail names,
18062 the availability thereof is advertised in
18063 response to EHLO only to those client hosts that match this option. See
18064 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18065
18066
18067 .option spamd_address main string "127.0.0.1 783"
18068 This option is available when Exim is compiled with the content-scanning
18069 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18070 See section &<<SECTscanspamass>>& for more details.
18071
18072
18073
18074 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18075 This option is available when Exim is compiled with SPF support.
18076 See section &<<SECSPF>>& for more details.
18077
18078 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18079 This option is available when Exim is compiled with SPF support.  It
18080 allows the customisation of the SMTP comment that the SPF library
18081 generates.  You are strongly encouraged to link to your own explanative
18082 site. The template must not contain spaces. If you need spaces in the
18083 output, use the proper placeholder. If libspf2 can not parse the
18084 template, it uses a built-in default broken link. The following placeholders
18085 (along with Exim variables (but see below)) are allowed in the template:
18086 .ilist
18087 &*%_*&: A space.
18088 .next
18089 &*%{L}*&: Envelope sender's local part.
18090 .next
18091 &*%{S}*&: Envelope sender.
18092 .next
18093 &*%{O}*&: Envelope sender's domain.
18094 .next
18095 &*%{D}*&: Current(?) domain.
18096 .next
18097 &*%{I}*&: SMTP client Ip.
18098 .next
18099 &*%{C}*&: SMTP client pretty IP.
18100 .next
18101 &*%{T}*&: Epoch time (UTC).
18102 .next
18103 &*%{P}*&: SMTP client domain name.
18104 .next
18105 &*%{V}*&: IP version.
18106 .next
18107 &*%{H}*&: EHLO/HELO domain.
18108 .next
18109 &*%{R}*&: Receiving domain.
18110 .endlist
18111 The capitalized placeholders do proper URL encoding, if you use them
18112 lowercased, no encoding takes place.  This list was compiled from the
18113 libspf2 sources.
18114
18115 A note on using Exim variables: As
18116 currently the SPF library is initialized before the SMTP EHLO phase,
18117 the variables useful for expansion are quite limited.
18118
18119
18120 .option split_spool_directory main boolean false
18121 .cindex "multiple spool directories"
18122 .cindex "spool directory" "split"
18123 .cindex "directories, multiple"
18124 If this option is set, it causes Exim to split its input directory into 62
18125 subdirectories, each with a single alphanumeric character as its name. The
18126 sixth character of the message id is used to allocate messages to
18127 subdirectories; this is the least significant base-62 digit of the time of
18128 arrival of the message.
18129
18130 Splitting up the spool in this way may provide better performance on systems
18131 where there are long mail queues, by reducing the number of files in any one
18132 directory. The msglog directory is also split up in a similar way to the input
18133 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18134 are still placed in the single directory &_msglog.OLD_&.
18135
18136 It is not necessary to take any special action for existing messages when
18137 changing &%split_spool_directory%&. Exim notices messages that are in the
18138 &"wrong"& place, and continues to process them. If the option is turned off
18139 after a period of being on, the subdirectories will eventually empty and be
18140 automatically deleted.
18141
18142 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18143 changes. Instead of creating a list of all messages in the queue, and then
18144 trying to deliver each one, in turn, it constructs a list of those in one
18145 sub-directory and tries to deliver them, before moving on to the next
18146 sub-directory. The sub-directories are processed in a random order. This
18147 spreads out the scanning of the input directories, and uses less memory. It is
18148 particularly beneficial when there are lots of messages in the queue. However,
18149 if &%queue_run_in_order%& is set, none of this new processing happens. The
18150 entire queue has to be scanned and sorted before any deliveries can start.
18151
18152
18153 .option spool_directory main string&!! "set at compile time"
18154 .cindex "spool directory" "path to"
18155 This defines the directory in which Exim keeps its spool, that is, the messages
18156 it is waiting to deliver. The default value is taken from the compile-time
18157 configuration setting, if there is one. If not, this option must be set. The
18158 string is expanded, so it can contain, for example, a reference to
18159 &$primary_hostname$&.
18160
18161 If the spool directory name is fixed on your installation, it is recommended
18162 that you set it at build time rather than from this option, particularly if the
18163 log files are being written to the spool directory (see &%log_file_path%&).
18164 Otherwise log files cannot be used for errors that are detected early on, such
18165 as failures in the configuration file.
18166
18167 By using this option to override the compiled-in path, it is possible to run
18168 tests of Exim without using the standard spool.
18169
18170 .option spool_wireformat main boolean false
18171 .cindex "spool directory" "file formats"
18172 If this option is set, Exim may for some messages use an alternative format
18173 for data-files in the spool which matches the wire format.
18174 Doing this permits more efficient message reception and transmission.
18175 Currently it is only done for messages received using the ESMTP CHUNKING
18176 option.
18177
18178 The following variables will not have useful values:
18179 .code
18180 $max_received_linelength
18181 $body_linecount
18182 $body_zerocount
18183 .endd
18184
18185 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18186 and any external programs which are passed a reference to a message data file
18187 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18188 will need to be aware of the different formats potentially available.
18189
18190 Using any of the ACL conditions noted will negate the reception benefit
18191 (as a Unix-mbox-format file is constructed for them).
18192 The transmission benefit is maintained.
18193
18194 .option sqlite_lock_timeout main time 5s
18195 .cindex "sqlite lookup type" "lock timeout"
18196 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18197 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18198
18199 .option strict_acl_vars main boolean false
18200 .cindex "&ACL;" "variables, handling unset"
18201 This option controls what happens if a syntactically valid but undefined ACL
18202 variable is referenced. If it is false (the default), an empty string
18203 is substituted; if it is true, an error is generated. See section
18204 &<<SECTaclvariables>>& for details of ACL variables.
18205
18206 .option strip_excess_angle_brackets main boolean false
18207 .cindex "angle brackets, excess"
18208 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18209 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18210 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18211 passed on to another MTA, the excess angle brackets are not passed on. If this
18212 option is not set, multiple pairs of angle brackets cause a syntax error.
18213
18214
18215 .option strip_trailing_dot main boolean false
18216 .cindex "trailing dot on domain"
18217 .cindex "dot" "trailing on domain"
18218 If this option is set, a trailing dot at the end of a domain in an address is
18219 ignored. If this is in the envelope and the message is passed on to another
18220 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18221 domain causes a syntax error.
18222 However, addresses in header lines are checked only when an ACL requests header
18223 syntax checking.
18224
18225
18226 .option syslog_duplication main boolean true
18227 .cindex "syslog" "duplicate log lines; suppressing"
18228 When Exim is logging to syslog, it writes the log lines for its three
18229 separate logs at different syslog priorities so that they can in principle
18230 be separated on the logging hosts. Some installations do not require this
18231 separation, and in those cases, the duplication of certain log lines is a
18232 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18233 particular log line is written to syslog. For lines that normally go to
18234 both the main log and the reject log, the reject log version (possibly
18235 containing message header lines) is written, at LOG_NOTICE priority.
18236 Lines that normally go to both the main and the panic log are written at
18237 the LOG_ALERT priority.
18238
18239
18240 .option syslog_facility main string unset
18241 .cindex "syslog" "facility; setting"
18242 This option sets the syslog &"facility"& name, used when Exim is logging to
18243 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18244 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18245 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18246 details of Exim's logging.
18247
18248
18249 .option syslog_pid main boolean true
18250 .cindex "syslog" "pid"
18251 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18252 omitted when these lines are sent to syslog. (Syslog normally prefixes
18253 the log lines with the PID of the logging process automatically.) You need
18254 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18255 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18256
18257
18258
18259 .option syslog_processname main string &`exim`&
18260 .cindex "syslog" "process name; setting"
18261 This option sets the syslog &"ident"& name, used when Exim is logging to
18262 syslog. The value must be no longer than 32 characters. See chapter
18263 &<<CHAPlog>>& for details of Exim's logging.
18264
18265
18266
18267 .option syslog_timestamp main boolean true
18268 .cindex "syslog" "timestamps"
18269 .cindex timestamps syslog
18270 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18271 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18272 details of Exim's logging.
18273
18274
18275 .option system_filter main string&!! unset
18276 .cindex "filter" "system filter"
18277 .cindex "system filter" "specifying"
18278 .cindex "Sieve filter" "not available for system filter"
18279 This option specifies an Exim filter file that is applied to all messages at
18280 the start of each delivery attempt, before any routing is done. System filters
18281 must be Exim filters; they cannot be Sieve filters. If the system filter
18282 generates any deliveries to files or pipes, or any new mail messages, the
18283 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18284 which transports are to be used. Details of this facility are given in chapter
18285 &<<CHAPsystemfilter>>&.
18286 A forced expansion failure results in no filter operation.
18287
18288
18289 .option system_filter_directory_transport main string&!! unset
18290 .vindex "&$address_file$&"
18291 This sets the name of the transport driver that is to be used when the
18292 &%save%& command in a system message filter specifies a path ending in &"/"&,
18293 implying delivery of each message into a separate file in some directory.
18294 During the delivery, the variable &$address_file$& contains the path name.
18295
18296
18297 .option system_filter_file_transport main string&!! unset
18298 .cindex "file" "transport for system filter"
18299 This sets the name of the transport driver that is to be used when the &%save%&
18300 command in a system message filter specifies a path not ending in &"/"&. During
18301 the delivery, the variable &$address_file$& contains the path name.
18302
18303 .option system_filter_group main string unset
18304 .cindex "gid (group id)" "system filter"
18305 This option is used only when &%system_filter_user%& is also set. It sets the
18306 gid under which the system filter is run, overriding any gid that is associated
18307 with the user. The value may be numerical or symbolic.
18308
18309 .option system_filter_pipe_transport main string&!! unset
18310 .cindex "&(pipe)& transport" "for system filter"
18311 .vindex "&$address_pipe$&"
18312 This specifies the transport driver that is to be used when a &%pipe%& command
18313 is used in a system filter. During the delivery, the variable &$address_pipe$&
18314 contains the pipe command.
18315
18316
18317 .option system_filter_reply_transport main string&!! unset
18318 .cindex "&(autoreply)& transport" "for system filter"
18319 This specifies the transport driver that is to be used when a &%mail%& command
18320 is used in a system filter.
18321
18322
18323 .option system_filter_user main string unset
18324 .cindex "uid (user id)" "system filter"
18325 If this option is set to root, the system filter is run in the main Exim
18326 delivery process, as root.  Otherwise, the system filter runs in a separate
18327 process, as the given user, defaulting to the Exim run-time user.
18328 Unless the string consists entirely of digits, it
18329 is looked up in the password data. Failure to find the named user causes a
18330 configuration error. The gid is either taken from the password data, or
18331 specified by &%system_filter_group%&. When the uid is specified numerically,
18332 &%system_filter_group%& is required to be set.
18333
18334 If the system filter generates any pipe, file, or reply deliveries, the uid
18335 under which the filter is run is used when transporting them, unless a
18336 transport option overrides.
18337
18338
18339 .option tcp_nodelay main boolean true
18340 .cindex "daemon" "TCP_NODELAY on sockets"
18341 .cindex "Nagle algorithm"
18342 .cindex "TCP_NODELAY on listening sockets"
18343 If this option is set false, it stops the Exim daemon setting the
18344 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18345 turns off the &"Nagle algorithm"&, which is a way of improving network
18346 performance in interactive (character-by-character) situations. Turning it off
18347 should improve Exim's performance a bit, so that is what happens by default.
18348 However, it appears that some broken clients cannot cope, and time out. Hence
18349 this option. It affects only those sockets that are set up for listening by the
18350 daemon. Sockets created by the smtp transport for delivering mail always set
18351 TCP_NODELAY.
18352
18353
18354 .option timeout_frozen_after main time 0s
18355 .cindex "frozen messages" "timing out"
18356 .cindex "timeout" "frozen messages"
18357 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18358 message of any kind that has been in the queue for longer than the given time
18359 is automatically cancelled at the next queue run. If the frozen message is a
18360 bounce message, it is just discarded; otherwise, a bounce is sent to the
18361 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18362 If you want to timeout frozen bounce messages earlier than other kinds of
18363 frozen message, see &%ignore_bounce_errors_after%&.
18364
18365 &*Note:*& the default value of zero means no timeouts; with this setting,
18366 frozen messages remain in the queue forever (except for any frozen bounce
18367 messages that are released by &%ignore_bounce_errors_after%&).
18368
18369
18370 .option timezone main string unset
18371 .cindex "timezone, setting"
18372 .cindex "environment" "values from"
18373 The value of &%timezone%& is used to set the environment variable TZ while
18374 running Exim (if it is different on entry). This ensures that all timestamps
18375 created by Exim are in the required timezone. If you want all your timestamps
18376 to be in UTC (aka GMT) you should set
18377 .code
18378 timezone = UTC
18379 .endd
18380 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18381 or, if that is not set, from the value of the TZ environment variable when Exim
18382 is built. If &%timezone%& is set to the empty string, either at build or run
18383 time, any existing TZ variable is removed from the environment when Exim
18384 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18385 unfortunately not all, operating systems.
18386
18387
18388 .option tls_advertise_hosts main "host list&!!" *
18389 .cindex "TLS" "advertising"
18390 .cindex "encryption" "on SMTP connection"
18391 .cindex "SMTP" "encrypted connection"
18392 .cindex "ESMTP extensions" STARTTLS
18393 When Exim is built with support for TLS encrypted connections, the availability
18394 of the STARTTLS command to set up an encrypted session is advertised in
18395 response to EHLO only to those client hosts that match this option. See
18396 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18397 Note that the default value requires that a certificate be supplied
18398 using the &%tls_certificate%& option.  If TLS support for incoming connections
18399 is not required the &%tls_advertise_hosts%& option should be set empty.
18400
18401
18402 .option tls_alpn main "string list&!!" "smtp : esmtp"
18403 .cindex TLS "Application Layer Protocol Names"
18404 .cindex TLS ALPN
18405 .cindex ALPN "set acceptable names for server"
18406 If this option is set,
18407 the TLS library supports ALPN,
18408 and the client offers either more than one
18409 ALPN name or a name which does not match the list,
18410 the TLS connection is declined.
18411
18412
18413 .option tls_certificate main "string list&!!" unset
18414 .cindex "TLS" "server certificate; location of"
18415 .cindex "certificate" "server, location of"
18416 The value of this option is expanded, and must then be a list of absolute paths to
18417 files which contain the server's certificates (in PEM format).
18418 Commonly only one file is needed.
18419 The server's private key is also
18420 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18421 &<<CHAPTLS>>& for further details.
18422
18423 &*Note*&: The certificates defined by this option are used only when Exim is
18424 receiving incoming messages as a server. If you want to supply certificates for
18425 use when sending messages as a client, you must set the &%tls_certificate%&
18426 option in the relevant &(smtp)& transport.
18427
18428 &*Note*&: If you use filenames based on IP addresses, change the list
18429 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18430
18431 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18432 when a list of more than one
18433 file is used, the &$tls_in_ourcert$& variable is unreliable.
18434 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18435
18436 .cindex SNI "selecting server certificate based on"
18437 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18438 if the OpenSSL build supports TLS extensions and the TLS client sends the
18439 Server Name Indication extension, then this option and others documented in
18440 &<<SECTtlssni>>& will be re-expanded.
18441
18442 If this option is unset or empty a self-signed certificate will be
18443 used.
18444 Under Linux this is generated at daemon startup; on other platforms it will be
18445 generated fresh for every connection.
18446
18447 .option tls_crl main string&!! unset
18448 .cindex "TLS" "server certificate revocation list"
18449 .cindex "certificate" "revocation list for server"
18450 This option specifies a certificate revocation list. The expanded value must
18451 be the name of a file that contains CRLs in PEM format.
18452
18453 Under OpenSSL the option can specify a directory with CRL files.
18454
18455 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18456 for each signing element of the certificate chain (i.e. all but the leaf).
18457 For the file variant this can be multiple PEM blocks in the one file.
18458
18459 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18460
18461
18462 .option tls_dh_max_bits main integer 2236
18463 .cindex "TLS" "D-H bit count"
18464 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18465 the chosen TLS library.  That value might prove to be too high for
18466 interoperability.  This option provides a maximum clamp on the value
18467 suggested, trading off security for interoperability.
18468
18469 The value must be at least 1024.
18470
18471 The value 2236 was chosen because, at time of adding the option, it was the
18472 hard-coded maximum value supported by the NSS cryptographic library, as used
18473 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18474
18475 If you prefer more security and are willing to break some clients, raise this
18476 number.
18477
18478 Note that the value passed to GnuTLS for *generating* a new prime may be a
18479 little less than this figure, because GnuTLS is inexact and may produce a
18480 larger prime than requested.
18481
18482
18483 .option tls_dhparam main string&!! unset
18484 .cindex "TLS" "D-H parameters for server"
18485 The value of this option is expanded and indicates the source of DH parameters
18486 to be used by Exim.
18487
18488 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18489 local DH parameters*&, which has been supported across all versions of Exim.  The
18490 other specific constants available are a fallback so that even when
18491 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18492
18493 If &%tls_dhparam%& is a filename starting with a &`/`&,
18494 then it names a file from which DH
18495 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18496 PKCS#3 representation of the DH prime.  If the file does not exist, for
18497 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18498 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18499 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18500 and treated as though the &%tls_dhparam%& were set to "none".
18501
18502 If this option expands to the string "none", then no DH parameters will be
18503 loaded by Exim.
18504
18505 If this option expands to the string "historic" and Exim is using GnuTLS, then
18506 Exim will attempt to load a file from inside the spool directory.  If the file
18507 does not exist, Exim will attempt to create it.
18508 See section &<<SECTgnutlsparam>>& for further details.
18509
18510 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18511 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18512
18513 In older versions of Exim the default was the 2048 bit prime described in section
18514 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18515 in IKE is assigned number 23.
18516
18517 Otherwise, the option must expand to the name used by Exim for any of a number
18518 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18519 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18520 the number used by IKE, or "default" which corresponds to
18521 &`exim.dev.20160529.3`&.
18522
18523 The available standard primes are:
18524 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18525 &`ike1`&, &`ike2`&, &`ike5`&,
18526 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18527 &`ike22`&, &`ike23`& and &`ike24`&.
18528
18529 The available additional primes are:
18530 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18531
18532 Some of these will be too small to be accepted by clients.
18533 Some may be too large to be accepted by clients.
18534 The open cryptographic community has suspicions about the integrity of some
18535 of the later IKE values, which led into RFC7919 providing new fixed constants
18536 (the "ffdhe" identifiers).
18537
18538 At this point, all of the "ike" values should be considered obsolete;
18539 they are still in Exim to avoid breaking unusual configurations, but are
18540 candidates for removal the next time we have backwards-incompatible changes.
18541 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18542 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18543 SHOULD NOT.
18544 Because of this, Exim regards them as deprecated; if either of the first pair
18545 are used, warnings will be logged in the paniclog, and if any are used then
18546 warnings will be logged in the mainlog.
18547 All four will be removed in a future Exim release.
18548
18549 The TLS protocol does not negotiate an acceptable size for this; clients tend
18550 to hard-drop connections if what is offered by the server is unacceptable,
18551 whether too large or too small, and there's no provision for the client to
18552 tell the server what these constraints are.  Thus, as a server operator, you
18553 need to make an educated guess as to what is most likely to work for your
18554 userbase.
18555
18556 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18557 is most likely to maximise interoperability.  The upper bound comes from
18558 applications using the Mozilla Network Security Services (NSS) library, which
18559 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18560 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18561 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18562 acceptable bound from 1024 to 2048.
18563
18564
18565 .option tls_eccurve main string list&!! &`auto`&
18566 .cindex TLS "EC cryptography"
18567 This option selects EC curves for use by Exim when used with OpenSSL.
18568 It has no effect when Exim is used with GnuTLS
18569 (the equivalent can be done using a priority string for the
18570 &%tls_require_ciphers%& option).
18571
18572 After expansion it must contain
18573 .new
18574 one or (only for OpenSSL versiona 1.1.1 onwards) more
18575 .wen
18576 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18577 Consult your OpenSSL manual for valid curve names.
18578
18579 For OpenSSL versions before (and not including) 1.0.2, the string
18580 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18581 &`auto`& tells the library to choose.
18582
18583 .new
18584 If the option expands to an empty string, the effect is undefined.
18585 .wen
18586
18587
18588 .option tls_ocsp_file main string&!! unset
18589 .cindex TLS "certificate status"
18590 .cindex TLS "OCSP proof file"
18591 This option
18592 must if set expand to the absolute path to a file which contains a current
18593 status proof for the server's certificate, as obtained from the
18594 Certificate Authority.
18595
18596 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18597 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18598
18599 For OpenSSL 1.1.0 or later, and
18600 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18601 of files, to match a list given for the &%tls_certificate%& option.
18602 The ordering of the two lists must match.
18603 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18604
18605 The file(s) should be in DER format,
18606 except for GnuTLS 3.6.3 or later
18607 or for OpenSSL,
18608 when an optional filetype prefix can be used.
18609 The prefix must be one of "DER" or "PEM", followed by
18610 a single space.  If one is used it sets the format for subsequent
18611 files in the list; the initial format is DER.
18612 If multiple proofs are wanted, for multiple chain elements
18613 (this only works under TLS1.3)
18614 they must be coded as a combined OCSP response.
18615
18616 Although GnuTLS will accept PEM files with multiple separate
18617 PEM blobs (ie. separate OCSP responses), it sends them in the
18618 TLS Certificate record interleaved with the certificates of the chain;
18619 although a GnuTLS client is happy with that, an OpenSSL client is not.
18620
18621 .option tls_on_connect_ports main "string list" unset
18622 .cindex SSMTP
18623 .cindex SMTPS
18624 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18625 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18626 set up without waiting for the client to issue a STARTTLS command. For
18627 further details, see section &<<SECTsupobssmt>>&.
18628
18629
18630
18631 .option tls_privatekey main "string list&!!" unset
18632 .cindex "TLS" "server private key; location of"
18633 The value of this option is expanded, and must then be a list of absolute paths to
18634 files which contains the server's private keys.
18635 If this option is unset, or if
18636 the expansion is forced to fail, or the result is an empty string, the private
18637 key is assumed to be in the same file as the server's certificates. See chapter
18638 &<<CHAPTLS>>& for further details.
18639
18640 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18641
18642
18643 .option tls_remember_esmtp main boolean false
18644 .cindex "TLS" "esmtp state; remembering"
18645 .cindex "TLS" "broken clients"
18646 If this option is set true, Exim violates the RFCs by remembering that it is in
18647 &"esmtp"& state after successfully negotiating a TLS session. This provides
18648 support for broken clients that fail to send a new EHLO after starting a
18649 TLS session.
18650
18651
18652 .option tls_require_ciphers main string&!! unset
18653 .cindex "TLS" "requiring specific ciphers"
18654 .cindex "cipher" "requiring specific"
18655 This option controls which ciphers can be used for incoming TLS connections.
18656 The &(smtp)& transport has an option of the same name for controlling outgoing
18657 connections. This option is expanded for each connection, so can be varied for
18658 different clients if required. The value of this option must be a list of
18659 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18660 in somewhat different ways. If GnuTLS is being used, the client controls the
18661 preference order of the available ciphers. Details are given in sections
18662 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18663
18664
18665 .option tls_resumption_hosts main "host list&!!" unset
18666 .cindex TLS resumption
18667 This option controls which connections to offer the TLS resumption feature.
18668 See &<<SECTresumption>>& for details.
18669
18670
18671 .option tls_try_verify_hosts main "host list&!!" unset
18672 .cindex "TLS" "client certificate verification"
18673 .cindex "certificate" "verification of client"
18674 See &%tls_verify_hosts%& below.
18675
18676
18677 .option tls_verify_certificates main string&!! system
18678 .cindex "TLS" "client certificate verification"
18679 .cindex "certificate" "verification of client"
18680 The value of this option is expanded, and must then be either the
18681 word "system"
18682 or the absolute path to
18683 a file or directory containing permitted certificates for clients that
18684 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18685
18686 The "system" value for the option will use a
18687 system default location compiled into the SSL library.
18688 This is not available for GnuTLS versions preceding 3.0.20,
18689 and will be taken as empty; an explicit location
18690 must be specified.
18691
18692 The use of a directory for the option value is not available for GnuTLS versions
18693 preceding 3.3.6 and a single file must be used.
18694
18695 With OpenSSL the certificates specified
18696 explicitly
18697 either by file or directory
18698 are added to those given by the system default location.
18699
18700 These certificates should be for the certificate authorities trusted, rather
18701 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18702 the value is a file then the certificates are sent by Exim as a server to
18703 connecting clients, defining the list of accepted certificate authorities.
18704 Thus the values defined should be considered public data.  To avoid this,
18705 use the explicit directory version. (If your peer is Exim up to 4.85,
18706 using GnuTLS, you may need to send the CAs (thus using the file
18707 variant). Otherwise the peer doesn't send its certificate.)
18708
18709 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18710
18711 A forced expansion failure or setting to an empty string is equivalent to
18712 being unset.
18713
18714
18715 .option tls_verify_hosts main "host list&!!" unset
18716 .cindex "TLS" "client certificate verification"
18717 .cindex "certificate" "verification of client"
18718 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18719 certificates from clients. The expected certificates are defined by
18720 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18721 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18722 &%tls_verify_certificates%& is not set.
18723
18724 Any client that matches &%tls_verify_hosts%& is constrained by
18725 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18726 present one of the listed certificates. If it does not, the connection is
18727 aborted.
18728 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18729 the host to use TLS. It can still send SMTP commands through unencrypted
18730 connections. Forcing a client to use TLS has to be done separately using an
18731 ACL to reject inappropriate commands when the connection is not encrypted.
18732
18733 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18734 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18735 certificate and checks it against &%tls_verify_certificates%&, but does not
18736 abort the connection if there is no certificate or if it does not match. This
18737 state can be detected in an ACL, which makes it possible to implement policies
18738 such as &"accept for relay only if a verified certificate has been received,
18739 but accept for local delivery if encrypted, even without a verified
18740 certificate"&.
18741
18742 Client hosts that match neither of these lists are not asked to present
18743 certificates.
18744
18745
18746 .option trusted_groups main "string list&!!" unset
18747 .cindex "trusted groups"
18748 .cindex "groups" "trusted"
18749 This option is expanded just once, at the start of Exim's processing. If this
18750 option is set, any process that is running in one of the listed groups, or
18751 which has one of them as a supplementary group, is trusted. The groups can be
18752 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18753 details of what trusted callers are permitted to do. If neither
18754 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18755 are trusted.
18756
18757 .option trusted_users main "string list&!!" unset
18758 .cindex "trusted users"
18759 .cindex "user" "trusted"
18760 This option is expanded just once, at the start of Exim's processing. If this
18761 option is set, any process that is running as one of the listed users is
18762 trusted. The users can be specified numerically or by name. See section
18763 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18764 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18765 Exim user are trusted.
18766
18767 .option unknown_login main string&!! unset
18768 .cindex "uid (user id)" "unknown caller"
18769 .vindex "&$caller_uid$&"
18770 This is a specialized feature for use in unusual configurations. By default, if
18771 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18772 gives up. The &%unknown_login%& option can be used to set a login name to be
18773 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18774 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18775 is used for the user's real name (gecos field), unless this has been set by the
18776 &%-F%& option.
18777
18778 .option unknown_username main string unset
18779 See &%unknown_login%&.
18780
18781 .option untrusted_set_sender main "address list&!!" unset
18782 .cindex "trusted users"
18783 .cindex "sender" "setting by untrusted user"
18784 .cindex "untrusted user setting sender"
18785 .cindex "user" "untrusted setting sender"
18786 .cindex "envelope from"
18787 .cindex "envelope sender"
18788 When an untrusted user submits a message to Exim using the standard input, Exim
18789 normally creates an envelope sender address from the user's login and the
18790 default qualification domain. Data from the &%-f%& option (for setting envelope
18791 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18792 is used) is ignored.
18793
18794 However, untrusted users are permitted to set an empty envelope sender address,
18795 to declare that a message should never generate any bounces. For example:
18796 .code
18797 exim -f '<>' user@domain.example
18798 .endd
18799 .vindex "&$sender_ident$&"
18800 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18801 other envelope sender addresses in a controlled way. When it is set, untrusted
18802 users are allowed to set envelope sender addresses that match any of the
18803 patterns in the list. Like all address lists, the string is expanded. The
18804 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18805 users to setting senders that start with their login ids
18806 followed by a hyphen
18807 by a setting like this:
18808 .code
18809 untrusted_set_sender = ^$sender_ident-
18810 .endd
18811 If you want to allow untrusted users to set envelope sender addresses without
18812 restriction, you can use
18813 .code
18814 untrusted_set_sender = *
18815 .endd
18816 The &%untrusted_set_sender%& option applies to all forms of local input, but
18817 only to the setting of the envelope sender. It does not permit untrusted users
18818 to use the other options which trusted user can use to override message
18819 parameters. Furthermore, it does not stop Exim from removing an existing
18820 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18821 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18822 overriding these actions. The handling of the &'Sender:'& header is also
18823 described in section &<<SECTthesenhea>>&.
18824
18825 The log line for a message's arrival shows the envelope sender following
18826 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18827 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18828 envelope sender address, the user's login is shown in parentheses after the
18829 sender address.
18830
18831
18832 .option uucp_from_pattern main string "see below"
18833 .cindex "&""From""& line"
18834 .cindex "UUCP" "&""From""& line"
18835 Some applications that pass messages to an MTA via a command line interface use
18836 an initial line starting with &"From&~"& to pass the envelope sender. In
18837 particular, this is used by UUCP software. Exim recognizes such a line by means
18838 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18839 matches, the sender address is constructed by expanding the contents of
18840 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18841 default pattern recognizes lines in the following two forms:
18842 .code
18843 From ph10 Fri Jan  5 12:35 GMT 1996
18844 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18845 .endd
18846 The pattern can be seen by running
18847 .code
18848 exim -bP uucp_from_pattern
18849 .endd
18850 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18851 year in the second case. The first word after &"From&~"& is matched in the
18852 regular expression by a parenthesized subpattern. The default value for
18853 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18854 (&"ph10"& in the example above) as the message's sender. See also
18855 &%ignore_fromline_hosts%&.
18856
18857
18858 .option uucp_from_sender main string&!! &`$1`&
18859 See &%uucp_from_pattern%& above.
18860
18861
18862 .option warn_message_file main string&!! unset
18863 .cindex "warning of delay" "customizing the message"
18864 .cindex "customizing" "warning message"
18865 This option defines a template file containing paragraphs of text to be used
18866 for constructing the warning message which is sent by Exim when a message has
18867 been in the queue for a specified amount of time, as specified by
18868 &%delay_warning%&. Details of the file's contents are given in chapter
18869 &<<CHAPemsgcust>>&.
18870 .cindex warn_message_file "tainted data"
18871 The option is expanded to give the file path, which must be
18872 absolute and untainted.
18873 See also &%bounce_message_file%&.
18874
18875
18876 .option write_rejectlog main boolean true
18877 .cindex "reject log" "disabling"
18878 If this option is set false, Exim no longer writes anything to the reject log.
18879 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18880 .ecindex IIDconfima
18881 .ecindex IIDmaiconf
18882
18883
18884
18885
18886 . ////////////////////////////////////////////////////////////////////////////
18887 . ////////////////////////////////////////////////////////////////////////////
18888
18889 .chapter "Generic options for routers" "CHAProutergeneric"
18890 .scindex IIDgenoprou1 "options" "generic; for routers"
18891 .scindex IIDgenoprou2 "generic options" "router"
18892 This chapter describes the generic options that apply to all routers.
18893 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18894
18895 For a general description of how a router operates, see sections
18896 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18897 which the preconditions are tested. The order of expansion of the options that
18898 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18899 &%headers_remove%&, &%transport%&.
18900
18901 The name of a router is limited to be &drivernamemax; ASCII characters long;
18902 prior to Exim 4.95 names would be silently truncated at this length, but now
18903 it is enforced.
18904
18905
18906 .option address_data routers string&!! unset
18907 .cindex "router" "data attached to address"
18908 The string is expanded just before the router is run, that is, after all the
18909 precondition tests have succeeded. If the expansion is forced to fail, the
18910 router declines, the value of &%address_data%& remains unchanged, and the
18911 &%more%& option controls what happens next. Other expansion failures cause
18912 delivery of the address to be deferred.
18913
18914 .vindex "&$address_data$&"
18915 When the expansion succeeds, the value is retained with the address, and can be
18916 accessed using the variable &$address_data$& in the current router, subsequent
18917 routers, and the eventual transport.
18918
18919 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18920 that runs a user's filter file, the contents of &$address_data$& are accessible
18921 in the filter. This is not normally a problem, because such data is usually
18922 either not confidential or it &"belongs"& to the current user, but if you do
18923 put confidential data into &$address_data$& you need to remember this point.
18924
18925 Even if the router declines or passes, the value of &$address_data$& remains
18926 with the address, though it can be changed by another &%address_data%& setting
18927 on a subsequent router. If a router generates child addresses, the value of
18928 &$address_data$& propagates to them. This also applies to the special kind of
18929 &"child"& that is generated by a router with the &%unseen%& option.
18930
18931 The idea of &%address_data%& is that you can use it to look up a lot of data
18932 for the address once, and then pick out parts of the data later. For example,
18933 you could use a single LDAP lookup to return a string of the form
18934 .code
18935 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18936 .endd
18937 In the transport you could pick out the mailbox by a setting such as
18938 .code
18939 file = ${extract{mailbox}{$address_data}}
18940 .endd
18941 This makes the configuration file less messy, and also reduces the number of
18942 lookups (though Exim does cache lookups).
18943
18944 See also the &%set%& option below.
18945
18946 .vindex "&$sender_address_data$&"
18947 .vindex "&$address_data$&"
18948 The &%address_data%& facility is also useful as a means of passing information
18949 from one router to another, and from a router to a transport. In addition, if
18950 &$address_data$& is set by a router when verifying a recipient address from an
18951 ACL, it remains available for use in the rest of the ACL statement. After
18952 verifying a sender, the value is transferred to &$sender_address_data$&.
18953
18954
18955
18956 .option address_test routers&!? boolean true
18957 .oindex "&%-bt%&"
18958 .cindex "router" "skipping when address testing"
18959 If this option is set false, the router is skipped when routing is being tested
18960 by means of the &%-bt%& command line option. This can be a convenience when
18961 your first router sends messages to an external scanner, because it saves you
18962 having to set the &"already scanned"& indicator when testing real address
18963 routing.
18964
18965
18966
18967 .option cannot_route_message routers string&!! unset
18968 .cindex "router" "customizing &""cannot route""& message"
18969 .cindex "customizing" "&""cannot route""& message"
18970 This option specifies a text message that is used when an address cannot be
18971 routed because Exim has run out of routers. The default message is
18972 &"Unrouteable address"&. This option is useful only on routers that have
18973 &%more%& set false, or on the very last router in a configuration, because the
18974 value that is used is taken from the last router that is considered. This
18975 includes a router that is skipped because its preconditions are not met, as
18976 well as a router that declines. For example, using the default configuration,
18977 you could put:
18978 .code
18979 cannot_route_message = Remote domain not found in DNS
18980 .endd
18981 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18982 and
18983 .code
18984 cannot_route_message = Unknown local user
18985 .endd
18986 on the final router that checks for local users. If string expansion fails for
18987 this option, the default message is used. Unless the expansion failure was
18988 explicitly forced, a message about the failure is written to the main and panic
18989 logs, in addition to the normal message about the routing failure.
18990
18991
18992 .option caseful_local_part routers boolean false
18993 .cindex "case of local parts"
18994 .cindex "router" "case of local parts"
18995 By default, routers handle the local parts of addresses in a case-insensitive
18996 manner, though the actual case is preserved for transmission with the message.
18997 If you want the case of letters to be significant in a router, you must set
18998 this option true. For individual router options that contain address or local
18999 part lists (for example, &%local_parts%&), case-sensitive matching can be
19000 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
19001 more details.
19002
19003 .vindex "&$local_part$&"
19004 .vindex "&$original_local_part$&"
19005 .vindex "&$parent_local_part$&"
19006 The value of the &$local_part$& variable is forced to lower case while a
19007 router is running unless &%caseful_local_part%& is set. When a router assigns
19008 an address to a transport, the value of &$local_part$& when the transport runs
19009 is the same as it was in the router. Similarly, when a router generates child
19010 addresses by aliasing or forwarding, the values of &$original_local_part$&
19011 and &$parent_local_part$& are those that were used by the redirecting router.
19012
19013 This option applies to the processing of an address by a router. When a
19014 recipient address is being processed in an ACL, there is a separate &%control%&
19015 modifier that can be used to specify case-sensitive processing within the ACL
19016 (see section &<<SECTcontrols>>&).
19017
19018
19019
19020 .option check_local_user routers&!? boolean false
19021 .cindex "local user, checking in router"
19022 .cindex "router" "checking for local user"
19023 .cindex "&_/etc/passwd_&"
19024 .vindex "&$home$&"
19025 When this option is true, Exim checks that the local part of the recipient
19026 address (with affixes removed if relevant) is the name of an account on the
19027 local system. The check is done by calling the &[getpwnam()]& function rather
19028 than trying to read &_/etc/passwd_& directly. This means that other methods of
19029 holding password data (such as NIS) are supported. If the local part is a local
19030 user,
19031 .cindex "tainted data" "de-tainting"
19032 .cindex "de-tainting" "using router check_local_user option"
19033 &$local_part_data$& is set to an untainted version of the local part and
19034 &$home$& is set from the password data. The latter can be tested in other
19035 preconditions that are evaluated after this one (the order of evaluation is
19036 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19037 overridden by &%router_home_directory%&. If the local part is not a local user,
19038 the router is skipped.
19039
19040 If you want to check that the local part is either the name of a local user
19041 or matches something else, you cannot combine &%check_local_user%& with a
19042 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19043 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19044 setting to achieve this. For example:
19045 .code
19046 local_parts = passwd;$local_part : lsearch;/etc/other/users
19047 .endd
19048 Note, however, that the side effects of &%check_local_user%& (such as setting
19049 up a home directory) do not occur when a &(passwd)& lookup is used in a
19050 &%local_parts%& (or any other) precondition.
19051
19052
19053
19054 .option condition routers&!? string&!! unset
19055 .cindex "router" "customized precondition"
19056 This option specifies a general precondition test that has to succeed for the
19057 router to be called. The &%condition%& option is the last precondition to be
19058 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19059 result is a forced failure, or an empty string, or one of the strings &"0"& or
19060 &"no"& or &"false"& (checked without regard to the case of the letters), the
19061 router is skipped, and the address is offered to the next one.
19062
19063 If the result is any other value, the router is run (as this is the last
19064 precondition to be evaluated, all the other preconditions must be true).
19065
19066 This option is unusual in that multiple &%condition%& options may be present.
19067 All &%condition%& options must succeed.
19068
19069 The &%condition%& option provides a means of applying custom conditions to the
19070 running of routers. Note that in the case of a simple conditional expansion,
19071 the default expansion values are exactly what is wanted. For example:
19072 .code
19073 condition = ${if >{$message_age}{600}}
19074 .endd
19075 Because of the default behaviour of the string expansion, this is equivalent to
19076 .code
19077 condition = ${if >{$message_age}{600}{true}{}}
19078 .endd
19079
19080 A multiple condition example, which succeeds:
19081 .code
19082 condition = ${if >{$message_age}{600}}
19083 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19084 condition = foobar
19085 .endd
19086
19087 If the expansion fails (other than forced failure) delivery is deferred. Some
19088 of the other precondition options are common special cases that could in fact
19089 be specified using &%condition%&.
19090
19091 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19092 are far older, and use one set of semantics.  ACLs are newer and when
19093 they were created, the ACL &%condition%& process was given far stricter
19094 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19095 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19096 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19097 Router rules processing behavior.
19098
19099 This is best illustrated in an example:
19100 .code
19101 # If used in an ACL condition will fail with a syntax error, but
19102 # in a router condition any extra characters are treated as a string
19103
19104 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19105 true {yes} {no}}
19106
19107 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19108  {yes} {no}}
19109 .endd
19110 In each example above, the &%if%& statement actually ends after
19111 &"{google.com}}"&.  Since no true or false braces were defined, the
19112 default &%if%& behavior is to return a boolean true or a null answer
19113 (which evaluates to false). The rest of the line is then treated as a
19114 string. So the first example resulted in the boolean answer &"true"&
19115 with the string &" {yes} {no}}"& appended to it. The second example
19116 resulted in the null output (indicating false) with the string
19117 &" {yes} {no}}"& appended to it.
19118
19119 In fact you can put excess forward braces in too.  In the router
19120 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19121 mean something, like after a &"$"& or when required as part of a
19122 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19123 string characters.
19124
19125 Thus, in a Router, the above expansion strings will both always evaluate
19126 true, as the result of expansion is a non-empty string which doesn't
19127 match an explicit false value.  This can be tricky to debug.  By
19128 contrast, in an ACL either of those strings will always result in an
19129 expansion error because the result doesn't look sufficiently boolean.
19130
19131
19132 .option debug_print routers string&!! unset
19133 .cindex "testing" "variables in drivers"
19134 If this option is set and debugging is enabled (see the &%-d%& command line
19135 option) or in address-testing mode (see the &%-bt%& command line option),
19136 the string is expanded and included in the debugging output.
19137 If expansion of the string fails, the error message is written to the debugging
19138 output, and Exim carries on processing.
19139 This option is provided to help with checking out the values of variables and
19140 so on when debugging router configurations. For example, if a &%condition%&
19141 option appears not to be working, &%debug_print%& can be used to output the
19142 variables it references. The output happens after checks for &%domains%&,
19143 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19144 are tested. A newline is added to the text if it does not end with one.
19145 The variable &$router_name$& contains the name of the router.
19146
19147
19148
19149 .option disable_logging routers boolean false
19150 If this option is set true, nothing is logged for any routing errors
19151 or for any deliveries caused by this router. You should not set this option
19152 unless you really, really know what you are doing. See also the generic
19153 transport option of the same name.
19154
19155 .option dnssec_request_domains routers "domain list&!!" *
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_request_domains%& will be done with
19161 the DNSSEC request bit set.
19162 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19163
19164 .option dnssec_require_domains routers "domain list&!!" unset
19165 .cindex "MX record" "security"
19166 .cindex "DNSSEC" "MX lookup"
19167 .cindex "security" "MX lookup"
19168 .cindex "DNS" "DNSSEC"
19169 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19170 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19171 (AD bit) set will be ignored and logged as a host-lookup failure.
19172 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19173
19174
19175 .option domains routers&!? "domain list&!!" unset
19176 .cindex "router" "restricting to specific domains"
19177 .vindex "&$domain_data$&"
19178 If this option is set, the router is skipped unless the current domain matches
19179 the list. If the match is achieved by means of a file lookup, the data that the
19180 lookup returned for the domain is placed in &$domain_data$& for use in string
19181 expansions of the driver's private options and in the transport.
19182 See section &<<SECTrouprecon>>& for
19183 a list of the order in which preconditions are evaluated.
19184
19185
19186
19187 .option driver routers string unset
19188 This option must always be set. It specifies which of the available routers is
19189 to be used.
19190
19191
19192 .option dsn_lasthop routers boolean false
19193 .cindex "DSN" "success"
19194 .cindex "Delivery Status Notification" "success"
19195 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19196 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19197 instead send a success DSN as if the next hop does not support DSN.
19198 Not effective on redirect routers.
19199
19200
19201
19202 .option errors_to routers string&!! unset
19203 .cindex "envelope from"
19204 .cindex "envelope sender"
19205 .cindex "router" "changing address for errors"
19206 If a router successfully handles an address, it may assign the address to a
19207 transport for delivery or it may generate child addresses. In both cases, if
19208 there is a delivery problem during later processing, the resulting bounce
19209 message is sent to the address that results from expanding this string,
19210 provided that the address verifies successfully. The &%errors_to%& option is
19211 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19212
19213 The &%errors_to%& setting associated with an address can be overridden if it
19214 subsequently passes through other routers that have their own &%errors_to%&
19215 settings, or if the message is delivered by a transport with a &%return_path%&
19216 setting.
19217
19218 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19219 the expansion fails to verify, the errors address associated with the incoming
19220 address is used. At top level, this is the envelope sender. A non-forced
19221 expansion failure causes delivery to be deferred.
19222
19223 If an address for which &%errors_to%& has been set ends up being delivered over
19224 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19225 any bounces that are generated by other MTAs on the delivery route are also
19226 sent there. You can set &%errors_to%& to the empty string by either of these
19227 settings:
19228 .code
19229 errors_to =
19230 errors_to = ""
19231 .endd
19232 An expansion item that yields an empty string has the same effect. If you do
19233 this, a locally detected delivery error for addresses processed by this router
19234 no longer gives rise to a bounce message; the error is discarded. If the
19235 address is delivered to a remote host, the return path is set to &`<>`&, unless
19236 overridden by the &%return_path%& option on the transport.
19237
19238 .vindex "&$address_data$&"
19239 If for some reason you want to discard local errors, but use a non-empty
19240 MAIL command for remote delivery, you can preserve the original return
19241 path in &$address_data$& in the router, and reinstate it in the transport by
19242 setting &%return_path%&.
19243
19244 The most common use of &%errors_to%& is to direct mailing list bounces to the
19245 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19246 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19247
19248
19249
19250 .option expn routers&!? boolean true
19251 .cindex "address" "testing"
19252 .cindex "testing" "addresses"
19253 .cindex "EXPN" "router skipping"
19254 .cindex "router" "skipping for EXPN"
19255 If this option is turned off, the router is skipped when testing an address
19256 as a result of processing an SMTP EXPN command. You might, for example,
19257 want to turn it off on a router for users' &_.forward_& files, while leaving it
19258 on for the system alias file.
19259 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19260 are evaluated.
19261
19262 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19263 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19264 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19265
19266
19267
19268 .option fail_verify routers boolean false
19269 .cindex "router" "forcing verification failure"
19270 Setting this option has the effect of setting both &%fail_verify_sender%& and
19271 &%fail_verify_recipient%& to the same value.
19272
19273
19274
19275 .option fail_verify_recipient routers boolean false
19276 If this option is true and an address is accepted by this router when
19277 verifying a recipient, verification fails.
19278
19279
19280
19281 .option fail_verify_sender routers boolean false
19282 If this option is true and an address is accepted by this router when
19283 verifying a sender, verification fails.
19284
19285
19286
19287 .option fallback_hosts routers "string list" unset
19288 .cindex "router" "fallback hosts"
19289 .cindex "fallback" "hosts specified on router"
19290 String expansion is not applied to this option. The argument must be a
19291 colon-separated list of host names or IP addresses. The list separator can be
19292 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19293 each name or address. In fact, the format of each item is exactly the same as
19294 defined for the list of hosts in a &(manualroute)& router (see section
19295 &<<SECTformatonehostitem>>&).
19296
19297 If a router queues an address for a remote transport, this host list is
19298 associated with the address, and used instead of the transport's fallback host
19299 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19300 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19301 transport for further details.
19302
19303
19304 .option group routers string&!! "see below"
19305 .cindex "gid (group id)" "local delivery"
19306 .cindex "local transports" "uid and gid"
19307 .cindex "transport" "local"
19308 .cindex "router" "setting group"
19309 When a router queues an address for a transport, and the transport does not
19310 specify a group, the group given here is used when running the delivery
19311 process.
19312 The group may be specified numerically or by name. If expansion fails, the
19313 error is logged and delivery is deferred.
19314 The default is unset, unless &%check_local_user%& is set, when the default
19315 is taken from the password information. See also &%initgroups%& and &%user%&
19316 and the discussion in chapter &<<CHAPenvironment>>&.
19317
19318
19319
19320 .option headers_add routers list&!! unset
19321 .cindex "header lines" "adding"
19322 .cindex "router" "adding header lines"
19323 This option specifies a list of text headers,
19324 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19325 that is associated with any addresses that are accepted by the router.
19326 Each item is separately expanded, at routing time.  However, this
19327 option has no effect when an address is just being verified. The way in which
19328 the text is used to add header lines at transport time is described in section
19329 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19330 message is in the process of being transported. This means that references to
19331 header lines in string expansions in the transport's configuration do not
19332 &"see"& the added header lines.
19333
19334 The &%headers_add%& option is expanded after &%errors_to%&, but before
19335 &%headers_remove%& and &%transport%&. If an item is empty, or if
19336 an item expansion is forced to fail, the item has no effect. Other expansion
19337 failures are treated as configuration errors.
19338
19339 Unlike most options, &%headers_add%& can be specified multiple times
19340 for a router; all listed headers are added.
19341
19342 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19343 router that has the &%one_time%& option set.
19344
19345 .cindex "duplicate addresses"
19346 .oindex "&%unseen%&"
19347 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19348 additions are deleted when the address is passed on to subsequent routers.
19349 For a &%redirect%& router, if a generated address is the same as the incoming
19350 address, this can lead to duplicate addresses with different header
19351 modifications. Exim does not do duplicate deliveries (except, in certain
19352 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19353 which of the duplicates is discarded, so this ambiguous situation should be
19354 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19355
19356
19357
19358 .option headers_remove routers list&!! unset
19359 .cindex "header lines" "removing"
19360 .cindex "router" "removing header lines"
19361 This option specifies a list of text headers,
19362 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19363 that is associated with any addresses that are accepted by the router.
19364 However, the option has no effect when an address is just being verified.
19365 Each list item is separately expanded, at transport time.
19366 If an item ends in *, it will match any header with the given prefix.
19367 The way in which
19368 the text is used to remove header lines at transport time is described in
19369 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19370 the message is in the process of being transported. This means that references
19371 to header lines in string expansions in the transport's configuration still
19372 &"see"& the original header lines.
19373
19374 The &%headers_remove%& option is handled after &%errors_to%& and
19375 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19376 the item has no effect. Other expansion failures are treated as configuration
19377 errors.
19378
19379 Unlike most options, &%headers_remove%& can be specified multiple times
19380 for a router; all listed headers are removed.
19381
19382 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19383 router that has the &%one_time%& option set.
19384
19385 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19386 removal requests are deleted when the address is passed on to subsequent
19387 routers, and this can lead to problems with duplicates -- see the similar
19388 warning for &%headers_add%& above.
19389
19390 &*Warning 3*&: Because of the separate expansion of the list items,
19391 items that contain a list separator must have it doubled.
19392 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19393
19394
19395
19396 .option ignore_target_hosts routers "host list&!!" unset
19397 .cindex "IP address" "discarding"
19398 .cindex "router" "discarding IP addresses"
19399 Although this option is a host list, it should normally contain IP address
19400 entries rather than names. If any host that is looked up by the router has an
19401 IP address that matches an item in this list, Exim behaves as if that IP
19402 address did not exist. This option allows you to cope with rogue DNS entries
19403 like
19404 .code
19405 remote.domain.example.  A  127.0.0.1
19406 .endd
19407 by setting
19408 .code
19409 ignore_target_hosts = 127.0.0.1
19410 .endd
19411 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19412 discarded in this way, the router declines. In a conventional configuration, an
19413 attempt to mail to such a domain would normally provoke the &"unrouteable
19414 domain"& error, and an attempt to verify an address in the domain would fail.
19415 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19416 router declines if presented with one of the listed addresses.
19417
19418 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19419 means of the first or the second of the following settings, respectively:
19420 .code
19421 ignore_target_hosts = 0.0.0.0/0
19422 ignore_target_hosts = <; 0::0/0
19423 .endd
19424 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19425 in the second line matches all IPv6 addresses.
19426
19427 This option may also be useful for ignoring link-local and site-local IPv6
19428 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19429 is expanded before use as a list, it is possible to make it dependent on the
19430 domain that is being routed.
19431
19432 .vindex "&$host_address$&"
19433 During its expansion, &$host_address$& is set to the IP address that is being
19434 checked.
19435
19436 .option initgroups routers boolean false
19437 .cindex "additional groups"
19438 .cindex "groups" "additional"
19439 .cindex "local transports" "uid and gid"
19440 .cindex "transport" "local"
19441 If the router queues an address for a transport, and this option is true, and
19442 the uid supplied by the router is not overridden by the transport, the
19443 &[initgroups()]& function is called when running the transport to ensure that
19444 any additional groups associated with the uid are set up. See also &%group%&
19445 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19446
19447
19448
19449 .option local_part_prefix routers&!? "string list" unset
19450 .cindex affix "router precondition"
19451 .cindex "router" "prefix for local part"
19452 .cindex "prefix" "for local part, used in router"
19453 If this option is set, the router is skipped unless the local part starts with
19454 one of the given strings, or &%local_part_prefix_optional%& is true. See
19455 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19456 evaluated.
19457
19458 The list is scanned from left to right, and the first prefix that matches is
19459 used. A limited form of wildcard is available; if the prefix begins with an
19460 asterisk, it matches the longest possible sequence of arbitrary characters at
19461 the start of the local part. An asterisk should therefore always be followed by
19462 some character that does not occur in normal local parts.
19463 .cindex "multiple mailboxes"
19464 .cindex "mailbox" "multiple"
19465 Wildcarding can be used to set up multiple user mailboxes, as described in
19466 section &<<SECTmulbox>>&.
19467
19468 .vindex "&$local_part$&"
19469 .vindex "&$local_part_prefix$&"
19470 During the testing of the &%local_parts%& option, and while the router is
19471 running, the prefix is removed from the local part, and is available in the
19472 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19473 the router accepts the address, this remains true during subsequent delivery by
19474 a transport. In particular, the local part that is transmitted in the RCPT
19475 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19476 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19477 the relevant transport.
19478
19479 .vindex &$local_part_prefix_v$&
19480 If wildcarding (above) was used then the part of the prefix matching the
19481 wildcard is available in &$local_part_prefix_v$&.
19482
19483 When an address is being verified, &%local_part_prefix%& affects only the
19484 behaviour of the router. If the callout feature of verification is in use, this
19485 means that the full address, including the prefix, will be used during the
19486 callout.
19487
19488 The prefix facility is commonly used to handle local parts of the form
19489 &%owner-something%&. Another common use is to support local parts of the form
19490 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19491 to tell a user their forwarding is broken &-- by placing a router like this one
19492 immediately before the router that handles &_.forward_& files:
19493 .code
19494 real_localuser:
19495   driver = accept
19496   local_part_prefix = real-
19497   check_local_user
19498   transport = local_delivery
19499 .endd
19500 For security, it would probably be a good idea to restrict the use of this
19501 router to locally-generated messages, using a condition such as this:
19502 .code
19503   condition = ${if match {$sender_host_address}\
19504                          {\N^(|127\.0\.0\.1)$\N}}
19505 .endd
19506
19507 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19508 both conditions must be met if not optional. Care must be taken if wildcards
19509 are used in both a prefix and a suffix on the same router. Different
19510 separator characters must be used to avoid ambiguity.
19511
19512
19513 .option local_part_prefix_optional routers boolean false
19514 See &%local_part_prefix%& above.
19515
19516
19517
19518 .option local_part_suffix routers&!? "string list" unset
19519 .cindex "router" "suffix for local part"
19520 .cindex "suffix for local part" "used in router"
19521 This option operates in the same way as &%local_part_prefix%&, except that the
19522 local part must end (rather than start) with the given string, the
19523 &%local_part_suffix_optional%& option determines whether the suffix is
19524 mandatory, and the wildcard * character, if present, must be the last
19525 character of the suffix. This option facility is commonly used to handle local
19526 parts of the form &%something-request%& and multiple user mailboxes of the form
19527 &%username-foo%&.
19528
19529
19530 .option local_part_suffix_optional routers boolean false
19531 See &%local_part_suffix%& above.
19532
19533
19534
19535 .option local_parts routers&!? "local part list&!!" unset
19536 .cindex "router" "restricting to specific local parts"
19537 .cindex "local part" "checking in router"
19538 The router is run only if the local part of the address matches the list.
19539 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19540 are evaluated, and
19541 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19542 string is expanded, it is possible to make it depend on the domain, for
19543 example:
19544 .code
19545 local_parts = dbm;/usr/local/specials/$domain_data
19546 .endd
19547 .vindex "&$local_part_data$&"
19548 If the match is achieved by a lookup, the data that the lookup returned
19549 for the local part is placed in the variable &$local_part_data$& for use in
19550 expansions of the router's private options or in the transport.
19551 You might use this option, for
19552 example, if you have a large number of local virtual domains, and you want to
19553 send all postmaster mail to the same place without having to set up an alias in
19554 each virtual domain:
19555 .code
19556 postmaster:
19557   driver = redirect
19558   local_parts = postmaster
19559   data = postmaster@real.domain.example
19560 .endd
19561
19562
19563 .option log_as_local routers boolean "see below"
19564 .cindex "log" "delivery line"
19565 .cindex "delivery" "log line format"
19566 Exim has two logging styles for delivery, the idea being to make local
19567 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19568 recipient address is given just as the local part, without a domain. The use of
19569 this style is controlled by this option. It defaults to true for the &(accept)&
19570 router, and false for all the others. This option applies only when a
19571 router assigns an address to a transport. It has no effect on routers that
19572 redirect addresses.
19573
19574
19575
19576 .option more routers boolean&!! true
19577 The result of string expansion for this option must be a valid boolean value,
19578 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19579 result causes an error, and delivery is deferred. If the expansion is forced to
19580 fail, the default value for the option (true) is used. Other failures cause
19581 delivery to be deferred.
19582
19583 If this option is set false, and the router declines to handle the address, no
19584 further routers are tried, routing fails, and the address is bounced.
19585 .oindex "&%self%&"
19586 However, if the router explicitly passes an address to the following router by
19587 means of the setting
19588 .code
19589 self = pass
19590 .endd
19591 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19592 does not affect the behaviour if one of the precondition tests fails. In that
19593 case, the address is always passed to the next router.
19594
19595 Note that &%address_data%& is not considered to be a precondition. If its
19596 expansion is forced to fail, the router declines, and the value of &%more%&
19597 controls what happens next.
19598
19599
19600 .option pass_on_timeout routers boolean false
19601 .cindex "timeout" "of router"
19602 .cindex "router" "timeout"
19603 If a router times out during a host lookup, it normally causes deferral of the
19604 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19605 router, overriding &%no_more%&. This may be helpful for systems that are
19606 intermittently connected to the Internet, or those that want to pass to a smart
19607 host any messages that cannot immediately be delivered.
19608
19609 There are occasional other temporary errors that can occur while doing DNS
19610 lookups. They are treated in the same way as a timeout, and this option
19611 applies to all of them.
19612
19613
19614
19615 .option pass_router routers string unset
19616 .cindex "router" "go to after &""pass""&"
19617 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19618 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19619 routing to continue, and overriding a false setting of &%more%&. When one of
19620 these routers returns &"pass"&, the address is normally handed on to the next
19621 router in sequence. This can be changed by setting &%pass_router%& to the name
19622 of another router. However (unlike &%redirect_router%&) the named router must
19623 be below the current router, to avoid loops. Note that this option applies only
19624 to the special case of &"pass"&. It does not apply when a router returns
19625 &"decline"& because it cannot handle an address.
19626
19627
19628
19629 .option redirect_router routers string unset
19630 .cindex "router" "start at after redirection"
19631 Sometimes an administrator knows that it is pointless to reprocess addresses
19632 generated from alias or forward files with the same router again. For
19633 example, if an alias file translates real names into login ids there is no
19634 point searching the alias file a second time, especially if it is a large file.
19635
19636 The &%redirect_router%& option can be set to the name of any router instance.
19637 It causes the routing of any generated addresses to start at the named router
19638 instead of at the first router. This option has no effect if the router in
19639 which it is set does not generate new addresses.
19640
19641
19642
19643 .option require_files routers&!? "string list&!!" unset
19644 .cindex "file" "requiring for router"
19645 .cindex "router" "requiring file existence"
19646 This option provides a general mechanism for predicating the running of a
19647 router on the existence or non-existence of certain files or directories.
19648 Before running a router, as one of its precondition tests, Exim works its way
19649 through the &%require_files%& list, expanding each item separately.
19650
19651 Because the list is split before expansion, any colons in expansion items must
19652 be doubled, or the facility for using a different list separator must be used
19653 (&<<SECTlistsepchange>>&).
19654 If any expansion is forced to fail, the item is ignored. Other expansion
19655 failures cause routing of the address to be deferred.
19656
19657 If any expanded string is empty, it is ignored. Otherwise, except as described
19658 below, each string must be a fully qualified file path, optionally preceded by
19659 &"!"&. The paths are passed to the &[stat()]& function to test for the
19660 existence of the files or directories. The router is skipped if any paths not
19661 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19662
19663 .cindex "NFS"
19664 If &[stat()]& cannot determine whether a file exists or not, delivery of
19665 the message is deferred. This can happen when NFS-mounted filesystems are
19666 unavailable.
19667
19668 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19669 options, so you cannot use it to check for the existence of a file in which to
19670 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19671 full list of the order in which preconditions are evaluated.) However, as
19672 these options are all expanded, you can use the &%exists%& expansion condition
19673 to make such tests. The &%require_files%& option is intended for checking files
19674 that the router may be going to use internally, or which are needed by a
19675 transport (e.g., &_.procmailrc_&).
19676
19677 During delivery, the &[stat()]& function is run as root, but there is a
19678 facility for some checking of the accessibility of a file by another user.
19679 This is not a proper permissions check, but just a &"rough"& check that
19680 operates as follows:
19681
19682 If an item in a &%require_files%& list does not contain any forward slash
19683 characters, it is taken to be the user (and optional group, separated by a
19684 comma) to be checked for subsequent files in the list. If no group is specified
19685 but the user is specified symbolically, the gid associated with the uid is
19686 used. For example:
19687 .code
19688 require_files = mail:/some/file
19689 require_files = $local_part_data:$home/.procmailrc
19690 .endd
19691 If a user or group name in a &%require_files%& list does not exist, the
19692 &%require_files%& condition fails.
19693
19694 Exim performs the check by scanning along the components of the file path, and
19695 checking the access for the given uid and gid. It checks for &"x"& access on
19696 directories, and &"r"& access on the final file. Note that this means that file
19697 access control lists, if the operating system has them, are ignored.
19698
19699 &*Warning 1*&: When the router is being run to verify addresses for an
19700 incoming SMTP message, Exim is not running as root, but under its own uid. This
19701 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19702 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19703 user is not permitted to read one of the directories on the file's path.
19704
19705 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19706 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19707 without root access. In this case, if a check for access by a particular user
19708 is requested, Exim creates a subprocess that runs as that user, and tries the
19709 check again in that process.
19710
19711 The default action for handling an unresolved EACCES is to consider it to
19712 be caused by a configuration error, and routing is deferred because the
19713 existence or non-existence of the file cannot be determined. However, in some
19714 circumstances it may be desirable to treat this condition as if the file did
19715 not exist. If the filename (or the exclamation mark that precedes the filename
19716 for non-existence) is preceded by a plus sign, the EACCES error is treated
19717 as if the file did not exist. For example:
19718 .code
19719 require_files = +/some/file
19720 .endd
19721 If the router is not an essential part of verification (for example, it
19722 handles users' &_.forward_& files), another solution is to set the &%verify%&
19723 option false so that the router is skipped when verifying.
19724
19725
19726
19727 .option retry_use_local_part routers boolean "see below"
19728 .cindex "hints database" "retry keys"
19729 .cindex "local part" "in retry keys"
19730 When a delivery suffers a temporary routing failure, a retry record is created
19731 in Exim's hints database. For addresses whose routing depends only on the
19732 domain, the key for the retry record should not involve the local part, but for
19733 other addresses, both the domain and the local part should be included.
19734 Usually, remote routing is of the former kind, and local routing is of the
19735 latter kind.
19736
19737 This option controls whether the local part is used to form the key for retry
19738 hints for addresses that suffer temporary errors while being handled by this
19739 router. The default value is true for any router that has any of
19740 &%check_local_user%&,
19741 &%local_parts%&,
19742 &%condition%&,
19743 &%local_part_prefix%&,
19744 &%local_part_suffix%&,
19745 &%senders%& or
19746 &%require_files%&
19747 set, and false otherwise. Note that this option does not apply to hints keys
19748 for transport delays; they are controlled by a generic transport option of the
19749 same name.
19750
19751 Failing to set this option when it is needed
19752 (because a remote router handles only some of the local-parts for a domain)
19753 can result in incorrect error messages being generated.
19754
19755 The setting of &%retry_use_local_part%& applies only to the router on which it
19756 appears. If the router generates child addresses, they are routed
19757 independently; this setting does not become attached to them.
19758
19759
19760
19761 .option router_home_directory routers string&!! unset
19762 .cindex "router" "home directory for"
19763 .cindex "home directory" "for router"
19764 .vindex "&$home$&"
19765 This option sets a home directory for use while the router is running. (Compare
19766 &%transport_home_directory%&, which sets a home directory for later
19767 transporting.) In particular, if used on a &(redirect)& router, this option
19768 sets a value for &$home$& while a filter is running. The value is expanded;
19769 forced expansion failure causes the option to be ignored &-- other failures
19770 cause the router to defer.
19771
19772 Expansion of &%router_home_directory%& happens immediately after the
19773 &%check_local_user%& test (if configured), before any further expansions take
19774 place.
19775 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19776 are evaluated.)
19777 While the router is running, &%router_home_directory%& overrides the value of
19778 &$home$& that came from &%check_local_user%&.
19779
19780 When a router accepts an address and assigns it to a local transport (including
19781 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19782 delivery), the home directory setting for the transport is taken from the first
19783 of these values that is set:
19784
19785 .ilist
19786 The &%home_directory%& option on the transport;
19787 .next
19788 The &%transport_home_directory%& option on the router;
19789 .next
19790 The password data if &%check_local_user%& is set on the router;
19791 .next
19792 The &%router_home_directory%& option on the router.
19793 .endlist
19794
19795 In other words, &%router_home_directory%& overrides the password data for the
19796 router, but not for the transport.
19797
19798
19799
19800 .option self routers string freeze
19801 .cindex "MX record" "pointing to local host"
19802 .cindex "local host" "MX pointing to"
19803 This option applies to those routers that use a recipient address to find a
19804 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19805 and &(manualroute)& routers.
19806 Certain configurations of the &(queryprogram)& router can also specify a list
19807 of remote hosts.
19808 Usually such routers are configured to send the message to a remote host via an
19809 &(smtp)& transport. The &%self%& option specifies what happens when the first
19810 host on the list turns out to be the local host.
19811 The way in which Exim checks for the local host is described in section
19812 &<<SECTreclocipadd>>&.
19813
19814 Normally this situation indicates either an error in Exim's configuration (for
19815 example, the router should be configured not to process this domain), or an
19816 error in the DNS (for example, the MX should not point to this host). For this
19817 reason, the default action is to log the incident, defer the address, and
19818 freeze the message. The following alternatives are provided for use in special
19819 cases:
19820
19821 .vlist
19822 .vitem &%defer%&
19823 Delivery of the message is tried again later, but the message is not frozen.
19824
19825 .vitem "&%reroute%&: <&'domain'&>"
19826 The domain is changed to the given domain, and the address is passed back to
19827 be reprocessed by the routers. No rewriting of headers takes place. This
19828 behaviour is essentially a redirection.
19829
19830 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19831 The domain is changed to the given domain, and the address is passed back to be
19832 reprocessed by the routers. Any headers that contain the original domain are
19833 rewritten.
19834
19835 .vitem &%pass%&
19836 .oindex "&%more%&"
19837 .vindex "&$self_hostname$&"
19838 The router passes the address to the next router, or to the router named in the
19839 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19840 subsequent routing and delivery, the variable &$self_hostname$& contains the
19841 name of the local host that the router encountered. This can be used to
19842 distinguish between different cases for hosts with multiple names. The
19843 combination
19844 .code
19845 self = pass
19846 no_more
19847 .endd
19848 ensures that only those addresses that routed to the local host are passed on.
19849 Without &%no_more%&, addresses that were declined for other reasons would also
19850 be passed to the next router.
19851
19852 .vitem &%fail%&
19853 Delivery fails and an error report is generated.
19854
19855 .vitem &%send%&
19856 .cindex "local host" "sending to"
19857 The anomaly is ignored and the address is queued for the transport. This
19858 setting should be used with extreme caution. For an &(smtp)& transport, it
19859 makes sense only in cases where the program that is listening on the SMTP port
19860 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19861 different configuration file that handles the domain in another way.
19862 .endlist
19863
19864
19865
19866 .option senders routers&!? "address list&!!" unset
19867 .cindex "router" "checking senders"
19868 If this option is set, the router is skipped unless the message's sender
19869 address matches something on the list.
19870 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19871 are evaluated.
19872
19873 There are issues concerning verification when the running of routers is
19874 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19875 setting, it sets the sender to the null string. When using the &%-bt%& option
19876 to check a configuration file, it is necessary also to use the &%-f%& option to
19877 set an appropriate sender. For incoming mail, the sender is unset when
19878 verifying the sender, but is available when verifying any recipients. If the
19879 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19880 matters.
19881
19882
19883 .option set routers "string list" unset
19884 .cindex router variables
19885 This option may be used multiple times on a router;
19886 because of this the list aspect is mostly irrelevant.
19887 The list separator is a semicolon but can be changed in the
19888 usual way.
19889
19890 Each list-element given must be of the form &"name = value"&
19891 and the names used must start with the string &"r_"&.
19892 Values containing a list-separator should have them doubled.
19893 When a router runs, the strings are evaluated in order,
19894 to create variables which are added to the set associated with
19895 the address.
19896 This is done immediately after all the preconditions, before the
19897 evaluation of the &%address_data%& option.
19898 The variable is set with the expansion of the value.
19899 The variables can be used by the router options
19900 (not including any preconditions)
19901 and by the transport.
19902 Later definitions of a given named variable will override former ones.
19903 Variable use is via the usual &$r_...$& syntax.
19904
19905 This is similar to the &%address_data%& option, except that
19906 many independent variables can be used, with choice of naming.
19907
19908
19909 .option translate_ip_address routers string&!! unset
19910 .cindex "IP address" "translating"
19911 .cindex "packet radio"
19912 .cindex "router" "IP address translation"
19913 There exist some rare networking situations (for example, packet radio) where
19914 it is helpful to be able to translate IP addresses generated by normal routing
19915 mechanisms into other IP addresses, thus performing a kind of manual IP
19916 routing. This should be done only if the normal IP routing of the TCP/IP stack
19917 is inadequate or broken. Because this is an extremely uncommon requirement, the
19918 code to support this option is not included in the Exim binary unless
19919 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19920
19921 .vindex "&$host_address$&"
19922 The &%translate_ip_address%& string is expanded for every IP address generated
19923 by the router, with the generated address set in &$host_address$&. If the
19924 expansion is forced to fail, no action is taken.
19925 For any other expansion error, delivery of the message is deferred.
19926 If the result of the expansion is an IP address, that replaces the original
19927 address; otherwise the result is assumed to be a host name &-- this is looked
19928 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19929 produce one or more replacement IP addresses. For example, to subvert all IP
19930 addresses in some specific networks, this could be added to a router:
19931 .code
19932 translate_ip_address = \
19933   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19934     {$value}fail}}
19935 .endd
19936 The file would contain lines like
19937 .code
19938 10.2.3.128/26    some.host
19939 10.8.4.34/26     10.44.8.15
19940 .endd
19941 You should not make use of this facility unless you really understand what you
19942 are doing.
19943
19944
19945
19946 .option transport routers string&!! unset
19947 This option specifies the transport to be used when a router accepts an address
19948 and sets it up for delivery. A transport is never needed if a router is used
19949 only for verification. The value of the option is expanded at routing time,
19950 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19951 and result must be the name of one of the configured transports. If it is not,
19952 delivery is deferred.
19953
19954 The &%transport%& option is not used by the &(redirect)& router, but it does
19955 have some private options that set up transports for pipe and file deliveries
19956 (see chapter &<<CHAPredirect>>&).
19957
19958
19959
19960 .option transport_current_directory routers string&!! unset
19961 .cindex "current directory for local transport"
19962 This option associates a current directory with any address that is routed
19963 to a local transport. This can happen either because a transport is
19964 explicitly configured for the router, or because it generates a delivery to a
19965 file or a pipe. During the delivery process (that is, at transport time), this
19966 option string is expanded and is set as the current directory, unless
19967 overridden by a setting on the transport.
19968 If the expansion fails for any reason, including forced failure, an error is
19969 logged, and delivery is deferred.
19970 See chapter &<<CHAPenvironment>>& for details of the local delivery
19971 environment.
19972
19973
19974
19975
19976 .option transport_home_directory routers string&!! "see below"
19977 .cindex "home directory" "for local transport"
19978 This option associates a home directory with any address that is routed to a
19979 local transport. This can happen either because a transport is explicitly
19980 configured for the router, or because it generates a delivery to a file or a
19981 pipe. During the delivery process (that is, at transport time), the option
19982 string is expanded and is set as the home directory, unless overridden by a
19983 setting of &%home_directory%& on the transport.
19984 If the expansion fails for any reason, including forced failure, an error is
19985 logged, and delivery is deferred.
19986
19987 If the transport does not specify a home directory, and
19988 &%transport_home_directory%& is not set for the router, the home directory for
19989 the transport is taken from the password data if &%check_local_user%& is set for
19990 the router. Otherwise it is taken from &%router_home_directory%& if that option
19991 is set; if not, no home directory is set for the transport.
19992
19993 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19994 environment.
19995
19996
19997
19998
19999 .option unseen routers boolean&!! false
20000 .cindex "router" "carrying on after success"
20001 The result of string expansion for this option must be a valid boolean value,
20002 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
20003 result causes an error, and delivery is deferred. If the expansion is forced to
20004 fail, the default value for the option (false) is used. Other failures cause
20005 delivery to be deferred.
20006
20007 When this option is set true, routing does not cease if the router accepts the
20008 address. Instead, a copy of the incoming address is passed to the next router,
20009 overriding a false setting of &%more%&. There is little point in setting
20010 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
20011 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20012 sometimes true and sometimes false).
20013
20014 .cindex "copy of message (&%unseen%& option)"
20015 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20016 qualifier in filter files. It can be used to cause copies of messages to be
20017 delivered to some other destination, while also carrying out a normal delivery.
20018 In effect, the current address is made into a &"parent"& that has two children
20019 &-- one that is delivered as specified by this router, and a clone that goes on
20020 to be routed further. For this reason, &%unseen%& may not be combined with the
20021 &%one_time%& option in a &(redirect)& router.
20022
20023 &*Warning*&: Header lines added to the address (or specified for removal) by
20024 this router or by previous routers affect the &"unseen"& copy of the message
20025 only. The clone that continues to be processed by further routers starts with
20026 no added headers and none specified for removal. For a &%redirect%& router, if
20027 a generated address is the same as the incoming address, this can lead to
20028 duplicate addresses with different header modifications. Exim does not do
20029 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20030 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20031 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20032 &%redirect%& router may be of help.
20033
20034 Unlike the handling of header modifications, any data that was set by the
20035 &%address_data%& option in the current or previous routers &'is'& passed on to
20036 subsequent routers.
20037
20038
20039 .option user routers string&!! "see below"
20040 .cindex "uid (user id)" "local delivery"
20041 .cindex "local transports" "uid and gid"
20042 .cindex "transport" "local"
20043 .cindex "router" "user for filter processing"
20044 .cindex "filter" "user for processing"
20045 When a router queues an address for a transport, and the transport does not
20046 specify a user, the user given here is used when running the delivery process.
20047 The user may be specified numerically or by name. If expansion fails, the
20048 error is logged and delivery is deferred.
20049 This user is also used by the &(redirect)& router when running a filter file.
20050 The default is unset, except when &%check_local_user%& is set. In this case,
20051 the default is taken from the password information. If the user is specified as
20052 a name, and &%group%& is not set, the group associated with the user is used.
20053 See also &%initgroups%& and &%group%& and the discussion in chapter
20054 &<<CHAPenvironment>>&.
20055
20056
20057
20058 .option verify routers&!? boolean true
20059 Setting this option has the effect of setting &%verify_sender%& and
20060 &%verify_recipient%& to the same value.
20061
20062
20063 .option verify_only routers&!? boolean false
20064 .cindex "EXPN" "with &%verify_only%&"
20065 .oindex "&%-bv%&"
20066 .cindex "router" "used only when verifying"
20067 If this option is set, the router is used only when verifying an address,
20068 delivering in cutthrough mode or
20069 testing with the &%-bv%& option, not when actually doing a delivery, testing
20070 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20071 restricted to verifying only senders or recipients by means of
20072 &%verify_sender%& and &%verify_recipient%&.
20073
20074 &*Warning*&: When the router is being run to verify addresses for an incoming
20075 SMTP message, Exim is not running as root, but under its own uid. If the router
20076 accesses any files, you need to make sure that they are accessible to the Exim
20077 user or group.
20078
20079
20080 .option verify_recipient routers&!? boolean true
20081 If this option is false, the router is skipped when verifying recipient
20082 addresses,
20083 delivering in cutthrough mode
20084 or testing recipient verification using &%-bv%&.
20085 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20086 are evaluated.
20087 See also the &$verify_mode$& variable.
20088
20089
20090 .option verify_sender routers&!? boolean true
20091 If this option is false, the router is skipped when verifying sender addresses
20092 or testing sender verification using &%-bvs%&.
20093 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20094 are evaluated.
20095 See also the &$verify_mode$& variable.
20096 .ecindex IIDgenoprou1
20097 .ecindex IIDgenoprou2
20098
20099
20100
20101
20102
20103
20104 . ////////////////////////////////////////////////////////////////////////////
20105 . ////////////////////////////////////////////////////////////////////////////
20106
20107 .chapter "The accept router" "CHID4"
20108 .cindex "&(accept)& router"
20109 .cindex "routers" "&(accept)&"
20110 The &(accept)& router has no private options of its own. Unless it is being
20111 used purely for verification (see &%verify_only%&) a transport is required to
20112 be defined by the generic &%transport%& option. If the preconditions that are
20113 specified by generic options are met, the router accepts the address and queues
20114 it for the given transport. The most common use of this router is for setting
20115 up deliveries to local mailboxes. For example:
20116 .code
20117 localusers:
20118   driver = accept
20119   domains = mydomain.example
20120   check_local_user
20121   transport = local_delivery
20122 .endd
20123 The &%domains%& condition in this example checks the domain of the address, and
20124 &%check_local_user%& checks that the local part is the login of a local user.
20125 When both preconditions are met, the &(accept)& router runs, and queues the
20126 address for the &(local_delivery)& transport.
20127
20128
20129
20130
20131
20132
20133 . ////////////////////////////////////////////////////////////////////////////
20134 . ////////////////////////////////////////////////////////////////////////////
20135
20136 .chapter "The dnslookup router" "CHAPdnslookup"
20137 .scindex IIDdnsrou1 "&(dnslookup)& router"
20138 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20139 The &(dnslookup)& router looks up the hosts that handle mail for the
20140 recipient's domain in the DNS. A transport must always be set for this router,
20141 unless &%verify_only%& is set.
20142
20143 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20144 SRV records. If none are found, or if SRV support is not configured,
20145 MX records are looked up. If no MX records exist, address records are sought.
20146 However, &%mx_domains%& can be set to disable the direct use of address
20147 records.
20148
20149 MX records of equal priority are sorted by Exim into a random order. Exim then
20150 looks for address records for the host names obtained from MX or SRV records.
20151 When a host has more than one IP address, they are sorted into a random order,
20152 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20153 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20154 generic option, the router declines.
20155
20156 Unless they have the highest priority (lowest MX value), MX records that point
20157 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20158 are discarded, together with any other MX records of equal or lower priority.
20159
20160 .cindex "MX record" "pointing to local host"
20161 .cindex "local host" "MX pointing to"
20162 .oindex "&%self%&" "in &(dnslookup)& router"
20163 If the host pointed to by the highest priority MX record, or looked up as an
20164 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20165 happens is controlled by the generic &%self%& option.
20166
20167
20168 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20169 There have been problems with DNS servers when SRV records are looked up.
20170 Some misbehaving servers return a DNS error or timeout when a non-existent
20171 SRV record is sought. Similar problems have in the past been reported for
20172 MX records. The global &%dns_again_means_nonexist%& option can help with this
20173 problem, but it is heavy-handed because it is a global option.
20174
20175 For this reason, there are two options, &%srv_fail_domains%& and
20176 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20177 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20178 an attempt to look up an SRV or MX record causes one of these results, and the
20179 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20180 such record"&. In the case of an SRV lookup, this means that the router
20181 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20182 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20183 case routing fails.
20184
20185
20186 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20187 .cindex "&(dnslookup)& router" "declines"
20188 There are a few cases where a &(dnslookup)& router will decline to accept
20189 an address; if such a router is expected to handle "all remaining non-local
20190 domains", then it is important to set &%no_more%&.
20191
20192 The router will defer rather than decline if the domain
20193 is found in the &%fail_defer_domains%& router option.
20194
20195 Reasons for a &(dnslookup)& router to decline currently include:
20196 .ilist
20197 The domain does not exist in DNS
20198 .next
20199 The domain exists but the MX record's host part is just "."; this is a common
20200 convention (borrowed from SRV) used to indicate that there is no such service
20201 for this domain and to not fall back to trying A/AAAA records.
20202 .next
20203 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20204 .next
20205 MX record points to a non-existent host.
20206 .next
20207 MX record points to an IP address and the main section option
20208 &%allow_mx_to_ip%& is not set.
20209 .next
20210 MX records exist and point to valid hosts, but all hosts resolve only to
20211 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20212 .next
20213 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20214 &%dns_check_names_pattern%& for handling one variant of this)
20215 .next
20216 &%check_secondary_mx%& is set on this router but the local host can
20217 not be found in the MX records (see below)
20218 .endlist
20219
20220
20221
20222
20223 .section "Private options for dnslookup" "SECID118"
20224 .cindex "options" "&(dnslookup)& router"
20225 The private options for the &(dnslookup)& router are as follows:
20226
20227 .option check_secondary_mx dnslookup boolean false
20228 .cindex "MX record" "checking for secondary"
20229 If this option is set, the router declines unless the local host is found in
20230 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20231 process domains for which the local host is a secondary mail exchanger
20232 differently to other domains. The way in which Exim decides whether a host is
20233 the local host is described in section &<<SECTreclocipadd>>&.
20234
20235
20236 .option check_srv dnslookup string&!! unset
20237 .cindex "SRV record" "enabling use of"
20238 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20239 addition to MX and address records. The support is disabled by default. To
20240 enable SRV support, set the &%check_srv%& option to the name of the service
20241 required. For example,
20242 .code
20243 check_srv = smtp
20244 .endd
20245 looks for SRV records that refer to the normal smtp service. The option is
20246 expanded, so the service name can vary from message to message or address
20247 to address. This might be helpful if SRV records are being used for a
20248 submission service. If the expansion is forced to fail, the &%check_srv%&
20249 option is ignored, and the router proceeds to look for MX records in the
20250 normal way.
20251
20252 When the expansion succeeds, the router searches first for SRV records for
20253 the given service (it assumes TCP protocol). A single SRV record with a
20254 host name that consists of just a single dot indicates &"no such service for
20255 this domain"&; if this is encountered, the router declines. If other kinds of
20256 SRV record are found, they are used to construct a host list for delivery
20257 according to the rules of RFC 2782. MX records are not sought in this case.
20258
20259 When no SRV records are found, MX records (and address records) are sought in
20260 the traditional way. In other words, SRV records take precedence over MX
20261 records, just as MX records take precedence over address records. Note that
20262 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20263 defined it. It is apparently believed that MX records are sufficient for email
20264 and that SRV records should not be used for this purpose. However, SRV records
20265 have an additional &"weight"& feature which some people might find useful when
20266 trying to split an SMTP load between hosts of different power.
20267
20268 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20269 when there is a DNS lookup error.
20270
20271
20272
20273
20274 .option fail_defer_domains dnslookup "domain list&!!" unset
20275 .cindex "MX record" "not found"
20276 DNS lookups for domains matching &%fail_defer_domains%&
20277 which find no matching record will cause the router to defer
20278 rather than the default behaviour of decline.
20279 This maybe be useful for queueing messages for a newly created
20280 domain while the DNS configuration is not ready.
20281 However, it will result in any message with mistyped domains
20282 also being queued.
20283
20284
20285 .option ipv4_only "string&!!" unset
20286 .cindex IPv6 disabling
20287 .cindex DNS "IPv6 disabling"
20288 The string is expanded, and if the result is anything but a forced failure,
20289 or an empty string, or one of the strings “0” or “no” or “false”
20290 (checked without regard to the case of the letters),
20291 only A records are used.
20292
20293 .option ipv4_prefer "string&!!" unset
20294 .cindex IPv4 preference
20295 .cindex DNS "IPv4 preference"
20296 The string is expanded, and if the result is anything but a forced failure,
20297 or an empty string, or one of the strings “0” or “no” or “false”
20298 (checked without regard to the case of the letters),
20299 A records are sorted before AAAA records (inverting the default).
20300
20301 .option mx_domains dnslookup "domain list&!!" unset
20302 .cindex "MX record" "required to exist"
20303 .cindex "SRV record" "required to exist"
20304 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20305 record in order to be recognized. (The name of this option could be improved.)
20306 For example, if all the mail hosts in &'fict.example'& are known to have MX
20307 records, except for those in &'discworld.fict.example'&, you could use this
20308 setting:
20309 .code
20310 mx_domains = ! *.discworld.fict.example : *.fict.example
20311 .endd
20312 This specifies that messages addressed to a domain that matches the list but
20313 has no MX record should be bounced immediately instead of being routed using
20314 the address record.
20315
20316
20317 .option mx_fail_domains dnslookup "domain list&!!" unset
20318 If the DNS lookup for MX records for one of the domains in this list causes a
20319 DNS lookup error, Exim behaves as if no MX records were found. See section
20320 &<<SECTprowitdnsloo>>& for more discussion.
20321
20322
20323
20324
20325 .option qualify_single dnslookup boolean true
20326 .cindex "DNS" "resolver options"
20327 .cindex "DNS" "qualifying single-component names"
20328 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20329 lookups. Typically, but not standardly, this causes the resolver to qualify
20330 single-component names with the default domain. For example, on a machine
20331 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20332 &'thesaurus.ref.example'& inside the resolver. For details of what your
20333 resolver actually does, consult your man pages for &'resolver'& and
20334 &'resolv.conf'&.
20335
20336
20337
20338 .option rewrite_headers dnslookup boolean true
20339 .cindex "rewriting" "header lines"
20340 .cindex "header lines" "rewriting"
20341 If the domain name in the address that is being processed is not fully
20342 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20343 an address is specified as &'dormouse@teaparty'&, the domain might be
20344 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20345 occur as a result of setting the &%widen_domains%& option. If
20346 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20347 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20348 header lines of the message are rewritten with the full domain name.
20349
20350 This option should be turned off only when it is known that no message is
20351 ever going to be sent outside an environment where the abbreviation makes
20352 sense.
20353
20354 When an MX record is looked up in the DNS and matches a wildcard record, name
20355 servers normally return a record containing the name that has been looked up,
20356 making it impossible to detect whether a wildcard was present or not. However,
20357 some name servers have recently been seen to return the wildcard entry. If the
20358 name returned by a DNS lookup begins with an asterisk, it is not used for
20359 header rewriting.
20360
20361
20362 .option same_domain_copy_routing dnslookup boolean false
20363 .cindex "address" "copying routing"
20364 Addresses with the same domain are normally routed by the &(dnslookup)& router
20365 to the same list of hosts. However, this cannot be presumed, because the router
20366 options and preconditions may refer to the local part of the address. By
20367 default, therefore, Exim routes each address in a message independently. DNS
20368 servers run caches, so repeated DNS lookups are not normally expensive, and in
20369 any case, personal messages rarely have more than a few recipients.
20370
20371 If you are running mailing lists with large numbers of subscribers at the same
20372 domain, and you are using a &(dnslookup)& router which is independent of the
20373 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20374 lookups for identical domains in one message. In this case, when &(dnslookup)&
20375 routes an address to a remote transport, any other unrouted addresses in the
20376 message that have the same domain are automatically given the same routing
20377 without processing them independently,
20378 provided the following conditions are met:
20379
20380 .ilist
20381 No router that processed the address specified &%headers_add%& or
20382 &%headers_remove%&.
20383 .next
20384 The router did not change the address in any way, for example, by &"widening"&
20385 the domain.
20386 .endlist
20387
20388
20389
20390
20391 .option search_parents dnslookup boolean false
20392 .cindex "DNS" "resolver options"
20393 When this option is true, the resolver option RES_DNSRCH is set for DNS
20394 lookups. This is different from the &%qualify_single%& option in that it
20395 applies to domains containing dots. Typically, but not standardly, it causes
20396 the resolver to search for the name in the current domain and in parent
20397 domains. For example, on a machine in the &'fict.example'& domain, if looking
20398 up &'teaparty.wonderland'& failed, the resolver would try
20399 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20400 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20401
20402 Setting this option true can cause problems in domains that have a wildcard MX
20403 record, because any domain that does not have its own MX record matches the
20404 local wildcard.
20405
20406
20407
20408 .option srv_fail_domains dnslookup "domain list&!!" unset
20409 If the DNS lookup for SRV records for one of the domains in this list causes a
20410 DNS lookup error, Exim behaves as if no SRV records were found. See section
20411 &<<SECTprowitdnsloo>>& for more discussion.
20412
20413
20414
20415
20416 .option widen_domains dnslookup "string list" unset
20417 .cindex "domain" "partial; widening"
20418 If a DNS lookup fails and this option is set, each of its strings in turn is
20419 added onto the end of the domain, and the lookup is tried again. For example,
20420 if
20421 .code
20422 widen_domains = fict.example:ref.example
20423 .endd
20424 is set and a lookup of &'klingon.dictionary'& fails,
20425 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20426 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20427 and &%search_parents%& options can cause some widening to be undertaken inside
20428 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20429 when verifying, unless &%rewrite_headers%& is false (not the default).
20430
20431
20432 .section "Effect of qualify_single and search_parents" "SECID119"
20433 When a domain from an envelope recipient is changed by the resolver as a result
20434 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20435 corresponding address in the message's header lines unless &%rewrite_headers%&
20436 is set false. Exim then re-routes the address, using the full domain.
20437
20438 These two options affect only the DNS lookup that takes place inside the router
20439 for the domain of the address that is being routed. They do not affect lookups
20440 such as that implied by
20441 .code
20442 domains = @mx_any
20443 .endd
20444 that may happen while processing a router precondition before the router is
20445 entered. No widening ever takes place for these lookups.
20446 .ecindex IIDdnsrou1
20447 .ecindex IIDdnsrou2
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457 . ////////////////////////////////////////////////////////////////////////////
20458 . ////////////////////////////////////////////////////////////////////////////
20459
20460 .chapter "The ipliteral router" "CHID5"
20461 .cindex "&(ipliteral)& router"
20462 .cindex "domain literal" "routing"
20463 .cindex "routers" "&(ipliteral)&"
20464 This router has no private options. Unless it is being used purely for
20465 verification (see &%verify_only%&) a transport is required to be defined by the
20466 generic &%transport%& option. The router accepts the address if its domain part
20467 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20468 router handles the address
20469 .code
20470 root@[192.168.1.1]
20471 .endd
20472 by setting up delivery to the host with that IP address. IPv4 domain literals
20473 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20474 are similar, but the address is preceded by &`ipv6:`&. For example:
20475 .code
20476 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20477 .endd
20478 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20479 grounds that sooner or later somebody will try it.
20480
20481 .oindex "&%self%&" "in &(ipliteral)& router"
20482 If the IP address matches something in &%ignore_target_hosts%&, the router
20483 declines. If an IP literal turns out to refer to the local host, the generic
20484 &%self%& option determines what happens.
20485
20486 The RFCs require support for domain literals; however, their use is
20487 controversial in today's Internet. If you want to use this router, you must
20488 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20489 Exim will not recognize the domain literal syntax in addresses.
20490
20491
20492
20493 . ////////////////////////////////////////////////////////////////////////////
20494 . ////////////////////////////////////////////////////////////////////////////
20495
20496 .chapter "The iplookup router" "CHID6"
20497 .cindex "&(iplookup)& router"
20498 .cindex "routers" "&(iplookup)&"
20499 The &(iplookup)& router was written to fulfil a specific requirement in
20500 Cambridge University (which in fact no longer exists). For this reason, it is
20501 not included in the binary of Exim by default. If you want to include it, you
20502 must set
20503 .code
20504 ROUTER_IPLOOKUP=yes
20505 .endd
20506 in your &_Local/Makefile_& configuration file.
20507
20508 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20509 connection to one or more specific hosts. The host can then return the same or
20510 a different address &-- in effect rewriting the recipient address in the
20511 message's envelope. The new address is then passed on to subsequent routers. If
20512 this process fails, the address can be passed on to other routers, or delivery
20513 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20514 must not be specified for it.
20515
20516 .cindex "options" "&(iplookup)& router"
20517 .option hosts iplookup string unset
20518 This option must be supplied. Its value is a colon-separated list of host
20519 names. The hosts are looked up using &[gethostbyname()]&
20520 (or &[getipnodebyname()]& when available)
20521 and are tried in order until one responds to the query. If none respond, what
20522 happens is controlled by &%optional%&.
20523
20524
20525 .option optional iplookup boolean false
20526 If &%optional%& is true, if no response is obtained from any host, the address
20527 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20528 delivery to the address is deferred.
20529
20530
20531 .option port iplookup integer 0
20532 .cindex "port" "&(iplookup)& router"
20533 This option must be supplied. It specifies the port number for the TCP or UDP
20534 call.
20535
20536
20537 .option protocol iplookup string udp
20538 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20539 protocols is to be used.
20540
20541
20542 .option query iplookup string&!! "see below"
20543 This defines the content of the query that is sent to the remote hosts. The
20544 default value is:
20545 .code
20546 $local_part@$domain $local_part@$domain
20547 .endd
20548 The repetition serves as a way of checking that a response is to the correct
20549 query in the default case (see &%response_pattern%& below).
20550
20551
20552 .option reroute iplookup string&!! unset
20553 If this option is not set, the rerouted address is precisely the byte string
20554 returned by the remote host, up to the first white space, if any. If set, the
20555 string is expanded to form the rerouted address. It can include parts matched
20556 in the response by &%response_pattern%& by means of numeric variables such as
20557 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20558 whether or not a pattern is in use. In all cases, the rerouted address must end
20559 up in the form &'local_part@domain'&.
20560
20561
20562 .option response_pattern iplookup string unset
20563 This option can be set to a regular expression that is applied to the string
20564 returned from the remote host. If the pattern does not match the response, the
20565 router declines. If &%response_pattern%& is not set, no checking of the
20566 response is done, unless the query was defaulted, in which case there is a
20567 check that the text returned after the first white space is the original
20568 address. This checks that the answer that has been received is in response to
20569 the correct question. For example, if the response is just a new domain, the
20570 following could be used:
20571 .code
20572 response_pattern = ^([^@]+)$
20573 reroute = $local_part@$1
20574 .endd
20575
20576 .option timeout iplookup time 5s
20577 This specifies the amount of time to wait for a response from the remote
20578 machine. The same timeout is used for the &[connect()]& function for a TCP
20579 call. It does not apply to UDP.
20580
20581
20582
20583
20584 . ////////////////////////////////////////////////////////////////////////////
20585 . ////////////////////////////////////////////////////////////////////////////
20586
20587 .chapter "The manualroute router" "CHID7"
20588 .scindex IIDmanrou1 "&(manualroute)& router"
20589 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20590 .cindex "domain" "manually routing"
20591 The &(manualroute)& router is so-called because it provides a way of manually
20592 routing an address according to its domain. It is mainly used when you want to
20593 route addresses to remote hosts according to your own rules, bypassing the
20594 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20595 route to local transports, a facility that may be useful if you want to save
20596 messages for dial-in hosts in local files.
20597
20598 The &(manualroute)& router compares a list of domain patterns with the domain
20599 it is trying to route. If there is no match, the router declines. Each pattern
20600 has associated with it a list of hosts and some other optional data, which may
20601 include a transport. The combination of a pattern and its data is called a
20602 &"routing rule"&. For patterns that do not have an associated transport, the
20603 generic &%transport%& option must specify a transport, unless the router is
20604 being used purely for verification (see &%verify_only%&).
20605
20606 .vindex "&$host$&"
20607 In the case of verification, matching the domain pattern is sufficient for the
20608 router to accept the address. When actually routing an address for delivery,
20609 an address that matches a domain pattern is queued for the associated
20610 transport. If the transport is not a local one, a host list must be associated
20611 with the pattern; IP addresses are looked up for the hosts, and these are
20612 passed to the transport along with the mail address. For local transports, a
20613 host list is optional. If it is present, it is passed in &$host$& as a single
20614 text string.
20615
20616 The list of routing rules can be provided as an inline string in
20617 &%route_list%&, or the data can be obtained by looking up the domain in a file
20618 or database by setting &%route_data%&. Only one of these settings may appear in
20619 any one instance of &(manualroute)&. The format of routing rules is described
20620 below, following the list of private options.
20621
20622
20623 .section "Private options for manualroute" "SECTprioptman"
20624
20625 .cindex "options" "&(manualroute)& router"
20626 The private options for the &(manualroute)& router are as follows:
20627
20628 .option host_all_ignored manualroute string defer
20629 See &%host_find_failed%&.
20630
20631 .option host_find_failed manualroute string freeze
20632 This option controls what happens when &(manualroute)& tries to find an IP
20633 address for a host, and the host does not exist. The option can be set to one
20634 of the following values:
20635 .code
20636 decline
20637 defer
20638 fail
20639 freeze
20640 ignore
20641 pass
20642 .endd
20643 The default (&"freeze"&) assumes that this state is a serious configuration
20644 error. The difference between &"pass"& and &"decline"& is that the former
20645 forces the address to be passed to the next router (or the router defined by
20646 &%pass_router%&),
20647 .oindex "&%more%&"
20648 overriding &%no_more%&, whereas the latter passes the address to the next
20649 router only if &%more%& is true.
20650
20651 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20652 cannot be found. If all the hosts in the list are ignored, the behaviour is
20653 controlled by the &%host_all_ignored%& option. This takes the same values
20654 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20655
20656 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20657 state; if a host lookup gets a temporary error, delivery is deferred unless the
20658 generic &%pass_on_timeout%& option is set.
20659
20660
20661 .option hosts_randomize manualroute boolean false
20662 .cindex "randomized host list"
20663 .cindex "host" "list of; randomized"
20664 If this option is set, the order of the items in a host list in a routing rule
20665 is randomized each time the list is used, unless an option in the routing rule
20666 overrides (see below). Randomizing the order of a host list can be used to do
20667 crude load sharing. However, if more than one mail address is routed by the
20668 same router to the same host list, the host lists are considered to be the same
20669 (even though they may be randomized into different orders) for the purpose of
20670 deciding whether to batch the deliveries into a single SMTP transaction.
20671
20672 When &%hosts_randomize%& is true, a host list may be split
20673 into groups whose order is separately randomized. This makes it possible to
20674 set up MX-like behaviour. The boundaries between groups are indicated by an
20675 item that is just &`+`& in the host list. For example:
20676 .code
20677 route_list = * host1:host2:host3:+:host4:host5
20678 .endd
20679 The order of the first three hosts and the order of the last two hosts is
20680 randomized for each use, but the first three always end up before the last two.
20681 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20682 randomized host list is passed to an &(smtp)& transport that also has
20683 &%hosts_randomize set%&, the list is not re-randomized.
20684
20685
20686 .option route_data manualroute string&!! unset
20687 If this option is set, it must expand to yield the data part of a routing rule.
20688 Typically, the expansion string includes a lookup based on the domain. For
20689 example:
20690 .code
20691 route_data = ${lookup{$domain}dbm{/etc/routes}}
20692 .endd
20693 If the expansion is forced to fail, or the result is an empty string, the
20694 router declines. Other kinds of expansion failure cause delivery to be
20695 deferred.
20696
20697
20698 .option route_list manualroute "string list" unset
20699 This string is a list of routing rules, in the form defined below. Note that,
20700 unlike most string lists, the items are separated by semicolons. This is so
20701 that they may contain colon-separated host lists.
20702
20703
20704 .option same_domain_copy_routing manualroute boolean false
20705 .cindex "address" "copying routing"
20706 Addresses with the same domain are normally routed by the &(manualroute)&
20707 router to the same list of hosts. However, this cannot be presumed, because the
20708 router options and preconditions may refer to the local part of the address. By
20709 default, therefore, Exim routes each address in a message independently. DNS
20710 servers run caches, so repeated DNS lookups are not normally expensive, and in
20711 any case, personal messages rarely have more than a few recipients.
20712
20713 If you are running mailing lists with large numbers of subscribers at the same
20714 domain, and you are using a &(manualroute)& router which is independent of the
20715 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20716 lookups for identical domains in one message. In this case, when
20717 &(manualroute)& routes an address to a remote transport, any other unrouted
20718 addresses in the message that have the same domain are automatically given the
20719 same routing without processing them independently. However, this is only done
20720 if &%headers_add%& and &%headers_remove%& are unset.
20721
20722
20723
20724
20725 .section "Routing rules in route_list" "SECID120"
20726 The value of &%route_list%& is a string consisting of a sequence of routing
20727 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20728 entered as two semicolons. Alternatively, the list separator can be changed as
20729 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20730 Empty rules are ignored. The format of each rule is
20731 .display
20732 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20733 .endd
20734 The following example contains two rules, each with a simple domain pattern and
20735 no options:
20736 .code
20737 route_list = \
20738   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20739   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20740 .endd
20741 The three parts of a rule are separated by white space. The pattern and the
20742 list of hosts can be enclosed in quotes if necessary, and if they are, the
20743 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20744 single domain pattern, which is the only mandatory item in the rule. The
20745 pattern is in the same format as one item in a domain list (see section
20746 &<<SECTdomainlist>>&),
20747 except that it may not be the name of an interpolated file.
20748 That is, it may be wildcarded, or a regular expression, or a file or database
20749 lookup (with semicolons doubled, because of the use of semicolon as a separator
20750 in a &%route_list%&).
20751
20752 The rules in &%route_list%& are searched in order until one of the patterns
20753 matches the domain that is being routed. The list of hosts and then options are
20754 then used as described below. If there is no match, the router declines. When
20755 &%route_list%& is set, &%route_data%& must not be set.
20756
20757
20758
20759 .section "Routing rules in route_data" "SECID121"
20760 The use of &%route_list%& is convenient when there are only a small number of
20761 routing rules. For larger numbers, it is easier to use a file or database to
20762 hold the routing information, and use the &%route_data%& option instead.
20763 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20764 Most commonly, &%route_data%& is set as a string that contains an
20765 expansion lookup. For example, suppose we place two routing rules in a file
20766 like this:
20767 .code
20768 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20769 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20770 .endd
20771 This data can be accessed by setting
20772 .code
20773 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20774 .endd
20775 Failure of the lookup results in an empty string, causing the router to
20776 decline. However, you do not have to use a lookup in &%route_data%&. The only
20777 requirement is that the result of expanding the string is a list of hosts,
20778 possibly followed by options, separated by white space. The list of hosts must
20779 be enclosed in quotes if it contains white space.
20780
20781
20782
20783
20784 .section "Format of the list of hosts" "SECID122"
20785 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20786 always separately expanded before use. If the expansion fails, the router
20787 declines. The result of the expansion must be a colon-separated list of names
20788 and/or IP addresses, optionally also including ports.
20789 If the list is written with spaces, it must be protected with quotes.
20790 The format of each item
20791 in the list is described in the next section. The list separator can be changed
20792 as described in section &<<SECTlistsepchange>>&.
20793
20794 If the list of hosts was obtained from a &%route_list%& item, the following
20795 variables are set during its expansion:
20796
20797 .ilist
20798 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20799 If the domain was matched against a regular expression, the numeric variables
20800 &$1$&, &$2$&, etc. may be set. For example:
20801 .code
20802 route_list = ^domain(\d+)   host-$1.text.example
20803 .endd
20804 .next
20805 &$0$& is always set to the entire domain.
20806 .next
20807 &$1$& is also set when partial matching is done in a file lookup.
20808
20809 .next
20810 .vindex "&$value$&"
20811 If the pattern that matched the domain was a lookup item, the data that was
20812 looked up is available in the expansion variable &$value$&. For example:
20813 .code
20814 route_list = lsearch;;/some/file.routes  $value
20815 .endd
20816 .endlist
20817
20818 Note the doubling of the semicolon in the pattern that is necessary because
20819 semicolon is the default route list separator.
20820
20821
20822
20823 .section "Format of one host item" "SECTformatonehostitem"
20824 Each item in the list of hosts can be either a host name or an IP address,
20825 optionally with an attached port number, or it can be a single "+"
20826 (see &%hosts_randomize%&).
20827 When no port is given, an IP address
20828 is not enclosed in brackets. When a port is specified, it overrides the port
20829 specification on the transport. The port is separated from the name or address
20830 by a colon. This leads to some complications:
20831
20832 .ilist
20833 Because colon is the default separator for the list of hosts, either
20834 the colon that specifies a port must be doubled, or the list separator must
20835 be changed. The following two examples have the same effect:
20836 .code
20837 route_list = * "host1.tld::1225 : host2.tld::1226"
20838 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20839 .endd
20840 .next
20841 When IPv6 addresses are involved, it gets worse, because they contain
20842 colons of their own. To make this case easier, it is permitted to
20843 enclose an IP address (either v4 or v6) in square brackets if a port
20844 number follows. For example:
20845 .code
20846 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20847 .endd
20848 .endlist
20849
20850 .section "How the list of hosts is used" "SECThostshowused"
20851 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20852 the hosts is tried, in the order specified, when carrying out the SMTP
20853 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20854 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20855 transport.
20856
20857 Hosts may be listed by name or by IP address. An unadorned name in the list of
20858 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20859 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20860 records in the DNS. For example:
20861 .code
20862 route_list = *  x.y.z:p.q.r/MX:e.f.g
20863 .endd
20864 If this feature is used with a port specifier, the port must come last. For
20865 example:
20866 .code
20867 route_list = *  dom1.tld/mx::1225
20868 .endd
20869 If the &%hosts_randomize%& option is set, the order of the items in the list is
20870 randomized before any lookups are done. Exim then scans the list; for any name
20871 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20872 be an interface on the local host and the item is not the first in the list,
20873 Exim discards it and any subsequent items. If it is the first item, what
20874 happens is controlled by the
20875 .oindex "&%self%&" "in &(manualroute)& router"
20876 &%self%& option of the router.
20877
20878 A name on the list that is followed by &`/MX`& is replaced with the list of
20879 hosts obtained by looking up MX records for the name. This is always a DNS
20880 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20881 below) are not relevant here. The order of these hosts is determined by the
20882 preference values in the MX records, according to the usual rules. Because
20883 randomizing happens before the MX lookup, it does not affect the order that is
20884 defined by MX preferences.
20885
20886 If the local host is present in the sublist obtained from MX records, but is
20887 not the most preferred host in that list, it and any equally or less
20888 preferred hosts are removed before the sublist is inserted into the main list.
20889
20890 If the local host is the most preferred host in the MX list, what happens
20891 depends on where in the original list of hosts the &`/MX`& item appears. If it
20892 is not the first item (that is, there are previous hosts in the main list),
20893 Exim discards this name and any subsequent items in the main list.
20894
20895 If the MX item is first in the list of hosts, and the local host is the
20896 most preferred host, what happens is controlled by the &%self%& option of the
20897 router.
20898
20899 DNS failures when lookup up the MX records are treated in the same way as DNS
20900 failures when looking up IP addresses: &%pass_on_timeout%& and
20901 &%host_find_failed%& are used when relevant.
20902
20903 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20904 whether obtained from an MX lookup or not.
20905
20906
20907
20908 .section "How the options are used" "SECThowoptused"
20909 The options are a sequence of words, space-separated.
20910 One of the words can be the name of a transport; this overrides the
20911 &%transport%& option on the router for this particular routing rule only. The
20912 other words (if present) control randomization of the list of hosts on a
20913 per-rule basis, and how the IP addresses of the hosts are to be found when
20914 routing to a remote transport. These options are as follows:
20915
20916 .ilist
20917 &%randomize%&: randomize the order of the hosts in this list, overriding the
20918 setting of &%hosts_randomize%& for this routing rule only.
20919 .next
20920 &%no_randomize%&: do not randomize the order of the hosts in this list,
20921 overriding the setting of &%hosts_randomize%& for this routing rule only.
20922 .next
20923 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20924 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20925 also look in &_/etc/hosts_& or other sources of information.
20926 .next
20927 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20928 no address records are found. If there is a temporary DNS error (such as a
20929 timeout), delivery is deferred.
20930 .next
20931 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20932 .next
20933 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20934 .endlist
20935
20936 For example:
20937 .code
20938 route_list = domain1  host1:host2:host3  randomize bydns;\
20939              domain2  host4:host5
20940 .endd
20941 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20942 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20943 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20944 or &[gethostbyname()]&, and the result of the lookup is the result of that
20945 call.
20946
20947 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20948 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20949 instead of TRY_AGAIN. That is why the default action is to try a DNS
20950 lookup first. Only if that gives a definite &"no such host"& is the local
20951 function called.
20952
20953 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20954 inadvertent constraint that a transport name as an option had to be the last
20955 option specified.
20956
20957
20958
20959 If no IP address for a host can be found, what happens is controlled by the
20960 &%host_find_failed%& option.
20961
20962 .vindex "&$host$&"
20963 When an address is routed to a local transport, IP addresses are not looked up.
20964 The host list is passed to the transport in the &$host$& variable.
20965
20966
20967
20968 .section "Manualroute examples" "SECID123"
20969 In some of the examples that follow, the presence of the &%remote_smtp%&
20970 transport, as defined in the default configuration file, is assumed:
20971
20972 .ilist
20973 .cindex "smart host" "example router"
20974 The &(manualroute)& router can be used to forward all external mail to a
20975 &'smart host'&. If you have set up, in the main part of the configuration, a
20976 named domain list that contains your local domains, for example:
20977 .code
20978 domainlist local_domains = my.domain.example
20979 .endd
20980 You can arrange for all other domains to be routed to a smart host by making
20981 your first router something like this:
20982 .code
20983 smart_route:
20984   driver = manualroute
20985   domains = !+local_domains
20986   transport = remote_smtp
20987   route_list = * smarthost.ref.example
20988 .endd
20989 This causes all non-local addresses to be sent to the single host
20990 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20991 they are tried in order
20992 (but you can use &%hosts_randomize%& to vary the order each time).
20993 Another way of configuring the same thing is this:
20994 .code
20995 smart_route:
20996   driver = manualroute
20997   transport = remote_smtp
20998   route_list = !+local_domains  smarthost.ref.example
20999 .endd
21000 There is no difference in behaviour between these two routers as they stand.
21001 However, they behave differently if &%no_more%& is added to them. In the first
21002 example, the router is skipped if the domain does not match the &%domains%&
21003 precondition; the following router is always tried. If the router runs, it
21004 always matches the domain and so can never decline. Therefore, &%no_more%&
21005 would have no effect. In the second case, the router is never skipped; it
21006 always runs. However, if it doesn't match the domain, it declines. In this case
21007 &%no_more%& would prevent subsequent routers from running.
21008
21009 .next
21010 .cindex "mail hub example"
21011 A &'mail hub'& is a host which receives mail for a number of domains via MX
21012 records in the DNS and delivers it via its own private routing mechanism. Often
21013 the final destinations are behind a firewall, with the mail hub being the one
21014 machine that can connect to machines both inside and outside the firewall. The
21015 &(manualroute)& router is usually used on a mail hub to route incoming messages
21016 to the correct hosts. For a small number of domains, the routing can be inline,
21017 using the &%route_list%& option, but for a larger number a file or database
21018 lookup is easier to manage.
21019
21020 If the domain names are in fact the names of the machines to which the mail is
21021 to be sent by the mail hub, the configuration can be quite simple. For
21022 example:
21023 .code
21024 hub_route:
21025   driver = manualroute
21026   transport = remote_smtp
21027   route_list = *.rhodes.tvs.example  $domain
21028 .endd
21029 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21030 whose names are the same as the mail domains. A similar approach can be taken
21031 if the host name can be obtained from the domain name by a string manipulation
21032 that the expansion facilities can handle. Otherwise, a lookup based on the
21033 domain can be used to find the host:
21034 .code
21035 through_firewall:
21036   driver = manualroute
21037   transport = remote_smtp
21038   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21039 .endd
21040 The result of the lookup must be the name or IP address of the host (or
21041 hosts) to which the address is to be routed. If the lookup fails, the route
21042 data is empty, causing the router to decline. The address then passes to the
21043 next router.
21044
21045 .next
21046 .cindex "batched SMTP output example"
21047 .cindex "SMTP" "batched outgoing; example"
21048 You can use &(manualroute)& to deliver messages to pipes or files in batched
21049 SMTP format for onward transportation by some other means. This is one way of
21050 storing mail for a dial-up host when it is not connected. The route list entry
21051 can be as simple as a single domain name in a configuration like this:
21052 .code
21053 save_in_file:
21054   driver = manualroute
21055   transport = batchsmtp_appendfile
21056   route_list = saved.domain.example
21057 .endd
21058 though often a pattern is used to pick up more than one domain. If there are
21059 several domains or groups of domains with different transport requirements,
21060 different transports can be listed in the routing information:
21061 .code
21062 save_in_file:
21063   driver = manualroute
21064   route_list = \
21065     *.saved.domain1.example  $domain  batch_appendfile; \
21066     *.saved.domain2.example  \
21067       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21068       batch_pipe
21069 .endd
21070 .vindex "&$domain$&"
21071 .vindex "&$host$&"
21072 The first of these just passes the domain in the &$host$& variable, which
21073 doesn't achieve much (since it is also in &$domain$&), but the second does a
21074 file lookup to find a value to pass, causing the router to decline to handle
21075 the address if the lookup fails.
21076
21077 .next
21078 .cindex "UUCP" "example of router for"
21079 Routing mail directly to UUCP software is a specific case of the use of
21080 &(manualroute)& in a gateway to another mail environment. This is an example of
21081 one way it can be done:
21082 .code
21083 # Transport
21084 uucp:
21085   driver = pipe
21086   user = nobody
21087   command = /usr/local/bin/uux -r - \
21088     ${substr_-5:$host}!rmail ${local_part}
21089   return_fail_output = true
21090
21091 # Router
21092 uucphost:
21093   transport = uucp
21094   driver = manualroute
21095   route_data = \
21096     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21097 .endd
21098 The file &_/usr/local/exim/uucphosts_& contains entries like
21099 .code
21100 darksite.ethereal.example:           darksite.UUCP
21101 .endd
21102 It can be set up more simply without adding and removing &".UUCP"& but this way
21103 makes clear the distinction between the domain name
21104 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21105 .endlist
21106 .ecindex IIDmanrou1
21107 .ecindex IIDmanrou2
21108
21109
21110
21111
21112
21113
21114
21115
21116 . ////////////////////////////////////////////////////////////////////////////
21117 . ////////////////////////////////////////////////////////////////////////////
21118
21119 .chapter "The queryprogram router" "CHAPdriverlast"
21120 .scindex IIDquerou1 "&(queryprogram)& router"
21121 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21122 .cindex "routing" "by external program"
21123 The &(queryprogram)& router routes an address by running an external command
21124 and acting on its output. This is an expensive way to route, and is intended
21125 mainly for use in lightly-loaded systems, or for performing experiments.
21126 However, if it is possible to use the precondition options (&%domains%&,
21127 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21128 be used in special cases, even on a busy host. There are the following private
21129 options:
21130 .cindex "options" "&(queryprogram)& router"
21131
21132 .option command queryprogram string&!! unset
21133 This option must be set. It specifies the command that is to be run. The
21134 command is split up into a command name and arguments, and then each is
21135 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21136 &<<CHAPpipetransport>>&).
21137
21138
21139 .option command_group queryprogram string unset
21140 .cindex "gid (group id)" "in &(queryprogram)& router"
21141 This option specifies a gid to be set when running the command while routing an
21142 address for deliver. It must be set if &%command_user%& specifies a numerical
21143 uid. If it begins with a digit, it is interpreted as the numerical value of the
21144 gid. Otherwise it is looked up using &[getgrnam()]&.
21145
21146
21147 .option command_user queryprogram string unset
21148 .cindex "uid (user id)" "for &(queryprogram)&"
21149 This option must be set. It specifies the uid which is set when running the
21150 command while routing an address for delivery. If the value begins with a digit,
21151 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21152 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21153 not set, a value for the gid also.
21154
21155 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21156 root, which it does during a normal delivery in a conventional configuration.
21157 However, when an address is being verified during message reception, Exim is
21158 usually running as the Exim user, not as root. If the &(queryprogram)& router
21159 is called from a non-root process, Exim cannot change uid or gid before running
21160 the command. In this circumstance the command runs under the current uid and
21161 gid.
21162
21163
21164 .option current_directory queryprogram string /
21165 This option specifies an absolute path which is made the current directory
21166 before running the command.
21167
21168
21169 .option timeout queryprogram time 1h
21170 If the command does not complete within the timeout period, its process group
21171 is killed and the message is frozen. A value of zero time specifies no
21172 timeout.
21173
21174
21175 The standard output of the command is connected to a pipe, which is read when
21176 the command terminates. It should consist of a single line of output,
21177 containing up to five fields, separated by white space. The maximum length of
21178 the line is 1023 characters. Longer lines are silently truncated. The first
21179 field is one of the following words (case-insensitive):
21180
21181 .ilist
21182 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21183 below).
21184 .next
21185 &'Decline'&: the router declines; pass the address to the next router, unless
21186 &%no_more%& is set.
21187 .next
21188 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21189 subsequent text on the line is an error message. If the router is run as part
21190 of address verification during an incoming SMTP message, the message is
21191 included in the SMTP response.
21192 .next
21193 &'Defer'&: routing could not be completed at this time; try again later. Any
21194 subsequent text on the line is an error message which is logged. It is not
21195 included in any SMTP response.
21196 .next
21197 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21198 .next
21199 &'Pass'&: pass the address to the next router (or the router specified by
21200 &%pass_router%&), overriding &%no_more%&.
21201 .next
21202 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21203 new addresses, which are routed independently, starting with the first router,
21204 or the router specified by &%redirect_router%&, if set.
21205 .endlist
21206
21207 When the first word is &'accept'&, the remainder of the line consists of a
21208 number of keyed data values, as follows (split into two lines here, to fit on
21209 the page):
21210 .code
21211 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21212 LOOKUP=byname|bydns DATA=<text>
21213 .endd
21214 The data items can be given in any order, and all are optional. If no transport
21215 is included, the transport specified by the generic &%transport%& option is
21216 used. The list of hosts and the lookup type are needed only if the transport is
21217 an &(smtp)& transport that does not itself supply a list of hosts.
21218
21219 The format of the list of hosts is the same as for the &(manualroute)& router.
21220 As well as host names and IP addresses with optional port numbers, as described
21221 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21222 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21223 (see section &<<SECThostshowused>>&).
21224
21225 If the lookup type is not specified, Exim behaves as follows when trying to
21226 find an IP address for each host: First, a DNS lookup is done. If this yields
21227 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21228 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21229 result of the lookup is the result of that call.
21230
21231 .vindex "&$address_data$&"
21232 If the DATA field is set, its value is placed in the &$address_data$&
21233 variable. For example, this return line
21234 .code
21235 accept hosts=x1.y.example:x2.y.example data="rule1"
21236 .endd
21237 routes the address to the default transport, passing a list of two hosts. When
21238 the transport runs, the string &"rule1"& is in &$address_data$&.
21239 .ecindex IIDquerou1
21240 .ecindex IIDquerou2
21241
21242
21243
21244
21245 . ////////////////////////////////////////////////////////////////////////////
21246 . ////////////////////////////////////////////////////////////////////////////
21247
21248 .chapter "The redirect router" "CHAPredirect"
21249 .scindex IIDredrou1 "&(redirect)& router"
21250 .scindex IIDredrou2 "routers" "&(redirect)&"
21251 .cindex "alias file" "in a &(redirect)& router"
21252 .cindex "address redirection" "&(redirect)& router"
21253 The &(redirect)& router handles several kinds of address redirection. Its most
21254 common uses are for resolving local part aliases from a central alias file
21255 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21256 files, but it has many other potential uses. The incoming address can be
21257 redirected in several different ways:
21258
21259 .ilist
21260 It can be replaced by one or more new addresses which are themselves routed
21261 independently.
21262 .next
21263 It can be routed to be delivered to a given file or directory.
21264 .next
21265 It can be routed to be delivered to a specified pipe command.
21266 .next
21267 It can cause an automatic reply to be generated.
21268 .next
21269 It can be forced to fail, optionally with a custom error message.
21270 .next
21271 It can be temporarily deferred, optionally with a custom message.
21272 .next
21273 It can be discarded.
21274 .endlist
21275
21276 The generic &%transport%& option must not be set for &(redirect)& routers.
21277 However, there are some private options which define transports for delivery to
21278 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21279 &%pipe_transport%& and &%reply_transport%& descriptions below.
21280
21281 If success DSNs have been requested
21282 .cindex "DSN" "success"
21283 .cindex "Delivery Status Notification" "success"
21284 redirection triggers one and the DSN options are not passed any further.
21285
21286
21287
21288 .section "Redirection data" "SECID124"
21289 The router operates by interpreting a text string which it obtains either by
21290 expanding the contents of the &%data%& option, or by reading the entire
21291 contents of a file whose name is given in the &%file%& option. These two
21292 options are mutually exclusive. The first is commonly used for handling system
21293 aliases, in a configuration like this:
21294 .code
21295 system_aliases:
21296   driver = redirect
21297   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21298 .endd
21299 If the lookup fails, the expanded string in this example is empty. When the
21300 expansion of &%data%& results in an empty string, the router declines. A forced
21301 expansion failure also causes the router to decline; other expansion failures
21302 cause delivery to be deferred.
21303
21304 A configuration using &%file%& is commonly used for handling users'
21305 &_.forward_& files, like this:
21306 .code
21307 userforward:
21308   driver = redirect
21309   check_local_user
21310   file = $home/.forward
21311   no_verify
21312 .endd
21313 If the file does not exist, or causes no action to be taken (for example, it is
21314 empty or consists only of comments), the router declines. &*Warning*&: This
21315 is not the case when the file contains syntactically valid items that happen to
21316 yield empty addresses, for example, items containing only RFC 2822 address
21317 comments.
21318
21319 .cindex "tainted data" "in filenames"
21320 .cindex redirect "tainted data"
21321 Tainted data may not be used for a filename.
21322
21323 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21324 directly for redirection,
21325 as they are provided by a potential attacker.
21326 In the examples above, &$local_part$& is used for looking up data held locally
21327 on the system, and not used directly (the second example derives &$home$& via
21328 the passsword file or database, using &$local_part$&).
21329
21330
21331
21332 .section "Forward files and address verification" "SECID125"
21333 .cindex "address redirection" "while verifying"
21334 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21335 &_.forward_& files, as in the example above. There are two reasons for this:
21336
21337 .ilist
21338 When Exim is receiving an incoming SMTP message from a remote host, it is
21339 running under the Exim uid, not as root. Exim is unable to change uid to read
21340 the file as the user, and it may not be able to read it as the Exim user. So in
21341 practice the router may not be able to operate.
21342 .next
21343 However, even when the router can operate, the existence of a &_.forward_& file
21344 is unimportant when verifying an address. What should be checked is whether the
21345 local part is a valid user name or not. Cutting out the redirection processing
21346 saves some resources.
21347 .endlist
21348
21349
21350
21351
21352
21353
21354 .section "Interpreting redirection data" "SECID126"
21355 .cindex "Sieve filter" "specifying in redirection data"
21356 .cindex "filter" "specifying in redirection data"
21357 The contents of the data string, whether obtained from &%data%& or &%file%&,
21358 can be interpreted in two different ways:
21359
21360 .ilist
21361 If the &%allow_filter%& option is set true, and the data begins with the text
21362 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21363 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21364 respectively. Details of the syntax and semantics of filter files are described
21365 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21366 document is intended for use by end users.
21367 .next
21368 Otherwise, the data must be a comma-separated list of redirection items, as
21369 described in the next section.
21370 .endlist
21371
21372 When a message is redirected to a file (a &"mail folder"&), the filename given
21373 in a non-filter redirection list must always be an absolute path. A filter may
21374 generate a relative path &-- how this is handled depends on the transport's
21375 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21376 for the &(appendfile)& transport.
21377
21378
21379
21380 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21381 .cindex "address redirection" "non-filter list items"
21382 When the redirection data is not an Exim or Sieve filter, for example, if it
21383 comes from a conventional alias or forward file, it consists of a list of
21384 addresses, filenames, pipe commands, or certain special items (see section
21385 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21386 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21387 depending on their default values. The items in the list are separated by
21388 commas or newlines.
21389 If a comma is required in an item, the entire item must be enclosed in double
21390 quotes.
21391
21392 Lines starting with a # character are comments, and are ignored, and # may
21393 also appear following a comma, in which case everything between the # and the
21394 next newline character is ignored.
21395
21396 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21397 double quotes are retained because some forms of mail address require their use
21398 (but never to enclose the entire address). In the following description,
21399 &"item"& refers to what remains after any surrounding double quotes have been
21400 removed.
21401
21402 .vindex "&$local_part$&"
21403 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21404 and the expansion contains a reference to &$local_part$&, you should make use
21405 of the &%quote_local_part%& expansion operator, in case the local part contains
21406 special characters. For example, to redirect all mail for the domain
21407 &'obsolete.example'&, retaining the existing local part, you could use this
21408 setting:
21409 .code
21410 data = ${quote_local_part:$local_part}@newdomain.example
21411 .endd
21412
21413
21414 .section "Redirecting to a local mailbox" "SECTredlocmai"
21415 .cindex "routing" "loops in"
21416 .cindex "loop" "while routing, avoidance of"
21417 .cindex "address redirection" "to local mailbox"
21418 A redirection item may safely be the same as the address currently under
21419 consideration. This does not cause a routing loop, because a router is
21420 automatically skipped if any ancestor of the address that is being processed
21421 is the same as the current address and was processed by the current router.
21422 Such an address is therefore passed to the following routers, so it is handled
21423 as if there were no redirection. When making this loop-avoidance test, the
21424 complete local part, including any prefix or suffix, is used.
21425
21426 .cindex "address redirection" "local part without domain"
21427 Specifying the same local part without a domain is a common usage in personal
21428 filter files when the user wants to have messages delivered to the local
21429 mailbox and also forwarded elsewhere. For example, the user whose login is
21430 &'cleo'& might have a &_.forward_& file containing this:
21431 .code
21432 cleo, cleopatra@egypt.example
21433 .endd
21434 .cindex "backslash in alias file"
21435 .cindex "alias file" "backslash in"
21436 For compatibility with other MTAs, such unqualified local parts may be
21437 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21438 it does make a difference if more than one domain is being handled
21439 synonymously.
21440
21441 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21442 2822 address that does not include a domain, the item is qualified using the
21443 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21444 addresses are qualified using the value in &%qualify_recipient%&, but you can
21445 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21446
21447 Care must be taken if there are alias names for local users.
21448 Consider an MTA handling a single local domain where the system alias file
21449 contains:
21450 .code
21451 Sam.Reman: spqr
21452 .endd
21453 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21454 messages in the local mailbox, and also forward copies elsewhere. He creates
21455 this forward file:
21456 .code
21457 Sam.Reman, spqr@reme.elsewhere.example
21458 .endd
21459 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21460 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21461 second time round, because it has previously routed it,
21462 and the following routers presumably cannot handle the alias. The forward file
21463 should really contain
21464 .code
21465 spqr, spqr@reme.elsewhere.example
21466 .endd
21467 but because this is such a common error, the &%check_ancestor%& option (see
21468 below) exists to provide a way to get round it. This is normally set on a
21469 &(redirect)& router that is handling users' &_.forward_& files.
21470
21471
21472
21473 .section "Special items in redirection lists" "SECTspecitredli"
21474 In addition to addresses, the following types of item may appear in redirection
21475 lists (that is, in non-filter redirection data):
21476
21477 .ilist
21478 .cindex "pipe" "in redirection list"
21479 .cindex "address redirection" "to pipe"
21480 An item is treated as a pipe command if it begins with &"|"& and does not parse
21481 as a valid RFC 2822 address that includes a domain. A transport for running the
21482 command must be specified by the &%pipe_transport%& option.
21483 Normally, either the router or the transport specifies a user and a group under
21484 which to run the delivery. The default is to use the Exim user and group.
21485
21486 Single or double quotes can be used for enclosing the individual arguments of
21487 the pipe command; no interpretation of escapes is done for single quotes. If
21488 the command contains a comma character, it is necessary to put the whole item
21489 in double quotes, for example:
21490 .code
21491 "|/some/command ready,steady,go"
21492 .endd
21493 since items in redirection lists are terminated by commas. Do not, however,
21494 quote just the command. An item such as
21495 .code
21496 |"/some/command ready,steady,go"
21497 .endd
21498 is interpreted as a pipe with a rather strange command name, and no arguments.
21499
21500 Note that the above example assumes that the text comes from a lookup source
21501 of some sort, so that the quotes are part of the data.  If composing a
21502 redirect router with a &%data%& option directly specifying this command, the
21503 quotes will be used by the configuration parser to define the extent of one
21504 string, but will not be passed down into the redirect router itself.  There
21505 are two main approaches to get around this: escape quotes to be part of the
21506 data itself, or avoid using this mechanism and instead create a custom
21507 transport with the &%command%& option set and reference that transport from
21508 an &%accept%& router.
21509
21510 .next
21511 .cindex "file" "in redirection list"
21512 .cindex "address redirection" "to file"
21513 An item is interpreted as a path name if it begins with &"/"& and does not
21514 parse as a valid RFC 2822 address that includes a domain. For example,
21515 .code
21516 /home/world/minbari
21517 .endd
21518 is treated as a filename, but
21519 .code
21520 /s=molari/o=babylon/@x400gate.way
21521 .endd
21522 is treated as an address. For a filename, a transport must be specified using
21523 the &%file_transport%& option. However, if the generated path name ends with a
21524 forward slash character, it is interpreted as a directory name rather than a
21525 filename, and &%directory_transport%& is used instead.
21526
21527 Normally, either the router or the transport specifies a user and a group under
21528 which to run the delivery. The default is to use the Exim user and group.
21529
21530 .cindex "&_/dev/null_&"
21531 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21532 bypassed at a high level, and the log entry shows &"**bypassed**"&
21533 instead of a transport name. In this case the user and group are not used.
21534
21535 .next
21536 .cindex "included address list"
21537 .cindex "address redirection" "included external list"
21538 If an item is of the form
21539 .code
21540 :include:<path name>
21541 .endd
21542 a list of further items is taken from the given file and included at that
21543 point. &*Note*&: Such a file can not be a filter file; it is just an
21544 out-of-line addition to the list. The items in the included list are separated
21545 by commas or newlines and are not subject to expansion. If this is the first
21546 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21547 the alias name. This example is incorrect:
21548 .code
21549 list1    :include:/opt/lists/list1
21550 .endd
21551 It must be given as
21552 .code
21553 list1:   :include:/opt/lists/list1
21554 .endd
21555 .cindex "tainted data" "in filenames"
21556 .cindex redirect "tainted data"
21557 Tainted data may not be used for a filename.
21558 .next
21559 .cindex "address redirection" "to black hole"
21560 .cindex "delivery" "discard"
21561 .cindex "delivery" "blackhole"
21562 .cindex "black hole"
21563 .cindex "abandoning mail"
21564 Sometimes you want to throw away mail to a particular local part.  Making the
21565 &%data%& option expand to an empty string does not work, because that causes
21566 the router to decline. Instead, the alias item
21567 .code
21568 :blackhole:
21569 .endd
21570 can be used. It does what its name implies. No delivery is
21571 done, and no error message is generated. This has the same effect as specifying
21572 &_/dev/null_& as a destination, but it can be independently disabled.
21573
21574 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21575 delivery is done for the original local part, even if other redirection items
21576 are present. If you are generating a multi-item list (for example, by reading a
21577 database) and need the ability to provide a no-op item, you must use
21578 &_/dev/null_&.
21579
21580 .next
21581 .cindex "delivery" "forcing failure"
21582 .cindex "delivery" "forcing deferral"
21583 .cindex "failing delivery" "forcing"
21584 .cindex "deferred delivery, forcing"
21585 .cindex "customizing" "failure message"
21586 An attempt to deliver a particular address can be deferred or forced to fail by
21587 redirection items of the form
21588 .code
21589 :defer:
21590 :fail:
21591 .endd
21592 respectively. When a redirection list contains such an item, it applies
21593 to the entire redirection; any other items in the list are ignored. Any
21594 text following &':fail:'& or &':defer:'& is placed in the error text
21595 associated with the failure. For example, an alias file might contain:
21596 .code
21597 X.Employee:  :fail: Gone away, no forwarding address
21598 .endd
21599 In the case of an address that is being verified from an ACL or as the subject
21600 of a
21601 .cindex "VRFY" "error text, display of"
21602 VRFY command, the text is included in the SMTP error response by
21603 default.
21604 .cindex "EXPN" "error text, display of"
21605 The text is not included in the response to an EXPN command. In non-SMTP cases
21606 the text is included in the error message that Exim generates.
21607
21608 .cindex "SMTP" "error codes"
21609 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21610 &':fail:'&. However, if the message starts with three digits followed by a
21611 space, optionally followed by an extended code of the form &'n.n.n'&, also
21612 followed by a space, and the very first digit is the same as the default error
21613 code, the code from the message is used instead. If the very first digit is
21614 incorrect, a panic error is logged, and the default code is used. You can
21615 suppress the use of the supplied code in a redirect router by setting the
21616 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21617 ignored.
21618
21619 .vindex "&$acl_verify_message$&"
21620 In an ACL, an explicitly provided message overrides the default, but the
21621 default message is available in the variable &$acl_verify_message$& and can
21622 therefore be included in a custom message if this is desired.
21623
21624 Normally the error text is the rest of the redirection list &-- a comma does
21625 not terminate it &-- but a newline does act as a terminator. Newlines are not
21626 normally present in alias expansions. In &(lsearch)& lookups they are removed
21627 as part of the continuation process, but they may exist in other kinds of
21628 lookup and in &':include:'& files.
21629
21630 During routing for message delivery (as opposed to verification), a redirection
21631 containing &':fail:'& causes an immediate failure of the incoming address,
21632 whereas &':defer:'& causes the message to remain in the queue so that a
21633 subsequent delivery attempt can happen at a later time. If an address is
21634 deferred for too long, it will ultimately fail, because the normal retry
21635 rules still apply.
21636
21637 .next
21638 .cindex "alias file" "exception to default"
21639 Sometimes it is useful to use a single-key search type with a default (see
21640 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21641 for exceptions to the default. These can be handled by aliasing them to
21642 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21643 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21644 results in an empty redirection list has the same effect.
21645 .endlist
21646
21647
21648 .section "Duplicate addresses" "SECTdupaddr"
21649 .cindex "duplicate addresses"
21650 .cindex "address duplicate, discarding"
21651 .cindex "pipe" "duplicated"
21652 Exim removes duplicate addresses from the list to which it is delivering, so as
21653 to deliver just one copy to each address. This does not apply to deliveries
21654 routed to pipes by different immediate parent addresses, but an indirect
21655 aliasing scheme of the type
21656 .code
21657 pipe:       |/some/command $local_part
21658 localpart1: pipe
21659 localpart2: pipe
21660 .endd
21661 does not work with a message that is addressed to both local parts, because
21662 when the second is aliased to the intermediate local part &"pipe"& it gets
21663 discarded as being the same as a previously handled address. However, a scheme
21664 such as
21665 .code
21666 localpart1: |/some/command $local_part
21667 localpart2: |/some/command $local_part
21668 .endd
21669 does result in two different pipe deliveries, because the immediate parents of
21670 the pipes are distinct.
21671
21672
21673
21674 .section "Repeated redirection expansion" "SECID128"
21675 .cindex "repeated redirection expansion"
21676 .cindex "address redirection" "repeated for each delivery attempt"
21677 When a message cannot be delivered to all of its recipients immediately,
21678 leading to two or more delivery attempts, redirection expansion is carried out
21679 afresh each time for those addresses whose children were not all previously
21680 delivered. If redirection is being used as a mailing list, this can lead to new
21681 members of the list receiving copies of old messages. The &%one_time%& option
21682 can be used to avoid this.
21683
21684
21685 .section "Errors in redirection lists" "SECID129"
21686 .cindex "address redirection" "errors"
21687 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21688 error is skipped, and an entry is written to the main log. This may be useful
21689 for mailing lists that are automatically managed. Otherwise, if an error is
21690 detected while generating the list of new addresses, the original address is
21691 deferred. See also &%syntax_errors_to%&.
21692
21693
21694
21695 .section "Private options for the redirect router" "SECID130"
21696
21697 .cindex "options" "&(redirect)& router"
21698 The private options for the &(redirect)& router are as follows:
21699
21700
21701 .option allow_defer redirect boolean false
21702 Setting this option allows the use of &':defer:'& in non-filter redirection
21703 data, or the &%defer%& command in an Exim filter file.
21704
21705
21706 .option allow_fail redirect boolean false
21707 .cindex "failing delivery" "from filter"
21708 If this option is true, the &':fail:'& item can be used in a redirection list,
21709 and the &%fail%& command may be used in an Exim filter file.
21710
21711
21712 .option allow_filter redirect boolean false
21713 .cindex "filter" "enabling use of"
21714 .cindex "Sieve filter" "enabling use of"
21715 Setting this option allows Exim to interpret redirection data that starts with
21716 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21717 are some features of Exim filter files that some administrators may wish to
21718 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21719
21720 It is also possible to lock out Exim filters or Sieve filters while allowing
21721 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21722
21723
21724 The filter is run using the uid and gid set by the generic &%user%& and
21725 &%group%& options. These take their defaults from the password data if
21726 &%check_local_user%& is set, so in the normal case of users' personal filter
21727 files, the filter is run as the relevant user. When &%allow_filter%& is set
21728 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21729
21730
21731
21732 .option allow_freeze redirect boolean false
21733 .cindex "freezing messages" "allowing in filter"
21734 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21735 This command is more normally encountered in system filters, and is disabled by
21736 default for redirection filters because it isn't something you usually want to
21737 let ordinary users do.
21738
21739
21740
21741 .option check_ancestor redirect boolean false
21742 This option is concerned with handling generated addresses that are the same
21743 as some address in the list of redirection ancestors of the current address.
21744 Although it is turned off by default in the code, it is set in the default
21745 configuration file for handling users' &_.forward_& files. It is recommended
21746 for this use of the &(redirect)& router.
21747
21748 When &%check_ancestor%& is set, if a generated address (including the domain)
21749 is the same as any ancestor of the current address, it is replaced by a copy of
21750 the current address. This helps in the case where local part A is aliased to B,
21751 and B has a &_.forward_& file pointing back to A. For example, within a single
21752 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21753 &_&~jb/.forward_& contains:
21754 .code
21755 \Joe.Bloggs, <other item(s)>
21756 .endd
21757 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21758 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21759 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21760 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21761 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21762 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21763 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21764 original address. See also the &%repeat_use%& option below.
21765
21766
21767 .option check_group redirect boolean "see below"
21768 When the &%file%& option is used, the group owner of the file is checked only
21769 when this option is set. The permitted groups are those listed in the
21770 &%owngroups%& option, together with the user's default group if
21771 &%check_local_user%& is set. If the file has the wrong group, routing is
21772 deferred. The default setting for this option is true if &%check_local_user%&
21773 is set and the &%modemask%& option permits the group write bit, or if the
21774 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21775
21776
21777
21778 .option check_owner redirect boolean "see below"
21779 When the &%file%& option is used, the owner of the file is checked only when
21780 this option is set. If &%check_local_user%& is set, the local user is
21781 permitted; otherwise the owner must be one of those listed in the &%owners%&
21782 option. The default value for this option is true if &%check_local_user%& or
21783 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21784
21785
21786 .option data redirect string&!! unset
21787 This option is mutually exclusive with &%file%&. One or other of them must be
21788 set, but not both. The contents of &%data%& are expanded, and then used as the
21789 list of forwarding items, or as a set of filtering instructions. If the
21790 expansion is forced to fail, or the result is an empty string or a string that
21791 has no effect (consists entirely of comments), the router declines.
21792
21793 When filtering instructions are used, the string must begin with &"#Exim
21794 filter"&, and all comments in the string, including this initial one, must be
21795 terminated with newline characters. For example:
21796 .code
21797 data = #Exim filter\n\
21798        if $h_to: contains Exim then save $home/mail/exim endif
21799 .endd
21800 If you are reading the data from a database where newlines cannot be included,
21801 you can use the &${sg}$& expansion item to turn the escape string of your
21802 choice into a newline.
21803
21804
21805 .option directory_transport redirect string&!! unset
21806 A &(redirect)& router sets up a direct delivery to a directory when a path name
21807 ending with a slash is specified as a new &"address"&. The transport used is
21808 specified by this option, which, after expansion, must be the name of a
21809 configured transport. This should normally be an &(appendfile)& transport.
21810
21811
21812 .option file redirect string&!! unset
21813 This option specifies the name of a file that contains the redirection data. It
21814 is mutually exclusive with the &%data%& option. The string is expanded before
21815 use; if the expansion is forced to fail, the router declines. Other expansion
21816 failures cause delivery to be deferred. The result of a successful expansion
21817 must be an absolute path. The entire file is read and used as the redirection
21818 data. If the data is an empty string or a string that has no effect (consists
21819 entirely of comments), the router declines.
21820
21821 .cindex "NFS" "checking for file existence"
21822 If the attempt to open the file fails with a &"does not exist"& error, Exim
21823 runs a check on the containing directory,
21824 unless &%ignore_enotdir%& is true (see below).
21825 If the directory does not appear to exist, delivery is deferred. This can
21826 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21827 is a mount problem. If the containing directory does exist, but the file does
21828 not, the router declines.
21829
21830
21831 .option file_transport redirect string&!! unset
21832 .vindex "&$address_file$&"
21833 A &(redirect)& router sets up a direct delivery to a file when a path name not
21834 ending in a slash is specified as a new &"address"&. The transport used is
21835 specified by this option, which, after expansion, must be the name of a
21836 configured transport. This should normally be an &(appendfile)& transport. When
21837 it is running, the filename is in &$address_file$&.
21838
21839
21840 .option filter_prepend_home redirect boolean true
21841 When this option is true, if a &(save)& command in an Exim filter specifies a
21842 relative path, and &$home$& is defined, it is automatically prepended to the
21843 relative path. If this option is set false, this action does not happen. The
21844 relative path is then passed to the transport unmodified.
21845
21846
21847 .option forbid_blackhole redirect boolean false
21848 .cindex "restricting access to features"
21849 .cindex "filter" "locking out certain features"
21850 If this option is true, the &':blackhole:'& item may not appear in a
21851 redirection list.
21852
21853
21854 .option forbid_exim_filter redirect boolean false
21855 .cindex "restricting access to features"
21856 .cindex "filter" "locking out certain features"
21857 If this option is set true, only Sieve filters are permitted when
21858 &%allow_filter%& is true.
21859
21860
21861
21862
21863 .option forbid_file redirect boolean false
21864 .cindex "restricting access to features"
21865 .cindex "delivery" "to file; forbidding"
21866 .cindex "filter" "locking out certain features"
21867 .cindex "Sieve filter" "forbidding delivery to a file"
21868 .cindex "Sieve filter" "&""keep""& facility; disabling"
21869 If this option is true, this router may not generate a new address that
21870 specifies delivery to a local file or directory, either from a filter or from a
21871 conventional forward file. This option is forced to be true if &%one_time%& is
21872 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21873 locks out the Sieve's &"keep"& facility.
21874
21875
21876 .option forbid_filter_dlfunc redirect boolean false
21877 .cindex "restricting access to features"
21878 .cindex "filter" "locking out certain features"
21879 If this option is true, string expansions in Exim filters are not allowed to
21880 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21881 functions.
21882
21883 .option forbid_filter_existstest redirect boolean false
21884 .cindex "restricting access to features"
21885 .cindex "filter" "locking out certain features"
21886 .cindex "expansion" "statting a file"
21887 If this option is true, string expansions in Exim filters are not allowed to
21888 make use of the &%exists%& condition or the &%stat%& expansion item.
21889
21890 .option forbid_filter_logwrite redirect boolean false
21891 .cindex "restricting access to features"
21892 .cindex "filter" "locking out certain features"
21893 If this option is true, use of the logging facility in Exim filters is not
21894 permitted. Logging is in any case available only if the filter is being run
21895 under some unprivileged uid (which is normally the case for ordinary users'
21896 &_.forward_& files).
21897
21898
21899 .option forbid_filter_lookup redirect boolean false
21900 .cindex "restricting access to features"
21901 .cindex "filter" "locking out certain features"
21902 If this option is true, string expansions in Exim filter files are not allowed
21903 to make use of &%lookup%& items.
21904
21905
21906 .option forbid_filter_perl redirect boolean false
21907 .cindex "restricting access to features"
21908 .cindex "filter" "locking out certain features"
21909 This option has an effect only if Exim is built with embedded Perl support. If
21910 it is true, string expansions in Exim filter files are not allowed to make use
21911 of the embedded Perl support.
21912
21913
21914 .option forbid_filter_readfile redirect boolean false
21915 .cindex "restricting access to features"
21916 .cindex "filter" "locking out certain features"
21917 If this option is true, string expansions in Exim filter files are not allowed
21918 to make use of &%readfile%& items.
21919
21920
21921 .option forbid_filter_readsocket redirect boolean false
21922 .cindex "restricting access to features"
21923 .cindex "filter" "locking out certain features"
21924 If this option is true, string expansions in Exim filter files are not allowed
21925 to make use of &%readsocket%& items.
21926
21927
21928 .option forbid_filter_reply redirect boolean false
21929 .cindex "restricting access to features"
21930 .cindex "filter" "locking out certain features"
21931 If this option is true, this router may not generate an automatic reply
21932 message. Automatic replies can be generated only from Exim or Sieve filter
21933 files, not from traditional forward files. This option is forced to be true if
21934 &%one_time%& is set.
21935
21936
21937 .option forbid_filter_run redirect boolean false
21938 .cindex "restricting access to features"
21939 .cindex "filter" "locking out certain features"
21940 If this option is true, string expansions in Exim filter files are not allowed
21941 to make use of &%run%& items.
21942
21943
21944 .option forbid_include redirect boolean false
21945 .cindex "restricting access to features"
21946 .cindex "filter" "locking out certain features"
21947 If this option is true, items of the form
21948 .code
21949 :include:<path name>
21950 .endd
21951 are not permitted in non-filter redirection lists.
21952
21953
21954 .option forbid_pipe redirect boolean false
21955 .cindex "restricting access to features"
21956 .cindex "filter" "locking out certain features"
21957 .cindex "delivery" "to pipe; forbidding"
21958 If this option is true, this router may not generate a new address which
21959 specifies delivery to a pipe, either from an Exim filter or from a conventional
21960 forward file. This option is forced to be true if &%one_time%& is set.
21961
21962
21963 .option forbid_sieve_filter redirect boolean false
21964 .cindex "restricting access to features"
21965 .cindex "filter" "locking out certain features"
21966 If this option is set true, only Exim filters are permitted when
21967 &%allow_filter%& is true.
21968
21969
21970 .cindex "SMTP" "error codes"
21971 .option forbid_smtp_code redirect boolean false
21972 If this option is set true, any SMTP error codes that are present at the start
21973 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21974 the default codes (451 and 550, respectively) are always used.
21975
21976
21977
21978
21979 .option hide_child_in_errmsg redirect boolean false
21980 .cindex "bounce message" "redirection details; suppressing"
21981 If this option is true, it prevents Exim from quoting a child address if it
21982 generates a bounce or delay message for it. Instead it says &"an address
21983 generated from <&'the top level address'&>"&. Of course, this applies only to
21984 bounces generated locally. If a message is forwarded to another host, &'its'&
21985 bounce may well quote the generated address.
21986
21987
21988 .option ignore_eacces redirect boolean false
21989 .cindex "EACCES"
21990 If this option is set and an attempt to open a redirection file yields the
21991 EACCES error (permission denied), the &(redirect)& router behaves as if the
21992 file did not exist.
21993
21994
21995 .option ignore_enotdir redirect boolean false
21996 .cindex "ENOTDIR"
21997 If this option is set and an attempt to open a redirection file yields the
21998 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21999 router behaves as if the file did not exist.
22000
22001 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
22002 router that has the &%file%& option set discovers that the file does not exist
22003 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
22004 against unmounted NFS directories. If the parent can not be statted, delivery
22005 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
22006 is set, because that option tells Exim to ignore &"something on the path is not
22007 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
22008 that some operating systems give ENOENT where others give ENOTDIR.
22009
22010
22011
22012 .option include_directory redirect string unset
22013 If this option is set, the path names of any &':include:'& items in a
22014 redirection list must start with this directory.
22015
22016
22017 .option modemask redirect "octal integer" 022
22018 This specifies mode bits which must not be set for a file specified by the
22019 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22020
22021
22022 .option one_time redirect boolean false
22023 .cindex "one-time aliasing/forwarding expansion"
22024 .cindex "alias file" "one-time expansion"
22025 .cindex "forward file" "one-time expansion"
22026 .cindex "mailing lists" "one-time expansion"
22027 .cindex "address redirection" "one-time expansion"
22028 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22029 files each time it tries to deliver a message causes a problem when one or more
22030 of the generated addresses fails be delivered at the first attempt. The problem
22031 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22032 but of what happens when the redirection list changes during the time that the
22033 message is on Exim's queue. This is particularly true in the case of mailing
22034 lists, where new subscribers might receive copies of messages that were posted
22035 before they subscribed.
22036
22037 If &%one_time%& is set and any addresses generated by the router fail to
22038 deliver at the first attempt, the failing addresses are added to the message as
22039 &"top level"& addresses, and the parent address that generated them is marked
22040 &"delivered"&. Thus, redirection does not happen again at the next delivery
22041 attempt.
22042
22043 &*Warning 1*&: Any header line addition or removal that is specified by this
22044 router would be lost if delivery did not succeed at the first attempt. For this
22045 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22046 permitted when &%one_time%& is set.
22047
22048 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22049 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22050 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22051
22052 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22053 &%one_time%&.
22054
22055 The original top-level address is remembered with each of the generated
22056 addresses, and is output in any log messages. However, any intermediate parent
22057 addresses are not recorded. This makes a difference to the log only if
22058 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22059 typically be used for mailing lists, where there is normally just one level of
22060 expansion.
22061
22062
22063 .option owners redirect "string list" unset
22064 .cindex "ownership" "alias file"
22065 .cindex "ownership" "forward file"
22066 .cindex "alias file" "ownership"
22067 .cindex "forward file" "ownership"
22068 This specifies a list of permitted owners for the file specified by &%file%&.
22069 This list is in addition to the local user when &%check_local_user%& is set.
22070 See &%check_owner%& above.
22071
22072
22073 .option owngroups redirect "string list" unset
22074 This specifies a list of permitted groups for the file specified by &%file%&.
22075 The list is in addition to the local user's primary group when
22076 &%check_local_user%& is set. See &%check_group%& above.
22077
22078
22079 .option pipe_transport redirect string&!! unset
22080 .vindex "&$address_pipe$&"
22081 A &(redirect)& router sets up a direct delivery to a pipe when a string
22082 starting with a vertical bar character is specified as a new &"address"&. The
22083 transport used is specified by this option, which, after expansion, must be the
22084 name of a configured transport. This should normally be a &(pipe)& transport.
22085 When the transport is run, the pipe command is in &$address_pipe$&.
22086
22087
22088 .option qualify_domain redirect string&!! unset
22089 .vindex "&$qualify_recipient$&"
22090 If this option is set, and an unqualified address (one without a domain) is
22091 generated, and that address would normally be qualified by the global setting
22092 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22093 expanding this string. If the expansion fails, the router declines. If you want
22094 to revert to the default, you can have the expansion generate
22095 &$qualify_recipient$&.
22096
22097 This option applies to all unqualified addresses generated by Exim filters,
22098 but for traditional &_.forward_& files, it applies only to addresses that are
22099 not preceded by a backslash. Sieve filters cannot generate unqualified
22100 addresses.
22101
22102 .option qualify_preserve_domain redirect boolean false
22103 .cindex "domain" "in redirection; preserving"
22104 .cindex "preserving domain in redirection"
22105 .cindex "address redirection" "domain; preserving"
22106 If this option is set, the router's local &%qualify_domain%& option must not be
22107 set (a configuration error occurs if it is). If an unqualified address (one
22108 without a domain) is generated, it is qualified with the domain of the parent
22109 address (the immediately preceding ancestor) instead of the global
22110 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22111 this applies whether or not the address is preceded by a backslash.
22112
22113
22114 .option repeat_use redirect boolean true
22115 If this option is set false, the router is skipped for a child address that has
22116 any ancestor that was routed by this router. This test happens before any of
22117 the other preconditions are tested. Exim's default anti-looping rules skip
22118 only when the ancestor is the same as the current address. See also
22119 &%check_ancestor%& above and the generic &%redirect_router%& option.
22120
22121
22122 .option reply_transport redirect string&!! unset
22123 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22124 &%vacation%& command is used in a filter file. The transport used is specified
22125 by this option, which, after expansion, must be the name of a configured
22126 transport. This should normally be an &(autoreply)& transport. Other transports
22127 are unlikely to do anything sensible or useful.
22128
22129
22130 .option rewrite redirect boolean true
22131 .cindex "address redirection" "disabling rewriting"
22132 If this option is set false, addresses generated by the router are not
22133 subject to address rewriting. Otherwise, they are treated like new addresses
22134 and are rewritten according to the global rewriting rules.
22135
22136
22137 .option sieve_subaddress redirect string&!! unset
22138 The value of this option is passed to a Sieve filter to specify the
22139 :subaddress part of an address.
22140
22141 .option sieve_useraddress redirect string&!! unset
22142 The value of this option is passed to a Sieve filter to specify the :user part
22143 of an address. However, if it is unset, the entire original local part
22144 (including any prefix or suffix) is used for :user.
22145
22146
22147 .option sieve_vacation_directory redirect string&!! unset
22148 .cindex "Sieve filter" "vacation directory"
22149 To enable the &"vacation"& extension for Sieve filters, you must set
22150 &%sieve_vacation_directory%& to the directory where vacation databases are held
22151 (do not put anything else in that directory), and ensure that the
22152 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22153 needs their own directory; Exim will create it if necessary.
22154
22155
22156
22157 .option skip_syntax_errors redirect boolean false
22158 .cindex "forward file" "broken"
22159 .cindex "address redirection" "broken files"
22160 .cindex "alias file" "broken"
22161 .cindex "broken alias or forward files"
22162 .cindex "ignoring faulty addresses"
22163 .cindex "skipping faulty addresses"
22164 .cindex "error" "skipping bad syntax"
22165 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22166 non-filter redirection data are skipped, and each failing address is logged. If
22167 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22168 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22169 are expanded and placed at the head of the error message generated by
22170 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22171 be the same address as the generic &%errors_to%& option. The
22172 &%skip_syntax_errors%& option is often used when handling mailing lists.
22173
22174 If all the addresses in a redirection list are skipped because of syntax
22175 errors, the router declines to handle the original address, and it is passed to
22176 the following routers.
22177
22178 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22179 error in the filter causes filtering to be abandoned without any action being
22180 taken. The incident is logged, and the router declines to handle the address,
22181 so it is passed to the following routers.
22182
22183 .cindex "Sieve filter" "syntax errors in"
22184 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22185 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22186 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22187
22188 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22189 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22190 option, used with an address that does not get redirected, can be used to
22191 notify users of these errors, by means of a router like this:
22192 .code
22193 userforward:
22194   driver = redirect
22195   allow_filter
22196   check_local_user
22197   file = $home/.forward
22198   file_transport = address_file
22199   pipe_transport = address_pipe
22200   reply_transport = address_reply
22201   no_verify
22202   skip_syntax_errors
22203   syntax_errors_to = real-$local_part@$domain
22204   syntax_errors_text = \
22205    This is an automatically generated message. An error has\n\
22206    been found in your .forward file. Details of the error are\n\
22207    reported below. While this error persists, you will receive\n\
22208    a copy of this message for every message that is addressed\n\
22209    to you. If your .forward file is a filter file, or if it is\n\
22210    a non-filter file containing no valid forwarding addresses,\n\
22211    a copy of each incoming message will be put in your normal\n\
22212    mailbox. If a non-filter file contains at least one valid\n\
22213    forwarding address, forwarding to the valid addresses will\n\
22214    happen, and those will be the only deliveries that occur.
22215 .endd
22216 You also need a router to ensure that local addresses that are prefixed by
22217 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22218 put this immediately before the &(userforward)& router:
22219 .code
22220 real_localuser:
22221   driver = accept
22222   check_local_user
22223   local_part_prefix = real-
22224   transport = local_delivery
22225 .endd
22226 For security, it would probably be a good idea to restrict the use of this
22227 router to locally-generated messages, using a condition such as this:
22228 .code
22229   condition = ${if match {$sender_host_address}\
22230                          {\N^(|127\.0\.0\.1)$\N}}
22231 .endd
22232
22233
22234 .option syntax_errors_text redirect string&!! unset
22235 See &%skip_syntax_errors%& above.
22236
22237
22238 .option syntax_errors_to redirect string unset
22239 See &%skip_syntax_errors%& above.
22240 .ecindex IIDredrou1
22241 .ecindex IIDredrou2
22242
22243
22244
22245
22246
22247
22248 . ////////////////////////////////////////////////////////////////////////////
22249 . ////////////////////////////////////////////////////////////////////////////
22250
22251 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22252          "Environment for local transports"
22253 .scindex IIDenvlotra1 "local transports" "environment for"
22254 .scindex IIDenvlotra2 "environment" "local transports"
22255 .scindex IIDenvlotra3 "transport" "local; environment for"
22256 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22257 transport can be thought of as similar to a pipe.) Exim always runs transports
22258 in subprocesses, under specified uids and gids. Typical deliveries to local
22259 mailboxes run under the uid and gid of the local user.
22260
22261 Exim also sets a specific current directory while running the transport; for
22262 some transports a home directory setting is also relevant. The &(pipe)&
22263 transport is the only one that sets up environment variables; see section
22264 &<<SECTpipeenv>>& for details.
22265
22266 The values used for the uid, gid, and the directories may come from several
22267 different places. In many cases, the router that handles the address associates
22268 settings with that address as a result of its &%check_local_user%&, &%group%&,
22269 or &%user%& options. However, values may also be given in the transport's own
22270 configuration, and these override anything that comes from the router.
22271
22272
22273
22274 .section "Concurrent deliveries" "SECID131"
22275 .cindex "concurrent deliveries"
22276 .cindex "simultaneous deliveries"
22277 If two different messages for the same local recipient arrive more or less
22278 simultaneously, the two delivery processes are likely to run concurrently. When
22279 the &(appendfile)& transport is used to write to a file, Exim applies locking
22280 rules to stop concurrent processes from writing to the same file at the same
22281 time.
22282
22283 However, when you use a &(pipe)& transport, it is up to you to arrange any
22284 locking that is needed. Here is a silly example:
22285 .code
22286 my_transport:
22287   driver = pipe
22288   command = /bin/sh -c 'cat >>/some/file'
22289 .endd
22290 This is supposed to write the message at the end of the file. However, if two
22291 messages arrive at the same time, the file will be scrambled. You can use the
22292 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22293 file using the same algorithm that Exim itself uses.
22294
22295
22296
22297
22298 .section "Uids and gids" "SECTenvuidgid"
22299 .cindex "local transports" "uid and gid"
22300 .cindex "transport" "local; uid and gid"
22301 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22302 overrides any group that the router set in the address, even if &%user%& is not
22303 set for the transport. This makes it possible, for example, to run local mail
22304 delivery under the uid of the recipient (set by the router), but in a special
22305 group (set by the transport). For example:
22306 .code
22307 # Routers ...
22308 # User/group are set by check_local_user in this router
22309 local_users:
22310   driver = accept
22311   check_local_user
22312   transport = group_delivery
22313
22314 # Transports ...
22315 # This transport overrides the group
22316 group_delivery:
22317   driver = appendfile
22318   file = /var/spool/mail/$local_part_data
22319   group = mail
22320 .endd
22321 If &%user%& is set for a transport, its value overrides what is set in the
22322 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22323 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22324 set.
22325
22326 .oindex "&%initgroups%&"
22327 When the uid is taken from the transport's configuration, the &[initgroups()]&
22328 function is called for the groups associated with that uid if the
22329 &%initgroups%& option is set for the transport. When the uid is not specified
22330 by the transport, but is associated with the address by a router, the option
22331 for calling &[initgroups()]& is taken from the router configuration.
22332
22333 .cindex "&(pipe)& transport" "uid for"
22334 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22335 is set and &%user%& is not set, the uid of the process that called Exim to
22336 receive the message is used, and if &%group%& is not set, the corresponding
22337 original gid is also used.
22338
22339 This is the detailed preference order for obtaining a gid; the first of the
22340 following that is set is used:
22341
22342 .ilist
22343 A &%group%& setting of the transport;
22344 .next
22345 A &%group%& setting of the router;
22346 .next
22347 A gid associated with a user setting of the router, either as a result of
22348 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22349 .next
22350 The group associated with a non-numeric &%user%& setting of the transport;
22351 .next
22352 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22353 the uid is the creator's uid;
22354 .next
22355 The Exim gid if the Exim uid is being used as a default.
22356 .endlist
22357
22358 If, for example, the user is specified numerically on the router and there are
22359 no group settings, no gid is available. In this situation, an error occurs.
22360 This is different for the uid, for which there always is an ultimate default.
22361 The first of the following that is set is used:
22362
22363 .ilist
22364 A &%user%& setting of the transport;
22365 .next
22366 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22367 .next
22368 A &%user%& setting of the router;
22369 .next
22370 A &%check_local_user%& setting of the router;
22371 .next
22372 The Exim uid.
22373 .endlist
22374
22375 Of course, an error will still occur if the uid that is chosen is on the
22376 &%never_users%& list.
22377
22378
22379
22380
22381
22382 .section "Current and home directories" "SECID132"
22383 .cindex "current directory for local transport"
22384 .cindex "home directory" "for local transport"
22385 .cindex "transport" "local; home directory for"
22386 .cindex "transport" "local; current directory for"
22387 Routers may set current and home directories for local transports by means of
22388 the &%transport_current_directory%& and &%transport_home_directory%& options.
22389 However, if the transport's &%current_directory%& or &%home_directory%& options
22390 are set, they override the router's values. In detail, the home directory
22391 for a local transport is taken from the first of these values that is set:
22392
22393 .ilist
22394 The &%home_directory%& option on the transport;
22395 .next
22396 The &%transport_home_directory%& option on the router;
22397 .next
22398 The password data if &%check_local_user%& is set on the router;
22399 .next
22400 The &%router_home_directory%& option on the router.
22401 .endlist
22402
22403 The current directory is taken from the first of these values that is set:
22404
22405 .ilist
22406 The &%current_directory%& option on the transport;
22407 .next
22408 The &%transport_current_directory%& option on the router.
22409 .endlist
22410
22411
22412 If neither the router nor the transport sets a current directory, Exim uses the
22413 value of the home directory, if it is set. Otherwise it sets the current
22414 directory to &_/_& before running a local transport.
22415
22416
22417
22418 .section "Expansion variables derived from the address" "SECID133"
22419 .vindex "&$domain$&"
22420 .vindex "&$local_part$&"
22421 .vindex "&$original_domain$&"
22422 Normally a local delivery is handling a single address, and in that case the
22423 variables such as &$domain$& and &$local_part$& are set during local
22424 deliveries. However, in some circumstances more than one address may be handled
22425 at once (for example, while writing batch SMTP for onward transmission by some
22426 other means). In this case, the variables associated with the local part are
22427 never set, &$domain$& is set only if all the addresses have the same domain,
22428 and &$original_domain$& is never set.
22429 .ecindex IIDenvlotra1
22430 .ecindex IIDenvlotra2
22431 .ecindex IIDenvlotra3
22432
22433
22434
22435
22436
22437
22438
22439 . ////////////////////////////////////////////////////////////////////////////
22440 . ////////////////////////////////////////////////////////////////////////////
22441
22442 .chapter "Generic options for transports" "CHAPtransportgeneric"
22443 .scindex IIDgenoptra1 "generic options" "transport"
22444 .scindex IIDgenoptra2 "options" "generic; for transports"
22445 .scindex IIDgenoptra3 "transport" "generic options for"
22446 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22447 prior to Exim 4.95 names would be silently truncated at this length, but now
22448 it is enforced.
22449
22450 The following generic options apply to all transports:
22451
22452
22453 .option body_only transports boolean false
22454 .cindex "transport" "body only"
22455 .cindex "message" "transporting body only"
22456 .cindex "body of message" "transporting"
22457 If this option is set, the message's headers are not transported. It is
22458 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22459 or &(pipe)& transports, the settings of &%message_prefix%& and
22460 &%message_suffix%& should be checked, because this option does not
22461 automatically suppress them.
22462
22463
22464 .option current_directory transports string&!! unset
22465 .cindex "transport" "current directory for"
22466 This specifies the current directory that is to be set while running the
22467 transport, overriding any value that may have been set by the router.
22468 If the expansion fails for any reason, including forced failure, an error is
22469 logged, and delivery is deferred.
22470
22471
22472 .option disable_logging transports boolean false
22473 If this option is set true, nothing is logged for any
22474 deliveries by the transport or for any
22475 transport errors. You should not set this option unless you really, really know
22476 what you are doing.
22477
22478
22479 .option debug_print transports string&!! unset
22480 .cindex "testing" "variables in drivers"
22481 If this option is set and debugging is enabled (see the &%-d%& command line
22482 option), the string is expanded and included in the debugging output when the
22483 transport is run.
22484 If expansion of the string fails, the error message is written to the debugging
22485 output, and Exim carries on processing.
22486 This facility is provided to help with checking out the values of variables and
22487 so on when debugging driver configurations. For example, if a &%headers_add%&
22488 option is not working properly, &%debug_print%& could be used to output the
22489 variables it references. A newline is added to the text if it does not end with
22490 one.
22491 The variables &$transport_name$& and &$router_name$& contain the name of the
22492 transport and the router that called it.
22493
22494 .option delivery_date_add transports boolean false
22495 .cindex "&'Delivery-date:'& header line"
22496 If this option is true, a &'Delivery-date:'& header is added to the message.
22497 This gives the actual time the delivery was made. As this is not a standard
22498 header, Exim has a configuration option (&%delivery_date_remove%&) which
22499 requests its removal from incoming messages, so that delivered messages can
22500 safely be resent to other recipients.
22501
22502
22503 .option driver transports string unset
22504 This specifies which of the available transport drivers is to be used.
22505 There is no default, and this option must be set for every transport.
22506
22507
22508 .option envelope_to_add transports boolean false
22509 .cindex "&'Envelope-to:'& header line"
22510 If this option is true, an &'Envelope-to:'& header is added to the message.
22511 This gives the original address(es) in the incoming envelope that caused this
22512 delivery to happen. More than one address may be present if the transport is
22513 configured to handle several addresses at once, or if more than one original
22514 address was redirected to the same final address. As this is not a standard
22515 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22516 its removal from incoming messages, so that delivered messages can safely be
22517 resent to other recipients.
22518
22519 &*Note:*& If used on a transport handling multiple recipients
22520 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22521 transport if &%batch_max%& is greater than 1)
22522 then information about Bcc recipients will be leaked.
22523 Doing so is generally not advised.
22524
22525
22526 .option event_action transports string&!! unset
22527 .cindex events
22528 This option declares a string to be expanded for Exim's events mechanism.
22529 For details see chapter &<<CHAPevents>>&.
22530
22531
22532 .option group transports string&!! "Exim group"
22533 .cindex "transport" "group; specifying"
22534 This option specifies a gid for running the transport process, overriding any
22535 value that the router supplies, and also overriding any value associated with
22536 &%user%& (see below).
22537
22538
22539 .option headers_add transports list&!! unset
22540 .cindex "header lines" "adding in transport"
22541 .cindex "transport" "header lines; adding"
22542 This option specifies a list of text headers,
22543 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22544 which are (separately) expanded and added to the header
22545 portion of a message as it is transported, as described in section
22546 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22547 routers. If the result of the expansion is an empty string, or if the expansion
22548 is forced to fail, no action is taken. Other expansion failures are treated as
22549 errors and cause the delivery to be deferred.
22550
22551 Unlike most options, &%headers_add%& can be specified multiple times
22552 for a transport; all listed headers are added.
22553
22554
22555 .option headers_only transports boolean false
22556 .cindex "transport" "header lines only"
22557 .cindex "message" "transporting headers only"
22558 .cindex "header lines" "transporting"
22559 If this option is set, the message's body is not transported. It is mutually
22560 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22561 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22562 checked, since this option does not automatically suppress them.
22563
22564
22565 .option headers_remove transports list&!! unset
22566 .cindex "header lines" "removing"
22567 .cindex "transport" "header lines; removing"
22568 This option specifies a list of text headers,
22569 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22570 to be removed from the message.
22571 However, the option has no effect when an address is just being verified.
22572 Each list item is separately expanded.
22573 If the result of the expansion is an empty string, or if the expansion
22574 is forced to fail, no action is taken. Other expansion failures are treated as
22575 errors and cause the delivery to be deferred.
22576 If an item ends in *, it will match any header with the given prefix.
22577
22578 Matching headers are omitted from the message as it is transported, as described
22579 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22580 routers.
22581
22582 Unlike most options, &%headers_remove%& can be specified multiple times
22583 for a transport; all listed headers are removed.
22584
22585 &*Warning*&: Because of the separate expansion of the list items,
22586 items that contain a list separator must have it doubled.
22587 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22588
22589
22590
22591 .option headers_rewrite transports string unset
22592 .cindex "transport" "header lines; rewriting"
22593 .cindex "rewriting" "at transport time"
22594 This option allows addresses in header lines to be rewritten at transport time,
22595 that is, as the message is being copied to its destination. The contents of the
22596 option are a colon-separated list of rewriting rules. Each rule is in exactly
22597 the same form as one of the general rewriting rules that are applied when a
22598 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22599 example,
22600 .code
22601 headers_rewrite = a@b c@d f : \
22602                   x@y w@z
22603 .endd
22604 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22605 &'w@z'& in all address-bearing header lines. The rules are applied to the
22606 header lines just before they are written out at transport time, so they affect
22607 only those copies of the message that pass through the transport. However, only
22608 the message's original header lines, and any that were added by a system
22609 filter, are rewritten. If a router or transport adds header lines, they are not
22610 affected by this option. These rewriting rules are &'not'& applied to the
22611 envelope. You can change the return path using &%return_path%&, but you cannot
22612 change envelope recipients at this time.
22613
22614
22615 .option home_directory transports string&!! unset
22616 .cindex "transport" "home directory for"
22617 .vindex "&$home$&"
22618 This option specifies a home directory setting for a local transport,
22619 overriding any value that may be set by the router. The home directory is
22620 placed in &$home$& while expanding the transport's private options. It is also
22621 used as the current directory if no current directory is set by the
22622 &%current_directory%& option on the transport or the
22623 &%transport_current_directory%& option on the router. If the expansion fails
22624 for any reason, including forced failure, an error is logged, and delivery is
22625 deferred.
22626
22627
22628 .option initgroups transports boolean false
22629 .cindex "additional groups"
22630 .cindex "groups" "additional"
22631 .cindex "transport" "group; additional"
22632 If this option is true and the uid for the delivery process is provided by the
22633 transport, the &[initgroups()]& function is called when running the transport
22634 to ensure that any additional groups associated with the uid are set up.
22635
22636
22637 .option max_parallel transports integer&!! unset
22638 .cindex limit "transport parallelism"
22639 .cindex transport "parallel processes"
22640 .cindex transport "concurrency limit"
22641 .cindex "delivery" "parallelism for transport"
22642 If this option is set and expands to an integer greater than zero
22643 it limits the number of concurrent runs of the transport.
22644 The control does not apply to shadow transports.
22645
22646 .cindex "hints database" "transport concurrency control"
22647 Exim implements this control by means of a hints database in which a record is
22648 incremented whenever a transport process is being created. The record
22649 is decremented and possibly removed when the process terminates.
22650 Obviously there is scope for
22651 records to get left lying around if there is a system or program crash. To
22652 guard against this, Exim ignores any records that are more than six hours old.
22653
22654 If you use this option, you should also arrange to delete the
22655 relevant hints database whenever your system reboots. The names of the files
22656 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22657 may be one or two files, depending on the type of DBM in use. The same files
22658 are used for ETRN and smtp transport serialization.
22659
22660
22661 .option message_size_limit transports string&!! 0
22662 .cindex "limit" "message size per transport"
22663 .cindex "size" "of message, limit"
22664 .cindex "transport" "message size; limiting"
22665 This option controls the size of messages passed through the transport. It is
22666 expanded before use; the result of the expansion must be a sequence of decimal
22667 digits, optionally followed by K or M. If the expansion fails for any reason,
22668 including forced failure, or if the result is not of the required form,
22669 delivery is deferred. If the value is greater than zero and the size of a
22670 message exceeds this limit, the address is failed. If there is any chance that
22671 the resulting bounce message could be routed to the same transport, you should
22672 ensure that &%return_size_limit%& is less than the transport's
22673 &%message_size_limit%&, as otherwise the bounce message will fail to get
22674 delivered.
22675
22676
22677
22678 .option rcpt_include_affixes transports boolean false
22679 .cindex "prefix" "for local part, including in envelope"
22680 .cindex "suffix for local part" "including in envelope"
22681 .cindex "local part" "prefix"
22682 .cindex "local part" "suffix"
22683 When this option is false (the default), and an address that has had any
22684 affixes (prefixes or suffixes) removed from the local part is delivered by any
22685 form of SMTP or LMTP, the affixes are not included. For example, if a router
22686 that contains
22687 .code
22688 local_part_prefix = *-
22689 .endd
22690 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22691 is delivered with
22692 .code
22693 RCPT TO:<xyz@some.domain>
22694 .endd
22695 This is also the case when an ACL-time callout is being used to verify a
22696 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22697 whole local part is included in the RCPT command. This option applies to BSMTP
22698 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22699 &(lmtp)& and &(smtp)& transports.
22700
22701
22702 .option retry_use_local_part transports boolean "see below"
22703 .cindex "hints database" "retry keys"
22704 When a delivery suffers a temporary failure, a retry record is created
22705 in Exim's hints database. For remote deliveries, the key for the retry record
22706 is based on the name and/or IP address of the failing remote host. For local
22707 deliveries, the key is normally the entire address, including both the local
22708 part and the domain. This is suitable for most common cases of local delivery
22709 temporary failure &-- for example, exceeding a mailbox quota should delay only
22710 deliveries to that mailbox, not to the whole domain.
22711
22712 However, in some special cases you may want to treat a temporary local delivery
22713 as a failure associated with the domain, and not with a particular local part.
22714 (For example, if you are storing all mail for some domain in files.) You can do
22715 this by setting &%retry_use_local_part%& false.
22716
22717 For all the local transports, its default value is true. For remote transports,
22718 the default value is false for tidiness, but changing the value has no effect
22719 on a remote transport in the current implementation.
22720
22721
22722 .option return_path transports string&!! unset
22723 .cindex "envelope sender"
22724 .cindex "envelope from"
22725 .cindex "transport" "return path; changing"
22726 .cindex "return path" "changing in transport"
22727 If this option is set, the string is expanded at transport time and replaces
22728 the existing return path (envelope sender) value in the copy of the message
22729 that is being delivered. An empty return path is permitted. This feature is
22730 designed for remote deliveries, where the value of this option is used in the
22731 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22732 only effect is to change the address that is placed in the &'Return-path:'&
22733 header line, if one is added to the message (see the next option).
22734
22735 &*Note:*& A changed return path is not logged unless you add
22736 &%return_path_on_delivery%& to the log selector.
22737
22738 .vindex "&$return_path$&"
22739 The expansion can refer to the existing value via &$return_path$&. This is
22740 either the message's envelope sender, or an address set by the
22741 &%errors_to%& option on a router. If the expansion is forced to fail, no
22742 replacement occurs; if it fails for another reason, delivery is deferred. This
22743 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22744 section &<<SECTverp>>&.
22745
22746 &*Note*&: If a delivery error is detected locally, including the case when a
22747 remote server rejects a message at SMTP time, the bounce message is not sent to
22748 the value of this option. It is sent to the previously set errors address.
22749 This defaults to the incoming sender address, but can be changed by setting
22750 &%errors_to%& in a router.
22751
22752
22753
22754 .option return_path_add transports boolean false
22755 .chindex Return-path:
22756 If this option is true, a &'Return-path:'& header is added to the message.
22757 Although the return path is normally available in the prefix line of BSD
22758 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22759 have easy access to it.
22760
22761 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22762 the delivery SMTP server makes the final delivery"&. This implies that this
22763 header should not be present in incoming messages. Exim has a configuration
22764 option, &%return_path_remove%&, which requests removal of this header from
22765 incoming messages, so that delivered messages can safely be resent to other
22766 recipients.
22767
22768
22769 .option shadow_condition transports string&!! unset
22770 See &%shadow_transport%& below.
22771
22772
22773 .option shadow_transport transports string unset
22774 .cindex "shadow transport"
22775 .cindex "transport" "shadow"
22776 A local transport may set the &%shadow_transport%& option to the name of
22777 another local transport. Shadow remote transports are not supported.
22778
22779 Whenever a delivery to the main transport succeeds, and either
22780 &%shadow_condition%& is unset, or its expansion does not result in the empty
22781 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22782 passed to the shadow transport, with the same delivery address or addresses. If
22783 expansion fails, no action is taken except that non-forced expansion failures
22784 cause a log line to be written.
22785
22786 The result of the shadow transport is discarded and does not affect the
22787 subsequent processing of the message. Only a single level of shadowing is
22788 provided; the &%shadow_transport%& option is ignored on any transport when it
22789 is running as a shadow. Options concerned with output from pipes are also
22790 ignored. The log line for the successful delivery has an item added on the end,
22791 of the form
22792 .code
22793 ST=<shadow transport name>
22794 .endd
22795 If the shadow transport did not succeed, the error message is put in
22796 parentheses afterwards. Shadow transports can be used for a number of different
22797 purposes, including keeping more detailed log information than Exim normally
22798 provides, and implementing automatic acknowledgment policies based on message
22799 headers that some sites insist on.
22800
22801
22802 .option transport_filter transports string&!! unset
22803 .cindex "transport" "filter"
22804 .cindex "filter" "transport filter"
22805 This option sets up a filtering (in the Unix shell sense) process for messages
22806 at transport time. It should not be confused with mail filtering as set up by
22807 individual users or via a system filter.
22808 If unset, or expanding to an empty string, no filtering is done.
22809
22810 When the message is about to be written out, the command specified by
22811 &%transport_filter%& is started up in a separate, parallel process, and
22812 the entire message, including the header lines, is passed to it on its standard
22813 input (this in fact is done from a third process, to avoid deadlock). The
22814 command must be specified as an absolute path.
22815
22816 The lines of the message that are written to the transport filter are
22817 terminated by newline (&"\n"&). The message is passed to the filter before any
22818 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22819 lines beginning with a dot, and also before any processing implied by the
22820 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22821 &(pipe)& transports.
22822
22823 The standard error for the filter process is set to the same destination as its
22824 standard output; this is read and written to the message's ultimate
22825 destination. The process that writes the message to the filter, the
22826 filter itself, and the original process that reads the result and delivers it
22827 are all run in parallel, like a shell pipeline.
22828
22829 The filter can perform any transformations it likes, but of course should take
22830 care not to break RFC 2822 syntax. Exim does not check the result, except to
22831 test for a final newline when SMTP is in use. All messages transmitted over
22832 SMTP must end with a newline, so Exim supplies one if it is missing.
22833
22834 .cindex "content scanning" "per user"
22835 A transport filter can be used to provide content-scanning on a per-user basis
22836 at delivery time if the only required effect of the scan is to modify the
22837 message. For example, a content scan could insert a new header line containing
22838 a spam score. This could be interpreted by a filter in the user's MUA. It is
22839 not possible to discard a message at this stage.
22840
22841 .cindex "SIZE" "ESMTP extension"
22842 A problem might arise if the filter increases the size of a message that is
22843 being sent down an SMTP connection. If the receiving SMTP server has indicated
22844 support for the SIZE parameter, Exim will have sent the size of the message
22845 at the start of the SMTP session. If what is actually sent is substantially
22846 more, the server might reject the message. This can be worked round by setting
22847 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22848 additions to the message, or to disable the use of SIZE altogether.
22849
22850 .vindex "&$pipe_addresses$&"
22851 The value of the &%transport_filter%& option is the command string for starting
22852 the filter, which is run directly from Exim, not under a shell. The string is
22853 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22854 Exim breaks it up into arguments and then expands each argument separately (see
22855 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22856 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22857 of arguments, one for each address that applies to this delivery. (This isn't
22858 an ideal name for this feature here, but as it was already implemented for the
22859 &(pipe)& transport, it seemed sensible not to change it.)
22860
22861 .vindex "&$host$&"
22862 .vindex "&$host_address$&"
22863 The expansion variables &$host$& and &$host_address$& are available when the
22864 transport is a remote one. They contain the name and IP address of the host to
22865 which the message is being sent. For example:
22866 . used to have $sender_address in this cmdline, but it's tainted
22867 .code
22868 transport_filter = /some/directory/transport-filter.pl \
22869   $host $host_address $pipe_addresses
22870 .endd
22871
22872 Two problems arise if you want to use more complicated expansion items to
22873 generate transport filter commands, both of which due to the fact that the
22874 command is split up &'before'& expansion.
22875 .ilist
22876 If an expansion item contains white space, you must quote it, so that it is all
22877 part of the same command item. If the entire option setting is one such
22878 expansion item, you have to take care what kind of quoting you use. For
22879 example:
22880 .code
22881 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22882 .endd
22883 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22884 &(/bin/cmd2)& otherwise.
22885
22886 Option strings in general have any fully-surrounding double quote wrapping
22887 removed early in parsing (see &<<SECTstrings>>&).
22888 Then, for this option, quotes protect against whitespace being
22889 regarded as a separator while splitting into the command argument vector.
22890 Either double or single quotes can be used here;
22891 the former interprets backlash-quoted charachters
22892 and the latter does not.
22893
22894 If double quotes had been used in this example, they would have been
22895 stripped by Exim when it read the option's value. When the value is used, if
22896 the single quotes were missing, the line would be split into two items,
22897 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22898 Exim tried to expand the first one.
22899 .next
22900 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22901 expansion cannot generate multiple arguments, or a command name followed by
22902 arguments. Consider this example:
22903 .code
22904 transport_filter = ${lookup{$host}lsearch{/a/file}\
22905                     {$value}{/bin/cat}}
22906 .endd
22907 The result of the lookup is interpreted as the name of the command, even
22908 if it contains white space. The simplest way round this is to use a shell:
22909 .code
22910 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22911                                {$value}{/bin/cat}}
22912 .endd
22913 .endlist
22914
22915 The filter process is run under the same uid and gid as the normal delivery.
22916 For remote deliveries this is the Exim uid/gid by default. The command should
22917 normally yield a zero return code. Transport filters are not supposed to fail.
22918 A non-zero code is taken to mean that the transport filter encountered some
22919 serious problem. Delivery of the message is deferred; the message remains on
22920 the queue and is tried again later. It is not possible to cause a message to be
22921 bounced from a transport filter.
22922
22923 If a transport filter is set on an autoreply transport, the original message is
22924 passed through the filter as it is being copied into the newly generated
22925 message, which happens if the &%return_message%& option is set.
22926
22927
22928 .option transport_filter_timeout transports time 5m
22929 .cindex "transport" "filter, timeout"
22930 When Exim is reading the output of a transport filter, it applies a timeout
22931 that can be set by this option. Exceeding the timeout is normally treated as a
22932 temporary delivery failure. However, if a transport filter is used with a
22933 &(pipe)& transport, a timeout in the transport filter is treated in the same
22934 way as a timeout in the pipe command itself. By default, a timeout is a hard
22935 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22936 becomes a temporary error.
22937
22938
22939 .option user transports string&!! "Exim user"
22940 .cindex "uid (user id)" "local delivery"
22941 .cindex "transport" "user, specifying"
22942 This option specifies the user under whose uid the delivery process is to be
22943 run, overriding any uid that may have been set by the router. If the user is
22944 given as a name, the uid is looked up from the password data, and the
22945 associated group is taken as the value of the gid to be used if the &%group%&
22946 option is not set.
22947
22948 For deliveries that use local transports, a user and group are normally
22949 specified explicitly or implicitly (for example, as a result of
22950 &%check_local_user%&) by the router or transport.
22951
22952 .cindex "hints database" "access by remote transport"
22953 For remote transports, you should leave this option unset unless you really are
22954 sure you know what you are doing. When a remote transport is running, it needs
22955 to be able to access Exim's hints databases, because each host may have its own
22956 retry data.
22957 .ecindex IIDgenoptra1
22958 .ecindex IIDgenoptra2
22959 .ecindex IIDgenoptra3
22960
22961
22962
22963
22964
22965
22966 . ////////////////////////////////////////////////////////////////////////////
22967 . ////////////////////////////////////////////////////////////////////////////
22968
22969 .chapter "Address batching in local transports" "CHAPbatching" &&&
22970          "Address batching"
22971 .cindex "transport" "local; address batching in"
22972 The only remote transport (&(smtp)&) is normally configured to handle more than
22973 one address at a time, so that when several addresses are routed to the same
22974 remote host, just one copy of the message is sent. Local transports, however,
22975 normally handle one address at a time. That is, a separate instance of the
22976 transport is run for each address that is routed to the transport. A separate
22977 copy of the message is delivered each time.
22978
22979 .cindex "batched local delivery"
22980 .oindex "&%batch_max%&"
22981 .oindex "&%batch_id%&"
22982 In special cases, it may be desirable to handle several addresses at once in a
22983 local transport, for example:
22984
22985 .ilist
22986 In an &(appendfile)& transport, when storing messages in files for later
22987 delivery by some other means, a single copy of the message with multiple
22988 recipients saves space.
22989 .next
22990 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22991 a single copy saves time, and is the normal way LMTP is expected to work.
22992 .next
22993 In a &(pipe)& transport, when passing the message
22994 to a scanner program or
22995 to some other delivery mechanism such as UUCP, multiple recipients may be
22996 acceptable.
22997 .endlist
22998
22999 These three local transports all have the same options for controlling multiple
23000 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
23001 repeating the information for each transport, these options are described here.
23002
23003 The &%batch_max%& option specifies the maximum number of addresses that can be
23004 delivered together in a single run of the transport. Its default value is one
23005 (no batching). When more than one address is routed to a transport that has a
23006 &%batch_max%& value greater than one, the addresses are delivered in a batch
23007 (that is, in a single run of the transport with multiple recipients), subject
23008 to certain conditions:
23009
23010 .ilist
23011 .vindex "&$local_part$&"
23012 If any of the transport's options contain a reference to &$local_part$&, no
23013 batching is possible.
23014 .next
23015 .vindex "&$domain$&"
23016 If any of the transport's options contain a reference to &$domain$&, only
23017 addresses with the same domain are batched.
23018 .next
23019 .cindex "customizing" "batching condition"
23020 If &%batch_id%& is set, it is expanded for each address, and only those
23021 addresses with the same expanded value are batched. This allows you to specify
23022 customized batching conditions. Failure of the expansion for any reason,
23023 including forced failure, disables batching, but it does not stop the delivery
23024 from taking place.
23025 .next
23026 Batched addresses must also have the same errors address (where to send
23027 delivery errors), the same header additions and removals, the same user and
23028 group for the transport, and if a host list is present, the first host must
23029 be the same.
23030 .endlist
23031
23032 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23033 both when the file or pipe command is specified in the transport, and when it
23034 is specified by a &(redirect)& router, but all the batched addresses must of
23035 course be routed to the same file or pipe command. These two transports have an
23036 option called &%use_bsmtp%&, which causes them to deliver the message in
23037 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23038 &%check_string%& and &%escape_string%& options are forced to the values
23039 .code
23040 check_string = "."
23041 escape_string = ".."
23042 .endd
23043 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23044 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23045 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23046
23047 .cindex "&'Envelope-to:'& header line"
23048 If the generic &%envelope_to_add%& option is set for a batching transport, the
23049 &'Envelope-to:'& header that is added to the message contains all the addresses
23050 that are being processed together. If you are using a batching &(appendfile)&
23051 transport without &%use_bsmtp%&, the only way to preserve the recipient
23052 addresses is to set the &%envelope_to_add%& option.
23053
23054 .cindex "&(pipe)& transport" "with multiple addresses"
23055 .vindex "&$pipe_addresses$&"
23056 If you are using a &(pipe)& transport without BSMTP, and setting the
23057 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23058 the command. This is not a true variable; it is a bit of magic that causes each
23059 of the recipient addresses to be inserted into the command as a separate
23060 argument. This provides a way of accessing all the addresses that are being
23061 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23062 are specified by a &(redirect)& router.
23063
23064
23065
23066
23067 . ////////////////////////////////////////////////////////////////////////////
23068 . ////////////////////////////////////////////////////////////////////////////
23069
23070 .chapter "The appendfile transport" "CHAPappendfile"
23071 .scindex IIDapptra1 "&(appendfile)& transport"
23072 .scindex IIDapptra2 "transports" "&(appendfile)&"
23073 .cindex "directory creation"
23074 .cindex "creating directories"
23075 The &(appendfile)& transport delivers a message by appending it to an existing
23076 file, or by creating an entirely new file in a specified directory. Single
23077 files to which messages are appended can be in the traditional Unix mailbox
23078 format, or optionally in the MBX format supported by the Pine MUA and
23079 University of Washington IMAP daemon, &'inter alia'&. When each message is
23080 being delivered as a separate file, &"maildir"& format can optionally be used
23081 to give added protection against failures that happen part-way through the
23082 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23083 supported. For all file formats, Exim attempts to create as many levels of
23084 directory as necessary, provided that &%create_directory%& is set.
23085
23086 The code for the optional formats is not included in the Exim binary by
23087 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23088 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23089 included.
23090
23091 .cindex "quota" "system"
23092 Exim recognizes system quota errors, and generates an appropriate message. Exim
23093 also supports its own quota control within the transport, for use when the
23094 system facility is unavailable or cannot be used for some reason.
23095
23096 If there is an error while appending to a file (for example, quota exceeded or
23097 partition filled), Exim attempts to reset the file's length and last
23098 modification time back to what they were before. If there is an error while
23099 creating an entirely new file, the new file is removed.
23100
23101 Before appending to a file, a number of security checks are made, and the
23102 file is locked. A detailed description is given below, after the list of
23103 private options.
23104
23105 The &(appendfile)& transport is most commonly used for local deliveries to
23106 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23107 putting messages into files for remote delivery by some means other than Exim.
23108 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23109 option).
23110
23111
23112
23113 .section "The file and directory options" "SECTfildiropt"
23114 The &%file%& option specifies a single file, to which the message is appended;
23115 the &%directory%& option specifies a directory, in which a new file containing
23116 the message is created. Only one of these two options can be set, and for
23117 normal deliveries to mailboxes, one of them &'must'& be set.
23118
23119 .vindex "&$address_file$&"
23120 .vindex "&$local_part$&"
23121 However, &(appendfile)& is also used for delivering messages to files or
23122 directories whose names (or parts of names) are obtained from alias,
23123 forwarding, or filtering operations (for example, a &%save%& command in a
23124 user's Exim filter). When such a transport is running, &$local_part$& contains
23125 the local part that was aliased or forwarded, and &$address_file$& contains the
23126 name (or partial name) of the file or directory generated by the redirection
23127 operation. There are two cases:
23128
23129 .ilist
23130 If neither &%file%& nor &%directory%& is set, the redirection operation
23131 must specify an absolute path (one that begins with &`/`&). This is the most
23132 common case when users with local accounts use filtering to sort mail into
23133 different folders. See for example, the &(address_file)& transport in the
23134 default configuration. If the path ends with a slash, it is assumed to be the
23135 name of a directory. A delivery to a directory can also be forced by setting
23136 &%maildir_format%& or &%mailstore_format%&.
23137 .next
23138 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23139 used to determine the file or directory name for the delivery. Normally, the
23140 contents of &$address_file$& are used in some way in the string expansion.
23141 .endlist
23142 If the &%create_file%& option is set to a path which
23143 matches (see the option definition below for details)
23144 a file or directory name
23145 for the delivery, that name becomes de-tainted.
23146
23147 .cindex "tainted data" "in filenames"
23148 .cindex appendfile "tainted data"
23149 Tainted data may not be used for a file or directory name.
23150 This means that, for instance, &$local_part$& cannot be used directly
23151 as a component of a path.  It can however be used as the key for a lookup
23152 which returns a path (or component).
23153
23154
23155 .cindex "Sieve filter" "configuring &(appendfile)&"
23156 .cindex "Sieve filter" "relative mailbox path handling"
23157 As an example of the second case, consider an environment where users do not
23158 have home directories. They may be permitted to use Exim filter commands of the
23159 form:
23160 .code
23161 save folder23
23162 .endd
23163 or Sieve filter commands of the form:
23164 .code
23165 require "fileinto";
23166 fileinto "folder23";
23167 .endd
23168 In this situation, the expansion of &%file%& or &%directory%& in the transport
23169 must transform the relative path into an appropriate absolute filename. In the
23170 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23171 is used as a result of a &"keep"& action in the filter. This example shows one
23172 way of handling this requirement:
23173 .code
23174 file = ${if eq{$address_file}{inbox} \
23175             {/var/mail/$local_part_data} \
23176             {${if eq{${substr_0_1:$address_file}}{/} \
23177                   {$address_file} \
23178                   {$home/mail/$address_file} \
23179             }} \
23180        }
23181 .endd
23182 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23183 location, absolute paths are used without change, and other folders are in the
23184 &_mail_& directory within the home directory.
23185
23186 &*Note 1*&: While processing an Exim filter, a relative path such as
23187 &_folder23_& is turned into an absolute path if a home directory is known to
23188 the router. In particular, this is the case if &%check_local_user%& is set. If
23189 you want to prevent this happening at routing time, you can set
23190 &%router_home_directory%& empty. This forces the router to pass the relative
23191 path to the transport.
23192
23193 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23194 the &%file%& or &%directory%& option is still used if it is set.
23195
23196
23197
23198
23199 .section "Private options for appendfile" "SECID134"
23200 .cindex "options" "&(appendfile)& transport"
23201
23202
23203
23204 .option allow_fifo appendfile boolean false
23205 .cindex "fifo (named pipe)"
23206 .cindex "named pipe (fifo)"
23207 .cindex "pipe" "named (fifo)"
23208 Setting this option permits delivery to named pipes (FIFOs) as well as to
23209 regular files. If no process is reading the named pipe at delivery time, the
23210 delivery is deferred.
23211
23212
23213 .option allow_symlink appendfile boolean false
23214 .cindex "symbolic link" "to mailbox"
23215 .cindex "mailbox" "symbolic link"
23216 By default, &(appendfile)& will not deliver if the path name for the file is
23217 that of a symbolic link. Setting this option relaxes that constraint, but there
23218 are security issues involved in the use of symbolic links. Be sure you know
23219 what you are doing if you set this. Details of exactly what this option affects
23220 are included in the discussion which follows this list of options.
23221
23222
23223 .option batch_id appendfile string&!! unset
23224 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23225 However, batching is automatically disabled for &(appendfile)& deliveries that
23226 happen as a result of forwarding or aliasing or other redirection directly to a
23227 file.
23228
23229
23230 .option batch_max appendfile integer 1
23231 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23232
23233
23234 .option check_group appendfile boolean false
23235 When this option is set, the group owner of the file defined by the &%file%&
23236 option is checked to see that it is the same as the group under which the
23237 delivery process is running. The default setting is false because the default
23238 file mode is 0600, which means that the group is irrelevant.
23239
23240
23241 .option check_owner appendfile boolean true
23242 When this option is set, the owner of the file defined by the &%file%& option
23243 is checked to ensure that it is the same as the user under which the delivery
23244 process is running.
23245
23246
23247 .option check_string appendfile string "see below"
23248 .cindex "&""From""& line"
23249 As &(appendfile)& writes the message, the start of each line is tested for
23250 matching &%check_string%&, and if it does, the initial matching characters are
23251 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23252 a literal string, not a regular expression, and the case of any letters it
23253 contains is significant.
23254
23255 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23256 are forced to &"."& and &".."& respectively, and any settings in the
23257 configuration are ignored. Otherwise, they default to &"From&~"& and
23258 &">From&~"& when the &%file%& option is set, and unset when any of the
23259 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23260
23261 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23262 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23263 &"From&~"& indicates the start of a new message. All four options need changing
23264 if another format is used. For example, to deliver to mailboxes in MMDF format:
23265 .cindex "MMDF format mailbox"
23266 .cindex "mailbox" "MMDF format"
23267 .code
23268 check_string = "\1\1\1\1\n"
23269 escape_string = "\1\1\1\1 \n"
23270 message_prefix = "\1\1\1\1\n"
23271 message_suffix = "\1\1\1\1\n"
23272 .endd
23273 .option create_directory appendfile boolean true
23274 .cindex "directory creation"
23275 When this option is true, Exim attempts to create any missing superior
23276 directories for the file that it is about to write. A created directory's mode
23277 is given by the &%directory_mode%& option.
23278
23279 The group ownership of a newly created directory is highly dependent on the
23280 operating system (and possibly the file system) that is being used. For
23281 example, in Solaris, if the parent directory has the setgid bit set, its group
23282 is propagated to the child; if not, the currently set group is used. However,
23283 in FreeBSD, the parent's group is always used.
23284
23285
23286
23287 .option create_file appendfile string anywhere
23288 This option constrains the location of files and directories that are created
23289 by this transport. It applies to files defined by the &%file%& option and
23290 directories defined by the &%directory%& option. In the case of maildir
23291 delivery, it applies to the top level directory, not the maildir directories
23292 beneath.
23293
23294 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23295 &"belowhome"&, or to an absolute path.
23296
23297 In the second and third cases, a home directory must have been
23298 set for the transport, and the file or directory being created must
23299 reside within it.
23300 The "belowhome" checking additionally checks for attempts to use "../"
23301 to evade the testing.
23302 This option is not useful when an explicit filename is
23303 given for normal mailbox deliveries. It is intended for the case when filenames
23304 are generated from users' &_.forward_& files. These are usually handled
23305 by an &(appendfile)& transport called &%address_file%&. See also
23306 &%file_must_exist%&.
23307
23308 In the fourth case,
23309 the value given for this option must be an absolute path for an
23310 existing directory.
23311 The value is used for checking instead of a home directory;
23312 checking is done in "belowhome" mode.
23313
23314 .cindex "tainted data" "de-tainting"
23315 .cindex "de-tainting" "using appendfile create_file option"
23316 If "belowhome" checking is used, the file or directory path
23317 becomes de-tainted.
23318
23319
23320 .option directory appendfile string&!! unset
23321 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23322 or &%directory%& must be set, unless the delivery is the direct result of a
23323 redirection (see section &<<SECTfildiropt>>&).
23324
23325 When &%directory%& is set, the string is expanded, and the message is delivered
23326 into a new file or files in or below the given directory, instead of being
23327 appended to a single mailbox file. A number of different formats are provided
23328 (see &%maildir_format%& and &%mailstore_format%&), and see section
23329 &<<SECTopdir>>& for further details of this form of delivery.
23330
23331 The result of expansion must not be tainted, unless the &%create_file%& option
23332 specifies a path.
23333
23334
23335 .option directory_file appendfile string&!! "see below"
23336 .cindex "base62"
23337 .vindex "&$inode$&"
23338 When &%directory%& is set, but neither &%maildir_format%& nor
23339 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23340 whose name is obtained by expanding this string. The default value is:
23341 .code
23342 q${base62:$tod_epoch}-$inode
23343 .endd
23344 This generates a unique name from the current time, in base 62 form, and the
23345 inode of the file. The variable &$inode$& is available only when expanding this
23346 option.
23347
23348
23349 .option directory_mode appendfile "octal integer" 0700
23350 If &(appendfile)& creates any directories as a result of the
23351 &%create_directory%& option, their mode is specified by this option.
23352
23353
23354 .option escape_string appendfile string "see description"
23355 See &%check_string%& above.
23356
23357
23358 .option file appendfile string&!! unset
23359 This option is mutually exclusive with the &%directory%& option, but one of
23360 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23361 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23362 specifies a single file, to which the message is appended. One or more of
23363 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23364 &%file%&.
23365
23366 The result of expansion must not be tainted, unless the &%create_file%& option
23367 specifies a path.
23368
23369 .cindex "NFS" "lock file"
23370 .cindex "locking files"
23371 .cindex "lock files"
23372 If you are using more than one host to deliver over NFS into the same
23373 mailboxes, you should always use lock files.
23374
23375 The string value is expanded for each delivery, and must yield an absolute
23376 path. The most common settings of this option are variations on one of these
23377 examples:
23378 .code
23379 file = /var/spool/mail/$local_part_data
23380 file = /home/$local_part_data/inbox
23381 file = $home/inbox
23382 .endd
23383 .cindex "&""sticky""& bit"
23384 In the first example, all deliveries are done into the same directory. If Exim
23385 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23386 create a file in the directory, so the &"sticky"& bit must be turned on for
23387 deliveries to be possible, or alternatively the &%group%& option can be used to
23388 run the delivery under a group id which has write access to the directory.
23389
23390
23391
23392 .option file_format appendfile string unset
23393 .cindex "file" "mailbox; checking existing format"
23394 This option requests the transport to check the format of an existing file
23395 before adding to it. The check consists of matching a specific string at the
23396 start of the file. The value of the option consists of an even number of
23397 colon-separated strings. The first of each pair is the test string, and the
23398 second is the name of a transport. If the transport associated with a matched
23399 string is not the current transport, control is passed over to the other
23400 transport. For example, suppose the standard &(local_delivery)& transport has
23401 this added to it:
23402 .code
23403 file_format = "From       : local_delivery :\
23404                \1\1\1\1\n : local_mmdf_delivery"
23405 .endd
23406 Mailboxes that begin with &"From"& are still handled by this transport, but if
23407 a mailbox begins with four binary ones followed by a newline, control is passed
23408 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23409 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23410 is assumed to match the current transport. If the start of a mailbox doesn't
23411 match any string, or if the transport named for a given string is not defined,
23412 delivery is deferred.
23413
23414
23415 .option file_must_exist appendfile boolean false
23416 If this option is true, the file specified by the &%file%& option must exist.
23417 A temporary error occurs if it does not, causing delivery to be deferred.
23418 If this option is false, the file is created if it does not exist.
23419
23420
23421 .option lock_fcntl_timeout appendfile time 0s
23422 .cindex "timeout" "mailbox locking"
23423 .cindex "mailbox" "locking, blocking and non-blocking"
23424 .cindex "locking files"
23425 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23426 when locking an open mailbox file. If the call fails, the delivery process
23427 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23428 Non-blocking calls are used so that the file is not kept open during the wait
23429 for the lock; the reason for this is to make it as safe as possible for
23430 deliveries over NFS in the case when processes might be accessing an NFS
23431 mailbox without using a lock file. This should not be done, but
23432 misunderstandings and hence misconfigurations are not unknown.
23433
23434 On a busy system, however, the performance of a non-blocking lock approach is
23435 not as good as using a blocking lock with a timeout. In this case, the waiting
23436 is done inside the system call, and Exim's delivery process acquires the lock
23437 and can proceed as soon as the previous lock holder releases it.
23438
23439 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23440 timeout, are used. There may still be some retrying: the maximum number of
23441 retries is
23442 .code
23443 (lock_retries * lock_interval) / lock_fcntl_timeout
23444 .endd
23445 rounded up to the next whole number. In other words, the total time during
23446 which &(appendfile)& is trying to get a lock is roughly the same, unless
23447 &%lock_fcntl_timeout%& is set very large.
23448
23449 You should consider setting this option if you are getting a lot of delayed
23450 local deliveries because of errors of the form
23451 .code
23452 failed to lock mailbox /some/file (fcntl)
23453 .endd
23454
23455 .option lock_flock_timeout appendfile time 0s
23456 This timeout applies to file locking when using &[flock()]& (see
23457 &%use_flock%&); the timeout operates in a similar manner to
23458 &%lock_fcntl_timeout%&.
23459
23460
23461 .option lock_interval appendfile time 3s
23462 This specifies the time to wait between attempts to lock the file. See below
23463 for details of locking.
23464
23465
23466 .option lock_retries appendfile integer 10
23467 This specifies the maximum number of attempts to lock the file. A value of zero
23468 is treated as 1. See below for details of locking.
23469
23470
23471 .option lockfile_mode appendfile "octal integer" 0600
23472 This specifies the mode of the created lock file, when a lock file is being
23473 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23474
23475
23476 .option lockfile_timeout appendfile time 30m
23477 .cindex "timeout" "mailbox locking"
23478 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23479 exists and is older than this value, it is assumed to have been left behind by
23480 accident, and Exim attempts to remove it.
23481
23482
23483 .option mailbox_filecount 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 number of files in the mailbox. It must be a decimal number, optionally
23488 followed by K or M. This provides a way of obtaining this information from an
23489 external source that maintains the data.
23490
23491
23492 .option mailbox_size appendfile string&!! unset
23493 .cindex "mailbox" "specifying size of"
23494 .cindex "size" "of mailbox"
23495 If this option is set, it is expanded, and the result is taken as the current
23496 size the mailbox. It must be a decimal number, optionally followed by K or M.
23497 This provides a way of obtaining this information from an external source that
23498 maintains the data. This is likely to be helpful for maildir deliveries where
23499 it is computationally expensive to compute the size of a mailbox.
23500
23501
23502
23503 .option maildir_format appendfile boolean false
23504 .cindex "maildir format" "specifying"
23505 If this option is set with the &%directory%& option, the delivery is into a new
23506 file, in the &"maildir"& format that is used by other mail software. When the
23507 transport is activated directly from a &(redirect)& router (for example, the
23508 &(address_file)& transport in the default configuration), setting
23509 &%maildir_format%& causes the path received from the router to be treated as a
23510 directory, whether or not it ends with &`/`&. This option is available only if
23511 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23512 &<<SECTmaildirdelivery>>& below for further details.
23513
23514
23515 .option maildir_quota_directory_regex appendfile string "See below"
23516 .cindex "maildir format" "quota; directories included in"
23517 .cindex "quota" "maildir; directories included in"
23518 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23519 a regular expression for specifying directories, relative to the quota
23520 directory (see &%quota_directory%&), that should be included in the quota
23521 calculation. The default value is:
23522 .code
23523 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23524 .endd
23525 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23526 (directories whose names begin with a dot). If you want to exclude the
23527 &_Trash_&
23528 folder from the count (as some sites do), you need to change this setting to
23529 .code
23530 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23531 .endd
23532 This uses a negative lookahead in the regular expression to exclude the
23533 directory whose name is &_.Trash_&. When a directory is excluded from quota
23534 calculations, quota processing is bypassed for any messages that are delivered
23535 directly into that directory.
23536
23537
23538 .option maildir_retries appendfile integer 10
23539 This option specifies the number of times to retry when writing a file in
23540 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23541
23542
23543 .option maildir_tag appendfile string&!! unset
23544 This option applies only to deliveries in maildir format, and is described in
23545 section &<<SECTmaildirdelivery>>& below.
23546
23547
23548 .option maildir_use_size_file appendfile&!! boolean false
23549 .cindex "maildir format" "&_maildirsize_& file"
23550 The result of string expansion for this option must be a valid boolean value.
23551 If it is true, it enables support for &_maildirsize_& files. Exim
23552 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23553 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23554 value is zero. See &%maildir_quota_directory_regex%& above and section
23555 &<<SECTmaildirdelivery>>& below for further details.
23556
23557 .option maildirfolder_create_regex appendfile string unset
23558 .cindex "maildir format" "&_maildirfolder_& file"
23559 .cindex "&_maildirfolder_&, creating"
23560 The value of this option is a regular expression. If it is unset, it has no
23561 effect. Otherwise, before a maildir delivery takes place, the pattern is
23562 matched against the name of the maildir directory, that is, the directory
23563 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23564 delivery. If there is a match, Exim checks for the existence of a file called
23565 &_maildirfolder_& in the directory, and creates it if it does not exist.
23566 See section &<<SECTmaildirdelivery>>& for more details.
23567
23568
23569 .option mailstore_format appendfile boolean false
23570 .cindex "mailstore format" "specifying"
23571 If this option is set with the &%directory%& option, the delivery is into two
23572 new files in  &"mailstore"& format. The option is available only if
23573 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23574 below for further details.
23575
23576
23577 .option mailstore_prefix appendfile string&!! unset
23578 This option applies only to deliveries in mailstore format, and is described in
23579 section &<<SECTopdir>>& below.
23580
23581
23582 .option mailstore_suffix appendfile string&!! unset
23583 This option applies only to deliveries in mailstore format, and is described in
23584 section &<<SECTopdir>>& below.
23585
23586
23587 .option mbx_format appendfile boolean false
23588 .cindex "locking files"
23589 .cindex "file" "locking"
23590 .cindex "file" "MBX format"
23591 .cindex "MBX format, specifying"
23592 This option is available only if Exim has been compiled with SUPPORT_MBX
23593 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23594 the message is appended to the mailbox file in MBX format instead of
23595 traditional Unix format. This format is supported by Pine4 and its associated
23596 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23597
23598 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23599 automatically changed by the use of &%mbx_format%&. They should normally be set
23600 empty when using MBX format, so this option almost always appears in this
23601 combination:
23602 .code
23603 mbx_format = true
23604 message_prefix =
23605 message_suffix =
23606 .endd
23607 If none of the locking options are mentioned in the configuration,
23608 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23609 is possible to specify the other kinds of locking with &%mbx_format%&, but
23610 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23611 interworks with &'c-client'&, providing for shared access to the mailbox. It
23612 should not be used if any program that does not use this form of locking is
23613 going to access the mailbox, nor should it be used if the mailbox file is NFS
23614 mounted, because it works only when the mailbox is accessed from a single host.
23615
23616 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23617 the standard version of &'c-client'&, because as long as it has a mailbox open
23618 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23619 append messages to it.
23620
23621
23622 .option message_prefix appendfile string&!! "see below"
23623 .cindex "&""From""& line"
23624 The string specified here is expanded and output at the start of every message.
23625 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23626 in which case it is:
23627 .code
23628 message_prefix = "From ${if def:return_path{$return_path}\
23629   {MAILER-DAEMON}} $tod_bsdinbox\n"
23630 .endd
23631 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23632 &`\n`& to &`\r\n`& in &%message_prefix%&.
23633
23634 .option message_suffix appendfile string&!! "see below"
23635 The string specified here is expanded and output at the end of every message.
23636 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23637 in which case it is a single newline character. The suffix can be suppressed by
23638 setting
23639 .code
23640 message_suffix =
23641 .endd
23642 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23643 &`\n`& to &`\r\n`& in &%message_suffix%&.
23644
23645 .option mode appendfile "octal integer" 0600
23646 If the output file is created, it is given this mode. If it already exists and
23647 has wider permissions, they are reduced to this mode. If it has narrower
23648 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23649 if the delivery is the result of a &%save%& command in a filter file specifying
23650 a particular mode, the mode of the output file is always forced to take that
23651 value, and this option is ignored.
23652
23653
23654 .option mode_fail_narrower appendfile boolean true
23655 This option applies in the case when an existing mailbox file has a narrower
23656 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23657 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23658 continues with the delivery attempt, using the existing mode of the file.
23659
23660
23661 .option notify_comsat appendfile boolean false
23662 If this option is true, the &'comsat'& daemon is notified after every
23663 successful delivery to a user mailbox. This is the daemon that notifies logged
23664 on users about incoming mail.
23665
23666
23667 .option quota appendfile string&!! unset
23668 .cindex "quota" "imposed by Exim"
23669 This option imposes a limit on the size of the file to which Exim is appending,
23670 or to the total space used in the directory tree when the &%directory%& option
23671 is set. In the latter case, computation of the space used is expensive, because
23672 all the files in the directory (and any sub-directories) have to be
23673 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23674 &%maildir_use_size_file%& for ways to avoid this in environments where users
23675 have no shell access to their mailboxes).
23676
23677 As there is no interlock against two simultaneous deliveries into a
23678 multi-file mailbox, it is possible for the quota to be overrun in this case.
23679 For single-file mailboxes, of course, an interlock is a necessity.
23680
23681 A file's size is taken as its &'used'& value. Because of blocking effects, this
23682 may be a lot less than the actual amount of disk space allocated to the file.
23683 If the sizes of a number of files are being added up, the rounding effect can
23684 become quite noticeable, especially on systems that have large block sizes.
23685 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23686 the obvious value which users understand most easily.
23687
23688 The value of the option is expanded, and must then be a numerical value
23689 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23690 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23691 and further option modifiers. If Exim is running on a system with
23692 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23693 be handled.
23694
23695 The option modifier &%no_check%& can be used to force delivery even if the over
23696 quota condition is met. The quota gets updated as usual.
23697
23698 &*Note*&: A value of zero is interpreted as &"no quota"&.
23699
23700 The expansion happens while Exim is running as root, before it changes uid for
23701 the delivery. This means that files that are inaccessible to the end user can
23702 be used to hold quota values that are looked up in the expansion. When delivery
23703 fails because this quota is exceeded, the handling of the error is as for
23704 system quota failures.
23705
23706 By default, Exim's quota checking mimics system quotas, and restricts the
23707 mailbox to the specified maximum size, though the value is not accurate to the
23708 last byte, owing to separator lines and additional headers that may get added
23709 during message delivery. When a mailbox is nearly full, large messages may get
23710 refused even though small ones are accepted, because the size of the current
23711 message is added to the quota when the check is made. This behaviour can be
23712 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23713 for exceeding the quota does not include the current message. Thus, deliveries
23714 continue until the quota has been exceeded; thereafter, no further messages are
23715 delivered. See also &%quota_warn_threshold%&.
23716
23717
23718 .option quota_directory appendfile string&!! unset
23719 This option defines the directory to check for quota purposes when delivering
23720 into individual files. The default is the delivery directory, or, if a file
23721 called &_maildirfolder_& exists in a maildir directory, the parent of the
23722 delivery directory.
23723
23724
23725 .option quota_filecount appendfile string&!! 0
23726 This option applies when the &%directory%& option is set. It limits the total
23727 number of files in the directory (compare the inode limit in system quotas). It
23728 can only be used if &%quota%& is also set. The value is expanded; an expansion
23729 failure causes delivery to be deferred. A value of zero is interpreted as
23730 &"no quota"&.
23731
23732 The option modifier &%no_check%& can be used to force delivery even if the over
23733 quota condition is met. The quota gets updated as usual.
23734
23735 .option quota_is_inclusive appendfile boolean true
23736 See &%quota%& above.
23737
23738
23739 .option quota_size_regex appendfile string unset
23740 This option applies when one of the delivery modes that writes a separate file
23741 for each message is being used. When Exim wants to find the size of one of
23742 these files in order to test the quota, it first checks &%quota_size_regex%&.
23743 If this is set to a regular expression that matches the filename, and it
23744 captures one string, that string is interpreted as a representation of the
23745 file's size. The value of &%quota_size_regex%& is not expanded.
23746
23747 This feature is useful only when users have no shell access to their mailboxes
23748 &-- otherwise they could defeat the quota simply by renaming the files. This
23749 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23750 the file length to the filename. For example:
23751 .code
23752 maildir_tag = ,S=$message_size
23753 quota_size_regex = ,S=(\d+)
23754 .endd
23755 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23756 number of lines in the message.
23757
23758 The regular expression should not assume that the length is at the end of the
23759 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23760 sometimes add other information onto the ends of message filenames.
23761
23762 Section &<<SECID136>>& contains further information.
23763
23764 This option should not be used when other message-handling software
23765 may duplicate messages by making hardlinks to the files.  When that is done Exim
23766 will count the message size once for each filename, in contrast with the actual
23767 disk usage.  When the option is not set, calculating total usage requires
23768 a system-call per file to get the size; the number of links is then available also
23769 as is used to adjust the effective size.
23770
23771
23772 .option quota_warn_message appendfile string&!! "see below"
23773 See below for the use of this option. If it is not set when
23774 &%quota_warn_threshold%& is set, it defaults to
23775 .code
23776 quota_warn_message = "\
23777   To: $local_part@$domain\n\
23778   Subject: Your mailbox\n\n\
23779   This message is automatically created \
23780   by mail delivery software.\n\n\
23781   The size of your mailbox has exceeded \
23782   a warning threshold that is\n\
23783   set by the system administrator.\n"
23784 .endd
23785
23786
23787 .option quota_warn_threshold appendfile string&!! 0
23788 .cindex "quota" "warning threshold"
23789 .cindex "mailbox" "size warning"
23790 .cindex "size" "of mailbox"
23791 This option is expanded in the same way as &%quota%& (see above). If the
23792 resulting value is greater than zero, and delivery of the message causes the
23793 size of the file or total space in the directory tree to cross the given
23794 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23795 may be specified as a percentage of it by following the value with a percent
23796 sign. For example:
23797 .code
23798 quota = 10M
23799 quota_warn_threshold = 75%
23800 .endd
23801 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23802 percent sign is ignored.
23803
23804 The warning message itself is specified by the &%quota_warn_message%& option,
23805 and it must start with a &'To:'& header line containing the recipient(s) of the
23806 warning message. These do not necessarily have to include the recipient(s) of
23807 the original message. A &'Subject:'& line should also normally be supplied. You
23808 can include any other header lines that you want. If you do not include a
23809 &'From:'& line, the default is:
23810 .code
23811 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23812 .endd
23813 .oindex &%errors_reply_to%&
23814 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23815 option.
23816
23817 The &%quota%& option does not have to be set in order to use this option; they
23818 are independent of one another except when the threshold is specified as a
23819 percentage.
23820
23821
23822 .option use_bsmtp appendfile boolean false
23823 .cindex "envelope from"
23824 .cindex "envelope sender"
23825 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23826 format, with the envelope sender and recipient(s) included as SMTP commands. If
23827 you want to include a leading HELO command with such messages, you can do
23828 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23829 for details of batch SMTP.
23830
23831
23832 .option use_crlf appendfile boolean false
23833 .cindex "carriage return"
23834 .cindex "linefeed"
23835 This option causes lines to be terminated with the two-character CRLF sequence
23836 (carriage return, linefeed) instead of just a linefeed character. In the case
23837 of batched SMTP, the byte sequence written to the file is then an exact image
23838 of what would be sent down a real SMTP connection.
23839
23840 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23841 (which are used to supply the traditional &"From&~"& and blank line separators
23842 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23843 carriage return characters if these are needed. In cases where these options
23844 have non-empty defaults, the values end with a single linefeed, so they must be
23845 changed to end with &`\r\n`& if &%use_crlf%& is set.
23846
23847
23848 .option use_fcntl_lock appendfile boolean "see below"
23849 This option controls the use of the &[fcntl()]& function to lock a file for
23850 exclusive use when a message is being appended. It is set by default unless
23851 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23852 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23853 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23854
23855
23856 .option use_flock_lock appendfile boolean false
23857 This option is provided to support the use of &[flock()]& for file locking, for
23858 the few situations where it is needed. Most modern operating systems support
23859 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23860 each other. Exim uses &[fcntl()]& locking by default.
23861
23862 This option is required only if you are using an operating system where
23863 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23864 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23865 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23866
23867 .cindex "Solaris" "&[flock()]& support"
23868 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23869 have it (and some, I think, provide a not quite right version built on top of
23870 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23871 the ability to use it, and any attempt to do so will cause a configuration
23872 error.
23873
23874 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23875 is just being mapped onto &[fcntl()]& by the OS).
23876
23877
23878 .option use_lockfile appendfile boolean "see below"
23879 If this option is turned off, Exim does not attempt to create a lock file when
23880 appending to a mailbox file. In this situation, the only locking is by
23881 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23882 sure that every MUA that is ever going to look at your users' mailboxes uses
23883 &[fcntl()]& rather than a lock file, and even then only when you are not
23884 delivering over NFS from more than one host.
23885
23886 .cindex "NFS" "lock file"
23887 In order to append to an NFS file safely from more than one host, it is
23888 necessary to take out a lock &'before'& opening the file, and the lock file
23889 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23890 file corruption.
23891
23892 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23893 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23894 except when &%mbx_format%& is set.
23895
23896
23897 .option use_mbx_lock appendfile boolean "see below"
23898 This option is available only if Exim has been compiled with SUPPORT_MBX
23899 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23900 locking rules be used. It is set by default if &%mbx_format%& is set and none
23901 of the locking options are mentioned in the configuration. The locking rules
23902 are the same as are used by the &'c-client'& library that underlies Pine and
23903 the IMAP4 and POP daemons that come with it (see the discussion below). The
23904 rules allow for shared access to the mailbox. However, this kind of locking
23905 does not work when the mailbox is NFS mounted.
23906
23907 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23908 &%use_flock_lock%& to control what kind of locking is used in implementing the
23909 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23910 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23911
23912
23913
23914
23915 .section "Operational details for appending" "SECTopappend"
23916 .cindex "appending to a file"
23917 .cindex "file" "appending"
23918 Before appending to a file, the following preparations are made:
23919
23920 .ilist
23921 If the name of the file is &_/dev/null_&, no action is taken, and a success
23922 return is given.
23923
23924 .next
23925 .cindex "directory creation"
23926 If any directories on the file's path are missing, Exim creates them if the
23927 &%create_directory%& option is set. A created directory's mode is given by the
23928 &%directory_mode%& option.
23929
23930 .next
23931 If &%file_format%& is set, the format of an existing file is checked. If this
23932 indicates that a different transport should be used, control is passed to that
23933 transport.
23934
23935 .next
23936 .cindex "file" "locking"
23937 .cindex "locking files"
23938 .cindex "NFS" "lock file"
23939 If &%use_lockfile%& is set, a lock file is built in a way that will work
23940 reliably over NFS, as follows:
23941
23942 .olist
23943 Create a &"hitching post"& file whose name is that of the lock file with the
23944 current time, primary host name, and process id added, by opening for writing
23945 as a new file. If this fails with an access error, delivery is deferred.
23946 .next
23947 Close the hitching post file, and hard link it to the lock filename.
23948 .next
23949 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23950 Unlink the hitching post name.
23951 .next
23952 Otherwise, use &[stat()]& to get information about the hitching post file, and
23953 then unlink hitching post name. If the number of links is exactly two, creation
23954 of the lock file succeeded but something (for example, an NFS server crash and
23955 restart) caused this fact not to be communicated to the &[link()]& call.
23956 .next
23957 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23958 up to &%lock_retries%& times. However, since any program that writes to a
23959 mailbox should complete its task very quickly, it is reasonable to time out old
23960 lock files that are normally the result of user agent and system crashes. If an
23961 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23962 it before trying again.
23963 .endlist olist
23964
23965 .next
23966 A call is made to &[lstat()]& to discover whether the main file exists, and if
23967 so, what its characteristics are. If &[lstat()]& fails for any reason other
23968 than non-existence, delivery is deferred.
23969
23970 .next
23971 .cindex "symbolic link" "to mailbox"
23972 .cindex "mailbox" "symbolic link"
23973 If the file does exist and is a symbolic link, delivery is deferred, unless the
23974 &%allow_symlink%& option is set, in which case the ownership of the link is
23975 checked, and then &[stat()]& is called to find out about the real file, which
23976 is then subjected to the checks below. The check on the top-level link
23977 ownership prevents one user creating a link for another's mailbox in a sticky
23978 directory, though allowing symbolic links in this case is definitely not a good
23979 idea. If there is a chain of symbolic links, the intermediate ones are not
23980 checked.
23981
23982 .next
23983 If the file already exists but is not a regular file, or if the file's owner
23984 and group (if the group is being checked &-- see &%check_group%& above) are
23985 different from the user and group under which the delivery is running,
23986 delivery is deferred.
23987
23988 .next
23989 If the file's permissions are more generous than specified, they are reduced.
23990 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23991 is set false, in which case the delivery is tried using the existing
23992 permissions.
23993
23994 .next
23995 The file's inode number is saved, and the file is then opened for appending.
23996 If this fails because the file has vanished, &(appendfile)& behaves as if it
23997 hadn't existed (see below). For any other failures, delivery is deferred.
23998
23999 .next
24000 If the file is opened successfully, check that the inode number hasn't
24001 changed, that it is still a regular file, and that the owner and permissions
24002 have not changed. If anything is wrong, defer delivery and freeze the message.
24003
24004 .next
24005 If the file did not exist originally, defer delivery if the &%file_must_exist%&
24006 option is set. Otherwise, check that the file is being created in a permitted
24007 directory if the &%create_file%& option is set (deferring on failure), and then
24008 open for writing as a new file, with the O_EXCL and O_CREAT options,
24009 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24010 set). In this case, which can happen if the link points to a non-existent file,
24011 the file is opened for writing using O_CREAT but not O_EXCL, because
24012 that prevents link following.
24013
24014 .next
24015 .cindex "loop" "while file testing"
24016 If opening fails because the file exists, obey the tests given above for
24017 existing files. However, to avoid looping in a situation where the file is
24018 being continuously created and destroyed, the exists/not-exists loop is broken
24019 after 10 repetitions, and the message is then frozen.
24020
24021 .next
24022 If opening fails with any other error, defer delivery.
24023
24024 .next
24025 .cindex "file" "locking"
24026 .cindex "locking files"
24027 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24028 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24029 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24030 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24031 file, and an exclusive lock on the file whose name is
24032 .code
24033 /tmp/.<device-number>.<inode-number>
24034 .endd
24035 using the device and inode numbers of the open mailbox file, in accordance with
24036 the MBX locking rules. This file is created with a mode that is specified by
24037 the &%lockfile_mode%& option.
24038
24039 If Exim fails to lock the file, there are two possible courses of action,
24040 depending on the value of the locking timeout. This is obtained from
24041 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24042
24043 If the timeout value is zero, the file is closed, Exim waits for
24044 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24045 to lock it again. This happens up to &%lock_retries%& times, after which the
24046 delivery is deferred.
24047
24048 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24049 &[flock()]& are used (with the given timeout), so there has already been some
24050 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24051 immediately. It retries up to
24052 .code
24053 (lock_retries * lock_interval) / <timeout>
24054 .endd
24055 times (rounded up).
24056 .endlist
24057
24058 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24059 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24060
24061
24062 .section "Operational details for delivery to a new file" "SECTopdir"
24063 .cindex "delivery" "to single file"
24064 .cindex "&""From""& line"
24065 When the &%directory%& option is set instead of &%file%&, each message is
24066 delivered into a newly-created file or set of files. When &(appendfile)& is
24067 activated directly from a &(redirect)& router, neither &%file%& nor
24068 &%directory%& is normally set, because the path for delivery is supplied by the
24069 router. (See for example, the &(address_file)& transport in the default
24070 configuration.) In this case, delivery is to a new file if either the path name
24071 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24072
24073 No locking is required while writing the message to a new file, so the various
24074 locking options of the transport are ignored. The &"From"& line that by default
24075 separates messages in a single file is not normally needed, nor is the escaping
24076 of message lines that start with &"From"&, and there is no need to ensure a
24077 newline at the end of each message. Consequently, the default values for
24078 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24079 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24080
24081 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24082 the files in the delivery directory by default. However, you can specify a
24083 different directory by setting &%quota_directory%&. Also, for maildir
24084 deliveries (see below) the &_maildirfolder_& convention is honoured.
24085
24086
24087 .cindex "maildir format"
24088 .cindex "mailstore format"
24089 There are three different ways in which delivery to individual files can be
24090 done, controlled by the settings of the &%maildir_format%& and
24091 &%mailstore_format%& options. Note that code to support maildir or mailstore
24092 formats is not included in the binary unless SUPPORT_MAILDIR or
24093 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24094
24095 .cindex "directory creation"
24096 In all three cases an attempt is made to create the directory and any necessary
24097 sub-directories if they do not exist, provided that the &%create_directory%&
24098 option is set (the default). The location of a created directory can be
24099 constrained by setting &%create_file%&. A created directory's mode is given by
24100 the &%directory_mode%& option. If creation fails, or if the
24101 &%create_directory%& option is not set when creation is required, delivery is
24102 deferred.
24103
24104
24105
24106 .section "Maildir delivery" "SECTmaildirdelivery"
24107 .cindex "maildir format" "description of"
24108 If the &%maildir_format%& option is true, Exim delivers each message by writing
24109 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24110 directory that is defined by the &%directory%& option (the &"delivery
24111 directory"&). If the delivery is successful, the file is renamed into the
24112 &_new_& subdirectory.
24113
24114 In the filename, <&'stime'&> is the current time of day in seconds, and
24115 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24116 Exim checks that the time-of-day clock has moved on by at least one microsecond
24117 before terminating the delivery process. This guarantees uniqueness for the
24118 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24119 opening it. If any response other than ENOENT (does not exist) is given,
24120 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24121
24122 Before Exim carries out a maildir delivery, it ensures that subdirectories
24123 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24124 do not exist, Exim tries to create them and any superior directories in their
24125 path, subject to the &%create_directory%& and &%create_file%& options. If the
24126 &%maildirfolder_create_regex%& option is set, and the regular expression it
24127 contains matches the delivery directory, Exim also ensures that a file called
24128 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24129 &_maildirfolder_& file cannot be created, delivery is deferred.
24130
24131 These features make it possible to use Exim to create all the necessary files
24132 and directories in a maildir mailbox, including subdirectories for maildir++
24133 folders. Consider this example:
24134 .code
24135 maildir_format = true
24136 directory = /var/mail/$local_part_data\
24137            ${if eq{$local_part_suffix}{}{}\
24138            {/.${substr_1:$local_part_suffix}}}
24139 maildirfolder_create_regex = /\.[^/]+$
24140 .endd
24141 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24142 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24143 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24144 not match this name, so Exim will not look for or create the file
24145 &_/var/mail/pimbo/maildirfolder_&, though it will create
24146 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24147
24148 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24149 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24150 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24151 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24152 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24153
24154 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24155 not inadvertently match the toplevel maildir directory, because a
24156 &_maildirfolder_& file at top level would completely break quota calculations.
24157
24158 .cindex "quota" "in maildir delivery"
24159 .cindex "maildir++"
24160 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24161 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24162 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24163 Exim assumes the directory is a maildir++ folder directory, which is one level
24164 down from the user's top level mailbox directory. This causes it to start at
24165 the parent directory instead of the current directory when calculating the
24166 amount of space used.
24167
24168 One problem with delivering into a multi-file mailbox is that it is
24169 computationally expensive to compute the size of the mailbox for quota
24170 checking. Various approaches have been taken to reduce the amount of work
24171 needed. The next two sections describe two of them. A third alternative is to
24172 use some external process for maintaining the size data, and use the expansion
24173 of the &%mailbox_size%& option as a way of importing it into Exim.
24174
24175
24176
24177
24178 .section "Using tags to record message sizes" "SECID135"
24179 If &%maildir_tag%& is set, the string is expanded for each delivery.
24180 When the maildir file is renamed into the &_new_& sub-directory, the
24181 tag is added to its name. However, if adding the tag takes the length of the
24182 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24183 the tag is dropped and the maildir file is created with no tag.
24184
24185
24186 .vindex "&$message_size$&"
24187 Tags can be used to encode the size of files in their names; see
24188 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24189 happens after the message has been written. The value of the &$message_size$&
24190 variable is set to the number of bytes actually written. If the expansion is
24191 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24192 be deferred. The expanded tag may contain any printing characters except &"/"&.
24193 Non-printing characters in the string are ignored; if the resulting string is
24194 empty, it is ignored. If it starts with an alphanumeric character, a leading
24195 colon is inserted; this default has not proven to be the path that popular
24196 maildir implementations have chosen (but changing it in Exim would break
24197 backwards compatibility).
24198
24199 For one common implementation, you might set:
24200 .code
24201 maildir_tag = ,S=${message_size}
24202 .endd
24203 but you should check the documentation of the other software to be sure.
24204
24205 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24206 as this allows Exim to extract the size from your tag, instead of having to
24207 &[stat()]& each message file.
24208
24209
24210 .section "Using a maildirsize file" "SECID136"
24211 .cindex "quota" "in maildir delivery"
24212 .cindex "maildir format" "&_maildirsize_& file"
24213 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24214 storing quota and message size information in a file called &_maildirsize_&
24215 within the toplevel maildir directory. If this file does not exist, Exim
24216 creates it, setting the quota from the &%quota%& option of the transport. If
24217 the maildir directory itself does not exist, it is created before any attempt
24218 to write a &_maildirsize_& file.
24219
24220 The &_maildirsize_& file is used to hold information about the sizes of
24221 messages in the maildir, thus speeding up quota calculations. The quota value
24222 in the file is just a cache; if the quota is changed in the transport, the new
24223 value overrides the cached value when the next message is delivered. The cache
24224 is maintained for the benefit of other programs that access the maildir and
24225 need to know the quota.
24226
24227 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24228 file is maintained (with a zero quota setting), but no quota is imposed.
24229
24230 A regular expression is available for controlling which directories in the
24231 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24232 See the description of the &%maildir_quota_directory_regex%& option above for
24233 details.
24234
24235
24236 .section "Mailstore delivery" "SECID137"
24237 .cindex "mailstore format" "description of"
24238 If the &%mailstore_format%& option is true, each message is written as two
24239 files in the given directory. A unique base name is constructed from the
24240 message id and the current delivery process, and the files that are written use
24241 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24242 contains the message's envelope, and the &_.msg_& file contains the message
24243 itself. The base name is placed in the variable &$mailstore_basename$&.
24244
24245 During delivery, the envelope is first written to a file with the suffix
24246 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24247 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24248 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24249 file before accessing either of them. An alternative approach is to wait for
24250 the absence of a &_.tmp_& file.
24251
24252 The envelope file starts with any text defined by the &%mailstore_prefix%&
24253 option, expanded and terminated by a newline if there isn't one. Then follows
24254 the sender address on one line, then all the recipient addresses, one per line.
24255 There can be more than one recipient only if the &%batch_max%& option is set
24256 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24257 appended to the file, followed by a newline if it does not end with one.
24258
24259 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24260 failure, it is ignored. Other expansion errors are treated as serious
24261 configuration errors, and delivery is deferred. The variable
24262 &$mailstore_basename$& is available for use during these expansions.
24263
24264
24265 .section "Non-special new file delivery" "SECID138"
24266 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24267 file is created directly in the named directory. For example, when delivering
24268 messages into files in batched SMTP format for later delivery to some host (see
24269 section &<<SECTbatchSMTP>>&), a setting such as
24270 .code
24271 directory = /var/bsmtp/$host
24272 .endd
24273 might be used. A message is written to a file with a temporary name, which is
24274 then renamed when the delivery is complete. The final name is obtained by
24275 expanding the contents of the &%directory_file%& option.
24276 .ecindex IIDapptra1
24277 .ecindex IIDapptra2
24278
24279
24280
24281
24282
24283
24284 . ////////////////////////////////////////////////////////////////////////////
24285 . ////////////////////////////////////////////////////////////////////////////
24286
24287 .chapter "The autoreply transport" "CHID8"
24288 .scindex IIDauttra1 "transports" "&(autoreply)&"
24289 .scindex IIDauttra2 "&(autoreply)& transport"
24290 The &(autoreply)& transport is not a true transport in that it does not cause
24291 the message to be transmitted. Instead, it generates a new mail message as an
24292 automatic reply to the incoming message. &'References:'& and
24293 &'Auto-Submitted:'& header lines are included. These are constructed according
24294 to the rules in RFCs 2822 and 3834, respectively.
24295
24296 If the router that passes the message to this transport does not have the
24297 &%unseen%& option set, the original message (for the current recipient) is not
24298 delivered anywhere. However, when the &%unseen%& option is set on the router
24299 that passes the message to this transport, routing of the address continues, so
24300 another router can set up a normal message delivery.
24301
24302
24303 The &(autoreply)& transport is usually run as the result of mail filtering, a
24304 &"vacation"& message being the standard example. However, it can also be run
24305 directly from a router like any other transport. To reduce the possibility of
24306 message cascades, messages created by the &(autoreply)& transport always have
24307 empty envelope sender addresses, like bounce messages.
24308
24309 The parameters of the message to be sent can be specified in the configuration
24310 by options described below. However, these are used only when the address
24311 passed to the transport does not contain its own reply information. When the
24312 transport is run as a consequence of a
24313 &%mail%&
24314 or &%vacation%& command in a filter file, the parameters of the message are
24315 supplied by the filter, and passed with the address. The transport's options
24316 that define the message are then ignored (so they are not usually set in this
24317 case). The message is specified entirely by the filter or by the transport; it
24318 is never built from a mixture of options. However, the &%file_optional%&,
24319 &%mode%&, and &%return_message%& options apply in all cases.
24320
24321 &(Autoreply)& is implemented as a local transport. When used as a result of a
24322 command in a user's filter file, &(autoreply)& normally runs under the uid and
24323 gid of the user, and with appropriate current and home directories (see chapter
24324 &<<CHAPenvironment>>&).
24325
24326 There is a subtle difference between routing a message to a &(pipe)& transport
24327 that generates some text to be returned to the sender, and routing it to an
24328 &(autoreply)& transport. This difference is noticeable only if more than one
24329 address from the same message is so handled. In the case of a pipe, the
24330 separate outputs from the different addresses are gathered up and returned to
24331 the sender in a single message, whereas if &(autoreply)& is used, a separate
24332 message is generated for each address that is passed to it.
24333
24334 Non-printing characters are not permitted in the header lines generated for the
24335 message that &(autoreply)& creates, with the exception of newlines that are
24336 immediately followed by white space. If any non-printing characters are found,
24337 the transport defers.
24338 Whether characters with the top bit set count as printing characters or not is
24339 controlled by the &%print_topbitchars%& global option.
24340
24341 If any of the generic options for manipulating headers (for example,
24342 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24343 of the original message that is included in the generated message when
24344 &%return_message%& is set. They do not apply to the generated message itself.
24345
24346 .vindex "&$sender_address$&"
24347 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24348 the message, indicating that there were no recipients, it does not treat this
24349 as an error. This means that autoreplies sent to &$sender_address$& when this
24350 is empty (because the incoming message is a bounce message) do not cause
24351 problems. They are just discarded.
24352
24353
24354
24355 .section "Private options for autoreply" "SECID139"
24356 .cindex "options" "&(autoreply)& transport"
24357
24358 .option bcc autoreply string&!! unset
24359 This specifies the addresses that are to receive &"blind carbon copies"& of the
24360 message when the message is specified by the transport.
24361
24362
24363 .option cc autoreply string&!! unset
24364 This specifies recipients of the message and the contents of the &'Cc:'& header
24365 when the message is specified by the transport.
24366
24367
24368 .option file autoreply string&!! unset
24369 The contents of the file are sent as the body of the message when the message
24370 is specified by the transport. If both &%file%& and &%text%& are set, the text
24371 string comes first.
24372
24373
24374 .option file_expand autoreply boolean false
24375 If this is set, the contents of the file named by the &%file%& option are
24376 subjected to string expansion as they are added to the message.
24377
24378
24379 .option file_optional autoreply boolean false
24380 If this option is true, no error is generated if the file named by the &%file%&
24381 option or passed with the address does not exist or cannot be read.
24382
24383
24384 .option from autoreply string&!! unset
24385 This specifies the contents of the &'From:'& header when the message is
24386 specified by the transport.
24387
24388
24389 .option headers autoreply string&!! unset
24390 This specifies additional RFC 2822 headers that are to be added to the message
24391 when the message is specified by the transport. Several can be given by using
24392 &"\n"& to separate them. There is no check on the format.
24393
24394
24395 .option log autoreply string&!! unset
24396 This option names a file in which a record of every message sent is logged when
24397 the message is specified by the transport.
24398
24399
24400 .option mode autoreply "octal integer" 0600
24401 If either the log file or the &"once"& file has to be created, this mode is
24402 used.
24403
24404
24405 .option never_mail autoreply "address list&!!" unset
24406 If any run of the transport creates a message with a recipient that matches any
24407 item in the list, that recipient is quietly discarded. If all recipients are
24408 discarded, no message is created. This applies both when the recipients are
24409 generated by a filter and when they are specified in the transport.
24410
24411
24412
24413 .option once autoreply string&!! unset
24414 This option names a file or DBM database in which a record of each &'To:'&
24415 recipient is kept when the message is specified by the transport. &*Note*&:
24416 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24417
24418 If &%once%& is unset, or is set to an empty string, the message is always sent.
24419 By default, if &%once%& is set to a non-empty filename, the message
24420 is not sent if a potential recipient is already listed in the database.
24421 However, if the &%once_repeat%& option specifies a time greater than zero, the
24422 message is sent if that much time has elapsed since a message was last sent to
24423 this recipient. A setting of zero time for &%once_repeat%& (the default)
24424 prevents a message from being sent a second time &-- in this case, zero means
24425 infinity.
24426
24427 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24428 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24429 greater than zero, it changes the way Exim implements the &%once%& option.
24430 Instead of using a DBM file to record every recipient it sends to, it uses a
24431 regular file, whose size will never get larger than the given value.
24432
24433 In the file, Exim keeps a linear list of recipient addresses and the times at
24434 which they were sent messages. If the file is full when a new address needs to
24435 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24436 means that a given recipient may receive multiple messages, but at
24437 unpredictable intervals that depend on the rate of turnover of addresses in the
24438 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24439
24440
24441 .option once_file_size autoreply integer 0
24442 See &%once%& above.
24443
24444
24445 .option once_repeat autoreply time&!! 0s
24446 See &%once%& above.
24447 After expansion, the value of this option must be a valid time value.
24448
24449
24450 .option reply_to autoreply string&!! unset
24451 This specifies the contents of the &'Reply-To:'& header when the message is
24452 specified by the transport.
24453
24454
24455 .option return_message autoreply boolean false
24456 If this is set, a copy of the original message is returned with the new
24457 message, subject to the maximum size set in the &%return_size_limit%& global
24458 configuration option.
24459
24460
24461 .option subject autoreply string&!! unset
24462 This specifies the contents of the &'Subject:'& header when the message is
24463 specified by the transport. It is tempting to quote the original subject in
24464 automatic responses. For example:
24465 .code
24466 subject = Re: $h_subject:
24467 .endd
24468 There is a danger in doing this, however. It may allow a third party to
24469 subscribe your users to an opt-in mailing list, provided that the list accepts
24470 bounce messages as subscription confirmations. Well-managed lists require a
24471 non-bounce message to confirm a subscription, so the danger is relatively
24472 small.
24473
24474
24475
24476 .option text autoreply string&!! unset
24477 This specifies a single string to be used as the body of the message when the
24478 message is specified by the transport. If both &%text%& and &%file%& are set,
24479 the text comes first.
24480
24481
24482 .option to autoreply string&!! unset
24483 This specifies recipients of the message and the contents of the &'To:'& header
24484 when the message is specified by the transport.
24485 .ecindex IIDauttra1
24486 .ecindex IIDauttra2
24487
24488
24489
24490
24491 . ////////////////////////////////////////////////////////////////////////////
24492 . ////////////////////////////////////////////////////////////////////////////
24493
24494 .chapter "The lmtp transport" "CHAPLMTP"
24495 .cindex "transports" "&(lmtp)&"
24496 .cindex "&(lmtp)& transport"
24497 .cindex "LMTP" "over a pipe"
24498 .cindex "LMTP" "over a socket"
24499 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24500 specified command
24501 or by interacting with a Unix domain socket.
24502 This transport is something of a cross between the &(pipe)& and &(smtp)&
24503 transports. Exim also has support for using LMTP over TCP/IP; this is
24504 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24505 to be of minority interest, the default build-time configure in &_src/EDITME_&
24506 has it commented out. You need to ensure that
24507 .code
24508 TRANSPORT_LMTP=yes
24509 .endd
24510 .cindex "options" "&(lmtp)& transport"
24511 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24512 included in the Exim binary. The private options of the &(lmtp)& transport are
24513 as follows:
24514
24515 .option batch_id lmtp string&!! unset
24516 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24517
24518
24519 .option batch_max lmtp integer 1
24520 This limits the number of addresses that can be handled in a single delivery.
24521 Most LMTP servers can handle several addresses at once, so it is normally a
24522 good idea to increase this value. See the description of local delivery
24523 batching in chapter &<<CHAPbatching>>&.
24524
24525
24526 .option command lmtp string&!! unset
24527 This option must be set if &%socket%& is not set. The string is a command which
24528 is run in a separate process. It is split up into a command name and list of
24529 arguments, each of which is separately expanded (so expansion cannot change the
24530 number of arguments). The command is run directly, not via a shell. The message
24531 is passed to the new process using the standard input and output to operate the
24532 LMTP protocol.
24533
24534 .option ignore_quota lmtp boolean false
24535 .cindex "LMTP" "ignoring quota errors"
24536 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24537 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24538 in its response to the LHLO command.
24539
24540 .option socket lmtp string&!! unset
24541 This option must be set if &%command%& is not set. The result of expansion must
24542 be the name of a Unix domain socket. The transport connects to the socket and
24543 delivers the message to it using the LMTP protocol.
24544
24545
24546 .option timeout lmtp time 5m
24547 The transport is aborted if the created process or Unix domain socket does not
24548 respond to LMTP commands or message input within this timeout. Delivery
24549 is deferred, and will be tried again later. Here is an example of a typical
24550 LMTP transport:
24551 .code
24552 lmtp:
24553   driver = lmtp
24554   command = /some/local/lmtp/delivery/program
24555   batch_max = 20
24556   user = exim
24557 .endd
24558 This delivers up to 20 addresses at a time, in a mixture of domains if
24559 necessary, running as the user &'exim'&.
24560
24561
24562
24563 . ////////////////////////////////////////////////////////////////////////////
24564 . ////////////////////////////////////////////////////////////////////////////
24565
24566 .chapter "The pipe transport" "CHAPpipetransport"
24567 .scindex IIDpiptra1 "transports" "&(pipe)&"
24568 .scindex IIDpiptra2 "&(pipe)& transport"
24569 The &(pipe)& transport is used to deliver messages via a pipe to a command
24570 running in another process. One example is the use of &(pipe)& as a
24571 pseudo-remote transport for passing messages to some other delivery mechanism
24572 (such as UUCP). Another is the use by individual users to automatically process
24573 their incoming messages. The &(pipe)& transport can be used in one of the
24574 following ways:
24575
24576 .ilist
24577 .vindex "&$local_part$&"
24578 A router routes one address to a transport in the normal way, and the
24579 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24580 contains the local part of the address (as usual), and the command that is run
24581 is specified by the &%command%& option on the transport.
24582 .next
24583 .vindex "&$pipe_addresses$&"
24584 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24585 transport can handle more than one address in a single run. In this case, when
24586 more than one address is routed to the transport, &$local_part$& is not set
24587 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24588 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24589 that are routed to the transport.
24590 .next
24591 .vindex "&$address_pipe$&"
24592 A router redirects an address directly to a pipe command (for example, from an
24593 alias or forward file). In this case, &$address_pipe$& contains the text of the
24594 pipe command, and the &%command%& option on the transport is ignored unless
24595 &%force_command%& is set. If only one address is being transported
24596 (&%batch_max%& is not greater than one, or only one address was redirected to
24597 this pipe command), &$local_part$& contains the local part that was redirected.
24598 .endlist
24599
24600
24601 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24602 deliver messages over pipes using the LMTP interactive protocol. This is
24603 implemented by the &(lmtp)& transport.
24604
24605 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24606 &_.forward_& file, the command runs under the uid and gid of that user. In
24607 other cases, the uid and gid have to be specified explicitly, either on the
24608 transport or on the router that handles the address. Current and &"home"&
24609 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24610 details of the local delivery environment and chapter &<<CHAPbatching>>&
24611 for a discussion of local delivery batching.
24612
24613 .cindex "tainted data" "in pipe command"
24614 .cindex pipe "tainted data"
24615 Tainted data may not be used for the command name.
24616
24617
24618 .section "Concurrent delivery" "SECID140"
24619 If two messages arrive at almost the same time, and both are routed to a pipe
24620 delivery, the two pipe transports may be run concurrently. You must ensure that
24621 any pipe commands you set up are robust against this happening. If the commands
24622 write to a file, the &%exim_lock%& utility might be of use.
24623 Alternatively the &%max_parallel%& option could be used with a value
24624 of "1" to enforce serialization.
24625
24626
24627
24628
24629 .section "Returned status and data" "SECID141"
24630 .cindex "&(pipe)& transport" "returned data"
24631 If the command exits with a non-zero return code, the delivery is deemed to
24632 have failed, unless either the &%ignore_status%& option is set (in which case
24633 the return code is treated as zero), or the return code is one of those listed
24634 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24635 later"&. In this case, delivery is deferred. Details of a permanent failure are
24636 logged, but are not included in the bounce message, which merely contains
24637 &"local delivery failed"&.
24638
24639 If the command exits on a signal and the &%freeze_signal%& option is set then
24640 the message will be frozen in the queue. If that option is not set, a bounce
24641 will be sent as normal.
24642
24643 If the return code is greater than 128 and the command being run is a shell
24644 script, it normally means that the script was terminated by a signal whose
24645 value is the return code minus 128. The &%freeze_signal%& option does not
24646 apply in this case.
24647
24648 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24649 return code is set to 127. This is the value that a shell returns if it is
24650 asked to run a non-existent command. The wording for the log line suggests that
24651 a non-existent command may be the problem.
24652
24653 The &%return_output%& option can affect the result of a pipe delivery. If it is
24654 set and the command produces any output on its standard output or standard
24655 error streams, the command is considered to have failed, even if it gave a zero
24656 return code or if &%ignore_status%& is set. The output from the command is
24657 included as part of the bounce message. The &%return_fail_output%& option is
24658 similar, except that output is returned only when the command exits with a
24659 failure return code, that is, a value other than zero or a code that matches
24660 &%temp_errors%&.
24661
24662
24663
24664 .section "How the command is run" "SECThowcommandrun"
24665 .cindex "&(pipe)& transport" "path for command"
24666 The command line is (by default) broken down into a command name and arguments
24667 by the &(pipe)& transport itself. The &%allow_commands%& and
24668 &%restrict_to_path%& options can be used to restrict the commands that may be
24669 run.
24670
24671 .cindex "quoting" "in pipe command"
24672 Unquoted arguments are delimited by white space. If an argument appears in
24673 double quotes, backslash is interpreted as an escape character in the usual
24674 way. If an argument appears in single quotes, no escaping is done.
24675
24676 String expansion is applied to the command line except when it comes from a
24677 traditional &_.forward_& file (commands from a filter file are expanded). The
24678 expansion is applied to each argument in turn rather than to the whole line.
24679 For this reason, any string expansion item that contains white space must be
24680 quoted so as to be contained within a single argument. A setting such as
24681 .code
24682 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24683 .endd
24684 will not work, because the expansion item gets split between several
24685 arguments. You have to write
24686 .code
24687 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24688 .endd
24689 to ensure that it is all in one argument. The expansion is done in this way,
24690 argument by argument, so that the number of arguments cannot be changed as a
24691 result of expansion, and quotes or backslashes in inserted variables do not
24692 interact with external quoting. However, this leads to problems if you want to
24693 generate multiple arguments (or the command name plus arguments) from a single
24694 expansion. In this situation, the simplest solution is to use a shell. For
24695 example:
24696 .code
24697 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24698 .endd
24699
24700 .cindex "transport" "filter"
24701 .cindex "filter" "transport filter"
24702 .vindex "&$pipe_addresses$&"
24703 Special handling takes place when an argument consists of precisely the text
24704 &`$pipe_addresses`& (no quotes).
24705 This is not a general expansion variable; the only
24706 place this string is recognized is when it appears as an argument for a pipe or
24707 transport filter command. It causes each address that is being handled to be
24708 inserted in the argument list at that point &'as a separate argument'&. This
24709 avoids any problems with spaces or shell metacharacters, and is of use when a
24710 &(pipe)& transport is handling groups of addresses in a batch.
24711
24712 If &%force_command%& is enabled on the transport, special handling takes place
24713 for an argument that consists of precisely the text &`$address_pipe`&.  It
24714 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24715 argument is inserted in the argument list at that point
24716 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24717 the only item in the argument; in fact, if it were then &%force_command%&
24718 should behave as a no-op.  Rather, it should be used to adjust the command
24719 run while preserving the argument vector separation.
24720
24721 After splitting up into arguments and expansion, the resulting command is run
24722 in a subprocess directly from the transport, &'not'& under a shell. The
24723 message that is being delivered is supplied on the standard input, and the
24724 standard output and standard error are both connected to a single pipe that is
24725 read by Exim. The &%max_output%& option controls how much output the command
24726 may produce, and the &%return_output%& and &%return_fail_output%& options
24727 control what is done with it.
24728
24729 Not running the command under a shell (by default) lessens the security risks
24730 in cases when a command from a user's filter file is built out of data that was
24731 taken from an incoming message. If a shell is required, it can of course be
24732 explicitly specified as the command to be run. However, there are circumstances
24733 where existing commands (for example, in &_.forward_& files) expect to be run
24734 under a shell and cannot easily be modified. To allow for these cases, there is
24735 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24736 works. Instead of breaking up the command line as just described, it expands it
24737 as a single string and passes the result to &_/bin/sh_&. The
24738 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24739 with &%use_shell%&, and the whole mechanism is inherently less secure.
24740
24741
24742
24743 .section "Environment variables" "SECTpipeenv"
24744 .cindex "&(pipe)& transport" "environment for command"
24745 .cindex "environment" "&(pipe)& transport"
24746 The environment variables listed below are set up when the command is invoked.
24747 This list is a compromise for maximum compatibility with other MTAs. Note that
24748 the &%environment%& option can be used to add additional variables to this
24749 environment. The environment for the &(pipe)& transport is not subject
24750 to the &%add_environment%& and &%keep_environment%& main config options.
24751 &*Note*&: Using enviroment variables loses track of tainted data.
24752 Writers of &(pipe)& transport commands should be wary of data supplied
24753 by potential attackers.
24754 .display
24755 &`DOMAIN            `&   the domain of the address
24756 &`HOME              `&   the home directory, if set
24757 &`HOST              `&   the host name when called from a router (see below)
24758 &`LOCAL_PART        `&   see below
24759 &`LOCAL_PART_PREFIX `&   see below
24760 &`LOCAL_PART_SUFFIX `&   see below
24761 &`LOGNAME           `&   see below
24762 &`MESSAGE_ID        `&   Exim's local ID for the message
24763 &`PATH              `&   as specified by the &%path%& option below
24764 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24765 &`RECIPIENT         `&   the complete recipient address
24766 &`SENDER            `&   the sender of the message (empty if a bounce)
24767 &`SHELL             `&   &`/bin/sh`&
24768 &`TZ                `&   the value of the &%timezone%& option, if set
24769 &`USER              `&   see below
24770 .endd
24771 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24772 router, LOCAL_PART is set to the local part of the address. When it is
24773 called as a result of a forward or alias expansion, LOCAL_PART is set to
24774 the local part of the address that was expanded. In both cases, any affixes are
24775 removed from the local part, and made available in LOCAL_PART_PREFIX and
24776 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24777 same value as LOCAL_PART for compatibility with other MTAs.
24778
24779 .cindex "HOST"
24780 HOST is set only when a &(pipe)& transport is called from a router that
24781 associates hosts with an address, typically when using &(pipe)& as a
24782 pseudo-remote transport. HOST is set to the first host name specified by
24783 the router.
24784
24785 .cindex "HOME"
24786 If the transport's generic &%home_directory%& option is set, its value is used
24787 for the HOME environment variable. Otherwise, a home directory may be set
24788 by the router's &%transport_home_directory%& option, which defaults to the
24789 user's home directory if &%check_local_user%& is set.
24790
24791
24792 .section "Private options for pipe" "SECID142"
24793 .cindex "options" "&(pipe)& transport"
24794
24795
24796
24797 .option allow_commands pipe "string list&!!" unset
24798 .cindex "&(pipe)& transport" "permitted commands"
24799 The string is expanded, and is then interpreted as a colon-separated list of
24800 permitted commands. If &%restrict_to_path%& is not set, the only commands
24801 permitted are those in the &%allow_commands%& list. They need not be absolute
24802 paths; the &%path%& option is still used for relative paths. If
24803 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24804 in the &%allow_commands%& list, or a name without any slashes that is found on
24805 the path. In other words, if neither &%allow_commands%& nor
24806 &%restrict_to_path%& is set, there is no restriction on the command, but
24807 otherwise only commands that are permitted by one or the other are allowed. For
24808 example, if
24809 .code
24810 allow_commands = /usr/bin/vacation
24811 .endd
24812 and &%restrict_to_path%& is not set, the only permitted command is
24813 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24814 &%use_shell%& is set.
24815
24816
24817 .option batch_id pipe string&!! unset
24818 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24819
24820
24821 .option batch_max pipe integer 1
24822 This limits the number of addresses that can be handled in a single delivery.
24823 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24824
24825
24826 .option check_string pipe string unset
24827 As &(pipe)& writes the message, the start of each line is tested for matching
24828 &%check_string%&, and if it does, the initial matching characters are replaced
24829 by the contents of &%escape_string%&, provided both are set. The value of
24830 &%check_string%& is a literal string, not a regular expression, and the case of
24831 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24832 of &%check_string%& and &%escape_string%& are forced to values that implement
24833 the SMTP escaping protocol. Any settings made in the configuration file are
24834 ignored.
24835
24836
24837 .option command pipe string&!! unset
24838 This option need not be set when &(pipe)& is being used to deliver to pipes
24839 obtained directly from address redirections. In other cases, the option must be
24840 set, to provide a command to be run. It need not yield an absolute path (see
24841 the &%path%& option below). The command is split up into separate arguments by
24842 Exim, and each argument is separately expanded, as described in section
24843 &<<SECThowcommandrun>>& above.
24844
24845 .cindex "tainted data"
24846 No part of the resulting command may be tainted.
24847
24848
24849 .option environment pipe string&!! unset
24850 .cindex "&(pipe)& transport" "environment for command"
24851 .cindex "environment" "&(pipe)& transport"
24852 This option is used to add additional variables to the environment in which the
24853 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24854 a string which is expanded, and then interpreted as a colon-separated list of
24855 environment settings of the form <&'name'&>=<&'value'&>.
24856
24857
24858 .option escape_string pipe string unset
24859 See &%check_string%& above.
24860
24861
24862 .option freeze_exec_fail pipe boolean false
24863 .cindex "exec failure"
24864 .cindex "failure of exec"
24865 .cindex "&(pipe)& transport" "failure of exec"
24866 Failure to exec the command in a pipe transport is by default treated like
24867 any other failure while running the command. However, if &%freeze_exec_fail%&
24868 is set, failure to exec is treated specially, and causes the message to be
24869 frozen, whatever the setting of &%ignore_status%&.
24870
24871
24872 .option freeze_signal pipe boolean false
24873 .cindex "signal exit"
24874 .cindex "&(pipe)& transport", "signal exit"
24875 Normally if the process run by a command in a pipe transport exits on a signal,
24876 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24877 frozen in Exim's queue instead.
24878
24879
24880 .option force_command pipe boolean false
24881 .cindex "force command"
24882 .cindex "&(pipe)& transport", "force command"
24883 Normally when a router redirects an address directly to a pipe command
24884 the &%command%& option on the transport is ignored.  If &%force_command%&
24885 is set, the &%command%& option will used. This is especially
24886 useful for forcing a wrapper or additional argument to be added to the
24887 command. For example:
24888 .code
24889 command = /usr/bin/remote_exec myhost -- $address_pipe
24890 force_command
24891 .endd
24892
24893 Note that &$address_pipe$& is handled specially in &%command%& when
24894 &%force_command%& is set, expanding out to the original argument vector as
24895 separate items, similarly to a Unix shell &`"$@"`& construct.
24896
24897
24898 .option ignore_status pipe boolean false
24899 If this option is true, the status returned by the subprocess that is set up to
24900 run the command is ignored, and Exim behaves as if zero had been returned.
24901 Otherwise, a non-zero status or termination by signal causes an error return
24902 from the transport unless the status value is one of those listed in
24903 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24904
24905 &*Note*&: This option does not apply to timeouts, which do not return a status.
24906 See the &%timeout_defer%& option for how timeouts are handled.
24907
24908
24909 .option log_defer_output pipe boolean false
24910 .cindex "&(pipe)& transport" "logging output"
24911 If this option is set, and the status returned by the command is
24912 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24913 and any output was produced on stdout or stderr, the first line of it is
24914 written to the main log.
24915
24916
24917 .option log_fail_output pipe boolean false
24918 If this option is set, and the command returns any output on stdout or
24919 stderr, and also ends with a return code that is neither zero nor one of
24920 the return codes listed in &%temp_errors%& (that is, the delivery
24921 failed), the first line of output is written to the main log. This
24922 option and &%log_output%& are mutually exclusive.  Only one of them may
24923 be set.
24924
24925
24926 .option log_output pipe boolean false
24927 If this option is set and the command returns any output on stdout or
24928 stderr, the first line of output is written to the main log, whatever
24929 the return code. This option and &%log_fail_output%& are mutually
24930 exclusive. Only one of them may be set.
24931
24932
24933 .option max_output pipe integer 20K
24934 This specifies the maximum amount of output that the command may produce on its
24935 standard output and standard error file combined. If the limit is exceeded, the
24936 process running the command is killed. This is intended as a safety measure to
24937 catch runaway processes. The limit is applied independently of the settings of
24938 the options that control what is done with such output (for example,
24939 &%return_output%&). Because of buffering effects, the amount of output may
24940 exceed the limit by a small amount before Exim notices.
24941
24942
24943 .option message_prefix pipe string&!! "see below"
24944 The string specified here is expanded and output at the start of every message.
24945 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24946 .code
24947 message_prefix = \
24948   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24949   ${tod_bsdinbox}\n
24950 .endd
24951 .cindex "Cyrus"
24952 .cindex "&%tmail%&"
24953 .cindex "&""From""& line"
24954 This is required by the commonly used &_/usr/bin/vacation_& program.
24955 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24956 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24957 setting
24958 .code
24959 message_prefix =
24960 .endd
24961 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24962 &`\n`& to &`\r\n`& in &%message_prefix%&.
24963
24964
24965 .option message_suffix pipe string&!! "see below"
24966 The string specified here is expanded and output at the end of every message.
24967 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24968 The suffix can be suppressed by setting
24969 .code
24970 message_suffix =
24971 .endd
24972 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24973 &`\n`& to &`\r\n`& in &%message_suffix%&.
24974
24975
24976 .option path pipe string&!! "/bin:/usr/bin"
24977 This option is expanded and
24978 specifies the string that is set up in the PATH environment
24979 variable of the subprocess.
24980 If the &%command%& option does not yield an absolute path name, the command is
24981 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24982 apply to a command specified as a transport filter.
24983
24984
24985 .option permit_coredump pipe boolean false
24986 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24987 a core-dump of a pipe command, enable this command.  This enables core-dumps
24988 during delivery and affects both the Exim binary and the pipe command run.
24989 It is recommended that this option remain off unless and until you have a need
24990 for it and that this only be enabled when needed, as the risk of excessive
24991 resource consumption can be quite high.  Note also that Exim is typically
24992 installed as a setuid binary and most operating systems will inhibit coredumps
24993 of these by default, so further OS-specific action may be required.
24994
24995
24996 .option pipe_as_creator pipe boolean false
24997 .cindex "uid (user id)" "local delivery"
24998 If the generic &%user%& option is not set and this option is true, the delivery
24999 process is run under the uid that was in force when Exim was originally called
25000 to accept the message. If the group id is not otherwise set (via the generic
25001 &%group%& option), the gid that was in force when Exim was originally called to
25002 accept the message is used.
25003
25004
25005 .option restrict_to_path pipe boolean false
25006 When this option is set, any command name not listed in &%allow_commands%& must
25007 contain no slashes. The command is searched for only in the directories listed
25008 in the &%path%& option. This option is intended for use in the case when a pipe
25009 command has been generated from a user's &_.forward_& file. This is usually
25010 handled by a &(pipe)& transport called &%address_pipe%&.
25011
25012
25013 .option return_fail_output pipe boolean false
25014 If this option is true, and the command produced any output and ended with a
25015 return code other than zero or one of the codes listed in &%temp_errors%& (that
25016 is, the delivery failed), the output is returned in the bounce message.
25017 However, if the message has a null sender (that is, it is itself a bounce
25018 message), output from the command is discarded. This option and
25019 &%return_output%& are mutually exclusive. Only one of them may be set.
25020
25021
25022
25023 .option return_output pipe boolean false
25024 If this option is true, and the command produced any output, the delivery is
25025 deemed to have failed whatever the return code from the command, and the output
25026 is returned in the bounce message. Otherwise, the output is just discarded.
25027 However, if the message has a null sender (that is, it is a bounce message),
25028 output from the command is always discarded, whatever the setting of this
25029 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25030 of them may be set.
25031
25032
25033
25034 .option temp_errors pipe "string list" "see below"
25035 .cindex "&(pipe)& transport" "temporary failure"
25036 This option contains either a colon-separated list of numbers, or a single
25037 asterisk. If &%ignore_status%& is false
25038 and &%return_output%& is not set,
25039 and the command exits with a non-zero return code, the failure is treated as
25040 temporary and the delivery is deferred if the return code matches one of the
25041 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25042 codes are treated as permanent errors. The default setting contains the codes
25043 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25044 compiled on a system that does not define these macros, it assumes values of 75
25045 and 73, respectively.
25046
25047
25048 .option timeout pipe time 1h
25049 If the command fails to complete within this time, it is killed. This normally
25050 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25051 specifies no timeout. In order to ensure that any subprocesses created by the
25052 command are also killed, Exim makes the initial process a process group leader,
25053 and kills the whole process group on a timeout. However, this can be defeated
25054 if one of the processes starts a new process group.
25055
25056 .option timeout_defer pipe boolean false
25057 A timeout in a &(pipe)& transport, either in the command that the transport
25058 runs, or in a transport filter that is associated with it, is by default
25059 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25060 is set true, both kinds of timeout become temporary errors, causing the
25061 delivery to be deferred.
25062
25063 .option umask pipe "octal integer" 022
25064 This specifies the umask setting for the subprocess that runs the command.
25065
25066
25067 .option use_bsmtp pipe boolean false
25068 .cindex "envelope sender"
25069 If this option is set true, the &(pipe)& transport writes messages in &"batch
25070 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25071 commands. If you want to include a leading HELO command with such messages,
25072 you can do so by setting the &%message_prefix%& option. See section
25073 &<<SECTbatchSMTP>>& for details of batch SMTP.
25074
25075 .option use_classresources pipe boolean false
25076 .cindex "class resources (BSD)"
25077 This option is available only when Exim is running on FreeBSD, NetBSD, or
25078 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25079 resource limits when a &(pipe)& transport is run to perform a delivery. The
25080 limits for the uid under which the pipe is to run are obtained from the login
25081 class database.
25082
25083
25084 .option use_crlf pipe boolean false
25085 .cindex "carriage return"
25086 .cindex "linefeed"
25087 This option causes lines to be terminated with the two-character CRLF sequence
25088 (carriage return, linefeed) instead of just a linefeed character. In the case
25089 of batched SMTP, the byte sequence written to the pipe is then an exact image
25090 of what would be sent down a real SMTP connection.
25091
25092 The contents of the &%message_prefix%& and &%message_suffix%& options are
25093 written verbatim, so must contain their own carriage return characters if these
25094 are needed. When &%use_bsmtp%& is not set, the default values for both
25095 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25096 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25097
25098
25099 .option use_shell pipe boolean false
25100 .vindex "&$pipe_addresses$&"
25101 If this option is set, it causes the command to be passed to &_/bin/sh_&
25102 instead of being run directly from the transport, as described in section
25103 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25104 where the command is expected to be run under a shell and cannot easily be
25105 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25106 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25107 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25108 its &%-c%& option.
25109
25110
25111
25112 .section "Using an external local delivery agent" "SECID143"
25113 .cindex "local delivery" "using an external agent"
25114 .cindex "&'procmail'&"
25115 .cindex "external local delivery"
25116 .cindex "delivery" "&'procmail'&"
25117 .cindex "delivery" "by external agent"
25118 The &(pipe)& transport can be used to pass all messages that require local
25119 delivery to a separate local delivery agent such as &%procmail%&. When doing
25120 this, care must be taken to ensure that the pipe is run under an appropriate
25121 uid and gid. In some configurations one wants this to be a uid that is trusted
25122 by the delivery agent to supply the correct sender of the message. It may be
25123 necessary to recompile or reconfigure the delivery agent so that it trusts an
25124 appropriate user. The following is an example transport and router
25125 configuration for &%procmail%&:
25126 .code
25127 # transport
25128 procmail_pipe:
25129   driver = pipe
25130   command = /usr/local/bin/procmail -d $local_part_data
25131   return_path_add
25132   delivery_date_add
25133   envelope_to_add
25134   check_string = "From "
25135   escape_string = ">From "
25136   umask = 077
25137   user = $local_part_data
25138   group = mail
25139
25140 # router
25141 procmail:
25142   driver = accept
25143   check_local_user
25144   transport = procmail_pipe
25145 .endd
25146 In this example, the pipe is run as the local user, but with the group set to
25147 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25148 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25149 user to supply a correct sender address. If you do not specify either a
25150 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25151 home directory is the user's home directory by default.
25152
25153 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25154 .code
25155 IFS=" "
25156 .endd
25157 as shown in some &%procmail%& documentation, because Exim does not by default
25158 use a shell to run pipe commands.
25159
25160 .cindex "Cyrus"
25161 The next example shows a transport and a router for a system where local
25162 deliveries are handled by the Cyrus IMAP server.
25163 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25164 . but that suffix is tainted so cannot be used in a command arg
25165 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25166 .code
25167 # transport
25168 local_delivery_cyrus:
25169   driver = pipe
25170   command = /usr/cyrus/bin/deliver \
25171             -- $local_part_data
25172   user = cyrus
25173   group = mail
25174   return_output
25175   log_output
25176   message_prefix =
25177   message_suffix =
25178
25179 # router
25180 local_user_cyrus:
25181   driver = accept
25182   check_local_user
25183   transport = local_delivery_cyrus
25184 .endd
25185 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25186 &%return_output%& to cause any text written by Cyrus to be returned to the
25187 sender.
25188 .ecindex IIDpiptra1
25189 .ecindex IIDpiptra2
25190
25191
25192 . ////////////////////////////////////////////////////////////////////////////
25193 . ////////////////////////////////////////////////////////////////////////////
25194
25195 .chapter "The smtp transport" "CHAPsmtptrans"
25196 .scindex IIDsmttra1 "transports" "&(smtp)&"
25197 .scindex IIDsmttra2 "&(smtp)& transport"
25198 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25199 or LMTP protocol. The list of hosts to try can either be taken from the address
25200 that is being processed (having been set up by the router), or specified
25201 explicitly for the transport. Timeout and retry processing (see chapter
25202 &<<CHAPretry>>&) is applied to each IP address independently.
25203
25204
25205 .section "Multiple messages on a single connection" "SECID144"
25206 The sending of multiple messages over a single TCP/IP connection can arise in
25207 two ways:
25208
25209 .ilist
25210 If a message contains more than &%max_rcpt%& (see below) addresses that are
25211 routed to the same host, more than one copy of the message has to be sent to
25212 that host. In this situation, multiple copies may be sent in a single run of
25213 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25214 does when it has too many addresses to send in one message also depends on the
25215 value of the global &%remote_max_parallel%& option. Details are given in
25216 section &<<SECToutSMTPTCP>>&.)
25217 .next
25218 .cindex "hints database" "remembering routing"
25219 When a message has been successfully delivered over a TCP/IP connection, Exim
25220 looks in its hints database to see if there are any other messages awaiting a
25221 connection to the same host. If there are, a new delivery process is started
25222 for one of them, and the current TCP/IP connection is passed on to it. The new
25223 process may in turn send multiple copies and possibly create yet another
25224 process.
25225 .endlist
25226
25227
25228 For each copy sent over the same TCP/IP connection, a sequence counter is
25229 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25230 no further messages are sent over that connection.
25231
25232
25233
25234 .section "Use of the $host and $host_address variables" "SECID145"
25235 .vindex "&$host$&"
25236 .vindex "&$host_address$&"
25237 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25238 &$host_address$& are the name and IP address of the first host on the host list
25239 passed by the router. However, when the transport is about to connect to a
25240 specific host, and while it is connected to that host, &$host$& and
25241 &$host_address$& are set to the values for that host. These are the values
25242 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25243 &%serialize_hosts%&, and the various TLS options are expanded.
25244
25245
25246 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25247 .vindex &$tls_bits$&
25248 .vindex &$tls_cipher$&
25249 .vindex &$tls_peerdn$&
25250 .vindex &$tls_sni$&
25251 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25252 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25253 are the values that were set when the message was received.
25254 These are the values that are used for options that are expanded before any
25255 SMTP connections are made. Just before each connection is made, these four
25256 variables are emptied. If TLS is subsequently started, they are set to the
25257 appropriate values for the outgoing connection, and these are the values that
25258 are in force when any authenticators are run and when the
25259 &%authenticated_sender%& option is expanded.
25260
25261 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25262 and will be removed in a future release.
25263
25264
25265 .section "Private options for smtp" "SECID146"
25266 .cindex "options" "&(smtp)& transport"
25267 The private options of the &(smtp)& transport are as follows:
25268
25269
25270 .option address_retry_include_sender smtp boolean true
25271 .cindex "4&'xx'& responses" "retrying after"
25272 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25273 is the combination of sender and recipient that is delayed in subsequent queue
25274 runs until the retry time is reached. You can delay the recipient without
25275 reference to the sender (which is what earlier versions of Exim did), by
25276 setting &%address_retry_include_sender%& false. However, this can lead to
25277 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25278
25279 .option allow_localhost smtp boolean false
25280 .cindex "local host" "sending to"
25281 .cindex "fallback" "hosts specified on transport"
25282 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25283 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25284 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25285 the delivery anyway. This should be used only in special cases when the
25286 configuration ensures that no looping will result (for example, a differently
25287 configured Exim is listening on the port to which the message is sent).
25288
25289
25290 .option authenticated_sender smtp string&!! unset
25291 .cindex "Cyrus"
25292 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25293 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25294 overriding any existing authenticated sender value. If the string expansion is
25295 forced to fail, the option is ignored. Other expansion failures cause delivery
25296 to be deferred. If the result of expansion is an empty string, that is also
25297 ignored.
25298
25299 The expansion happens after the outgoing connection has been made and TLS
25300 started, if required. This means that the &$host$&, &$host_address$&,
25301 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25302 particular connection.
25303
25304 If the SMTP session is not authenticated, the expansion of
25305 &%authenticated_sender%& still happens (and can cause the delivery to be
25306 deferred if it fails), but no AUTH= item is added to MAIL commands
25307 unless &%authenticated_sender_force%& is true.
25308
25309 This option allows you to use the &(smtp)& transport in LMTP mode to
25310 deliver mail to Cyrus IMAP and provide the proper local part as the
25311 &"authenticated sender"&, via a setting such as:
25312 .code
25313 authenticated_sender = $local_part
25314 .endd
25315 This removes the need for IMAP subfolders to be assigned special ACLs to
25316 allow direct delivery to those subfolders.
25317
25318 Because of expected uses such as that just described for Cyrus (when no
25319 domain is involved), there is no checking on the syntax of the provided
25320 value.
25321
25322
25323 .option authenticated_sender_force smtp boolean false
25324 If this option is set true, the &%authenticated_sender%& option's value
25325 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25326 authenticated as a client.
25327
25328
25329 .option command_timeout smtp time 5m
25330 .cindex timeout "smtp transport command"
25331 This sets a timeout for receiving a response to an SMTP command that has been
25332 sent out. It is also used when waiting for the initial banner line from the
25333 remote host. Its value must not be zero.
25334
25335
25336 .option connect_timeout smtp time 5m
25337 .cindex timeout "smtp transport connect"
25338 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25339 to a remote host. A setting of zero allows the system timeout (typically
25340 several minutes) to act. To have any effect, the value of this option must be
25341 less than the system timeout. However, it has been observed that on some
25342 systems there is no system timeout, which is why the default value for this
25343 option is 5 minutes, a value recommended by RFC 1123.
25344
25345
25346 .option connection_max_messages smtp integer 500
25347 .cindex "SMTP" "passed connection"
25348 .cindex "SMTP" "multiple deliveries"
25349 .cindex "multiple SMTP deliveries"
25350 This controls the maximum number of separate message deliveries that are sent
25351 over a single TCP/IP connection. If the value is zero, there is no limit.
25352 For testing purposes, this value can be overridden by the &%-oB%& command line
25353 option.
25354
25355
25356 .option dane_require_tls_ciphers smtp string&!! unset
25357 .cindex "TLS" "requiring specific ciphers for DANE"
25358 .cindex "cipher" "requiring specific"
25359 .cindex DANE "TLS ciphers"
25360 This option may be used to override &%tls_require_ciphers%& for connections
25361 where DANE has been determined to be in effect.
25362 If not set, then &%tls_require_ciphers%& will be used.
25363 Normal SMTP delivery is not able to make strong demands of TLS cipher
25364 configuration, because delivery will fall back to plaintext.  Once DANE has
25365 been determined to be in effect, there is no plaintext fallback and making the
25366 TLS cipherlist configuration stronger will increase security, rather than
25367 counter-intuitively decreasing it.
25368 If the option expands to be empty or is forced to fail, then it will
25369 be treated as unset and &%tls_require_ciphers%& will be used instead.
25370
25371
25372 .option data_timeout smtp time 5m
25373 .cindex timeout "for transmitted SMTP data blocks"
25374 This sets a timeout for the transmission of each block in the data portion of
25375 the message. As a result, the overall timeout for a message depends on the size
25376 of the message. Its value must not be zero. See also &%final_timeout%&.
25377
25378
25379 .option dkim_canon smtp string&!! unset
25380 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25381 .option dkim_domain smtp "string list&!!" unset
25382 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25383 .option dkim_hash smtp string&!! sha256
25384 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25385 .option dkim_identity smtp string&!! unset
25386 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25387 .option dkim_private_key smtp string&!! unset
25388 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25389 .option dkim_selector smtp string&!! unset
25390 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25391 .option dkim_strict smtp string&!! unset
25392 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25393 .option dkim_sign_headers smtp string&!! "per RFC"
25394 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25395 .option dkim_timestamps smtp string&!! unset
25396 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25397
25398
25399 .option delay_after_cutoff smtp boolean true
25400 .cindex "final cutoff" "retries, controlling"
25401 .cindex retry "final cutoff"
25402 This option controls what happens when all remote IP addresses for a given
25403 domain have been inaccessible for so long that they have passed their retry
25404 cutoff times.
25405
25406 In the default state, if the next retry time has not been reached for any of
25407 them, the address is bounced without trying any deliveries. In other words,
25408 Exim delays retrying an IP address after the final cutoff time until a new
25409 retry time is reached, and can therefore bounce an address without ever trying
25410 a delivery, when machines have been down for a long time. Some people are
25411 unhappy at this prospect, so...
25412
25413 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25414 addresses are past their final cutoff time, Exim tries to deliver to those
25415 IP addresses that have not been tried since the message arrived. If there are
25416 none, of if they all fail, the address is bounced. In other words, it does not
25417 delay when a new message arrives, but immediately tries those expired IP
25418 addresses that haven't been tried since the message arrived. If there is a
25419 continuous stream of messages for the dead hosts, unsetting
25420 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25421 to them.
25422
25423
25424 .option dns_qualify_single smtp boolean true
25425 If the &%hosts%& or &%fallback_hosts%& option is being used,
25426 and the &%gethostbyname%& option is false,
25427 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25428 in chapter &<<CHAPdnslookup>>& for more details.
25429
25430
25431 .option dns_search_parents smtp boolean false
25432 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25433 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25434 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25435 details.
25436
25437
25438 .option dnssec_request_domains smtp "domain list&!!" *
25439 .cindex "MX record" "security"
25440 .cindex "DNSSEC" "MX lookup"
25441 .cindex "security" "MX lookup"
25442 .cindex "DNS" "DNSSEC"
25443 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25444 the DNSSEC request bit set. Setting this transport option is only useful if the
25445 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25446 router option.
25447
25448
25449
25450 .option dnssec_require_domains smtp "domain list&!!" unset
25451 .cindex "MX record" "security"
25452 .cindex "DNSSEC" "MX lookup"
25453 .cindex "security" "MX lookup"
25454 .cindex "DNS" "DNSSEC"
25455 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25456 the DNSSEC request bit set.  Setting this transport option is only
25457 useful if the transport overrides or sets the host names. See the
25458 &%dnssec_require_domains%& router option.
25459
25460
25461
25462 .option dscp smtp string&!! unset
25463 .cindex "DCSP" "outbound"
25464 This option causes the DSCP value associated with a socket to be set to one
25465 of a number of fixed strings or to numeric value.
25466 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25467 Common values include &`throughput`&, &`mincost`&, and on newer systems
25468 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25469
25470 The outbound packets from Exim will be marked with this value in the header
25471 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25472 that these values will have any effect, not be stripped by networking
25473 equipment, or do much of anything without cooperation with your Network
25474 Engineer and those of all network operators between the source and destination.
25475
25476
25477 .option fallback_hosts smtp "string list" unset
25478 .cindex "fallback" "hosts specified on transport"
25479 String expansion is not applied to this option. The argument must be a
25480 colon-separated list of host names or IP addresses, optionally also including
25481 port numbers, though the separator can be changed, as described in section
25482 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25483 item in a &%route_list%& setting for the &(manualroute)& router, as described
25484 in section &<<SECTformatonehostitem>>&.
25485
25486 Fallback hosts can also be specified on routers, which associate them with the
25487 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25488 &%fallback_hosts%& specified on the transport is used only if the address does
25489 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25490 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25491 However, &%hosts_randomize%& does apply to fallback host lists.
25492
25493 If Exim is unable to deliver to any of the hosts for a particular address, and
25494 the errors are not permanent rejections, the address is put on a separate
25495 transport queue with its host list replaced by the fallback hosts, unless the
25496 address was routed via MX records and the current host was in the original MX
25497 list. In that situation, the fallback host list is not used.
25498
25499 Once normal deliveries are complete, the fallback queue is delivered by
25500 re-running the same transports with the new host lists. If several failing
25501 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25502 copy of the message is sent.
25503
25504 The resolution of the host names on the fallback list is controlled by the
25505 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25506 both to cases when the host list comes with the address and when it is taken
25507 from &%hosts%&. This option provides a &"use a smart host only if delivery
25508 fails"& facility.
25509
25510
25511 .option final_timeout smtp time 10m
25512 .cindex timeout "for transmitted SMTP data accept"
25513 This is the timeout that applies while waiting for the response to the final
25514 line containing just &"."& that terminates a message. Its value must not be
25515 zero.
25516
25517 .option gethostbyname smtp boolean false
25518 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25519 being used, names are looked up using &[gethostbyname()]&
25520 (or &[getipnodebyname()]& when available)
25521 instead of using the DNS. Of course, that function may in fact use the DNS, but
25522 it may also consult other sources of information such as &_/etc/hosts_&.
25523
25524 .option gnutls_compat_mode smtp boolean unset
25525 This option controls whether GnuTLS is used in compatibility mode in an Exim
25526 server. This reduces security slightly, but improves interworking with older
25527 implementations of TLS.
25528
25529 .option helo_data smtp string&!! "see below"
25530 .cindex "HELO" "argument, setting"
25531 .cindex "EHLO" "argument, setting"
25532 .cindex "LHLO argument setting"
25533 The value of this option is expanded after a connection to a another host has
25534 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25535 command that starts the outgoing SMTP or LMTP session. The default value of the
25536 option is:
25537 .code
25538 $primary_hostname
25539 .endd
25540 During the expansion, the variables &$host$& and &$host_address$& are set to
25541 the identity of the remote host, and the variables &$sending_ip_address$& and
25542 &$sending_port$& are set to the local IP address and port number that are being
25543 used. These variables can be used to generate different values for different
25544 servers or different local IP addresses. For example, if you want the string
25545 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25546 interface address, you could use this:
25547 .code
25548 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25549   {${listextract{1}{<\n $value}}} \
25550   {$primary_hostname}}
25551 .endd
25552 The use of &%helo_data%& applies both to sending messages and when doing
25553 callouts.
25554
25555 .option host_name_extract smtp "string list&!!" "see below"
25556 .cindex "load balancer" "hosts behind"
25557 .cindex TLS resumption
25558 Some mail-accepting sites
25559 (notably Microsoft)
25560 operate many servers behind a network load-balancer.  When this is done,
25561 with separated TLS session caches, TLS session resuption becomes problematic.
25562 It will only succeed when the same server happens to be selected by the
25563 load-balancer, matching the session stored in the client's cache.
25564
25565 Exim can pull out a server name, if there is one, from the response to the
25566 client's SMTP EHLO command.
25567 The default value of this option:
25568 .code
25569     ${if and { {match {$host} {.outlook.com\$}} \
25570                {match {$item} {\N^250-([\w.]+)\s\N}} \
25571              } {$1}}
25572 .endd
25573 suffices for one known case.
25574 During the expansion of this option the &$item$& variable will have the
25575 server's EHLO response.
25576 The result of the option expansion is included in the key used to store and
25577 retrieve the TLS session, for session resumption.
25578
25579 Operators of high-load sites may wish to evaluate their logs for indications
25580 of other destination sites operating load-balancers, and develop a suitable
25581 expression for this option.
25582 The smtp:ehlo event and the &$tls_out_resumption$& variable
25583 will be useful for such work.
25584
25585 .option hosts smtp "string list&!!" unset
25586 Hosts are associated with an address by a router such as &(dnslookup)&, which
25587 finds the hosts by looking up the address domain in the DNS, or by
25588 &(manualroute)&, which has lists of hosts in its configuration. However,
25589 email addresses can be passed to the &(smtp)& transport by any router, and not
25590 all of them can provide an associated list of hosts.
25591
25592 The &%hosts%& option specifies a list of hosts to be used if the address being
25593 processed does not have any hosts associated with it. The hosts specified by
25594 &%hosts%& are also used, whether or not the address has its own hosts, if
25595 &%hosts_override%& is set.
25596
25597 The string is first expanded, before being interpreted as a colon-separated
25598 list of host names or IP addresses, possibly including port numbers. The
25599 separator may be changed to something other than colon, as described in section
25600 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25601 item in a &%route_list%& setting for the &(manualroute)& router, as described
25602 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25603 of the &(manualroute)& router is not available here.
25604
25605 If the expansion fails, delivery is deferred. Unless the failure was caused by
25606 the inability to complete a lookup, the error is logged to the panic log as
25607 well as the main log. Host names are looked up either by searching directly for
25608 address records in the DNS or by calling &[gethostbyname()]& (or
25609 &[getipnodebyname()]& when available), depending on the setting of the
25610 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25611 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25612 address are used.
25613
25614 During delivery, the hosts are tried in order, subject to their retry status,
25615 unless &%hosts_randomize%& is set.
25616
25617
25618 .option hosts_avoid_esmtp smtp "host list&!!" unset
25619 .cindex "ESMTP, avoiding use of"
25620 .cindex "HELO" "forcing use of"
25621 .cindex "EHLO" "avoiding use of"
25622 .cindex "PIPELINING" "avoiding the use of"
25623 This option is for use with broken hosts that announce ESMTP facilities (for
25624 example, PIPELINING) and then fail to implement them properly. When a host
25625 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25626 start of the SMTP session. This means that it cannot use any of the ESMTP
25627 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25628
25629
25630 .option hosts_avoid_pipelining smtp "host list&!!" unset
25631 .cindex "PIPELINING" "avoiding the use of"
25632 .cindex "ESMTP extensions" PIPELINING
25633 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25634 that matches this list, even if the server host advertises PIPELINING support.
25635
25636 .option hosts_pipe_connect smtp "host list&!!" unset
25637 .cindex "pipelining" "early connection"
25638 .cindex "pipelining" PIPECONNECT
25639 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25640 this option controls which to hosts the facility watched for
25641 and recorded, and used for subsequent connections.
25642
25643 The retry hints database is used for the record,
25644 and records are subject to the &%retry_data_expire%& option.
25645 When used, the pipelining saves on roundtrip times.
25646 It also turns SMTP into a client-first protocol
25647 so combines well with TCP Fast Open.
25648
25649 See also the &%pipelining_connect_advertise_hosts%& main option.
25650
25651 Note:
25652 When the facility is used, if the transport &%interface%& option is unset
25653 the &%helo_data%& option
25654 will be expanded before the &$sending_ip_address$& variable
25655 is filled in.
25656 A check is made for the use of that variable, without the
25657 presence of a &"def:"& test on it, but suitably complex coding
25658 can avoid the check and produce unexpected results.
25659 You have been warned.
25660
25661
25662 .option hosts_avoid_tls smtp "host list&!!" unset
25663 .cindex "TLS" "avoiding for certain hosts"
25664 Exim will not try to start a TLS session when delivering to any host that
25665 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25666
25667 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25668 .cindex "TLS" "avoiding for certain hosts"
25669 Exim will not try to start a TLS session for a verify callout,
25670 or when delivering in cutthrough mode,
25671 to any host that matches this list.
25672
25673
25674 .option hosts_max_try smtp integer 5
25675 .cindex "host" "maximum number to try"
25676 .cindex "limit" "number of hosts tried"
25677 .cindex "limit" "number of MX tried"
25678 .cindex "MX record" "maximum tried"
25679 This option limits the number of IP addresses that are tried for any one
25680 delivery in cases where there are temporary delivery errors. Section
25681 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25682
25683
25684 .option hosts_max_try_hardlimit smtp integer 50
25685 This is an additional check on the maximum number of IP addresses that Exim
25686 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25687 why it exists.
25688
25689
25690
25691 .option hosts_nopass_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 connection on which a TLS session has
25696 been started will not be passed to a new delivery process for sending another
25697 message on the same connection. See section &<<SECTmulmessam>>& for an
25698 explanation of when this might be needed.
25699
25700 .option hosts_noproxy_tls smtp "host list&!!" unset
25701 .cindex "TLS" "passing connection"
25702 .cindex "multiple SMTP deliveries"
25703 .cindex "TLS" "multiple message deliveries"
25704 For any host that matches this list, a TLS session which has
25705 been started will not be passed to a new delivery process for sending another
25706 message on the same session.
25707
25708 The traditional implementation closes down TLS and re-starts it in the new
25709 process, on the same open TCP connection, for each successive message
25710 sent.  If permitted by this option a pipe to to the new process is set up
25711 instead, and the original process maintains the TLS connection and proxies
25712 the SMTP connection from and to the new process and any subsequents.
25713 The new process has no access to TLS information, so cannot include it in
25714 logging.
25715
25716
25717
25718 .option hosts_override smtp boolean false
25719 If this option is set and the &%hosts%& option is also set, any hosts that are
25720 attached to the address are ignored, and instead the hosts specified by the
25721 &%hosts%& option are always used. This option does not apply to
25722 &%fallback_hosts%&.
25723
25724
25725 .option hosts_randomize smtp boolean false
25726 .cindex "randomized host list"
25727 .cindex "host" "list of; randomized"
25728 .cindex "fallback" "randomized hosts"
25729 If this option is set, and either the list of hosts is taken from the
25730 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25731 were not obtained from MX records (this includes fallback hosts from the
25732 router), and were not randomized by the router, the order of trying the hosts
25733 is randomized each time the transport runs. Randomizing the order of a host
25734 list can be used to do crude load sharing.
25735
25736 When &%hosts_randomize%& is true, a host list may be split into groups whose
25737 order is separately randomized. This makes it possible to set up MX-like
25738 behaviour. The boundaries between groups are indicated by an item that is just
25739 &`+`& in the host list. For example:
25740 .code
25741 hosts = host1:host2:host3:+:host4:host5
25742 .endd
25743 The order of the first three hosts and the order of the last two hosts is
25744 randomized for each use, but the first three always end up before the last two.
25745 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25746
25747 .option hosts_require_auth smtp "host list&!!" unset
25748 .cindex "authentication" "required by client"
25749 This option provides a list of servers for which authentication must succeed
25750 before Exim will try to transfer a message. If authentication fails for
25751 servers which are not in this list, Exim tries to send unauthenticated. If
25752 authentication fails for one of these servers, delivery is deferred. This
25753 temporary error is detectable in the retry rules, so it can be turned into a
25754 hard failure if required. See also &%hosts_try_auth%&, and chapter
25755 &<<CHAPSMTPAUTH>>& for details of authentication.
25756
25757
25758 .option hosts_request_ocsp smtp "host list&!!" "see below"
25759 .cindex "TLS" "requiring for certain servers"
25760 Exim will request a Certificate Status on a
25761 TLS session for any host that matches this list.
25762 &%tls_verify_certificates%& should also be set for the transport.
25763
25764 .new
25765 The default is &"**"& if DANE is not in use for the connection,
25766 or if DANE-TA us used.
25767 It is empty if DANE-EE is used.
25768 .wen
25769
25770 .option hosts_require_alpn smtp "host list&!!" unset
25771 .cindex ALPN "require negotiation in client"
25772 .cindex TLS ALPN
25773 .cindex TLS "Application Layer Protocol Names"
25774 If the TLS library supports ALPN
25775 then a successful negotiation of ALPN will be required for any host
25776 matching the list, for TLS to be used.
25777 See also the &%tls_alpn%& option.
25778
25779 &*Note*&: prevention of fallback to in-clear connection is not
25780 managed by this option; see &%hosts_require_tls%&.
25781
25782 .option hosts_require_dane smtp "host list&!!" unset
25783 .cindex DANE "transport options"
25784 .cindex DANE "requiring for certain servers"
25785 If built with DANE support, Exim  will require that a DNSSEC-validated
25786 TLSA record is present for any host matching the list,
25787 and that a DANE-verified TLS connection is made.
25788 There will be no fallback to in-clear communication.
25789 See the &%dnssec_request_domains%& router and transport options.
25790 See section &<<SECDANE>>&.
25791
25792 .option hosts_require_ocsp smtp "host list&!!" unset
25793 .cindex "TLS" "requiring for certain servers"
25794 Exim will request, and check for a valid Certificate Status being given, on a
25795 TLS session for any host that matches this list.
25796 &%tls_verify_certificates%& should also be set for the transport.
25797
25798 .option hosts_require_tls smtp "host list&!!" unset
25799 .cindex "TLS" "requiring for certain servers"
25800 Exim will insist on using a TLS session when delivering to any host that
25801 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25802 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25803 incoming messages, use an appropriate ACL.
25804
25805 .option hosts_try_auth smtp "host list&!!" unset
25806 .cindex "authentication" "optional in client"
25807 This option provides a list of servers to which, provided they announce
25808 authentication support, Exim will attempt to authenticate as a client when it
25809 connects. If authentication fails
25810 and &%hosts_require_auth%& permits,
25811 Exim will try to transfer the message unauthenticated.
25812 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25813
25814 .option hosts_try_chunking smtp "host list&!!" *
25815 .cindex CHUNKING "enabling, in client"
25816 .cindex BDAT "SMTP command"
25817 .cindex "RFC 3030" "CHUNKING"
25818 This option provides a list of servers to which, provided they announce
25819 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25820 Unless DKIM signing is being done,
25821 BDAT will not be used in conjunction with a transport filter.
25822
25823 .option hosts_try_dane smtp "host list&!!" *
25824 .cindex DANE "transport options"
25825 .cindex DANE "attempting for certain servers"
25826 If built with DANE support, Exim  will look up a
25827 TLSA record for any host matching the list,
25828 If one is found and that lookup was DNSSEC-validated,
25829 then Exim requires that a DANE-verified TLS connection is made for that host;
25830 there will be no fallback to in-clear communication.
25831 See the &%dnssec_request_domains%& router and transport options.
25832 See section &<<SECDANE>>&.
25833
25834 .option hosts_try_fastopen smtp "host list&!!" *
25835 .cindex "fast open, TCP" "enabling, in client"
25836 .cindex "TCP Fast Open" "enabling, in client"
25837 .cindex "RFC 7413" "TCP Fast Open"
25838 This option provides a list of servers to which, provided
25839 the facility is supported by this system, Exim will attempt to
25840 perform a TCP Fast Open.
25841 No data is sent on the SYN segment but, if the remote server also
25842 supports the facility, it can send its SMTP banner immediately after
25843 the SYN,ACK segment.  This can save up to one round-trip time.
25844
25845 The facility is only active for previously-contacted servers,
25846 as the initiator must present a cookie in the SYN segment.
25847
25848 On (at least some) current Linux distributions the facility must be enabled
25849 in the kernel by the sysadmin before the support is usable.
25850 There is no option for control of the server side; if the system supports
25851 it it is always enabled.  Note that lengthy operations in the connect ACL,
25852 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25853
25854 .option hosts_try_prdr smtp "host list&!!" *
25855 .cindex "PRDR" "enabling, optional in client"
25856 .cindex "ESMTP extensions" PRDR
25857 This option provides a list of servers to which, provided they announce
25858 PRDR support, Exim will attempt to negotiate PRDR
25859 for multi-recipient messages.
25860 The option can usually be left as default.
25861
25862 .option interface smtp "string list&!!" unset
25863 .cindex "bind IP address"
25864 .cindex "IP address" "binding"
25865 .vindex "&$host$&"
25866 .vindex "&$host_address$&"
25867 This option specifies which interface to bind to when making an outgoing SMTP
25868 call. The value is an IP address, not an interface name such as
25869 &`eth0`&. Do not confuse this with the interface address that was used when a
25870 message was received, which is in &$received_ip_address$&, formerly known as
25871 &$interface_address$&. The name was changed to minimize confusion with the
25872 outgoing interface address. There is no variable that contains an outgoing
25873 interface address because, unless it is set by this option, its value is
25874 unknown.
25875
25876 During the expansion of the &%interface%& option the variables &$host$& and
25877 &$host_address$& refer to the host to which a connection is about to be made
25878 during the expansion of the string. Forced expansion failure, or an empty
25879 string result causes the option to be ignored. Otherwise, after expansion, the
25880 string must be a list of IP addresses, colon-separated by default, but the
25881 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25882 For example:
25883 .code
25884 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25885 .endd
25886 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25887 connection. If none of them are the correct type, the option is ignored. If
25888 &%interface%& is not set, or is ignored, the system's IP functions choose which
25889 interface to use if the host has more than one.
25890
25891
25892 .option keepalive smtp boolean true
25893 .cindex "keepalive" "on outgoing connection"
25894 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25895 connections. When set, it causes the kernel to probe idle connections
25896 periodically, by sending packets with &"old"& sequence numbers. The other end
25897 of the connection should send a acknowledgment if the connection is still okay
25898 or a reset if the connection has been aborted. The reason for doing this is
25899 that it has the beneficial effect of freeing up certain types of connection
25900 that can get stuck when the remote host is disconnected without tidying up the
25901 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25902 unreachable hosts.
25903
25904
25905 .option lmtp_ignore_quota smtp boolean false
25906 .cindex "LMTP" "ignoring quota errors"
25907 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25908 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25909 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25910
25911 .option max_rcpt smtp integer&!! 100
25912 .cindex "RCPT" "maximum number of outgoing"
25913 This option,
25914 .new
25915 after expansion,
25916 .wen
25917 limits the number of RCPT commands that are sent in a single
25918 SMTP message transaction.
25919 A value setting of zero disables the limit.
25920
25921 .new
25922 If a constant is given,
25923 .wen
25924 each set of addresses is treated independently, and
25925 so can cause parallel connections to the same host if &%remote_max_parallel%&
25926 permits this.
25927
25928
25929 .option message_linelength_limit smtp integer 998
25930 .cindex "line length" limit
25931 This option sets the maximum line length, in bytes, that the transport
25932 will send.  Any messages with lines exceeding the given value
25933 will fail and a failure-DSN ("bounce") message will if possible be returned
25934 to the sender.
25935 The default value is that defined by the SMTP standards.
25936
25937 It is generally wise to also check in the data ACL so that messages
25938 received via SMTP can be refused without producing a bounce.
25939
25940
25941 .option multi_domain smtp boolean&!! true
25942 .vindex "&$domain$&"
25943 When this option is set, the &(smtp)& transport can handle a number of
25944 addresses containing a mixture of different domains provided they all resolve
25945 to the same list of hosts. Turning the option off restricts the transport to
25946 handling only one domain at a time. This is useful if you want to use
25947 &$domain$& in an expansion for the transport, because it is set only when there
25948 is a single domain involved in a remote delivery.
25949
25950 It is expanded per-address and can depend on any of
25951 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25952 &$host$&, &$host_address$& and &$host_port$&.
25953
25954 If the connection is DANE-enabled then this option is ignored;
25955 only messages having the domain used for the DANE TLSA lookup are
25956 sent on the connection.
25957
25958 .option port smtp string&!! "see below"
25959 .cindex "port" "sending TCP/IP"
25960 .cindex "TCP/IP" "setting outgoing port"
25961 This option specifies the TCP/IP port on the server to which Exim connects.
25962 &*Note:*& Do not confuse this with the port that was used when a message was
25963 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25964 The name was changed to minimize confusion with the outgoing port. There is no
25965 variable that contains an outgoing port.
25966
25967 If the value of this option begins with a digit it is taken as a port number;
25968 otherwise it is looked up using &[getservbyname()]&. The default value is
25969 normally &"smtp"&,
25970 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25971 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25972 If the expansion fails, or if a port number cannot be found, delivery
25973 is deferred.
25974
25975 Note that at least one Linux distribution has been seen failing
25976 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25977
25978
25979
25980 .option protocol smtp string smtp
25981 .cindex "LMTP" "over TCP/IP"
25982 .cindex "ssmtp protocol" "outbound"
25983 .cindex "TLS" "SSL-on-connect outbound"
25984 .vindex "&$port$&"
25985 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25986 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25987 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25988 deliveries into closed message stores. Exim also has support for running LMTP
25989 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25990
25991 If this option is set to &"smtps"&, the default value for the &%port%& option
25992 changes to &"smtps"&, and the transport initiates TLS immediately after
25993 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25994 The Internet standards bodies used to strongly discourage use of this mode,
25995 but as of RFC 8314 it is preferred over STARTTLS for message submission
25996 (as distinct from MTA-MTA communication).
25997
25998
25999 .option retry_include_ip_address smtp boolean&!! true
26000 Exim normally includes both the host name and the IP address in the key it
26001 constructs for indexing retry data after a temporary delivery failure. This
26002 means that when one of several IP addresses for a host is failing, it gets
26003 tried periodically (controlled by the retry rules), but use of the other IP
26004 addresses is not affected.
26005
26006 However, in some dialup environments hosts are assigned a different IP address
26007 each time they connect. In this situation the use of the IP address as part of
26008 the retry key leads to undesirable behaviour. Setting this option false causes
26009 Exim to use only the host name.
26010 Since it is expanded it can be made to depend on the host or domain.
26011
26012
26013 .option serialize_hosts smtp "host list&!!" unset
26014 .cindex "serializing connections"
26015 .cindex "host" "serializing connections"
26016 Because Exim operates in a distributed manner, if several messages for the same
26017 host arrive at around the same time, more than one simultaneous connection to
26018 the remote host can occur. This is not usually a problem except when there is a
26019 slow link between the hosts. In that situation it may be helpful to restrict
26020 Exim to one connection at a time. This can be done by setting
26021 &%serialize_hosts%& to match the relevant hosts.
26022
26023 .cindex "hints database" "serializing deliveries to a host"
26024 Exim implements serialization by means of a hints database in which a record is
26025 written whenever a process connects to one of the restricted hosts. The record
26026 is deleted when the connection is completed. Obviously there is scope for
26027 records to get left lying around if there is a system or program crash. To
26028 guard against this, Exim ignores any records that are more than six hours old.
26029
26030 If you set up this kind of serialization, you should also arrange to delete the
26031 relevant hints database whenever your system reboots. The names of the files
26032 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26033 may be one or two files, depending on the type of DBM in use. The same files
26034 are used for ETRN serialization.
26035
26036 See also the &%max_parallel%& generic transport option.
26037
26038
26039 .option size_addition smtp integer 1024
26040 .cindex "SIZE" "ESMTP extension"
26041 .cindex "message" "size issue for transport filter"
26042 .cindex "size" "of message"
26043 .cindex "transport" "filter"
26044 .cindex "filter" "transport filter"
26045 If a remote SMTP server indicates that it supports the SIZE option of the
26046 MAIL command, Exim uses this to pass over the message size at the start of
26047 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26048 sends, to allow for headers and other text that may be added during delivery by
26049 configuration options or in a transport filter. It may be necessary to increase
26050 this if a lot of text is added to messages.
26051
26052 Alternatively, if the value of &%size_addition%& is set negative, it disables
26053 the use of the SIZE option altogether.
26054
26055
26056 .option socks_proxy smtp string&!! unset
26057 .cindex proxy SOCKS
26058 This option enables use of SOCKS proxies for connections made by the
26059 transport.  For details see section &<<SECTproxySOCKS>>&.
26060
26061
26062 .option tls_alpn smtp string&!! unset
26063 .cindex TLS "Application Layer Protocol Names"
26064 .cindex TLS ALPN
26065 .cindex ALPN "set name in client"
26066 If this option is set
26067 and the TLS library supports ALPN,
26068 the value given is used.
26069
26070 As of writing no value has been standardised for email use.
26071 The authors suggest using &"smtp"&.
26072
26073
26074
26075 .option tls_certificate smtp string&!! unset
26076 .cindex "TLS" "client certificate, location of"
26077 .cindex "certificate" "client, location of"
26078 .vindex "&$host$&"
26079 .vindex "&$host_address$&"
26080 The value of this option must be the absolute path to a file which contains the
26081 client's certificate, for possible use when sending a message over an encrypted
26082 connection. The values of &$host$& and &$host_address$& are set to the name and
26083 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26084 details of TLS.
26085
26086 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26087 certificate when sending messages as a client. The global option of the same
26088 name specifies the certificate for Exim as a server; it is not automatically
26089 assumed that the same certificate should be used when Exim is operating as a
26090 client.
26091
26092
26093 .option tls_crl smtp string&!! unset
26094 .cindex "TLS" "client certificate revocation list"
26095 .cindex "certificate" "revocation list for client"
26096 This option specifies a certificate revocation list. The expanded value must
26097 be the name of a file that contains a CRL in PEM format.
26098
26099
26100 .option tls_dh_min_bits smtp integer 1024
26101 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26102 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26103 key agreement is negotiated, the server will provide a large prime number
26104 for use.  This option establishes the minimum acceptable size of that number.
26105 If the parameter offered by the server is too small, then the TLS handshake
26106 will fail.
26107
26108 Only supported when using GnuTLS.
26109
26110
26111 .option tls_privatekey smtp string&!! unset
26112 .cindex "TLS" "client private key, location of"
26113 .vindex "&$host$&"
26114 .vindex "&$host_address$&"
26115 The value of this option must be the absolute path to a file which contains the
26116 client's private key. This is used when sending a message over an encrypted
26117 connection using a client certificate. The values of &$host$& and
26118 &$host_address$& are set to the name and address of the server during the
26119 expansion. If this option is unset, or the expansion is forced to fail, or the
26120 result is an empty string, the private key is assumed to be in the same file as
26121 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26122
26123
26124 .option tls_require_ciphers smtp string&!! unset
26125 .cindex "TLS" "requiring specific ciphers"
26126 .cindex "cipher" "requiring specific"
26127 .vindex "&$host$&"
26128 .vindex "&$host_address$&"
26129 The value of this option must be a list of permitted cipher suites, for use
26130 when setting up an outgoing encrypted connection. (There is a global option of
26131 the same name for controlling incoming connections.) The values of &$host$& and
26132 &$host_address$& are set to the name and address of the server during the
26133 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26134 is used in different ways by OpenSSL and GnuTLS (see sections
26135 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26136 ciphers is a preference order.
26137
26138
26139 .option tls_resumption_hosts smtp "host list&!!" unset
26140 .cindex TLS resumption
26141 This option controls which connections to use the TLS resumption feature.
26142 See &<<SECTresumption>>& for details.
26143
26144
26145
26146 .option tls_sni smtp string&!! unset
26147 .cindex "TLS" "Server Name Indication"
26148 .cindex "TLS" SNI
26149 .cindex SNI "setting in client"
26150 .vindex "&$tls_sni$&"
26151 If this option is set
26152 and the connection is not DANE-validated
26153 then it sets the $tls_out_sni variable and causes any
26154 TLS session to pass this value as the Server Name Indication extension to
26155 the remote side, which can be used by the remote side to select an appropriate
26156 certificate and private key for the session.
26157
26158 See &<<SECTtlssni>>& for more information.
26159
26160 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26161 TLS extensions.
26162
26163
26164
26165
26166 .option tls_tempfail_tryclear smtp boolean true
26167 .cindex "4&'xx'& responses" "to STARTTLS"
26168 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26169 setting up a TLS session, this option determines whether or not Exim should try
26170 to deliver the message unencrypted. If it is set false, delivery to the
26171 current host is deferred; if there are other hosts, they are tried. If this
26172 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26173 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26174 TLS negotiation fails, Exim closes the current connection (because it is in an
26175 unknown state), opens a new one to the same host, and then tries the delivery
26176 in clear.
26177
26178
26179 .option tls_try_verify_hosts smtp "host list&!!" *
26180 .cindex "TLS" "server certificate verification"
26181 .cindex "certificate" "verification of server"
26182 This option gives a list of hosts for which, on encrypted connections,
26183 certificate verification will be tried but need not succeed.
26184 The &%tls_verify_certificates%& option must also be set.
26185 Note that unless the host is in this list
26186 TLS connections will be denied to hosts using self-signed certificates
26187 when &%tls_verify_certificates%& is matched.
26188 The &$tls_out_certificate_verified$& variable is set when
26189 certificate verification succeeds.
26190
26191
26192 .option tls_verify_cert_hostnames smtp "host list&!!" *
26193 .cindex "TLS" "server certificate hostname verification"
26194 .cindex "certificate" "verification of server"
26195 This option give a list of hosts for which,
26196 while verifying the server certificate,
26197 checks will be included on the host name
26198 (note that this will generally be the result of a DNS MX lookup)
26199 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26200 Wildcard names are permitted,
26201 limited to being the initial component of a 3-or-more component FQDN.
26202
26203 There is no equivalent checking on client certificates.
26204
26205
26206 .option tls_verify_certificates smtp string&!! system
26207 .cindex "TLS" "server certificate verification"
26208 .cindex "certificate" "verification of server"
26209 .vindex "&$host$&"
26210 .vindex "&$host_address$&"
26211 The value of this option must be either the
26212 word "system"
26213 or the absolute path to
26214 a file or directory containing permitted certificates for servers,
26215 for use when setting up an encrypted connection.
26216
26217 The "system" value for the option will use a location compiled into the SSL library.
26218 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26219 is taken as empty and an explicit location
26220 must be specified.
26221
26222 The use of a directory for the option value is not available for GnuTLS versions
26223 preceding 3.3.6 and a single file must be used.
26224
26225 With OpenSSL the certificates specified
26226 explicitly
26227 either by file or directory
26228 are added to those given by the system default location.
26229
26230 The values of &$host$& and
26231 &$host_address$& are set to the name and address of the server during the
26232 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26233
26234 For back-compatibility,
26235 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26236 (a single-colon empty list counts as being set)
26237 and certificate verification fails the TLS connection is closed.
26238
26239
26240 .option tls_verify_hosts smtp "host list&!!" unset
26241 .cindex "TLS" "server certificate verification"
26242 .cindex "certificate" "verification of server"
26243 This option gives a list of hosts for which, on encrypted connections,
26244 certificate verification must succeed.
26245 The &%tls_verify_certificates%& option must also be set.
26246 If both this option and &%tls_try_verify_hosts%& are unset
26247 operation is as if this option selected all hosts.
26248 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26249 that connections use TLS.
26250 Fallback to in-clear communication will be done unless restricted by
26251 the &%hosts_require_tls%& option.
26252
26253 .option utf8_downconvert smtp integer&!! -1
26254 .cindex utf8 "address downconversion"
26255 .cindex i18n "utf8 address downconversion"
26256 If built with internationalization support,
26257 this option controls conversion of UTF-8 in message envelope addresses
26258 to a-label form.
26259 If, after expansion, the value is 1, 0, or -1 then this value overrides
26260 any value previously set for the message.  Otherwise, any previously
26261 set value is used.  To permit use of a previous value,
26262 set this option to an empty string.
26263 For details on the values see section &<<SECTi18nMTA>>&.
26264
26265
26266
26267
26268 .section "How the limits for the number of hosts to try are used" &&&
26269          "SECTvalhosmax"
26270 .cindex "host" "maximum number to try"
26271 .cindex "limit" "hosts; maximum number tried"
26272 There are two options that are concerned with the number of hosts that are
26273 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26274 &%hosts_max_try_hardlimit%&.
26275
26276
26277 The &%hosts_max_try%& option limits the number of hosts that are tried
26278 for a single delivery. However, despite the term &"host"& in its name, the
26279 option actually applies to each IP address independently. In other words, a
26280 multihomed host is treated as several independent hosts, just as it is for
26281 retrying.
26282
26283 Many of the larger ISPs have multiple MX records which often point to
26284 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26285 created as a result of routing one of these domains.
26286
26287 Trying every single IP address on such a long list does not seem sensible; if
26288 several at the top of the list fail, it is reasonable to assume there is some
26289 problem that is likely to affect all of them. Roughly speaking, the value of
26290 &%hosts_max_try%& is the maximum number that are tried before deferring the
26291 delivery. However, the logic cannot be quite that simple.
26292
26293 Firstly, IP addresses that are skipped because their retry times have not
26294 arrived do not count, and in addition, addresses that are past their retry
26295 limits are also not counted, even when they are tried. This means that when
26296 some IP addresses are past their retry limits, more than the value of
26297 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26298 that all IP addresses are considered before timing out an email address (but
26299 see below for an exception).
26300
26301 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26302 list to see if there is a subsequent host with a different (higher valued) MX.
26303 If there is, that host is considered next, and the current IP address is used
26304 but not counted. This behaviour helps in the case of a domain with a retry rule
26305 that hardly ever delays any hosts, as is now explained:
26306
26307 Consider the case of a long list of hosts with one MX value, and a few with a
26308 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26309 hosts at the top of the list are tried at first. With the default retry rule,
26310 which specifies increasing retry times, the higher MX hosts are eventually
26311 tried when those at the top of the list are skipped because they have not
26312 reached their retry times.
26313
26314 However, it is common practice to put a fixed short retry time on domains for
26315 large ISPs, on the grounds that their servers are rarely down for very long.
26316 Unfortunately, these are exactly the domains that tend to resolve to long lists
26317 of hosts. The short retry time means that the lowest MX hosts are tried every
26318 time. The attempts may be in a different order because of random sorting, but
26319 without the special MX check, the higher MX hosts would never be tried until
26320 all the lower MX hosts had timed out (which might be several days), because
26321 there are always some lower MX hosts that have reached their retry times. With
26322 the special check, Exim considers at least one IP address from each MX value at
26323 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26324 reached.
26325
26326 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26327 particular, Exim normally eventually tries all the IP addresses before timing
26328 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26329 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26330 been set up with hundreds of IP addresses for some domains. It can
26331 take a very long time indeed for an address to time out in these cases.
26332
26333 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26334 Exim never tries more than this number of IP addresses; if it hits this limit
26335 and they are all timed out, the email address is bounced, even though not all
26336 possible IP addresses have been tried.
26337 .ecindex IIDsmttra1
26338 .ecindex IIDsmttra2
26339
26340
26341
26342
26343
26344 . ////////////////////////////////////////////////////////////////////////////
26345 . ////////////////////////////////////////////////////////////////////////////
26346
26347 .chapter "Address rewriting" "CHAPrewrite"
26348 .scindex IIDaddrew "rewriting" "addresses"
26349 There are some circumstances in which Exim automatically rewrites domains in
26350 addresses. The two most common are when an address is given without a domain
26351 (referred to as an &"unqualified address"&) or when an address contains an
26352 abbreviated domain that is expanded by DNS lookup.
26353
26354 Unqualified envelope addresses are accepted only for locally submitted
26355 messages, or for messages that are received from hosts matching
26356 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26357 appropriate. Unqualified addresses in header lines are qualified if they are in
26358 locally submitted messages, or messages from hosts that are permitted to send
26359 unqualified envelope addresses. Otherwise, unqualified addresses in header
26360 lines are neither qualified nor rewritten.
26361
26362 One situation in which Exim does &'not'& automatically rewrite a domain is
26363 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26364 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26365 do this. The new RFCs do not contain this suggestion.
26366
26367
26368 .section "Explicitly configured address rewriting" "SECID147"
26369 This chapter describes the rewriting rules that can be used in the
26370 main rewrite section of the configuration file, and also in the generic
26371 &%headers_rewrite%& option that can be set on any transport.
26372
26373 Some people believe that configured address rewriting is a Mortal Sin.
26374 Others believe that life is not possible without it. Exim provides the
26375 facility; you do not have to use it.
26376
26377 The main rewriting rules that appear in the &"rewrite"& section of the
26378 configuration file are applied to addresses in incoming messages, both envelope
26379 addresses and addresses in header lines. Each rule specifies the types of
26380 address to which it applies.
26381
26382 Whether or not addresses in header lines are rewritten depends on the origin of
26383 the headers and the type of rewriting. Global rewriting, that is, rewriting
26384 rules from the rewrite section of the configuration file, is applied only to
26385 those headers that were received with the message. Header lines that are added
26386 by ACLs or by a system filter or by individual routers or transports (which
26387 are specific to individual recipient addresses) are not rewritten by the global
26388 rules.
26389
26390 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26391 applies all headers except those added by routers and transports. That is, as
26392 well as the headers that were received with the message, it also applies to
26393 headers that were added by an ACL or a system filter.
26394
26395
26396 In general, rewriting addresses from your own system or domain has some
26397 legitimacy. Rewriting other addresses should be done only with great care and
26398 in special circumstances. The author of Exim believes that rewriting should be
26399 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26400 Although it can sometimes be used as a routing tool, this is very strongly
26401 discouraged.
26402
26403 There are two commonly encountered circumstances where rewriting is used, as
26404 illustrated by these examples:
26405
26406 .ilist
26407 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26408 exchange mail with each other behind a firewall, but there is only a single
26409 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26410 &'hitch.fict.example'& when sending mail off-site.
26411 .next
26412 A host rewrites the local parts of its own users so that, for example,
26413 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26414 .endlist
26415
26416
26417
26418 .section "When does rewriting happen?" "SECID148"
26419 .cindex "rewriting" "timing of"
26420 .cindex "&ACL;" "rewriting addresses in"
26421 Configured address rewriting can take place at several different stages of a
26422 message's processing.
26423
26424 .vindex "&$sender_address$&"
26425 At the start of an ACL for MAIL, the sender address may have been rewritten
26426 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26427 ordinary rewrite rules have yet been applied. If, however, the sender address
26428 is verified in the ACL, it is rewritten before verification, and remains
26429 rewritten thereafter. The subsequent value of &$sender_address$& is the
26430 rewritten address. This also applies if sender verification happens in a
26431 RCPT ACL. Otherwise, when the sender address is not verified, it is
26432 rewritten as soon as a message's header lines have been received.
26433
26434 .vindex "&$domain$&"
26435 .vindex "&$local_part$&"
26436 Similarly, at the start of an ACL for RCPT, the current recipient's address
26437 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26438 rewrite rules have yet been applied to it. However, the behaviour is different
26439 from the sender address when a recipient is verified. The address is rewritten
26440 for the verification, but the rewriting is not remembered at this stage. The
26441 value of &$local_part$& and &$domain$& after verification are always the same
26442 as they were before (that is, they contain the unrewritten &-- except for
26443 SMTP-time rewriting &-- address).
26444
26445 As soon as a message's header lines have been received, all the envelope
26446 recipient addresses are permanently rewritten, and rewriting is also applied to
26447 the addresses in the header lines (if configured). This happens before adding
26448 any header lines that were specified in MAIL or RCPT ACLs, and
26449 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26450 before the DATA ACL and &[local_scan()]& functions are run.
26451
26452 When an address is being routed, either for delivery or for verification,
26453 rewriting is applied immediately to child addresses that are generated by
26454 redirection, unless &%no_rewrite%& is set on the router.
26455
26456 .cindex "envelope from"
26457 .cindex "envelope sender" "rewriting at transport time"
26458 .cindex "rewriting" "at transport time"
26459 .cindex "header lines" "rewriting at transport time"
26460 At transport time, additional rewriting of addresses in header lines can be
26461 specified by setting the generic &%headers_rewrite%& option on a transport.
26462 This option contains rules that are identical in form to those in the rewrite
26463 section of the configuration file. They are applied to the original message
26464 header lines and any that were added by ACLs or a system filter. They are not
26465 applied to header lines that are added by routers or the transport.
26466
26467 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26468 transport option. However, it is not possible to rewrite envelope recipients at
26469 transport time.
26470
26471
26472
26473
26474 .section "Testing the rewriting rules that apply on input" "SECID149"
26475 .cindex "rewriting" "testing"
26476 .cindex "testing" "rewriting"
26477 Exim's input rewriting configuration appears in a part of the runtime
26478 configuration file headed by &"begin rewrite"&. It can be tested by the
26479 &%-brw%& command line option. This takes an address (which can be a full RFC
26480 2822 address) as its argument. The output is a list of how the address would be
26481 transformed by the rewriting rules for each of the different places it might
26482 appear in an incoming message, that is, for each different header and for the
26483 envelope sender and recipient fields. For example,
26484 .code
26485 exim -brw ph10@exim.workshop.example
26486 .endd
26487 might produce the output
26488 .code
26489 sender: Philip.Hazel@exim.workshop.example
26490 from: Philip.Hazel@exim.workshop.example
26491 to: ph10@exim.workshop.example
26492 cc: ph10@exim.workshop.example
26493 bcc: ph10@exim.workshop.example
26494 reply-to: Philip.Hazel@exim.workshop.example
26495 env-from: Philip.Hazel@exim.workshop.example
26496 env-to: ph10@exim.workshop.example
26497 .endd
26498 which shows that rewriting has been set up for that address when used in any of
26499 the source fields, but not when it appears as a recipient address. At the
26500 present time, there is no equivalent way of testing rewriting rules that are
26501 set for a particular transport.
26502
26503
26504 .section "Rewriting rules" "SECID150"
26505 .cindex "rewriting" "rules"
26506 The rewrite section of the configuration file consists of lines of rewriting
26507 rules in the form
26508 .display
26509 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26510 .endd
26511 Rewriting rules that are specified for the &%headers_rewrite%& generic
26512 transport option are given as a colon-separated list. Each item in the list
26513 takes the same form as a line in the main rewriting configuration (except that
26514 any colons must be doubled, of course).
26515
26516 The formats of source patterns and replacement strings are described below.
26517 Each is terminated by white space, unless enclosed in double quotes, in which
26518 case normal quoting conventions apply inside the quotes. The flags are single
26519 characters which may appear in any order. Spaces and tabs between them are
26520 ignored.
26521
26522 For each address that could potentially be rewritten, the rules are scanned in
26523 order, and replacements for the address from earlier rules can themselves be
26524 replaced by later rules (but see the &"q"& and &"R"& flags).
26525
26526 The order in which addresses are rewritten is undefined, may change between
26527 releases, and must not be relied on, with one exception: when a message is
26528 received, the envelope sender is always rewritten first, before any header
26529 lines are rewritten. For example, the replacement string for a rewrite of an
26530 address in &'To:'& must not assume that the message's address in &'From:'& has
26531 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26532 that the envelope sender has already been rewritten.
26533
26534 .vindex "&$domain$&"
26535 .vindex "&$local_part$&"
26536 The variables &$local_part$& and &$domain$& can be used in the replacement
26537 string to refer to the address that is being rewritten. Note that lookup-driven
26538 rewriting can be done by a rule of the form
26539 .code
26540 *@*   ${lookup ...
26541 .endd
26542 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26543 refer to the address that is being rewritten.
26544
26545
26546 .section "Rewriting patterns" "SECID151"
26547 .cindex "rewriting" "patterns"
26548 .cindex "address list" "in a rewriting pattern"
26549 The source pattern in a rewriting rule is any item which may appear in an
26550 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26551 single-item address list, which means that it is expanded before being tested
26552 against the address. As always, if you use a regular expression as a pattern,
26553 you must take care to escape dollar and backslash characters, or use the &`\N`&
26554 facility to suppress string expansion within the regular expression.
26555
26556 Domains in patterns should be given in lower case. Local parts in patterns are
26557 case-sensitive. If you want to do case-insensitive matching of local parts, you
26558 can use a regular expression that starts with &`^(?i)`&.
26559
26560 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26561 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26562 depending on the type of match which occurred. These can be used in the
26563 replacement string to insert portions of the incoming address. &$0$& always
26564 refers to the complete incoming address. When a regular expression is used, the
26565 numerical variables are set from its capturing subexpressions. For other types
26566 of pattern they are set as follows:
26567
26568 .ilist
26569 If a local part or domain starts with an asterisk, the numerical variables
26570 refer to the character strings matched by asterisks, with &$1$& associated with
26571 the first asterisk, and &$2$& with the second, if present. For example, if the
26572 pattern
26573 .code
26574 *queen@*.fict.example
26575 .endd
26576 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26577 .code
26578 $0 = hearts-queen@wonderland.fict.example
26579 $1 = hearts-
26580 $2 = wonderland
26581 .endd
26582 Note that if the local part does not start with an asterisk, but the domain
26583 does, it is &$1$& that contains the wild part of the domain.
26584
26585 .next
26586 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26587 of the domain are placed in the next available numerical variables. Suppose,
26588 for example, that the address &'foo@bar.baz.example'& is processed by a
26589 rewriting rule of the form
26590 .display
26591 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26592 .endd
26593 and the key in the file that matches the domain is &`*.baz.example`&. Then
26594 .code
26595 $1 = foo
26596 $2 = bar
26597 $3 = baz.example
26598 .endd
26599 If the address &'foo@baz.example'& is looked up, this matches the same
26600 wildcard file entry, and in this case &$2$& is set to the empty string, but
26601 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26602 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26603 whole domain. For non-partial domain lookups, no numerical variables are set.
26604 .endlist
26605
26606
26607 .section "Rewriting replacements" "SECID152"
26608 .cindex "rewriting" "replacements"
26609 If the replacement string for a rule is a single asterisk, addresses that
26610 match the pattern and the flags are &'not'& rewritten, and no subsequent
26611 rewriting rules are scanned. For example,
26612 .code
26613 hatta@lookingglass.fict.example  *  f
26614 .endd
26615 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26616 &'From:'& headers.
26617
26618 .vindex "&$domain$&"
26619 .vindex "&$local_part$&"
26620 If the replacement string is not a single asterisk, it is expanded, and must
26621 yield a fully qualified address. Within the expansion, the variables
26622 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26623 Any letters they contain retain their original case &-- they are not lower
26624 cased. The numerical variables are set up according to the type of pattern that
26625 matched the address, as described above. If the expansion is forced to fail by
26626 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26627 current rule is abandoned, but subsequent rules may take effect. Any other
26628 expansion failure causes the entire rewriting operation to be abandoned, and an
26629 entry written to the panic log.
26630
26631
26632
26633 .subsection "Rewriting flags" "SSECID153"
26634 There are three different kinds of flag that may appear on rewriting rules:
26635
26636 .ilist
26637 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26638 c, f, h, r, s, t.
26639 .next
26640 A flag that specifies rewriting at SMTP time: S.
26641 .next
26642 Flags that control the rewriting process: Q, q, R, w.
26643 .endlist
26644
26645 For rules that are part of the &%headers_rewrite%& generic transport option,
26646 E, F, T, and S are not permitted.
26647
26648
26649
26650 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26651          "SSECID154"
26652 .cindex rewriting flags
26653 If none of the following flag letters, nor the &"S"& flag (see section
26654 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26655 and to both the sender and recipient fields of the envelope, whereas a
26656 transport-time rewriting rule just applies to all headers. Otherwise, the
26657 rewriting rule is skipped unless the relevant addresses are being processed.
26658 .display
26659 &`E`&       rewrite all envelope fields
26660 &`F`&       rewrite the envelope From field
26661 &`T`&       rewrite the envelope To field
26662 &`b`&       rewrite the &'Bcc:'& header
26663 &`c`&       rewrite the &'Cc:'& header
26664 &`f`&       rewrite the &'From:'& header
26665 &`h`&       rewrite all headers
26666 &`r`&       rewrite the &'Reply-To:'& header
26667 &`s`&       rewrite the &'Sender:'& header
26668 &`t`&       rewrite the &'To:'& header
26669 .endd
26670 "All headers" means all of the headers listed above that can be selected
26671 individually, plus their &'Resent-'& versions. It does not include
26672 other headers such as &'Subject:'& etc.
26673
26674 You should be particularly careful about rewriting &'Sender:'& headers, and
26675 restrict this to special known cases in your own domains.
26676
26677
26678 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26679 .cindex SMTP "rewriting malformed addresses"
26680 .cindex RCPT "rewriting argument of"
26681 .cindex MAIL "rewriting argument of"
26682 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26683 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26684 before any other processing; even before syntax checking. The pattern is
26685 required to be a regular expression, and it is matched against the whole of the
26686 data for the command, including any surrounding angle brackets.
26687
26688 .vindex "&$domain$&"
26689 .vindex "&$local_part$&"
26690 This form of rewrite rule allows for the handling of addresses that are not
26691 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26692 input). Because the input is not required to be a syntactically valid address,
26693 the variables &$local_part$& and &$domain$& are not available during the
26694 expansion of the replacement string. The result of rewriting replaces the
26695 original address in the MAIL or RCPT command.
26696
26697
26698 .subsection "Flags controlling the rewriting process" SSECID155
26699 There are four flags which control the way the rewriting process works. These
26700 take effect only when a rule is invoked, that is, when the address is of the
26701 correct type (matches the flags) and matches the pattern:
26702
26703 .ilist
26704 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26705 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26706 absence of &"Q"& the rewritten address must always include a domain.
26707 .next
26708 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26709 even if no rewriting actually takes place because of a &"fail"& in the
26710 expansion. The &"q"& flag is not effective if the address is of the wrong type
26711 (does not match the flags) or does not match the pattern.
26712 .next
26713 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26714 address, up to ten times. It can be combined with the &"q"& flag, to stop
26715 rewriting once it fails to match (after at least one successful rewrite).
26716 .next
26717 .cindex "rewriting" "whole addresses"
26718 When an address in a header is rewritten, the rewriting normally applies only
26719 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26720 left unchanged. For example, rewriting might change
26721 .code
26722 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26723 .endd
26724 into
26725 .code
26726 From: Ford Prefect <prefectf@hitch.fict.example>
26727 .endd
26728 .cindex "RFC 2047"
26729 Sometimes there is a need to replace the whole address item, and this can be
26730 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26731 causes an address in a header line to be rewritten, the entire address is
26732 replaced, not just the working part. The replacement must be a complete RFC
26733 2822 address, including the angle brackets if necessary. If text outside angle
26734 brackets contains a character whose value is greater than 126 or less than 32
26735 (except for tab), the text is encoded according to RFC 2047. The character set
26736 is taken from &%headers_charset%&, which gets its default at build time.
26737
26738 When the &"w"& flag is set on a rule that causes an envelope address to be
26739 rewritten, all but the working part of the replacement address is discarded.
26740 .endlist
26741
26742
26743 .section "Rewriting examples" "SECID156"
26744 Here is an example of the two common rewriting paradigms:
26745 .code
26746 *@*.hitch.fict.example  $1@hitch.fict.example
26747 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26748                      {$value}fail}@hitch.fict.example bctfrF
26749 .endd
26750 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26751 the string expansion to fail if the lookup does not succeed. In this context it
26752 has the effect of leaving the original address unchanged, but Exim goes on to
26753 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26754 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26755 explicitly, which would cause the rewritten address to be the same as before,
26756 at the cost of a small bit of processing. Not supplying either of these is an
26757 error, since the rewritten address would then contain no local part.
26758
26759 The first example above replaces the domain with a superior, more general
26760 domain. This may not be desirable for certain local parts. If the rule
26761 .code
26762 root@*.hitch.fict.example  *
26763 .endd
26764 were inserted before the first rule, rewriting would be suppressed for the
26765 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26766
26767 Rewriting can be made conditional on a number of tests, by making use of
26768 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26769 messages that originate outside the local host:
26770 .code
26771 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26772                          {$1@hitch.fict.example}fail}"
26773 .endd
26774 The replacement string is quoted in this example because it contains white
26775 space.
26776
26777 .cindex "rewriting" "bang paths"
26778 .cindex "bang paths" "rewriting"
26779 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26780 an address it treats it as an unqualified local part which it qualifies with
26781 the local qualification domain (if the source of the message is local or if the
26782 remote host is permitted to send unqualified addresses). Rewriting can
26783 sometimes be used to handle simple bang paths with a fixed number of
26784 components. For example, the rule
26785 .code
26786 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26787 .endd
26788 rewrites a two-component bang path &'host.name!user'& as the domain address
26789 &'user@host.name'&. However, there is a security implication in using this as
26790 a global rewriting rule for envelope addresses. It can provide a backdoor
26791 method for using your system as a relay, because the incoming addresses appear
26792 to be local. If the bang path addresses are received via SMTP, it is safer to
26793 use the &"S"& flag to rewrite them as they are received, so that relay checking
26794 can be done on the rewritten addresses.
26795 .ecindex IIDaddrew
26796
26797
26798
26799
26800
26801 . ////////////////////////////////////////////////////////////////////////////
26802 . ////////////////////////////////////////////////////////////////////////////
26803
26804 .chapter "Retry configuration" "CHAPretry"
26805 .scindex IIDretconf1 "retry" "configuration, description of"
26806 .scindex IIDregconf2 "configuration file" "retry section"
26807 The &"retry"& section of the runtime configuration file contains a list of
26808 retry rules that control how often Exim tries to deliver messages that cannot
26809 be delivered at the first attempt. If there are no retry rules (the section is
26810 empty or not present), there are no retries. In this situation, temporary
26811 errors are treated as permanent. The default configuration contains a single,
26812 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26813 line option can be used to test which retry rule will be used for a given
26814 address, domain and error.
26815
26816 The most common cause of retries is temporary failure to deliver to a remote
26817 host because the host is down, or inaccessible because of a network problem.
26818 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26819 address) basis, not on a per-message basis. Thus, if one message has recently
26820 been delayed, delivery of a new message to the same host is not immediately
26821 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26822 log selector is set, the message
26823 .cindex "retry" "time not reached"
26824 &"retry time not reached"& is written to the main log whenever a delivery is
26825 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26826 the handling of errors during remote deliveries.
26827
26828 Retry processing applies to routing as well as to delivering, except as covered
26829 in the next paragraph. The retry rules do not distinguish between these
26830 actions. It is not possible, for example, to specify different behaviour for
26831 failures to route the domain &'snark.fict.example'& and failures to deliver to
26832 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26833 added complication, so did not implement it. However, although they share the
26834 same retry rule, the actual retry times for routing and transporting a given
26835 domain are maintained independently.
26836
26837 When a delivery is not part of a queue run (typically an immediate delivery on
26838 receipt of a message), the routers are always run, and local deliveries are
26839 always attempted, even if retry times are set for them. This makes for better
26840 behaviour if one particular message is causing problems (for example, causing
26841 quota overflow, or provoking an error in a filter file). If such a delivery
26842 suffers a temporary failure, the retry data is updated as normal, and
26843 subsequent delivery attempts from queue runs occur only when the retry time for
26844 the local address is reached.
26845
26846 .section "Changing retry rules" "SECID157"
26847 If you change the retry rules in your configuration, you should consider
26848 whether or not to delete the retry data that is stored in Exim's spool area in
26849 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26850 always safe; that is why they are called &"hints"&.
26851
26852 The hints retry data contains suggested retry times based on the previous
26853 rules. In the case of a long-running problem with a remote host, it might
26854 record the fact that the host has timed out. If your new rules increase the
26855 timeout time for such a host, you should definitely remove the old retry data
26856 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26857 messages that it should now be retaining.
26858
26859
26860
26861 .section "Format of retry rules" "SECID158"
26862 .cindex "retry" "rules"
26863 Each retry rule occupies one line and consists of three or four parts,
26864 separated by white space: a pattern, an error name, an optional list of sender
26865 addresses, and a list of retry parameters. The pattern and sender lists must be
26866 enclosed in double quotes if they contain white space. The rules are searched
26867 in order until one is found where the pattern, error name, and sender list (if
26868 present) match the failing host or address, the error that occurred, and the
26869 message's sender, respectively.
26870
26871
26872 The pattern is any single item that may appear in an address list (see section
26873 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26874 which means that it is expanded before being tested against the address that
26875 has been delayed. A negated address list item is permitted. Address
26876 list processing treats a plain domain name as if it were preceded by &"*@"&,
26877 which makes it possible for many retry rules to start with just a domain. For
26878 example,
26879 .code
26880 lookingglass.fict.example        *  F,24h,30m;
26881 .endd
26882 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26883 whereas
26884 .code
26885 alice@lookingglass.fict.example  *  F,24h,30m;
26886 .endd
26887 applies only to temporary failures involving the local part &%alice%&.
26888 In practice, almost all rules start with a domain name pattern without a local
26889 part.
26890
26891 .cindex "regular expressions" "in retry rules"
26892 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26893 must match a complete address, not just a domain, because that is how regular
26894 expressions work in address lists.
26895 .display
26896 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26897 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26898 .endd
26899
26900
26901 .section "Choosing which retry rule to use for address errors" "SECID159"
26902 When Exim is looking for a retry rule after a routing attempt has failed (for
26903 example, after a DNS timeout), each line in the retry configuration is tested
26904 against the complete address only if &%retry_use_local_part%& is set for the
26905 router. Otherwise, only the domain is used, except when matching against a
26906 regular expression, when the local part of the address is replaced with &"*"&.
26907 A domain on its own can match a domain pattern, or a pattern that starts with
26908 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26909 &%check_local_user%& is true, and false for other routers.
26910
26911 Similarly, when Exim is looking for a retry rule after a local delivery has
26912 failed (for example, after a mailbox full error), each line in the retry
26913 configuration is tested against the complete address only if
26914 &%retry_use_local_part%& is set for the transport (it defaults true for all
26915 local transports).
26916
26917 .cindex "4&'xx'& responses" "retry rules for"
26918 However, when Exim is looking for a retry rule after a remote delivery attempt
26919 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26920 whole address is always used as the key when searching the retry rules. The
26921 rule that is found is used to create a retry time for the combination of the
26922 failing address and the message's sender. It is the combination of sender and
26923 recipient that is delayed in subsequent queue runs until its retry time is
26924 reached. You can delay the recipient without regard to the sender by setting
26925 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26926 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26927 commands.
26928
26929
26930
26931 .section "Choosing which retry rule to use for host and message errors" &&&
26932          "SECID160"
26933 For a temporary error that is not related to an individual address (for
26934 example, a connection timeout), each line in the retry configuration is checked
26935 twice. First, the name of the remote host is used as a domain name (preceded by
26936 &"*@"& when matching a regular expression). If this does not match the line,
26937 the domain from the email address is tried in a similar fashion. For example,
26938 suppose the MX records for &'a.b.c.example'& are
26939 .code
26940 a.b.c.example  MX  5  x.y.z.example
26941                MX  6  p.q.r.example
26942                MX  7  m.n.o.example
26943 .endd
26944 and the retry rules are
26945 .code
26946 p.q.r.example    *      F,24h,30m;
26947 a.b.c.example    *      F,4d,45m;
26948 .endd
26949 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26950 first rule matches neither the host nor the domain, so Exim looks at the second
26951 rule. This does not match the host, but it does match the domain, so it is used
26952 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26953 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26954 first retry rule is used, because it matches the host.
26955
26956 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26957 first rule to determine retry times, but for all the other hosts for the domain
26958 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26959 routing to &'a.b.c.example'& suffers a temporary failure.
26960
26961 &*Note*&: The host name is used when matching the patterns, not its IP address.
26962 However, if a message is routed directly to an IP address without the use of a
26963 host name, for example, if a &(manualroute)& router contains a setting such as:
26964 .code
26965 route_list = *.a.example  192.168.34.23
26966 .endd
26967 then the &"host name"& that is used when searching for a retry rule is the
26968 textual form of the IP address.
26969
26970 .section "Retry rules for specific errors" "SECID161"
26971 .cindex "retry" "specific errors; specifying"
26972 The second field in a retry rule is the name of a particular error, or an
26973 asterisk, which matches any error. The errors that can be tested for are:
26974
26975 .vlist
26976 .vitem &%auth_failed%&
26977 Authentication failed when trying to send to a host in the
26978 &%hosts_require_auth%& list in an &(smtp)& transport.
26979
26980 .vitem &%data_4xx%&
26981 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26982 after the command, or after sending the message's data.
26983
26984 .vitem &%mail_4xx%&
26985 A 4&'xx'& error was received for an outgoing MAIL command.
26986
26987 .vitem &%rcpt_4xx%&
26988 A 4&'xx'& error was received for an outgoing RCPT command.
26989 .endlist
26990
26991 For the three 4&'xx'& errors, either the first or both of the x's can be given
26992 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26993 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26994 and have retries every ten minutes with a one-hour timeout, you could set up a
26995 retry rule of this form:
26996 .code
26997 the.domain.name  rcpt_452   F,1h,10m
26998 .endd
26999 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
27000 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
27001
27002 .vlist
27003 .vitem &%lost_connection%&
27004 A server unexpectedly closed the SMTP connection. There may, of course,
27005 legitimate reasons for this (host died, network died), but if it repeats a lot
27006 for the same host, it indicates something odd.
27007
27008 .vitem &%lookup%&
27009 A DNS lookup for a host failed.
27010 Note that a &%dnslookup%& router will need to have matched
27011 its &%fail_defer_domains%& option for this retry type to be usable.
27012 Also note that a &%manualroute%& router will probably need
27013 its &%host_find_failed%& option set to &%defer%&.
27014
27015 .vitem &%refused_MX%&
27016 A connection to a host obtained from an MX record was refused.
27017
27018 .vitem &%refused_A%&
27019 A connection to a host not obtained from an MX record was refused.
27020
27021 .vitem &%refused%&
27022 A connection was refused.
27023
27024 .vitem &%timeout_connect_MX%&
27025 A connection attempt to a host obtained from an MX record timed out.
27026
27027 .vitem &%timeout_connect_A%&
27028 A connection attempt to a host not obtained from an MX record timed out.
27029
27030 .vitem &%timeout_connect%&
27031 A connection attempt timed out.
27032
27033 .vitem &%timeout_MX%&
27034 There was a timeout while connecting or during an SMTP session with a host
27035 obtained from an MX record.
27036
27037 .vitem &%timeout_A%&
27038 There was a timeout while connecting or during an SMTP session with a host not
27039 obtained from an MX record.
27040
27041 .vitem &%timeout%&
27042 There was a timeout while connecting or during an SMTP session.
27043
27044 .vitem &%tls_required%&
27045 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27046 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27047 to STARTTLS, or there was a problem setting up the TLS connection.
27048
27049 .vitem &%quota%&
27050 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27051 transport.
27052
27053 .vitem &%quota_%&<&'time'&>
27054 .cindex "quota" "error testing in retry rule"
27055 .cindex "retry" "quota error testing"
27056 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27057 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27058 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27059 for four days.
27060 .endlist
27061
27062 .cindex "mailbox" "time of last read"
27063 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27064 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27065 it should be based on the last time that the user accessed the mailbox.
27066 However, it is not always possible to determine this. Exim uses the following
27067 heuristic rules:
27068
27069 .ilist
27070 If the mailbox is a single file, the time of last access (the &"atime"&) is
27071 used. As no new messages are being delivered (because the mailbox is over
27072 quota), Exim does not access the file, so this is the time of last user access.
27073 .next
27074 .cindex "maildir format" "time of last read"
27075 For a maildir delivery, the time of last modification of the &_new_&
27076 subdirectory is used. As the mailbox is over quota, no new files are created in
27077 the &_new_& subdirectory, because no new messages are being delivered. Any
27078 change to the &_new_& subdirectory is therefore assumed to be the result of an
27079 MUA moving a new message to the &_cur_& directory when it is first read. The
27080 time that is used is therefore the last time that the user read a new message.
27081 .next
27082 For other kinds of multi-file mailbox, the time of last access cannot be
27083 obtained, so a retry rule that uses this type of error field is never matched.
27084 .endlist
27085
27086 The quota errors apply both to system-enforced quotas and to Exim's own quota
27087 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27088 when a local delivery is deferred because a partition is full (the ENOSPC
27089 error).
27090
27091
27092
27093 .section "Retry rules for specified senders" "SECID162"
27094 .cindex "retry" "rules; sender-specific"
27095 You can specify retry rules that apply only when the failing message has a
27096 specific sender. In particular, this can be used to define retry rules that
27097 apply only to bounce messages. The third item in a retry rule can be of this
27098 form:
27099 .display
27100 &`senders=`&<&'address list'&>
27101 .endd
27102 The retry timings themselves are then the fourth item. For example:
27103 .code
27104 *   rcpt_4xx   senders=:   F,1h,30m
27105 .endd
27106 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27107 host. If the address list contains white space, it must be enclosed in quotes.
27108 For example:
27109 .code
27110 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27111 .endd
27112 &*Warning*&: This facility can be unhelpful if it is used for host errors
27113 (which do not depend on the recipient). The reason is that the sender is used
27114 only to match the retry rule. Once the rule has been found for a host error,
27115 its contents are used to set a retry time for the host, and this will apply to
27116 all messages, not just those with specific senders.
27117
27118 When testing retry rules using &%-brt%&, you can supply a sender using the
27119 &%-f%& command line option, like this:
27120 .code
27121 exim -f "" -brt user@dom.ain
27122 .endd
27123 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27124 list is never matched.
27125
27126
27127
27128
27129
27130 .section "Retry parameters" "SECID163"
27131 .cindex "retry" "parameters in rules"
27132 The third (or fourth, if a senders list is present) field in a retry rule is a
27133 sequence of retry parameter sets, separated by semicolons. Each set consists of
27134 .display
27135 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27136 .endd
27137 The letter identifies the algorithm for computing a new retry time; the cutoff
27138 time is the time beyond which this algorithm no longer applies, and the
27139 arguments vary the algorithm's action. The cutoff time is measured from the
27140 time that the first failure for the domain (combined with the local part if
27141 relevant) was detected, not from the time the message was received.
27142
27143 .cindex "retry" "algorithms"
27144 .cindex "retry" "fixed intervals"
27145 .cindex "retry" "increasing intervals"
27146 .cindex "retry" "random intervals"
27147 The available algorithms are:
27148
27149 .ilist
27150 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27151 the interval.
27152 .next
27153 &'G'&: retry at geometrically increasing intervals. The first argument
27154 specifies a starting value for the interval, and the second a multiplier, which
27155 is used to increase the size of the interval at each retry.
27156 .next
27157 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27158 retry, the previous interval is multiplied by the factor in order to get a
27159 maximum for the next interval. The minimum interval is the first argument of
27160 the parameter, and an actual interval is chosen randomly between them. Such a
27161 rule has been found to be helpful in cluster configurations when all the
27162 members of the cluster restart at once, and may therefore synchronize their
27163 queue processing times.
27164 .endlist
27165
27166 When computing the next retry time, the algorithm definitions are scanned in
27167 order until one whose cutoff time has not yet passed is reached. This is then
27168 used to compute a new retry time that is later than the current time. In the
27169 case of fixed interval retries, this simply means adding the interval to the
27170 current time. For geometrically increasing intervals, retry intervals are
27171 computed from the rule's parameters until one that is greater than the previous
27172 interval is found. The main configuration variable
27173 .cindex "limit" "retry interval"
27174 .cindex "retry" "interval, maximum"
27175 .oindex "&%retry_interval_max%&"
27176 &%retry_interval_max%& limits the maximum interval between retries. It
27177 cannot be set greater than &`24h`&, which is its default value.
27178
27179 A single remote domain may have a number of hosts associated with it, and each
27180 host may have more than one IP address. Retry algorithms are selected on the
27181 basis of the domain name, but are applied to each IP address independently. If,
27182 for example, a host has two IP addresses and one is unusable, Exim will
27183 generate retry times for it and will not try to use it until its next retry
27184 time comes. Thus the good IP address is likely to be tried first most of the
27185 time.
27186
27187 .cindex "hints database" "use for retrying"
27188 Retry times are hints rather than promises. Exim does not make any attempt to
27189 run deliveries exactly at the computed times. Instead, a queue runner process
27190 starts delivery processes for delayed messages periodically, and these attempt
27191 new deliveries only for those addresses that have passed their next retry time.
27192 If a new message arrives for a deferred address, an immediate delivery attempt
27193 occurs only if the address has passed its retry time. In the absence of new
27194 messages, the minimum time between retries is the interval between queue runner
27195 processes. There is not much point in setting retry times of five minutes if
27196 your queue runners happen only once an hour, unless there are a significant
27197 number of incoming messages (which might be the case on a system that is
27198 sending everything to a smart host, for example).
27199
27200 The data in the retry hints database can be inspected by using the
27201 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27202 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27203 &'exinext'& utility script can be used to find out what the next retry times
27204 are for the hosts associated with a particular mail domain, and also for local
27205 deliveries that have been deferred.
27206
27207
27208 .section "Retry rule examples" "SECID164"
27209 Here are some example retry rules:
27210 .code
27211 alice@wonderland.fict.example quota_5d  F,7d,3h
27212 wonderland.fict.example       quota_5d
27213 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27214 lookingglass.fict.example     *         F,24h,30m;
27215 *                 refused_A   F,2h,20m;
27216 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27217 .endd
27218 The first rule sets up special handling for mail to
27219 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27220 mailbox has not been read for at least 5 days. Retries continue every three
27221 hours for 7 days. The second rule handles over-quota errors for all other local
27222 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27223 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27224 fail are bounced immediately if the mailbox has not been read for at least 5
27225 days.
27226
27227 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27228 happen every 15 minutes for an hour, then with geometrically increasing
27229 intervals until two days have passed since a delivery first failed. After the
27230 first hour there is a delay of one hour, then two hours, then four hours, and
27231 so on (this is a rather extreme example).
27232
27233 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27234 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27235 all other domains, with special action for connection refusal from hosts that
27236 were not obtained from an MX record.
27237
27238 The final rule in a retry configuration should always have asterisks in the
27239 first two fields so as to provide a general catch-all for any addresses that do
27240 not have their own special handling. This example tries every 15 minutes for 2
27241 hours, then with intervals starting at one hour and increasing by a factor of
27242 1.5 up to 16 hours, then every 8 hours up to 5 days.
27243
27244
27245
27246 .section "Timeout of retry data" "SECID165"
27247 .cindex "timeout" "of retry data"
27248 .oindex "&%retry_data_expire%&"
27249 .cindex "hints database" "data expiry"
27250 .cindex "retry" "timeout of data"
27251 Exim timestamps the data that it writes to its retry hints database. When it
27252 consults the data during a delivery it ignores any that is older than the value
27253 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27254 been tried for 7 days, Exim will try to deliver to it immediately a message
27255 arrives, and if that fails, it will calculate a retry time as if it were
27256 failing for the first time.
27257
27258 This improves the behaviour for messages routed to rarely-used hosts such as MX
27259 backups. If such a host was down at one time, and happens to be down again when
27260 Exim tries a month later, using the old retry data would imply that it had been
27261 down all the time, which is not a justified assumption.
27262
27263 If a host really is permanently dead, this behaviour causes a burst of retries
27264 every now and again, but only if messages routed to it are rare. If there is a
27265 message at least once every 7 days the retry data never expires.
27266
27267
27268
27269
27270 .section "Long-term failures" "SECID166"
27271 .cindex "delivery failure, long-term"
27272 .cindex "retry" "after long-term failure"
27273 Special processing happens when an email address has been failing for so long
27274 that the cutoff time for the last algorithm is reached. For example, using the
27275 default retry rule:
27276 .code
27277 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27278 .endd
27279 the cutoff time is four days. Reaching the retry cutoff is independent of how
27280 long any specific message has been failing; it is the length of continuous
27281 failure for the recipient address that counts.
27282
27283 When the cutoff time is reached for a local delivery, or for all the IP
27284 addresses associated with a remote delivery, a subsequent delivery failure
27285 causes Exim to give up on the address, and a bounce message is generated.
27286 In order to cater for new messages that use the failing address, a next retry
27287 time is still computed from the final algorithm, and is used as follows:
27288
27289 For local deliveries, one delivery attempt is always made for any subsequent
27290 messages. If this delivery fails, the address fails immediately. The
27291 post-cutoff retry time is not used.
27292
27293 .cindex "final cutoff" "retries, controlling"
27294 .cindex retry "final cutoff"
27295 If the delivery is remote, there are two possibilities, controlled by the
27296 .oindex "&%delay_after_cutoff%&"
27297 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27298 default. Until the post-cutoff retry time for one of the IP addresses,
27299 as set by the &%retry_data_expire%& option, is
27300 reached, the failing email address is bounced immediately, without a delivery
27301 attempt taking place. After that time, one new delivery attempt is made to
27302 those IP addresses that are past their retry times, and if that still fails,
27303 the address is bounced and new retry times are computed.
27304
27305 In other words, when all the hosts for a given email address have been failing
27306 for a long time, Exim bounces rather then defers until one of the hosts' retry
27307 times is reached. Then it tries once, and bounces if that attempt fails. This
27308 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27309 to a broken destination, but if the host does recover, Exim will eventually
27310 notice.
27311
27312 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27313 addresses are past their final cutoff time, Exim tries to deliver to those IP
27314 addresses that have not been tried since the message arrived. If there are
27315 no suitable IP addresses, or if they all fail, the address is bounced. In other
27316 words, it does not delay when a new message arrives, but tries the expired
27317 addresses immediately, unless they have been tried since the message arrived.
27318 If there is a continuous stream of messages for the failing domains, setting
27319 &%delay_after_cutoff%& false means that there will be many more attempts to
27320 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27321 true.
27322
27323 .section "Deliveries that work intermittently" "SECID167"
27324 .cindex "retry" "intermittently working deliveries"
27325 Some additional logic is needed to cope with cases where a host is
27326 intermittently available, or when a message has some attribute that prevents
27327 its delivery when others to the same address get through. In this situation,
27328 because some messages are successfully delivered, the &"retry clock"& for the
27329 host or address keeps getting reset by the successful deliveries, and so
27330 failing messages remain in the queue for ever because the cutoff time is never
27331 reached.
27332
27333 Two exceptional actions are applied to prevent this happening. The first
27334 applies to errors that are related to a message rather than a remote host.
27335 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27336 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27337 commands, and quota failures. For this type of error, if a message's arrival
27338 time is earlier than the &"first failed"& time for the error, the earlier time
27339 is used when scanning the retry rules to decide when to try next and when to
27340 time out the address.
27341
27342 The exceptional second action applies in all cases. If a message has been on
27343 the queue for longer than the cutoff time of any applicable retry rule for a
27344 given address, a delivery is attempted for that address, even if it is not yet
27345 time, and if this delivery fails, the address is timed out. A new retry time is
27346 not computed in this case, so that other messages for the same address are
27347 considered immediately.
27348 .ecindex IIDretconf1
27349 .ecindex IIDregconf2
27350
27351
27352
27353
27354
27355
27356 . ////////////////////////////////////////////////////////////////////////////
27357 . ////////////////////////////////////////////////////////////////////////////
27358
27359 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27360 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27361 .scindex IIDauthconf2 "authentication"
27362 The &"authenticators"& section of Exim's runtime configuration is concerned
27363 with SMTP authentication. This facility is an extension to the SMTP protocol,
27364 described in RFC 2554, which allows a client SMTP host to authenticate itself
27365 to a server. This is a common way for a server to recognize clients that are
27366 permitted to use it as a relay. SMTP authentication is not of relevance to the
27367 transfer of mail between servers that have no managerial connection with each
27368 other.
27369
27370 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27371 prior to Exim 4.95 names would be silently truncated at this length, but now
27372 it is enforced.
27373
27374 .cindex "AUTH" "description of"
27375 .cindex "ESMTP extensions" AUTH
27376 Very briefly, the way SMTP authentication works is as follows:
27377
27378 .olist
27379 The server advertises a number of authentication &'mechanisms'& in response to
27380 the client's EHLO command.
27381 .next
27382 The client issues an AUTH command, naming a specific mechanism. The command
27383 may, optionally, contain some authentication data.
27384 .next
27385 The server may issue one or more &'challenges'&, to which the client must send
27386 appropriate responses. In simple authentication mechanisms, the challenges are
27387 just prompts for user names and passwords. The server does not have to issue
27388 any challenges &-- in some mechanisms the relevant data may all be transmitted
27389 with the AUTH command.
27390 .next
27391 The server either accepts or denies authentication.
27392 .next
27393 If authentication succeeds, the client may optionally make use of the AUTH
27394 option on the MAIL command to pass an authenticated sender in subsequent
27395 mail transactions. Authentication lasts for the remainder of the SMTP
27396 connection.
27397 .next
27398 If authentication fails, the client may give up, or it may try a different
27399 authentication mechanism, or it may try transferring mail over the
27400 unauthenticated connection.
27401 .endlist
27402
27403 If you are setting up a client, and want to know which authentication
27404 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27405 SMTP port) on the server, and issue an EHLO command. The response to this
27406 includes the list of supported mechanisms. For example:
27407 .display
27408 &`$ `&&*&`telnet server.example 25`&*&
27409 &`Trying 192.168.34.25...`&
27410 &`Connected to server.example.`&
27411 &`Escape character is &#x0027;^]&#x0027;.`&
27412 &`220 server.example ESMTP Exim 4.20 ...`&
27413 &*&`ehlo client.example`&*&
27414 &`250-server.example Hello client.example [10.8.4.5]`&
27415 &`250-SIZE 52428800`&
27416 &`250-PIPELINING`&
27417 &`250-AUTH PLAIN`&
27418 &`250 HELP`&
27419 .endd
27420 The second-last line of this example output shows that the server supports
27421 authentication using the PLAIN mechanism. In Exim, the different authentication
27422 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27423 routers and transports, which authenticators are included in the binary is
27424 controlled by build-time definitions. The following are currently available,
27425 included by setting
27426 .code
27427 AUTH_CRAM_MD5=yes
27428 AUTH_CYRUS_SASL=yes
27429 AUTH_DOVECOT=yes
27430 AUTH_EXTERNAL=yes
27431 AUTH_GSASL=yes
27432 AUTH_HEIMDAL_GSSAPI=yes
27433 AUTH_PLAINTEXT=yes
27434 AUTH_SPA=yes
27435 AUTH_TLS=yes
27436 .endd
27437 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27438 authentication mechanism (RFC 2195), and the second provides an interface to
27439 the Cyrus SASL authentication library.
27440 The third is an interface to Dovecot's authentication system, delegating the
27441 work via a socket interface.
27442 The fourth provides for negotiation of authentication done via non-SMTP means,
27443 as defined by RFC 4422 Appendix A.
27444 The fifth provides an interface to the GNU SASL authentication library, which
27445 provides mechanisms but typically not data sources.
27446 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27447 supporting setting a server keytab.
27448 The seventh can be configured to support
27449 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27450 not formally documented, but used by several MUAs.
27451 The eighth authenticator
27452 supports Microsoft's &'Secure Password Authentication'& mechanism.
27453 The last is an Exim authenticator but not an SMTP one;
27454 instead it can use information from a TLS negotiation.
27455
27456 The authenticators are configured using the same syntax as other drivers (see
27457 section &<<SECTfordricon>>&). If no authenticators are required, no
27458 authentication section need be present in the configuration file. Each
27459 authenticator can in principle have both server and client functions. When Exim
27460 is receiving SMTP mail, it is acting as a server; when it is sending out
27461 messages over SMTP, it is acting as a client. Authenticator configuration
27462 options are provided for use in both these circumstances.
27463
27464 To make it clear which options apply to which situation, the prefixes
27465 &%server_%& and &%client_%& are used on option names that are specific to
27466 either the server or the client function, respectively. Server and client
27467 functions are disabled if none of their options are set. If an authenticator is
27468 to be used for both server and client functions, a single definition, using
27469 both sets of options, is required. For example:
27470 .code
27471 cram:
27472   driver = cram_md5
27473   public_name = CRAM-MD5
27474   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27475   client_name = ph10
27476   client_secret = secret2
27477 .endd
27478 The &%server_%& option is used when Exim is acting as a server, and the
27479 &%client_%& options when it is acting as a client.
27480
27481 Descriptions of the individual authenticators are given in subsequent chapters.
27482 The remainder of this chapter covers the generic options for the
27483 authenticators, followed by general discussion of the way authentication works
27484 in Exim.
27485
27486 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27487 per-mechanism basis.  Please read carefully to determine which variables hold
27488 account labels such as usercodes and which hold passwords or other
27489 authenticating data.
27490
27491 Note that some mechanisms support two different identifiers for accounts: the
27492 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27493 and &'authz'& are commonly encountered.  The American spelling is standard here.
27494 Conceptually, authentication data such as passwords are tied to the identifier
27495 used to authenticate; servers may have rules to permit one user to act as a
27496 second user, so that after login the session is treated as though that second
27497 user had logged in.  That second user is the &'authorization id'&.  A robust
27498 configuration might confirm that the &'authz'& field is empty or matches the
27499 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27500 as verified data, the &'authz'& as an unverified request which the server might
27501 choose to honour.
27502
27503 A &'realm'& is a text string, typically a domain name, presented by a server
27504 to a client to help it select an account and credentials to use.  In some
27505 mechanisms, the client and server provably agree on the realm, but clients
27506 typically can not treat the realm as secure data to be blindly trusted.
27507
27508
27509
27510 .section "Generic options for authenticators" "SECID168"
27511 .cindex "authentication" "generic options"
27512 .cindex "options" "generic; for authenticators"
27513
27514 .option client_condition authenticators string&!! unset
27515 When Exim is authenticating as a client, it skips any authenticator whose
27516 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27517 used, for example, to skip plain text authenticators when the connection is not
27518 encrypted by a setting such as:
27519 .code
27520 client_condition = ${if !eq{$tls_out_cipher}{}}
27521 .endd
27522
27523
27524 .option client_set_id authenticators string&!! unset
27525 When client authentication succeeds, this condition is expanded; the
27526 result is used in the log lines for outbound messages.
27527 Typically it will be the user name used for authentication.
27528
27529
27530 .option driver authenticators string unset
27531 This option must always be set. It specifies which of the available
27532 authenticators is to be used.
27533
27534
27535 .option public_name authenticators string unset
27536 This option specifies the name of the authentication mechanism that the driver
27537 implements, and by which it is known to the outside world. These names should
27538 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27539 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27540 defaults to the driver's instance name.
27541
27542
27543 .option server_advertise_condition authenticators string&!! unset
27544 When a server is about to advertise an authentication mechanism, the condition
27545 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27546 mechanism is not advertised.
27547 If the expansion fails, the mechanism is not advertised. If the failure was not
27548 forced, and was not caused by a lookup defer, the incident is logged.
27549 See section &<<SECTauthexiser>>& below for further discussion.
27550
27551
27552 .option server_condition authenticators string&!! unset
27553 This option must be set for a &%plaintext%& server authenticator, where it
27554 is used directly to control authentication. See section &<<SECTplainserver>>&
27555 for details.
27556
27557 For the &(gsasl)& authenticator, this option is required for various
27558 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27559
27560 For the other authenticators, &%server_condition%& can be used as an additional
27561 authentication or authorization mechanism that is applied after the other
27562 authenticator conditions succeed. If it is set, it is expanded when the
27563 authenticator would otherwise return a success code. If the expansion is forced
27564 to fail, authentication fails. Any other expansion failure causes a temporary
27565 error code to be returned. If the result of a successful expansion is an empty
27566 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27567 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27568 other result, a temporary error code is returned, with the expanded string as
27569 the error text.
27570
27571
27572 .option server_debug_print authenticators string&!! unset
27573 If this option is set and authentication debugging is enabled (see the &%-d%&
27574 command line option), the string is expanded and included in the debugging
27575 output when the authenticator is run as a server. This can help with checking
27576 out the values of variables.
27577 If expansion of the string fails, the error message is written to the debugging
27578 output, and Exim carries on processing.
27579
27580
27581 .option server_set_id authenticators string&!! unset
27582 .vindex "&$authenticated_id$&"
27583 .vindex "&$authenticated_fail_id$&"
27584 When an Exim server successfully authenticates a client, this string is
27585 expanded using data from the authentication, and preserved for any incoming
27586 messages in the variable &$authenticated_id$&. It is also included in the log
27587 lines for incoming messages. For example, a user/password authenticator
27588 configuration might preserve the user name that was used to authenticate, and
27589 refer to it subsequently during delivery of the message.
27590 On a failing authentication the expansion result is instead saved in
27591 the &$authenticated_fail_id$& variable.
27592 If expansion fails, the option is ignored.
27593
27594
27595 .option server_mail_auth_condition authenticators string&!! unset
27596 This option allows a server to discard authenticated sender addresses supplied
27597 as part of MAIL commands in SMTP connections that are authenticated by the
27598 driver on which &%server_mail_auth_condition%& is set. The option is not used
27599 as part of the authentication process; instead its (unexpanded) value is
27600 remembered for later use.
27601 How it is used is described in the following section.
27602
27603
27604
27605
27606
27607 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27608 .cindex "authentication" "sender; authenticated"
27609 .cindex "AUTH" "on MAIL command"
27610 When a client supplied an AUTH= item on a MAIL command, Exim applies
27611 the following checks before accepting it as the authenticated sender of the
27612 message:
27613
27614 .ilist
27615 If the connection is not using extended SMTP (that is, HELO was used rather
27616 than EHLO), the use of AUTH= is a syntax error.
27617 .next
27618 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27619 .next
27620 .vindex "&$authenticated_sender$&"
27621 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27622 running, the value of &$authenticated_sender$& is set to the value obtained
27623 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27624 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27625 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27626 given for the MAIL command.
27627 .next
27628 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27629 is accepted and placed in &$authenticated_sender$& only if the client has
27630 authenticated.
27631 .next
27632 If the AUTH= value was accepted by either of the two previous rules, and
27633 the client has authenticated, and the authenticator has a setting for the
27634 &%server_mail_auth_condition%&, the condition is checked at this point. The
27635 valued that was saved from the authenticator is expanded. If the expansion
27636 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27637 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27638 the value of &$authenticated_sender$& is retained and passed on with the
27639 message.
27640 .endlist
27641
27642
27643 When &$authenticated_sender$& is set for a message, it is passed on to other
27644 hosts to which Exim authenticates as a client. Do not confuse this value with
27645 &$authenticated_id$&, which is a string obtained from the authentication
27646 process, and which is not usually a complete email address.
27647
27648 .vindex "&$sender_address$&"
27649 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27650 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27651 therefore make use of &$authenticated_sender$&. The converse is not true: the
27652 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27653 ACL is run.
27654
27655
27656
27657 .section "Authentication on an Exim server" "SECTauthexiser"
27658 .cindex "authentication" "on an Exim server"
27659 When Exim receives an EHLO command, it advertises the public names of those
27660 authenticators that are configured as servers, subject to the following
27661 conditions:
27662
27663 .ilist
27664 The client host must match &%auth_advertise_hosts%& (default *).
27665 .next
27666 If the &%server_advertise_condition%& option is set, its expansion must not
27667 yield the empty string, &"0"&, &"no"&, or &"false"&.
27668 .endlist
27669
27670 The order in which the authenticators are defined controls the order in which
27671 the mechanisms are advertised.
27672
27673 Some mail clients (for example, some versions of Netscape) require the user to
27674 provide a name and password for authentication whenever AUTH is advertised,
27675 even though authentication may not in fact be needed (for example, Exim may be
27676 set up to allow unconditional relaying from the client by an IP address check).
27677 You can make such clients more friendly by not advertising AUTH to them.
27678 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27679 that runs for RCPT) to relay without authentication, you should set
27680 .code
27681 auth_advertise_hosts = ! 10.9.8.0/24
27682 .endd
27683 so that no authentication mechanisms are advertised to them.
27684
27685 The &%server_advertise_condition%& controls the advertisement of individual
27686 authentication mechanisms. For example, it can be used to restrict the
27687 advertisement of a particular mechanism to encrypted connections, by a setting
27688 such as:
27689 .code
27690 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27691 .endd
27692 .vindex "&$tls_in_cipher$&"
27693 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27694 yields &"yes"&, which allows the advertisement to happen.
27695
27696 When an Exim server receives an AUTH command from a client, it rejects it
27697 immediately if AUTH was not advertised in response to an earlier EHLO
27698 command. This is the case if
27699
27700 .ilist
27701 The client host does not match &%auth_advertise_hosts%&; or
27702 .next
27703 No authenticators are configured with server options; or
27704 .next
27705 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27706 server authenticators.
27707 .endlist
27708
27709
27710 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27711 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27712 AUTH is accepted from any client host.
27713
27714 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27715 server authentication mechanism that was advertised in response to EHLO and
27716 that matches the one named in the AUTH command. If it finds one, it runs
27717 the appropriate authentication protocol, and authentication either succeeds or
27718 fails. If there is no matching advertised mechanism, the AUTH command is
27719 rejected with a 504 error.
27720
27721 .vindex "&$received_protocol$&"
27722 .vindex "&$sender_host_authenticated$&"
27723 When a message is received from an authenticated host, the value of
27724 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27725 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27726 public name) of the authenticator driver that successfully authenticated the
27727 client from which the message was received. This variable is empty if there was
27728 no successful authentication.
27729
27730 .cindex authentication "expansion item"
27731 Successful authentication sets up information used by the
27732 &%authresults%& expansion item.
27733
27734 .new
27735 .cindex authentication "failure event, server"
27736 If an authenticator is run and does not succeed,
27737 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27738 While the event is being processed the variables
27739 &$sender_host_authenticated$& (with the authenticator name)
27740 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27741 will be valid.
27742 If the event is serviced and a string is returned then the string will be logged
27743 instead of the default log line.
27744 See <<CHAPevents>> for details on events.
27745 .wen
27746
27747
27748 .section "Testing server authentication" "SECID169"
27749 .cindex "authentication" "testing a server"
27750 .cindex "AUTH" "testing a server"
27751 .cindex "base64 encoding" "creating authentication test data"
27752 Exim's &%-bh%& option can be useful for testing server authentication
27753 configurations. The data for the AUTH command has to be sent using base64
27754 encoding. A quick way to produce such data for testing is the following Perl
27755 script:
27756 .code
27757 use MIME::Base64;
27758 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27759 .endd
27760 .cindex "binary zero" "in authentication data"
27761 This interprets its argument as a Perl string, and then encodes it. The
27762 interpretation as a Perl string allows binary zeros, which are required for
27763 some kinds of authentication, to be included in the data. For example, a
27764 command line to run this script on such data might be
27765 .code
27766 encode '\0user\0password'
27767 .endd
27768 Note the use of single quotes to prevent the shell interpreting the
27769 backslashes, so that they can be interpreted by Perl to specify characters
27770 whose code value is zero.
27771
27772 &*Warning 1*&: If either of the user or password strings starts with an octal
27773 digit, you must use three zeros instead of one after the leading backslash. If
27774 you do not, the octal digit that starts your string will be incorrectly
27775 interpreted as part of the code for the first character.
27776
27777 &*Warning 2*&: If there are characters in the strings that Perl interprets
27778 specially, you must use a Perl escape to prevent them being misinterpreted. For
27779 example, a command such as
27780 .code
27781 encode '\0user@domain.com\0pas$$word'
27782 .endd
27783 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27784
27785 If you have the &%mimencode%& command installed, another way to produce
27786 base64-encoded strings is to run the command
27787 .code
27788 echo -e -n `\0user\0password' | mimencode
27789 .endd
27790 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27791 in the argument, and the &%-n%& option specifies no newline at the end of its
27792 output. However, not all versions of &%echo%& recognize these options, so you
27793 should check your version before relying on this suggestion.
27794
27795
27796
27797 .section "Authentication by an Exim client" "SECID170"
27798 .cindex "authentication" "on an Exim client"
27799 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27800 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27801 announces support for authentication, and the host matches an entry in either
27802 of these options, Exim (as a client) tries to authenticate as follows:
27803
27804 .ilist
27805 For each authenticator that is configured as a client, in the order in which
27806 they are defined in the configuration, it searches the authentication
27807 mechanisms announced by the server for one whose name matches the public name
27808 of the authenticator.
27809 .next
27810 .vindex "&$host$&"
27811 .vindex "&$host_address$&"
27812 When it finds one that matches, it runs the authenticator's client code. The
27813 variables &$host$& and &$host_address$& are available for any string expansions
27814 that the client might do. They are set to the server's name and IP address. If
27815 any expansion is forced to fail, the authentication attempt is abandoned, and
27816 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27817 delivery to be deferred.
27818 .next
27819 If the result of the authentication attempt is a temporary error or a timeout,
27820 Exim abandons trying to send the message to the host for the moment. It will
27821 try again later. If there are any backup hosts available, they are tried in the
27822 usual way.
27823
27824 .new
27825 .next
27826 .cindex authentication "failure event, client"
27827 If the response to authentication is a permanent error (5&'xx'& code),
27828 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27829 While the event is being processed the variable
27830 &$sender_host_authenticated$& (with the authenticator name)
27831 will be valid.
27832 If the event is serviced and a string is returned then the string will be logged.
27833 See <<CHAPevents>> for details on events.
27834 .wen
27835
27836 .next
27837 If the response to authentication is a permanent error (5&'xx'& code), Exim
27838 carries on searching the list of authenticators and tries another one if
27839 possible. If all authentication attempts give permanent errors, or if there are
27840 no attempts because no mechanisms match (or option expansions force failure),
27841 what happens depends on whether the host matches &%hosts_require_auth%& or
27842 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27843 delivery is deferred. The error can be detected in the retry rules, and thereby
27844 turned into a permanent error if you wish. In the second case, Exim tries to
27845 deliver the message unauthenticated.
27846 .endlist
27847
27848 Note that the hostlist test for whether to do authentication can be
27849 confused if name-IP lookups change between the time the peer is decided
27850 upon and the time that the transport runs.  For example, with a manualroute
27851 router given a host name, and with DNS "round-robin" used by that name: if
27852 the local resolver cache times out between the router and the transport
27853 running, the transport may get an IP for the name for its authentication
27854 check which does not match the connection peer IP.
27855 No authentication will then be done, despite the names being identical.
27856
27857 For such cases use a separate transport which always authenticates.
27858
27859 .cindex "AUTH" "on MAIL command"
27860 When Exim has authenticated itself to a remote server, it adds the AUTH
27861 parameter to the MAIL commands it sends, if it has an authenticated sender for
27862 the message. If the message came from a remote host, the authenticated sender
27863 is the one that was receiving on an incoming MAIL command, provided that the
27864 incoming connection was authenticated and the &%server_mail_auth%& condition
27865 allowed the authenticated sender to be retained. If a local process calls Exim
27866 to send a message, the sender address that is built from the login name and
27867 &%qualify_domain%& is treated as authenticated. However, if the
27868 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27869 the authenticated sender that was received with the message.
27870 .ecindex IIDauthconf1
27871 .ecindex IIDauthconf2
27872
27873
27874
27875
27876
27877
27878 . ////////////////////////////////////////////////////////////////////////////
27879 . ////////////////////////////////////////////////////////////////////////////
27880
27881 .chapter "The plaintext authenticator" "CHAPplaintext"
27882 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27883 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27884 The &(plaintext)& authenticator can be configured to support the PLAIN and
27885 LOGIN authentication mechanisms, both of which transfer authentication data as
27886 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27887 security risk; you are strongly advised to insist on the use of SMTP encryption
27888 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27889 use unencrypted plain text, you should not use the same passwords for SMTP
27890 connections as you do for login accounts.
27891
27892 .section "Avoiding cleartext use" "SECTplain_TLS"
27893 The following generic option settings will disable &(plaintext)& authenticators when
27894 TLS is not being used:
27895 .code
27896   server_advertise_condition = ${if def:tls_in_cipher }
27897   client_condition =           ${if def:tls_out_cipher}
27898 .endd
27899
27900 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27901 but is still vulnerable to a Man In The Middle attack unless certificates
27902 (including their names) have been properly verified.
27903
27904 .section "Plaintext server options" "SECID171"
27905 .cindex "options" "&(plaintext)& authenticator (server)"
27906 When configured as a server, &(plaintext)& uses the following options:
27907
27908 .option server_condition authenticators string&!! unset
27909 This is actually a global authentication option, but it must be set in order to
27910 configure the &(plaintext)& driver as a server. Its use is described below.
27911
27912 .option server_prompts plaintext "string list&!!" unset
27913 The contents of this option, after expansion, must be a colon-separated list of
27914 prompt strings. If expansion fails, a temporary authentication rejection is
27915 given.
27916
27917 .section "Using plaintext in a server" "SECTplainserver"
27918 .cindex "AUTH" "in &(plaintext)& authenticator"
27919 .cindex "binary zero" "in &(plaintext)& authenticator"
27920 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27921         "in &(plaintext)& authenticator"
27922 .vindex "&$auth1$&, &$auth2$&, etc"
27923 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27924
27925 When running as a server, &(plaintext)& performs the authentication test by
27926 expanding a string. The data sent by the client with the AUTH command, or in
27927 response to subsequent prompts, is base64 encoded, and so may contain any byte
27928 values when decoded. If any data is supplied with the command, it is treated as
27929 a list of strings, separated by NULs (binary zeros), the first three of which
27930 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27931 (neither LOGIN nor PLAIN uses more than three strings).
27932
27933 For compatibility with previous releases of Exim, the values are also placed in
27934 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27935 variables for this purpose is now deprecated, as it can lead to confusion in
27936 string expansions that also use them for other things.
27937
27938 If there are more strings in &%server_prompts%& than the number of strings
27939 supplied with the AUTH command, the remaining prompts are used to obtain more
27940 data. Each response from the client may be a list of NUL-separated strings.
27941
27942 .vindex "&$authenticated_id$&"
27943 Once a sufficient number of data strings have been received,
27944 &%server_condition%& is expanded. If the expansion is forced to fail,
27945 authentication fails. Any other expansion failure causes a temporary error code
27946 to be returned. If the result of a successful expansion is an empty string,
27947 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27948 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27949 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27950 For any other result, a temporary error code is returned, with the expanded
27951 string as the error text.
27952
27953 &*Warning*&: If you use a lookup in the expansion to find the user's
27954 password, be sure to make the authentication fail if the user is unknown.
27955 There are good and bad examples at the end of the next section.
27956
27957
27958
27959 .section "The PLAIN authentication mechanism" "SECID172"
27960 .cindex "PLAIN authentication mechanism"
27961 .cindex authentication PLAIN
27962 .cindex "binary zero" "in &(plaintext)& authenticator"
27963 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27964 sent as one item of data (that is, one combined string containing two NUL
27965 separators). The data is sent either as part of the AUTH command, or
27966 subsequently in response to an empty prompt from the server.
27967
27968 The second and third strings are a user name and a corresponding password.
27969 Using a single fixed user name and password as an example, this could be
27970 configured as follows:
27971 .code
27972 fixed_plain:
27973   driver = plaintext
27974   public_name = PLAIN
27975   server_prompts = :
27976   server_condition = \
27977     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27978   server_set_id = $auth2
27979 .endd
27980 Note that the default result strings from &%if%& (&"true"& or an empty string)
27981 are exactly what we want here, so they need not be specified. Obviously, if the
27982 password contains expansion-significant characters such as dollar, backslash,
27983 or closing brace, they have to be escaped.
27984
27985 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27986 the end of a string list are ignored). If all the data comes as part of the
27987 AUTH command, as is commonly the case, the prompt is not used. This
27988 authenticator is advertised in the response to EHLO as
27989 .code
27990 250-AUTH PLAIN
27991 .endd
27992 and a client host can authenticate itself by sending the command
27993 .code
27994 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27995 .endd
27996 As this contains three strings (more than the number of prompts), no further
27997 data is required from the client. Alternatively, the client may just send
27998 .code
27999 AUTH PLAIN
28000 .endd
28001 to initiate authentication, in which case the server replies with an empty
28002 prompt. The client must respond with the combined data string.
28003
28004 The data string is base64 encoded, as required by the RFC. This example,
28005 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
28006 represents a zero byte. This is split up into three strings, the first of which
28007 is empty. The &%server_condition%& option in the authenticator checks that the
28008 second two are &`username`& and &`mysecret`& respectively.
28009
28010 Having just one fixed user name and password, as in this example, is not very
28011 realistic, though for a small organization with only a handful of
28012 authenticating clients it could make sense.
28013
28014 A more sophisticated instance of this authenticator could use the user name in
28015 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28016 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28017 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28018 This is an incorrect example:
28019 .code
28020 server_condition = \
28021   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28022 .endd
28023 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28024 which it then compares to the supplied password (&$auth3$&). Why is this example
28025 incorrect? It works fine for existing users, but consider what happens if a
28026 non-existent user name is given. The lookup fails, but as no success/failure
28027 strings are given for the lookup, it yields an empty string. Thus, to defeat
28028 the authentication, all a client has to do is to supply a non-existent user
28029 name and an empty password. The correct way of writing this test is:
28030 .code
28031 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28032   {${if eq{$value}{$auth3}}} {false}}
28033 .endd
28034 In this case, if the lookup succeeds, the result is checked; if the lookup
28035 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28036 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28037 always fails if its second argument is empty. However, the second way of
28038 writing the test makes the logic clearer.
28039
28040
28041 .section "The LOGIN authentication mechanism" "SECID173"
28042 .cindex "LOGIN authentication mechanism"
28043 .cindex authentication LOGIN
28044 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28045 in a number of programs. No data is sent with the AUTH command. Instead, a
28046 user name and password are supplied separately, in response to prompts. The
28047 plaintext authenticator can be configured to support this as in this example:
28048 .code
28049 fixed_login:
28050   driver = plaintext
28051   public_name = LOGIN
28052   server_prompts = User Name : Password
28053   server_condition = \
28054     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28055   server_set_id = $auth1
28056 .endd
28057 Because of the way plaintext operates, this authenticator accepts data supplied
28058 with the AUTH command (in contravention of the specification of LOGIN), but
28059 if the client does not supply it (as is the case for LOGIN clients), the prompt
28060 strings are used to obtain two data items.
28061
28062 Some clients are very particular about the precise text of the prompts. For
28063 example, Outlook Express is reported to recognize only &"Username:"& and
28064 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28065 strings. It uses the &%ldapauth%& expansion condition to check the user
28066 name and password by binding to an LDAP server:
28067 .code
28068 login:
28069   driver = plaintext
28070   public_name = LOGIN
28071   server_prompts = Username:: : Password::
28072   server_condition = ${if and{{ \
28073     !eq{}{$auth1} }{ \
28074     ldapauth{\
28075       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28076       pass=${quote:$auth2} \
28077       ldap://ldap.example.org/} }} }
28078   server_set_id = uid=$auth1,ou=people,o=example.org
28079 .endd
28080 We have to check that the username is not empty before using it, because LDAP
28081 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28082 operator to correctly quote the DN for authentication. However, the basic
28083 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28084 correct one to use for the password, because quoting is needed only to make
28085 the password conform to the Exim syntax. At the LDAP level, the password is an
28086 uninterpreted string.
28087
28088
28089 .section "Support for different kinds of authentication" "SECID174"
28090 A number of string expansion features are provided for the purpose of
28091 interfacing to different ways of user authentication. These include checking
28092 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28093 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28094 &<<SECTexpcond>>&.
28095
28096
28097
28098
28099 .section "Using plaintext in a client" "SECID175"
28100 .cindex "options" "&(plaintext)& authenticator (client)"
28101 The &(plaintext)& authenticator has two client options:
28102
28103 .option client_ignore_invalid_base64 plaintext boolean false
28104 If the client receives a server prompt that is not a valid base64 string,
28105 authentication is abandoned by default. However, if this option is set true,
28106 the error in the challenge is ignored and the client sends the response as
28107 usual.
28108
28109 .option client_send plaintext string&!! unset
28110 The string is a colon-separated list of authentication data strings. Each
28111 string is independently expanded before being sent to the server. The first
28112 string is sent with the AUTH command; any more strings are sent in response
28113 to prompts from the server. Before each string is expanded, the value of the
28114 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28115 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28116 way. Thus, the prompt that is received in response to sending the first string
28117 (with the AUTH command) can be used in the expansion of the second string, and
28118 so on. If an invalid base64 string is received when
28119 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28120 &$auth$&<&'n'&> variable.
28121
28122 &*Note*&: You cannot use expansion to create multiple strings, because
28123 splitting takes priority and happens first.
28124
28125 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28126 the data, further processing is applied to each string before it is sent. If
28127 there are any single circumflex characters in the string, they are converted to
28128 NULs. Should an actual circumflex be required as data, it must be doubled in
28129 the string.
28130
28131 This is an example of a client configuration that implements the PLAIN
28132 authentication mechanism with a fixed user name and password:
28133 .code
28134 fixed_plain:
28135   driver = plaintext
28136   public_name = PLAIN
28137   client_send = ^username^mysecret
28138 .endd
28139 The lack of colons means that the entire text is sent with the AUTH
28140 command, with the circumflex characters converted to NULs.
28141 Note that due to the ambiguity of parsing three consectutive circumflex characters
28142 there is no way to provide a password having a leading circumflex.
28143
28144
28145 A similar example
28146 that uses the LOGIN mechanism is:
28147 .code
28148 fixed_login:
28149   driver = plaintext
28150   public_name = LOGIN
28151   client_send = : username : mysecret
28152 .endd
28153 The initial colon means that the first string is empty, so no data is sent with
28154 the AUTH command itself. The remaining strings are sent in response to
28155 prompts.
28156 .ecindex IIDplaiauth1
28157 .ecindex IIDplaiauth2
28158
28159
28160
28161
28162 . ////////////////////////////////////////////////////////////////////////////
28163 . ////////////////////////////////////////////////////////////////////////////
28164
28165 .chapter "The cram_md5 authenticator" "CHID9"
28166 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28167 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28168 .cindex "CRAM-MD5 authentication mechanism"
28169 .cindex authentication CRAM-MD5
28170 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28171 sends a challenge string to the client, and the response consists of a user
28172 name and the CRAM-MD5 digest of the challenge string combined with a secret
28173 string (password) which is known to both server and client. Thus, the secret
28174 is not sent over the network as plain text, which makes this authenticator more
28175 secure than &(plaintext)&. However, the downside is that the secret has to be
28176 available in plain text at either end.
28177
28178
28179 .section "Using cram_md5 as a server" "SECID176"
28180 .cindex "options" "&(cram_md5)& authenticator (server)"
28181 This authenticator has one server option, which must be set to configure the
28182 authenticator as a server:
28183
28184 .option server_secret cram_md5 string&!! unset
28185 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28186 When the server receives the client's response, the user name is placed in
28187 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28188 obtain the password for that user. The server then computes the CRAM-MD5 digest
28189 that the client should have sent, and checks that it received the correct
28190 string. If the expansion of &%server_secret%& is forced to fail, authentication
28191 fails. If the expansion fails for some other reason, a temporary error code is
28192 returned to the client.
28193
28194 For compatibility with previous releases of Exim, the user name is also placed
28195 in &$1$&. However, the use of this variables for this purpose is now
28196 deprecated, as it can lead to confusion in string expansions that also use
28197 numeric variables for other things.
28198
28199 For example, the following authenticator checks that the user name given by the
28200 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28201 user name, authentication fails.
28202 .code
28203 fixed_cram:
28204   driver = cram_md5
28205   public_name = CRAM-MD5
28206   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28207   server_set_id = $auth1
28208 .endd
28209 .vindex "&$authenticated_id$&"
28210 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28211 name in &$authenticated_id$&. A more typical configuration might look up the
28212 secret string in a file, using the user name as the key. For example:
28213 .code
28214 lookup_cram:
28215   driver = cram_md5
28216   public_name = CRAM-MD5
28217   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28218                   {$value}fail}
28219   server_set_id = $auth1
28220 .endd
28221 Note that this expansion explicitly forces failure if the lookup fails
28222 because &$auth1$& contains an unknown user name.
28223
28224 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28225 using the relevant libraries, you need to know the realm to specify in the
28226 lookup and then ask for the &"userPassword"& attribute for that user in that
28227 realm, with:
28228 .code
28229 cyrusless_crammd5:
28230   driver = cram_md5
28231   public_name = CRAM-MD5
28232   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28233                   dbmjz{/etc/sasldb2}{$value}fail}
28234   server_set_id = $auth1
28235 .endd
28236
28237 .section "Using cram_md5 as a client" "SECID177"
28238 .cindex "options" "&(cram_md5)& authenticator (client)"
28239 When used as a client, the &(cram_md5)& authenticator has two options:
28240
28241
28242
28243 .option client_name cram_md5 string&!! "the primary host name"
28244 This string is expanded, and the result used as the user name data when
28245 computing the response to the server's challenge.
28246
28247
28248 .option client_secret cram_md5 string&!! unset
28249 This option must be set for the authenticator to work as a client. Its value is
28250 expanded and the result used as the secret string when computing the response.
28251
28252
28253 .vindex "&$host$&"
28254 .vindex "&$host_address$&"
28255 Different user names and secrets can be used for different servers by referring
28256 to &$host$& or &$host_address$& in the options. Forced failure of either
28257 expansion string is treated as an indication that this authenticator is not
28258 prepared to handle this case. Exim moves on to the next configured client
28259 authenticator. Any other expansion failure causes Exim to give up trying to
28260 send the message to the current server.
28261
28262 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28263 strings, is:
28264 .code
28265 fixed_cram:
28266   driver = cram_md5
28267   public_name = CRAM-MD5
28268   client_name = ph10
28269   client_secret = secret
28270 .endd
28271 .ecindex IIDcramauth1
28272 .ecindex IIDcramauth2
28273
28274
28275
28276 . ////////////////////////////////////////////////////////////////////////////
28277 . ////////////////////////////////////////////////////////////////////////////
28278
28279 .chapter "The cyrus_sasl authenticator" "CHID10"
28280 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28281 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28282 .cindex "Cyrus" "SASL library"
28283 .cindex "Kerberos"
28284 The code for this authenticator was provided by Matthew Byng-Maddick while
28285 at A L Digital Ltd.
28286
28287 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28288 library implementation of the RFC 2222 (&"Simple Authentication and Security
28289 Layer"&). This library supports a number of authentication mechanisms,
28290 including PLAIN and LOGIN, but also several others that Exim does not support
28291 directly. In particular, there is support for Kerberos authentication.
28292
28293 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28294 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28295 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28296 name of the driver to determine which mechanism to support.
28297
28298 Where access to some kind of secret file is required, for example, in GSSAPI
28299 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28300 user, and that the Cyrus SASL library has no way of escalating privileges
28301 by default. You may also find you need to set environment variables,
28302 depending on the driver you are using.
28303
28304 The application name provided by Exim is &"exim"&, so various SASL options may
28305 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28306 Kerberos, note that because of limitations in the GSSAPI interface,
28307 changing the server keytab might need to be communicated down to the Kerberos
28308 layer independently. The mechanism for doing so is dependent upon the Kerberos
28309 implementation.
28310
28311 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28312 may be set to point to an alternative keytab file. Exim will pass this
28313 variable through from its own inherited environment when started as root or the
28314 Exim user. The keytab file needs to be readable by the Exim user.
28315 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28316 environment variable.  In practice, for those releases, the Cyrus authenticator
28317 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28318 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28319
28320
28321 .section "Using cyrus_sasl as a server" "SECID178"
28322 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28323 (on a successful authentication) into &$auth1$&. For compatibility with
28324 previous releases of Exim, the username is also placed in &$1$&. However, the
28325 use of this variable for this purpose is now deprecated, as it can lead to
28326 confusion in string expansions that also use numeric variables for other
28327 things.
28328
28329
28330 .option server_hostname cyrus_sasl string&!! "see below"
28331 This option selects the hostname that is used when communicating with the
28332 library. The default value is &`$primary_hostname`&. It is up to the underlying
28333 SASL plug-in what it does with this data.
28334
28335
28336 .option server_mech cyrus_sasl string "see below"
28337 This option selects the authentication mechanism this driver should use. The
28338 default is the value of the generic &%public_name%& option. This option allows
28339 you to use a different underlying mechanism from the advertised name. For
28340 example:
28341 .code
28342 sasl:
28343   driver = cyrus_sasl
28344   public_name = X-ANYTHING
28345   server_mech = CRAM-MD5
28346   server_set_id = $auth1
28347 .endd
28348
28349 .option server_realm cyrus_sasl string&!! unset
28350 This specifies the SASL realm that the server claims to be in.
28351
28352
28353 .option server_service cyrus_sasl string &`smtp`&
28354 This is the SASL service that the server claims to implement.
28355
28356
28357 For straightforward cases, you do not need to set any of the authenticator's
28358 private options. All you need to do is to specify an appropriate mechanism as
28359 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28360 PLAIN, you could have two authenticators as follows:
28361 .code
28362 sasl_cram_md5:
28363   driver = cyrus_sasl
28364   public_name = CRAM-MD5
28365   server_set_id = $auth1
28366
28367 sasl_plain:
28368   driver = cyrus_sasl
28369   public_name = PLAIN
28370   server_set_id = $auth2
28371 .endd
28372 Cyrus SASL does implement the LOGIN authentication method, even though it is
28373 not a standard method. It is disabled by default in the source distribution,
28374 but it is present in many binary distributions.
28375 .ecindex IIDcyrauth1
28376 .ecindex IIDcyrauth2
28377
28378
28379
28380
28381 . ////////////////////////////////////////////////////////////////////////////
28382 . ////////////////////////////////////////////////////////////////////////////
28383 .chapter "The dovecot authenticator" "CHAPdovecot"
28384 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28385 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28386 This authenticator is an interface to the authentication facility of the
28387 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28388 Note that Dovecot must be configured to use auth-client not auth-userdb.
28389 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28390 to use the same mechanisms for SMTP authentication. This is a server
28391 authenticator only. There is only one non-generic option:
28392
28393 .option server_socket dovecot string unset
28394
28395 This option must specify the UNIX socket that is the interface to Dovecot
28396 authentication. The &%public_name%& option must specify an authentication
28397 mechanism that Dovecot is configured to support. You can have several
28398 authenticators for different mechanisms. For example:
28399 .code
28400 dovecot_plain:
28401   driver = dovecot
28402   public_name = PLAIN
28403   server_advertise_condition = ${if def:tls_in_cipher}
28404   server_socket = /var/run/dovecot/auth-client
28405   server_set_id = $auth1
28406
28407 dovecot_ntlm:
28408   driver = dovecot
28409   public_name = NTLM
28410   server_socket = /var/run/dovecot/auth-client
28411   server_set_id = $auth1
28412 .endd
28413
28414 .new
28415 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28416 should not be advertised on cleartext SMTP connections.
28417 See the discussion in section &<<SECTplain_TLS>>&.
28418 .wen
28419
28420 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28421 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28422 option is passed in the Dovecot authentication command. If, for a TLS
28423 connection, a client certificate has been verified, the &"valid-client-cert"&
28424 option is passed. When authentication succeeds, the identity of the user
28425 who authenticated is placed in &$auth1$&.
28426
28427 The Dovecot configuration to match the above will look
28428 something like:
28429 .code
28430 conf.d/10-master.conf :-
28431
28432 service auth {
28433 ...
28434 #SASL
28435   unix_listener auth-client {
28436     mode = 0660
28437     user = mail
28438   }
28439 ...
28440 }
28441
28442 conf.d/10-auth.conf :-
28443
28444 auth_mechanisms = plain login ntlm
28445 .endd
28446
28447 .ecindex IIDdcotauth1
28448 .ecindex IIDdcotauth2
28449
28450
28451 . ////////////////////////////////////////////////////////////////////////////
28452 . ////////////////////////////////////////////////////////////////////////////
28453 .chapter "The gsasl authenticator" "CHAPgsasl"
28454 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28455 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28456 .cindex "authentication" "GNU SASL"
28457 .cindex "authentication" "SASL"
28458 .cindex "authentication" "EXTERNAL"
28459 .cindex "authentication" "ANONYMOUS"
28460 .cindex "authentication" "PLAIN"
28461 .cindex "authentication" "LOGIN"
28462 .cindex "authentication" "DIGEST-MD5"
28463 .cindex "authentication" "CRAM-MD5"
28464 .cindex "authentication" "SCRAM family"
28465 The &(gsasl)& authenticator provides integration for the GNU SASL
28466 library and the mechanisms it provides.  This is new as of the 4.80 release
28467 and there are a few areas where the library does not let Exim smoothly
28468 scale to handle future authentication mechanisms, so no guarantee can be
28469 made that any particular new authentication mechanism will be supported
28470 without code changes in Exim.
28471
28472 The library is expected to add support in an upcoming
28473 realease for the SCRAM-SHA-256 method.
28474 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28475 when this happens.
28476
28477 To see the list of mechanisms supported by the library run Exim with "auth" debug
28478 enabled and look for a line containing "GNU SASL supports".
28479 Note however that some may not have been tested from Exim.
28480
28481
28482 .option client_authz gsasl string&!! unset
28483 This option can be used to supply an &'authorization id'&
28484 which is different to the &'authentication_id'& provided
28485 by &%client_username%& option.
28486 If unset or (after expansion) empty it is not used,
28487 which is the common case.
28488
28489 .option client_channelbinding gsasl boolean false
28490 See &%server_channelbinding%& below.
28491
28492 .option client_password gsasl string&!! unset
28493 This option is exapanded before use, and should result in
28494 the password to be used, in clear.
28495
28496 .option client_username gsasl string&!! unset
28497 This option is exapanded before use, and should result in
28498 the account name to be used.
28499
28500
28501 .option client_spassword gsasl string&!! unset
28502 This option is only supported for library versions 1.9.1 and greater.
28503 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28504
28505 If a SCRAM mechanism is being used and this option is set
28506 and correctly sized
28507 it is used in preference to &%client_password%&.
28508 The value after expansion should be
28509 a 40 (for SHA-1) or 64 (for SHA-256) character string
28510 with the PBKDF2-prepared password, hex-encoded.
28511
28512 Note that this value will depend on the salt and iteration-count
28513 supplied by the server.
28514 The option is expanded before use.
28515 During the expansion &$auth1$& is set with the client username,
28516 &$auth2$& with the iteration count, and
28517 &$auth3$& with the salt.
28518
28519 The intent of this option
28520 is to support clients that can cache thes salted password
28521 to save on recalculation costs.
28522 The cache lookup should return an unusable value
28523 (eg. an empty string)
28524 if the salt or iteration count has changed
28525
28526 If the authentication succeeds then the above variables are set,
28527 .vindex "&$auth4$&"
28528 plus the calculated salted password value value in &$auth4$&,
28529 during the expansion of the &%client_set_id%& option.
28530 A side-effect of this expansion can be used to prime the cache.
28531
28532
28533 .option server_channelbinding gsasl boolean false
28534 Some authentication mechanisms are able to use external context at both ends
28535 of the session to bind the authentication to that context, and fail the
28536 authentication process if that context differs.  Specifically, some TLS
28537 ciphersuites can provide identifying information about the cryptographic
28538 context.
28539
28540 This should have meant that certificate identity and verification becomes a
28541 non-issue, as a man-in-the-middle attack will cause the correct client and
28542 server to see different identifiers and authentication will fail.
28543
28544 This is
28545 only usable by mechanisms which support "channel binding"; at time of
28546 writing, that's the SCRAM family.
28547 When using this feature the "-PLUS" variants of the method names need to be used.
28548
28549 This defaults off to ensure smooth upgrade across Exim releases, in case
28550 this option causes some clients to start failing.  Some future release
28551 of Exim might have switched the default to be true.
28552
28553 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28554 . Do not plan to rely upon this feature for security, ever, without consulting
28555 . with a subject matter expert (a cryptographic engineer).
28556
28557 This option was deprecated in previous releases due to doubts over
28558 the "Triple Handshake" vulnerability.
28559 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28560 Session Resumption was used) for safety.
28561
28562
28563 .option server_hostname gsasl string&!! "see below"
28564 This option selects the hostname that is used when communicating with the
28565 library. The default value is &`$primary_hostname`&.
28566 Some mechanisms will use this data.
28567
28568
28569 .option server_mech gsasl string "see below"
28570 This option selects the authentication mechanism this driver should use. The
28571 default is the value of the generic &%public_name%& option. This option allows
28572 you to use a different underlying mechanism from the advertised name. For
28573 example:
28574 .code
28575 sasl:
28576   driver = gsasl
28577   public_name = X-ANYTHING
28578   server_mech = CRAM-MD5
28579   server_set_id = $auth1
28580 .endd
28581
28582
28583 .option server_password gsasl string&!! unset
28584 Various mechanisms need access to the cleartext password on the server, so
28585 that proof-of-possession can be demonstrated on the wire, without sending
28586 the password itself.
28587
28588 The data available for lookup varies per mechanism.
28589 In all cases, &$auth1$& is set to the &'authentication id'&.
28590 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28591 if available, else the empty string.
28592 The &$auth3$& variable will always be the &'realm'& if available,
28593 else the empty string.
28594
28595 A forced failure will cause authentication to defer.
28596
28597 If using this option, it may make sense to set the &%server_condition%&
28598 option to be simply "true".
28599
28600
28601 .option server_realm gsasl string&!! unset
28602 This specifies the SASL realm that the server claims to be in.
28603 Some mechanisms will use this data.
28604
28605
28606 .option server_scram_iter gsasl string&!! 4096
28607 This option provides data for the SCRAM family of mechanisms.
28608 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28609 when this option is expanded.
28610
28611 The result of expansion should be a decimal number,
28612 and represents both a lower-bound on the security, and
28613 a compute cost factor imposed on the client
28614 (if it does not cache results, or the server changes
28615 either the iteration count or the salt).
28616 A minimum value of 4096 is required by the standards
28617 for all current SCRAM mechanism variants.
28618
28619 .option server_scram_salt gsasl string&!! unset
28620 This option provides data for the SCRAM family of mechanisms.
28621 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28622 when this option is expanded.
28623 The value should be a base64-encoded string,
28624 of random data typically 4-to-16 bytes long.
28625 If unset or empty after expansion the library will provides a value for the
28626 protocol conversation.
28627
28628
28629 .option server_key gsasl string&!! unset
28630 .option server_skey gsasl string&!! unset
28631 These options can be used for the SCRAM family of mechanisms
28632 to provide stored information related to a password,
28633 the storage of which is preferable to plaintext.
28634
28635 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28636 &%server_skey%& is StoredKey.
28637
28638 They are only available for version 1.9.0 (or later) of the gsasl library.
28639 When this is so, the macros
28640 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28641 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28642 will be defined.
28643
28644 The &$authN$& variables are available when these options are expanded.
28645
28646 If set, the results of expansion should for each
28647 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28648 of base64-coded data, and will be used in preference to the
28649 &%server_password%& option.
28650 If unset or not of the right length, &%server_password%& will be used.
28651
28652 The libgsasl library release includes a utility &'gsasl'& which can be used
28653 to generate these values.
28654
28655
28656 .option server_service gsasl string &`smtp`&
28657 This is the SASL service that the server claims to implement.
28658 Some mechanisms will use this data.
28659
28660
28661 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28662 .vindex "&$auth1$&, &$auth2$&, etc"
28663 These may be set when evaluating specific options, as detailed above.
28664 They will also be set when evaluating &%server_condition%&.
28665
28666 Unless otherwise stated below, the &(gsasl)& integration will use the following
28667 meanings for these variables:
28668
28669 .ilist
28670 .vindex "&$auth1$&"
28671 &$auth1$&: the &'authentication id'&
28672 .next
28673 .vindex "&$auth2$&"
28674 &$auth2$&: the &'authorization id'&
28675 .next
28676 .vindex "&$auth3$&"
28677 &$auth3$&: the &'realm'&
28678 .endlist
28679
28680 On a per-mechanism basis:
28681
28682 .ilist
28683 .cindex "authentication" "EXTERNAL"
28684 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28685 the &%server_condition%& option must be present.
28686 .next
28687 .cindex "authentication" "ANONYMOUS"
28688 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28689 the &%server_condition%& option must be present.
28690 .next
28691 .cindex "authentication" "GSSAPI"
28692 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28693 &$auth2$& will be set to the &'authorization id'&,
28694 the &%server_condition%& option must be present.
28695 .endlist
28696
28697 An &'anonymous token'& is something passed along as an unauthenticated
28698 identifier; this is analogous to FTP anonymous authentication passing an
28699 email address, or software-identifier@, as the "password".
28700
28701
28702 An example showing the password having the realm specified in the callback
28703 and demonstrating a Cyrus SASL to GSASL migration approach is:
28704 .code
28705 gsasl_cyrusless_crammd5:
28706   driver = gsasl
28707   public_name = CRAM-MD5
28708   server_realm = imap.example.org
28709   server_password = ${lookup{$auth1:$auth3:userPassword}\
28710                     dbmjz{/etc/sasldb2}{$value}fail}
28711   server_set_id = ${quote:$auth1}
28712   server_condition = yes
28713 .endd
28714
28715
28716 . ////////////////////////////////////////////////////////////////////////////
28717 . ////////////////////////////////////////////////////////////////////////////
28718
28719 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28720 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28721 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28722 .cindex "authentication" "GSSAPI"
28723 .cindex "authentication" "Kerberos"
28724 The &(heimdal_gssapi)& authenticator provides server integration for the
28725 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28726 reliably.
28727
28728 .option server_hostname heimdal_gssapi string&!! "see below"
28729 This option selects the hostname that is used, with &%server_service%&,
28730 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28731 identifier.  The default value is &`$primary_hostname`&.
28732
28733 .option server_keytab heimdal_gssapi string&!! unset
28734 If set, then Heimdal will not use the system default keytab (typically
28735 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28736 The value should be a pathname, with no &"file:"& prefix.
28737
28738 .option server_service heimdal_gssapi string&!! "smtp"
28739 This option specifies the service identifier used, in conjunction with
28740 &%server_hostname%&, for building the identifier for finding credentials
28741 from the keytab.
28742
28743
28744 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28745 Beware that these variables will typically include a realm, thus will appear
28746 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28747 not verified, so a malicious client can set it to anything.
28748
28749 The &$auth1$& field should be safely trustable as a value from the Key
28750 Distribution Center.  Note that these are not quite email addresses.
28751 Each identifier is for a role, and so the left-hand-side may include a
28752 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28753
28754 .vindex "&$auth1$&, &$auth2$&, etc"
28755 .ilist
28756 .vindex "&$auth1$&"
28757 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28758 .next
28759 .vindex "&$auth2$&"
28760 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28761 authentication.  If that was empty, this will also be set to the
28762 GSS Display Name.
28763 .endlist
28764
28765
28766 . ////////////////////////////////////////////////////////////////////////////
28767 . ////////////////////////////////////////////////////////////////////////////
28768
28769 .chapter "The spa authenticator" "CHAPspa"
28770 .scindex IIDspaauth1 "&(spa)& authenticator"
28771 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28772 .cindex "authentication" "Microsoft Secure Password"
28773 .cindex "authentication" "NTLM"
28774 .cindex "Microsoft Secure Password Authentication"
28775 .cindex "NTLM authentication"
28776 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28777 Password Authentication'& mechanism,
28778 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28779 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28780 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28781 server side was subsequently contributed by Tom Kistner. The mechanism works as
28782 follows:
28783
28784 .ilist
28785 After the AUTH command has been accepted, the client sends an SPA
28786 authentication request based on the user name and optional domain.
28787 .next
28788 The server sends back a challenge.
28789 .next
28790 The client builds a challenge response which makes use of the user's password
28791 and sends it to the server, which then accepts or rejects it.
28792 .endlist
28793
28794 Encryption is used to protect the password in transit.
28795
28796
28797
28798 .section "Using spa as a server" "SECID179"
28799 .cindex "options" "&(spa)& authenticator (server)"
28800 The &(spa)& authenticator has just one server option:
28801
28802 .option server_password spa string&!! unset
28803 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28804 This option is expanded, and the result must be the cleartext password for the
28805 authenticating user, whose name is at this point in &$auth1$&. For
28806 compatibility with previous releases of Exim, the user name is also placed in
28807 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28808 it can lead to confusion in string expansions that also use numeric variables
28809 for other things. For example:
28810 .code
28811 spa:
28812   driver = spa
28813   public_name = NTLM
28814   server_password = \
28815     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28816 .endd
28817 If the expansion is forced to fail, authentication fails. Any other expansion
28818 failure causes a temporary error code to be returned.
28819
28820
28821
28822
28823
28824 .section "Using spa as a client" "SECID180"
28825 .cindex "options" "&(spa)& authenticator (client)"
28826 The &(spa)& authenticator has the following client options:
28827
28828
28829
28830 .option client_domain spa string&!! unset
28831 This option specifies an optional domain for the authentication.
28832
28833
28834 .option client_password spa string&!! unset
28835 This option specifies the user's password, and must be set.
28836
28837
28838 .option client_username spa string&!! unset
28839 This option specifies the user name, and must be set. Here is an example of a
28840 configuration of this authenticator for use with the mail servers at
28841 &'msn.com'&:
28842 .code
28843 msn:
28844   driver = spa
28845   public_name = MSN
28846   client_username = msn/msn_username
28847   client_password = msn_plaintext_password
28848   client_domain = DOMAIN_OR_UNSET
28849 .endd
28850 .ecindex IIDspaauth1
28851 .ecindex IIDspaauth2
28852
28853
28854
28855
28856
28857 . ////////////////////////////////////////////////////////////////////////////
28858 . ////////////////////////////////////////////////////////////////////////////
28859
28860 .chapter "The external authenticator" "CHAPexternauth"
28861 .scindex IIDexternauth1 "&(external)& authenticator"
28862 .scindex IIDexternauth2 "authenticators" "&(external)&"
28863 .cindex "authentication" "Client Certificate"
28864 .cindex "authentication" "X509"
28865 .cindex "Certificate-based authentication"
28866 The &(external)& authenticator provides support for
28867 authentication based on non-SMTP information.
28868 The specification is in RFC 4422 Appendix A
28869 (&url(https://tools.ietf.org/html/rfc4422)).
28870 It is only a transport and negotiation mechanism;
28871 the process of authentication is entirely controlled
28872 by the server configuration.
28873
28874 The client presents an identity in-clear.
28875 It is probably wise for a server to only advertise,
28876 and for clients to only attempt,
28877 this authentication method on a secure (eg. under TLS) connection.
28878
28879 One possible use, compatible with the
28880 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28881 is for using X509 client certificates.
28882
28883 It thus overlaps in function with the TLS authenticator
28884 (see &<<CHAPtlsauth>>&)
28885 but is a full SMTP SASL authenticator
28886 rather than being implicit for TLS-connection carried
28887 client certificates only.
28888
28889 The examples and discussion in this chapter assume that
28890 client-certificate authentication is being done.
28891
28892 The client must present a certificate,
28893 for which it must have been requested via the
28894 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28895 (see &<<CHAPTLS>>&).
28896 For authentication to be effective the certificate should be
28897 verifiable against a trust-anchor certificate known to the server.
28898
28899 .section "External options" "SECTexternsoptions"
28900 .cindex "options" "&(external)& authenticator (server)"
28901 The &(external)& authenticator has two server options:
28902
28903 .option server_param2 external string&!! unset
28904 .option server_param3 external string&!! unset
28905 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28906 These options are expanded before the &%server_condition%& option
28907 and the result are placed in &$auth2$& and &$auth3$& resectively.
28908 If the expansion is forced to fail, authentication fails. Any other expansion
28909 failure causes a temporary error code to be returned.
28910
28911 They can be used to clarify the coding of a complex &%server_condition%&.
28912
28913 .section "Using external in a server" "SECTexternserver"
28914 .cindex "AUTH" "in &(external)& authenticator"
28915 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28916         "in &(external)& authenticator"
28917 .vindex "&$auth1$&, &$auth2$&, etc"
28918 .cindex "base64 encoding" "in &(external)& authenticator"
28919
28920 When running as a server, &(external)& performs the authentication test by
28921 expanding a string. The data sent by the client with the AUTH command, or in
28922 response to subsequent prompts, is base64 encoded, and so may contain any byte
28923 values when decoded. The decoded value is treated as
28924 an identity for authentication and
28925 placed in the expansion variable &$auth1$&.
28926
28927 For compatibility with previous releases of Exim, the value is also placed in
28928 the expansion variable &$1$&. However, the use of this
28929 variable for this purpose is now deprecated, as it can lead to confusion in
28930 string expansions that also use them for other things.
28931
28932 .vindex "&$authenticated_id$&"
28933 Once an identity has been received,
28934 &%server_condition%& is expanded. If the expansion is forced to fail,
28935 authentication fails. Any other expansion failure causes a temporary error code
28936 to be returned. If the result of a successful expansion is an empty string,
28937 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28938 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28939 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28940 For any other result, a temporary error code is returned, with the expanded
28941 string as the error text.
28942
28943 Example:
28944 .code
28945 ext_ccert_san_mail:
28946   driver =            external
28947   public_name =       EXTERNAL
28948
28949   server_advertise_condition = $tls_in_certificate_verified
28950   server_param2 =     ${certextract {subj_altname,mail,>:} \
28951                                     {$tls_in_peercert}}
28952   server_condition =  ${if forany {$auth2} \
28953                             {eq {$item}{$auth1}}}
28954   server_set_id =     $auth1
28955 .endd
28956 This accepts a client certificate that is verifiable against any
28957 of your configured trust-anchors
28958 (which usually means the full set of public CAs)
28959 and which has a mail-SAN matching the claimed identity sent by the client.
28960
28961 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28962 The account name is therefore guessable by an opponent.
28963 TLS 1.3 protects both server and client certificates, and is not vulnerable
28964 in this way.
28965
28966
28967 .section "Using external in a client" "SECTexternclient"
28968 .cindex "options" "&(external)& authenticator (client)"
28969 The &(external)& authenticator has one client option:
28970
28971 .option client_send external string&!! unset
28972 This option is expanded and sent with the AUTH command as the
28973 identity being asserted.
28974
28975 Example:
28976 .code
28977 ext_ccert:
28978   driver =      external
28979   public_name = EXTERNAL
28980
28981   client_condition = ${if !eq{$tls_out_cipher}{}}
28982   client_send = myaccount@smarthost.example.net
28983 .endd
28984
28985
28986 .ecindex IIDexternauth1
28987 .ecindex IIDexternauth2
28988
28989
28990
28991
28992
28993 . ////////////////////////////////////////////////////////////////////////////
28994 . ////////////////////////////////////////////////////////////////////////////
28995
28996 .chapter "The tls authenticator" "CHAPtlsauth"
28997 .scindex IIDtlsauth1 "&(tls)& authenticator"
28998 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28999 .cindex "authentication" "Client Certificate"
29000 .cindex "authentication" "X509"
29001 .cindex "Certificate-based authentication"
29002 The &(tls)& authenticator provides server support for
29003 authentication based on client certificates.
29004
29005 It is not an SMTP authentication mechanism and is not
29006 advertised by the server as part of the SMTP EHLO response.
29007 It is an Exim authenticator in the sense that it affects
29008 the protocol element of the log line, can be tested for
29009 by the &%authenticated%& ACL condition, and can set
29010 the &$authenticated_id$& variable.
29011
29012 The client must present a verifiable certificate,
29013 for which it must have been requested via the
29014 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29015 (see &<<CHAPTLS>>&).
29016
29017 If an authenticator of this type is configured it is
29018 run immediately after a TLS connection being negotiated
29019 (due to either STARTTLS or TLS-on-connect)
29020 and can authenticate the connection.
29021 If it does, SMTP authentication is not subsequently offered.
29022
29023 A maximum of one authenticator of this type may be present.
29024
29025
29026 .cindex "options" "&(tls)& authenticator (server)"
29027 The &(tls)& authenticator has three server options:
29028
29029 .option server_param1 tls string&!! unset
29030 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29031 This option is expanded after the TLS negotiation and
29032 the result is placed in &$auth1$&.
29033 If the expansion is forced to fail, authentication fails. Any other expansion
29034 failure causes a temporary error code to be returned.
29035
29036 .option server_param2 tls string&!! unset
29037 .option server_param3 tls string&!! unset
29038 As above, for &$auth2$& and &$auth3$&.
29039
29040 &%server_param1%& may also be spelled &%server_param%&.
29041
29042
29043 Example:
29044 .code
29045 tls:
29046   driver = tls
29047   server_param1 =     ${certextract {subj_altname,mail,>:} \
29048                                     {$tls_in_peercert}}
29049   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29050                                  {forany {$auth1} \
29051                             {!= {0} \
29052                                 {${lookup ldap{ldap:///\
29053                          mailname=${quote_ldap_dn:${lc:$item}},\
29054                          ou=users,LDAP_DC?mailid} {$value}{0} \
29055                        }    }  } }}}
29056   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29057 .endd
29058 This accepts a client certificate that is verifiable against any
29059 of your configured trust-anchors
29060 (which usually means the full set of public CAs)
29061 and which has a SAN with a good account name.
29062
29063 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29064 The account name is therefore guessable by an opponent.
29065 TLS 1.3 protects both server and client certificates, and is not vulnerable
29066 in this way.
29067 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29068
29069 . An alternative might use
29070 . .code
29071 .   server_param1 = ${sha256:$tls_in_peercert}
29072 . .endd
29073 . to require one of a set of specific certs that define a given account
29074 . (the verification is still required, but mostly irrelevant).
29075 . This would help for per-device use.
29076 .
29077 . However, for the future we really need support for checking a
29078 . user cert in LDAP - which probably wants a base-64 DER.
29079
29080 .ecindex IIDtlsauth1
29081 .ecindex IIDtlsauth2
29082
29083
29084 Note that because authentication is traditionally an SMTP operation,
29085 the &%authenticated%& ACL condition cannot be used in
29086 a connect- or helo-ACL.
29087
29088
29089
29090 . ////////////////////////////////////////////////////////////////////////////
29091 . ////////////////////////////////////////////////////////////////////////////
29092
29093 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29094          "Encrypted SMTP connections"
29095 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29096 .scindex IIDencsmtp2 "SMTP" "encryption"
29097 .cindex "TLS" "on SMTP connection"
29098 .cindex "OpenSSL"
29099 .cindex "GnuTLS"
29100 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29101 Sockets Layer), is implemented by making use of the OpenSSL library or the
29102 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29103 cryptographic code in the Exim distribution itself for implementing TLS. In
29104 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29105 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29106 You also need to understand the basic concepts of encryption at a managerial
29107 level, and in particular, the way that public keys, private keys, and
29108 certificates are used.
29109
29110 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29111 connection is established, the client issues a STARTTLS command. If the
29112 server accepts this, the client and the server negotiate an encryption
29113 mechanism. If the negotiation succeeds, the data that subsequently passes
29114 between them is encrypted.
29115
29116 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29117 and if so, what cipher suite is in use, whether the client supplied a
29118 certificate, and whether or not that certificate was verified. This makes it
29119 possible for an Exim server to deny or accept certain commands based on the
29120 encryption state.
29121
29122 &*Warning*&: Certain types of firewall and certain anti-virus products can
29123 disrupt TLS connections. You need to turn off SMTP scanning for these products
29124 in order to get TLS to work.
29125
29126
29127
29128 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29129          "SECID284"
29130 .cindex "submissions protocol"
29131 .cindex "ssmtp protocol"
29132 .cindex "smtps protocol"
29133 .cindex "SMTP" "submissions protocol"
29134 .cindex "SMTP" "ssmtp protocol"
29135 .cindex "SMTP" "smtps protocol"
29136 The history of port numbers for TLS in SMTP is a little messy and has been
29137 contentious.  As of RFC 8314, the common practice of using the historically
29138 allocated port 465 for "email submission but with TLS immediately upon connect
29139 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29140 by them in preference to STARTTLS.
29141
29142 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29143 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29144 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29145
29146 This approach was, for a while, officially abandoned when encrypted SMTP was
29147 standardized, but many clients kept using it, even as the TCP port number was
29148 reassigned for other use.
29149 Thus you may encounter guidance claiming that you shouldn't enable use of
29150 this port.
29151 In practice, a number of mail-clients have only ever supported submissions,
29152 not submission with STARTTLS upgrade.
29153 Ideally, offer both submission (587) and submissions (465) service.
29154
29155 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29156 global option. Its value must be a list of port numbers;
29157 the most common use is expected to be:
29158 .code
29159 tls_on_connect_ports = 465
29160 .endd
29161 The port numbers specified by this option apply to all SMTP connections, both
29162 via the daemon and via &'inetd'&. You still need to specify all the ports that
29163 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29164 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29165 an extra port &-- rather, it specifies different behaviour on a port that is
29166 defined elsewhere.
29167
29168 There is also a &%-tls-on-connect%& command line option. This overrides
29169 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29170
29171
29172
29173
29174
29175
29176 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29177 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29178 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29179 To build Exim to use OpenSSL you need to set
29180 .code
29181 USE_OPENSSL=yes
29182 .endd
29183 in Local/Makefile.
29184
29185 To build Exim to use GnuTLS, you need to set
29186 .code
29187 USE_GNUTLS=yes
29188 .endd
29189 in Local/Makefile.
29190
29191 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29192 include files and libraries for GnuTLS can be found.
29193
29194 There are some differences in usage when using GnuTLS instead of OpenSSL:
29195
29196 .ilist
29197 The &%tls_verify_certificates%& option
29198 cannot be the path of a directory
29199 for GnuTLS versions before 3.3.6
29200 (for later versions, or OpenSSL, it can be either).
29201 .next
29202 The default value for &%tls_dhparam%& differs for historical reasons.
29203 .next
29204 .vindex "&$tls_in_peerdn$&"
29205 .vindex "&$tls_out_peerdn$&"
29206 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29207 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29208 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29209 .next
29210 OpenSSL identifies cipher suites using hyphens as separators, for example:
29211 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29212 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29213 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29214 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29215 to handle its own older variants) when processing lists of cipher suites in the
29216 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29217 option).
29218 .next
29219 The &%tls_require_ciphers%& options operate differently, as described in the
29220 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29221 .next
29222 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29223 When using OpenSSL, this option is ignored.
29224 (If an API is found to let OpenSSL be configured in this way,
29225 let the Exim Maintainers know and we'll likely use it).
29226 .next
29227 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29228 main option, it must be ordered to match the &%tls_certificate%& list.
29229 .next
29230 Some other recently added features may only be available in one or the other.
29231 This should be documented with the feature.  If the documentation does not
29232 explicitly state that the feature is infeasible in the other TLS
29233 implementation, then patches are welcome.
29234 .next
29235 The output from "exim -bV" will show which (if any) support was included
29236 in the build.
29237 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29238 .endlist
29239
29240
29241 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29242 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29243 an explicit path; if the latter, then the text about generation still applies,
29244 but not the chosen filename.
29245 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29246 See the documentation of &%tls_dhparam%& for more information.
29247
29248 GnuTLS uses D-H parameters that may take a substantial amount of time
29249 to compute. It is unreasonable to re-compute them for every TLS session.
29250 Therefore, Exim keeps this data in a file in its spool directory, called
29251 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29252 of bits requested.
29253 The file is owned by the Exim user and is readable only by
29254 its owner. Every Exim process that start up GnuTLS reads the D-H
29255 parameters from this file. If the file does not exist, the first Exim process
29256 that needs it computes the data and writes it to a temporary file which is
29257 renamed once it is complete. It does not matter if several Exim processes do
29258 this simultaneously (apart from wasting a few resources). Once a file is in
29259 place, new Exim processes immediately start using it.
29260
29261 For maximum security, the parameters that are stored in this file should be
29262 recalculated periodically, the frequency depending on your paranoia level.
29263 If you are avoiding using the fixed D-H primes published in RFCs, then you
29264 are concerned about some advanced attacks and will wish to do this; if you do
29265 not regenerate then you might as well stick to the standard primes.
29266
29267 Arranging this is easy in principle; just delete the file when you want new
29268 values to be computed. However, there may be a problem. The calculation of new
29269 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29270 If the system is not very active, &_/dev/random_& may delay returning data
29271 until enough randomness (entropy) is available. This may cause Exim to hang for
29272 a substantial amount of time, causing timeouts on incoming connections.
29273
29274 The solution is to generate the parameters externally to Exim. They are stored
29275 in &_gnutls-params-N_& in PEM format, which means that they can be
29276 generated externally using the &(certtool)& command that is part of GnuTLS.
29277
29278 To replace the parameters with new ones, instead of deleting the file
29279 and letting Exim re-create it, you can generate new parameters using
29280 &(certtool)& and, when this has been done, replace Exim's cache file by
29281 renaming. The relevant commands are something like this:
29282 .code
29283 # ls
29284 [ look for file; assume gnutls-params-2236 is the most recent ]
29285 # rm -f new-params
29286 # touch new-params
29287 # chown exim:exim new-params
29288 # chmod 0600 new-params
29289 # certtool --generate-dh-params --bits 2236 >>new-params
29290 # openssl dhparam -noout -text -in new-params | head
29291 [ check the first line, make sure it's not more than 2236;
29292   if it is, then go back to the start ("rm") and repeat
29293   until the size generated is at most the size requested ]
29294 # chmod 0400 new-params
29295 # mv new-params gnutls-params-2236
29296 .endd
29297 If Exim never has to generate the parameters itself, the possibility of
29298 stalling is removed.
29299
29300 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29301 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29302 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29303 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29304 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29305 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29306 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29307 which applies to all D-H usage, client or server.  If the value returned by
29308 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29309 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29310 limit, which is still much higher than Exim historically used.
29311
29312 The filename and bits used will change as the GnuTLS maintainers change the
29313 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29314 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29315 2432 bits, while NSS is limited to 2236 bits.
29316
29317 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29318 increase the chance of the generated prime actually being within acceptable
29319 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29320 procedure above.  There is no sane procedure available to Exim to double-check
29321 the size of the generated prime, so it might still be too large.
29322
29323
29324 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29325 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29326 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29327 There is a function in the OpenSSL library that can be passed a list of cipher
29328 suites before the cipher negotiation takes place. This specifies which ciphers
29329 are acceptable for TLS versions prior to 1.3.
29330 The list is colon separated and may contain names like
29331 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29332 directly to this function call.
29333 Many systems will install the OpenSSL manual-pages, so you may have
29334 &'ciphers(1)'& available to you.
29335 The following quotation from the OpenSSL
29336 documentation specifies what forms of item are allowed in the cipher string:
29337
29338 .ilist
29339 It can consist of a single cipher suite such as RC4-SHA.
29340 .next
29341 It can represent a list of cipher suites containing a certain algorithm,
29342 or cipher suites of a certain type. For example SHA1 represents all
29343 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29344 SSL v3 algorithms.
29345 .next
29346 Lists of cipher suites can be combined in a single cipher string using
29347 the + character. This is used as a logical and operation. For example
29348 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29349 algorithms.
29350 .endlist
29351
29352 Each cipher string can be optionally preceded by one of the characters &`!`&,
29353 &`-`& or &`+`&.
29354 .ilist
29355 If &`!`& is used, the ciphers are permanently deleted from the list. The
29356 ciphers deleted can never reappear in the list even if they are explicitly
29357 stated.
29358 .next
29359 If &`-`& is used, the ciphers are deleted from the list, but some or all
29360 of the ciphers can be added again by later options.
29361 .next
29362 If &`+`& is used, the ciphers are moved to the end of the list. This
29363 option does not add any new ciphers; it just moves matching existing ones.
29364 .endlist
29365
29366 If none of these characters is present, the string is interpreted as
29367 a list of ciphers to be appended to the current preference list. If the list
29368 includes any ciphers already present they will be ignored: that is, they will
29369 not be moved to the end of the list.
29370 .endlist
29371
29372 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29373 string:
29374 .code
29375 # note single-quotes to get ! past any shell history expansion
29376 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29377 .endd
29378
29379 This example will let the library defaults be permitted on the MX port, where
29380 there's probably no identity verification anyway, but ups the ante on the
29381 submission ports where the administrator might have some influence on the
29382 choice of clients used:
29383 .code
29384 # OpenSSL variant; see man ciphers(1)
29385 tls_require_ciphers = ${if =={$received_port}{25}\
29386                            {DEFAULT}\
29387                            {HIGH:!MD5:!SHA1}}
29388 .endd
29389
29390 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29391 .code
29392 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29393 .endd
29394
29395 For TLS version 1.3 the control available is less fine-grained
29396 and Exim does not provide access to it at present.
29397 The value of the &%tls_require_ciphers%& option is ignored when
29398 TLS version 1.3 is negotiated.
29399
29400 As of writing the library default cipher suite list for TLSv1.3 is
29401 .code
29402 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29403 .endd
29404
29405
29406 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29407          "SECTreqciphgnu"
29408 .cindex "GnuTLS" "specifying parameters for"
29409 .cindex "TLS" "specifying ciphers (GnuTLS)"
29410 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29411 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29412 .cindex "TLS" "specifying protocols (GnuTLS)"
29413 .cindex "TLS" "specifying priority string (GnuTLS)"
29414 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29415 The GnuTLS library allows the caller to provide a "priority string", documented
29416 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29417 ciphersuite specification in OpenSSL.
29418
29419 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29420 and controls both protocols and ciphers.
29421
29422 The &%tls_require_ciphers%& option is available both as an global option,
29423 controlling how Exim behaves as a server, and also as an option of the
29424 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29425 the value is string expanded.  The resulting string is not an Exim list and
29426 the string is given to the GnuTLS library, so that Exim does not need to be
29427 aware of future feature enhancements of GnuTLS.
29428
29429 Documentation of the strings accepted may be found in the GnuTLS manual, under
29430 "Priority strings".  This is online as
29431 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29432 but beware that this relates to GnuTLS 3, which may be newer than the version
29433 installed on your system.  If you are using GnuTLS 3,
29434 then the example code
29435 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29436 on that site can be used to test a given string.
29437
29438 For example:
29439 .code
29440 # Disable older versions of protocols
29441 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29442 .endd
29443
29444 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29445 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29446 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29447
29448 This example will let the library defaults be permitted on the MX port, where
29449 there's probably no identity verification anyway, and lowers security further
29450 by increasing compatibility; but this ups the ante on the submission ports
29451 where the administrator might have some influence on the choice of clients
29452 used:
29453 .code
29454 # GnuTLS variant
29455 tls_require_ciphers = ${if =={$received_port}{25}\
29456                            {NORMAL:%COMPAT}\
29457                            {SECURE128}}
29458 .endd
29459
29460
29461 .section "Configuring an Exim server to use TLS" "SECID182"
29462 .cindex "TLS" "configuring an Exim server"
29463 .cindex "ESMTP extensions" STARTTLS
29464 When Exim has been built with TLS support, it advertises the availability of
29465 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29466 but not to any others. The default value of this option is *, which means
29467 that STARTTLS is always advertised.  Set it to blank to never advertise;
29468 this is reasonable for systems that want to use TLS only as a client.
29469
29470 If STARTTLS is to be used you
29471 need to set some other options in order to make TLS available.
29472
29473 If a client issues a STARTTLS command and there is some configuration
29474 problem in the server, the command is rejected with a 454 error. If the client
29475 persists in trying to issue SMTP commands, all except QUIT are rejected
29476 with the error
29477 .code
29478 554 Security failure
29479 .endd
29480 If a STARTTLS command is issued within an existing TLS session, it is
29481 rejected with a 554 error code.
29482
29483 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29484 must be set to match some hosts. The default is * which matches all hosts.
29485
29486 If this is all you do, TLS encryption will be enabled but not authentication -
29487 meaning that the peer has no assurance it is actually you he is talking to.
29488 You gain protection from a passive sniffer listening on the wire but not
29489 from someone able to intercept the communication.
29490
29491 Further protection requires some further configuration at the server end.
29492
29493 To make TLS work you need to set, in the server,
29494 .code
29495 tls_certificate = /some/file/name
29496 tls_privatekey = /some/file/name
29497 .endd
29498 These options are, in fact, expanded strings, so you can make them depend on
29499 the identity of the client that is connected if you wish. The first file
29500 contains the server's X509 certificate, and the second contains the private key
29501 that goes with it. These files need to be
29502 PEM format and readable by the Exim user, and must
29503 always be given as full path names.
29504 The key must not be password-protected.
29505 They can be the same file if both the
29506 certificate and the key are contained within it. If &%tls_privatekey%& is not
29507 set, or if its expansion is forced to fail or results in an empty string, this
29508 is assumed to be the case. The certificate file may also contain intermediate
29509 certificates that need to be sent to the client to enable it to authenticate
29510 the server's certificate.
29511
29512 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29513 colon-separated lists of file paths.  Ciphers using given authentication
29514 algorithms require the presence of a suitable certificate to supply the
29515 public-key.  The server selects among the certificates to present to the
29516 client depending on the selected cipher, hence the priority ordering for
29517 ciphers will affect which certificate is used.
29518
29519 If you do not understand about certificates and keys, please try to find a
29520 source of this background information, which is not Exim-specific. (There are a
29521 few comments below in section &<<SECTcerandall>>&.)
29522
29523 &*Note*&: These options do not apply when Exim is operating as a client &--
29524 they apply only in the case of a server. If you need to use a certificate in an
29525 Exim client, you must set the options of the same names in an &(smtp)&
29526 transport.
29527
29528 With just these options, an Exim server will be able to use TLS. It does not
29529 require the client to have a certificate (but see below for how to insist on
29530 this). There is one other option that may be needed in other situations. If
29531 .code
29532 tls_dhparam = /some/file/name
29533 .endd
29534 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29535 with the parameters contained in the file.
29536 Set this to &`none`& to disable use of DH entirely, by making no prime
29537 available:
29538 .code
29539 tls_dhparam = none
29540 .endd
29541 This may also be set to a string identifying a standard prime to be used for
29542 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29543 used is &`ike23`&.  There are a few standard primes available, see the
29544 documentation for &%tls_dhparam%& for the complete list.
29545
29546 See the command
29547 .code
29548 openssl dhparam
29549 .endd
29550 for a way of generating file data.
29551
29552 The strings supplied for these three options are expanded every time a client
29553 host connects. It is therefore possible to use different certificates and keys
29554 for different hosts, if you so wish, by making use of the client's IP address
29555 in &$sender_host_address$& to control the expansion. If a string expansion is
29556 forced to fail, Exim behaves as if the option is not set.
29557
29558 .cindex "cipher" "logging"
29559 .cindex "log" "TLS cipher"
29560 .vindex "&$tls_in_cipher$&"
29561 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29562 an incoming TLS connection. It is included in the &'Received:'& header of an
29563 incoming message (by default &-- you can, of course, change this), and it is
29564 also included in the log line that records a message's arrival, keyed by
29565 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29566 condition can be used to test for specific cipher suites in ACLs.
29567
29568 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29569 can check the name of the cipher suite and vary their actions accordingly. The
29570 cipher suite names vary, depending on which TLS library is being used. For
29571 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29572 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29573 documentation for more details.
29574
29575 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29576 (again depending on the &%tls_cipher%& log selector).
29577
29578
29579 .subsection "Requesting and verifying client certificates"
29580 .cindex "certificate" "verification of client"
29581 .cindex "TLS" "client certificate verification"
29582 If you want an Exim server to request a certificate when negotiating a TLS
29583 session with a client, you must set either &%tls_verify_hosts%& or
29584 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29585 apply to all TLS connections. For any host that matches one of these options,
29586 Exim requests a certificate as part of the setup of the TLS session. The
29587 contents of the certificate are verified by comparing it with a list of
29588 expected trust-anchors or certificates.
29589 These may be the system default set (depending on library version),
29590 an explicit file or,
29591 depending on library version, a directory, identified by
29592 &%tls_verify_certificates%&.
29593
29594 A file can contain multiple certificates, concatenated end to end. If a
29595 directory is used
29596 (OpenSSL only),
29597 each certificate must be in a separate file, with a name (or a symbolic link)
29598 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29599 certificate. You can compute the relevant hash by running the command
29600 .code
29601 openssl x509 -hash -noout -in /cert/file
29602 .endd
29603 where &_/cert/file_& contains a single certificate.
29604
29605 There is no checking of names of the client against the certificate
29606 Subject Name or Subject Alternate Names.
29607
29608 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29609 what happens if the client does not supply a certificate, or if the certificate
29610 does not match any of the certificates in the collection named by
29611 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29612 attempt to set up a TLS session is aborted, and the incoming connection is
29613 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29614 session continues. ACLs that run for subsequent SMTP commands can detect the
29615 fact that no certificate was verified, and vary their actions accordingly. For
29616 example, you can insist on a certificate before accepting a message for
29617 relaying, but not when the message is destined for local delivery.
29618
29619 .vindex "&$tls_in_peerdn$&"
29620 When a client supplies a certificate (whether it verifies or not), the value of
29621 the Distinguished Name of the certificate is made available in the variable
29622 &$tls_in_peerdn$& during subsequent processing of the message.
29623
29624 .cindex "log" "distinguished name"
29625 Because it is often a long text string, it is not included in the log line or
29626 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29627 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29628 &%received_header_text%& to change the &'Received:'& header. When no
29629 certificate is supplied, &$tls_in_peerdn$& is empty.
29630
29631
29632 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29633 .cindex certificate caching
29634 .cindex privatekey caching
29635 .cindex crl caching
29636 .cindex ocsp caching
29637 .cindex ciphers caching
29638 .cindex "CA bundle" caching
29639 .cindex "certificate authorities" caching
29640 .cindex tls_certificate caching
29641 .cindex tls_privatekey caching
29642 .cindex tls_crl caching
29643 .cindex tls_ocsp_file caching
29644 .cindex tls_require_ciphers caching
29645 .cindex tls_verify_certificate caching
29646 .cindex caching certificate
29647 .cindex caching privatekey
29648 .cindex caching crl
29649 .cindex caching ocsp
29650 .cindex caching ciphers
29651 .cindex caching "certificate authorities
29652 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29653 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29654 expandable elements,
29655 then the associated information is loaded at daemon startup.
29656 It is made available
29657 to child processes forked for handling received SMTP connections.
29658
29659 This caching is currently only supported under Linux and FreeBSD.
29660
29661 If caching is not possible, for example if an item has to be dependent
29662 on the peer host so contains a &$sender_host_name$& expansion, the load
29663 of the associated information is done at the startup of the TLS connection.
29664
29665 The cache is invalidated and reloaded after any changes to the directories
29666 containing files specified by these options.
29667
29668 The information specified by the main option &%tls_verify_certificates%&
29669 is similarly cached so long as it specifies files explicitly
29670 or (under GnuTLS) is the string &"system,cache"&.
29671 The latter case is not automatically invalidated;
29672 it is the operator's responsibility to arrange for a daemon restart
29673 any time the system certificate authority bundle is updated.
29674 A HUP signal is sufficient for this.
29675 The value &"system"& results in no caching under GnuTLS.
29676
29677 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29678 is acceptable in configurations for the Exim executavble.
29679
29680 Caching of the system Certificate Authorities bundle can
29681 save siginificant time and processing on every TLS connection
29682 accepted by Exim.
29683
29684
29685
29686
29687 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29688 .cindex "cipher" "logging"
29689 .cindex "log" "TLS cipher"
29690 .cindex "log" "distinguished name"
29691 .cindex "TLS" "configuring an Exim client"
29692 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29693 deliveries as well as to incoming, the latter one causing logging of the
29694 server certificate's DN. The remaining client configuration for TLS is all
29695 within the &(smtp)& transport.
29696
29697 .cindex "ESMTP extensions" STARTTLS
29698 It is not necessary to set any options to have TLS work in the &(smtp)&
29699 transport. If Exim is built with TLS support, and TLS is advertised by a
29700 server, the &(smtp)& transport always tries to start a TLS session. However,
29701 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29702 transport) to a list of server hosts for which TLS should not be used.
29703
29704 If you do not want Exim to attempt to send messages unencrypted when an attempt
29705 to set up an encrypted connection fails in any way, you can set
29706 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29707 those hosts, delivery is always deferred if an encrypted connection cannot be
29708 set up. If there are any other hosts for the address, they are tried in the
29709 usual way.
29710
29711 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29712 the message unencrypted. It always does this if the response to STARTTLS is
29713 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29714 session after a success response code, what happens is controlled by the
29715 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29716 delivery to this host is deferred, and other hosts (if available) are tried. If
29717 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29718 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29719 negotiation fails, Exim closes the current connection (because it is in an
29720 unknown state), opens a new one to the same host, and then tries the delivery
29721 unencrypted.
29722
29723 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29724 transport provide the client with a certificate, which is passed to the server
29725 if it requests it.
29726 This is an optional thing for TLS connections, although either end
29727 may insist on it.
29728 If the server is Exim, it will request a certificate only if
29729 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29730
29731 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29732 for client use (they are usable for server use).
29733 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29734 in failed connections.
29735
29736 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29737 specifies a collection of expected server certificates.
29738 These may be
29739 the system default set (depending on library version),
29740 a file,
29741 or (depending on library version) a directory.
29742 The client verifies the server's certificate
29743 against this collection, taking into account any revoked certificates that are
29744 in the list defined by &%tls_crl%&.
29745 Failure to verify fails the TLS connection unless either of the
29746 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29747
29748 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29749 certificate verification to the listed servers.  Verification either must
29750 or need not succeed respectively.
29751
29752 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29753 name checks are made on the server certificate.
29754 The match against this list is, as per other Exim usage, the
29755 IP for the host.  That is most closely associated with the
29756 name on the DNS A (or AAAA) record for the host.
29757 However, the name that needs to be in the certificate
29758 is the one at the head of any CNAME chain leading to the A record.
29759 The option defaults to always checking.
29760
29761 The &(smtp)& transport has two OCSP-related options:
29762 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29763 is requested and required for the connection to proceed.  The default
29764 value is empty.
29765 &%hosts_request_ocsp%&; a host-list for which (additionally)
29766 a Certificate Status is requested (but not necessarily verified).  The default
29767 value is "*" meaning that requests are made unless configured
29768 otherwise.
29769
29770 The host(s) should also be in &%hosts_require_tls%&, and
29771 &%tls_verify_certificates%& configured for the transport,
29772 for OCSP to be relevant.
29773
29774 If
29775 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29776 list of permitted cipher suites. If either of these checks fails, delivery to
29777 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29778 alternative hosts, if any.
29779
29780  &*Note*&:
29781 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29782 is operating as a client. Exim does not assume that a server certificate (set
29783 by the global options of the same name) should also be used when operating as a
29784 client.
29785
29786 .vindex "&$host$&"
29787 .vindex "&$host_address$&"
29788 All the TLS options in the &(smtp)& transport are expanded before use, with
29789 &$host$& and &$host_address$& containing the name and address of the server to
29790 which the client is connected. Forced failure of an expansion causes Exim to
29791 behave as if the relevant option were unset.
29792
29793 .vindex &$tls_out_bits$&
29794 .vindex &$tls_out_cipher$&
29795 .vindex &$tls_out_peerdn$&
29796 .vindex &$tls_out_sni$&
29797 Before an SMTP connection is established, the
29798 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29799 variables are emptied. (Until the first connection, they contain the values
29800 that were set when the message was received.) If STARTTLS is subsequently
29801 successfully obeyed, these variables are set to the relevant values for the
29802 outgoing connection.
29803
29804
29805
29806 .subsection "Caching of static client configuration items" SECTclientTLScache
29807 .cindex certificate caching
29808 .cindex privatekey caching
29809 .cindex crl caching
29810 .cindex ciphers caching
29811 .cindex "CA bundle" caching
29812 .cindex "certificate authorities" caching
29813 .cindex tls_certificate caching
29814 .cindex tls_privatekey caching
29815 .cindex tls_crl caching
29816 .cindex tls_require_ciphers caching
29817 .cindex tls_verify_certificate caching
29818 .cindex caching certificate
29819 .cindex caching privatekey
29820 .cindex caching crl
29821 .cindex caching ciphers
29822 .cindex caching "certificate authorities
29823 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29824 and &%tls_crl%& have values with no
29825 expandable elements,
29826 then the associated information is loaded per smtp transport
29827 at daemon startup, at the start of a queue run, or on a
29828 command-line specified message delivery.
29829 It is made available
29830 to child processes forked for handling making SMTP connections.
29831
29832 This caching is currently only supported under Linux.
29833
29834 If caching is not possible, the load
29835 of the associated information is done at the startup of the TLS connection.
29836
29837 The cache is invalidated in the daemon
29838 and reloaded after any changes to the directories
29839 containing files specified by these options.
29840
29841 The information specified by the main option &%tls_verify_certificates%&
29842 is similarly cached so long as it specifies files explicitly
29843 or (under GnuTLS) is the string &"system,cache"&.
29844 The latter case is not automatically invaludated;
29845 it is the operator's responsibility to arrange for a daemon restart
29846 any time the system certificate authority bundle is updated.
29847 A HUP signal is sufficient for this.
29848 The value &"system"& results in no caching under GnuTLS.
29849
29850 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29851 is acceptable in configurations for the Exim executavble.
29852
29853 Caching of the system Certificate Authorities bundle can
29854 save siginificant time and processing on every TLS connection
29855 initiated by Exim.
29856
29857
29858
29859
29860 .section "Use of TLS Server Name Indication" "SECTtlssni"
29861 .cindex "TLS" "Server Name Indication"
29862 .cindex "TLS" SNI
29863 .cindex SNI
29864 .vindex "&$tls_in_sni$&"
29865 .oindex "&%tls_in_sni%&"
29866 With TLS1.0 or above, there is an extension mechanism by which extra
29867 information can be included at various points in the protocol.  One of these
29868 extensions, documented in RFC 6066 (and before that RFC 4366) is
29869 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29870 client in the initial handshake, so that the server can examine the servername
29871 within and possibly choose to use different certificates and keys (and more)
29872 for this session.
29873
29874 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29875 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29876 address.
29877
29878 With SMTP to MX, there are the same problems here as in choosing the identity
29879 against which to validate a certificate: you can't rely on insecure DNS to
29880 provide the identity which you then cryptographically verify.  So this will
29881 be of limited use in that environment.
29882
29883 With SMTP to Submission, there is a well-defined hostname which clients are
29884 connecting to and can validate certificates against.  Thus clients &*can*&
29885 choose to include this information in the TLS negotiation.  If this becomes
29886 wide-spread, then hosters can choose to present different certificates to
29887 different clients.  Or even negotiate different cipher suites.
29888
29889 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29890 if not empty, will be sent on a TLS session as part of the handshake.  There's
29891 nothing more to it.  Choosing a sensible value not derived insecurely is the
29892 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29893 for the lifetime of the client connection (including during authentication).
29894
29895 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29896 is forced to the name of the destination host, after any MX- or CNAME-following.
29897
29898 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29899 received from a client.
29900 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29901
29902 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29903 option (prior to expansion) then the following options will be re-expanded
29904 during TLS session handshake, to permit alternative values to be chosen:
29905
29906 .ilist
29907 &%tls_certificate%&
29908 .next
29909 &%tls_crl%&
29910 .next
29911 &%tls_privatekey%&
29912 .next
29913 &%tls_verify_certificates%&
29914 .next
29915 &%tls_ocsp_file%&
29916 .endlist
29917
29918 Great care should be taken to deal with matters of case, various injection
29919 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29920 can always be referenced; it is important to remember that &$tls_in_sni$& is
29921 arbitrary unverified data provided prior to authentication.
29922 Further, the initial certificate is loaded before SNI has arrived, so
29923 an expansion for &%tls_certificate%& must have a default which is used
29924 when &$tls_in_sni$& is empty.
29925
29926 The Exim developers are proceeding cautiously and so far no other TLS options
29927 are re-expanded.
29928
29929 When Exim is built against OpenSSL, OpenSSL must have been built with support
29930 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29931 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29932 see &`-servername`& in the output, then OpenSSL has support.
29933
29934 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29935 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29936 built, then you have SNI support).
29937
29938 .subsection ALPN
29939 .cindex TLS ALPN
29940 .cindex ALPN "general information"
29941 .cindex TLS "Application Layer Protocol Names"
29942 There is a TLS feature related to SNI
29943 called Application Layer Protocol Name (ALPN).
29944 This is intended to declare, or select, what protocol layer will be using a TLS
29945 connection.
29946 The client for the connection proposes a set of protocol names, and
29947 the server responds with a selected one.
29948 It is not, as of 2021, commonly used for SMTP connections.
29949 However, to guard against misdirected or malicious use of web clients
29950 (which often do use ALPN) against MTA ports, Exim by default check that
29951 there is no incompatible ALPN specified by a client for a TLS connection.
29952 If there is, the connection is rejected.
29953
29954 As a client Exim does not supply ALPN by default.
29955 The behaviour of both client and server can be configured using the options
29956 &%tls_alpn%& and &%hosts_require_alpn%&.
29957 There are no variables providing observability.
29958 Some feature-specific logging may appear on denied connections, but this
29959 depends on the behaviour of the peer
29960 (not all peers can send a feature-specific TLS Alert).
29961
29962 This feature is available when Exim is built with
29963 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29964 the macro _HAVE_TLS_ALPN will be defined when this is so.
29965
29966
29967
29968 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29969          "SECTmulmessam"
29970 .cindex "multiple SMTP deliveries with TLS"
29971 .cindex "TLS" "multiple message deliveries"
29972 Exim sends multiple messages down the same TCP/IP connection by starting up
29973 an entirely new delivery process for each message, passing the socket from
29974 one process to the next. This implementation does not fit well with the use
29975 of TLS, because there is quite a lot of state information associated with a TLS
29976 connection, not just a socket identification. Passing all the state information
29977 to a new process is not feasible. Consequently, for sending using TLS Exim
29978 starts an additional proxy process for handling the encryption, piping the
29979 unencrypted data stream from and to the delivery processes.
29980
29981 An older mode of operation can be enabled on a per-host basis by the
29982 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29983 this list the proxy process described above is not used; instead Exim
29984 shuts down an existing TLS session being run by the delivery process
29985 before passing the socket to a new process. The new process may then
29986 try to start a new TLS session, and if successful, may try to re-authenticate
29987 if AUTH is in use, before sending the next message.
29988
29989 The RFC is not clear as to whether or not an SMTP session continues in clear
29990 after TLS has been shut down, or whether TLS may be restarted again later, as
29991 just described. However, if the server is Exim, this shutdown and
29992 reinitialization works. It is not known which (if any) other servers operate
29993 successfully if the client closes a TLS session and continues with unencrypted
29994 SMTP, but there are certainly some that do not work. For such servers, Exim
29995 should not pass the socket to another process, because the failure of the
29996 subsequent attempt to use it would cause Exim to record a temporary host error,
29997 and delay other deliveries to that host.
29998
29999 To test for this case, Exim sends an EHLO command to the server after
30000 closing down the TLS session. If this fails in any way, the connection is
30001 closed instead of being passed to a new delivery process, but no retry
30002 information is recorded.
30003
30004 There is also a manual override; you can set &%hosts_nopass_tls%& on the
30005 &(smtp)& transport to match those hosts for which Exim should not pass
30006 connections to new processes if TLS has been used.
30007
30008
30009
30010
30011 .section "Certificates and all that" "SECTcerandall"
30012 .cindex "certificate" "references to discussion"
30013 In order to understand fully how TLS works, you need to know about
30014 certificates, certificate signing, and certificate authorities.
30015 This is a large topic and an introductory guide is unsuitable for the Exim
30016 reference manual, so instead we provide pointers to existing documentation.
30017
30018 The Apache web-server was for a long time the canonical guide, so their
30019 documentation is a good place to start; their SSL module's Introduction
30020 document is currently at
30021 .display
30022 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30023 .endd
30024 and their FAQ is at
30025 .display
30026 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30027 .endd
30028
30029 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30030 0-201-61598-3) in 2001, contains both introductory and more in-depth
30031 descriptions.
30032 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30033 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30034 Ivan is the author of the popular TLS testing tools at
30035 &url(https://www.ssllabs.com/).
30036
30037
30038 .subsection "Certificate chains" SECID186
30039 A file named by &%tls_certificate%& may contain more than one
30040 certificate. This is useful in the case where the certificate that is being
30041 sent is validated by an intermediate certificate which the other end does
30042 not have. Multiple certificates must be in the correct order in the file.
30043 First the host's certificate itself, then the first intermediate
30044 certificate to validate the issuer of the host certificate, then the next
30045 intermediate certificate to validate the issuer of the first intermediate
30046 certificate, and so on, until finally (optionally) the root certificate.
30047 The root certificate must already be trusted by the recipient for
30048 validation to succeed, of course, but if it's not preinstalled, sending the
30049 root certificate along with the rest makes it available for the user to
30050 install if the receiving end is a client MUA that can interact with a user.
30051
30052 Note that certificates using MD5 are unlikely to work on today's Internet;
30053 even if your libraries allow loading them for use in Exim when acting as a
30054 server, increasingly clients will not accept such certificates.  The error
30055 diagnostics in such a case can be frustratingly vague.
30056
30057
30058
30059 .subsection "Self-signed certificates" SECID187
30060 .cindex "certificate" "self-signed"
30061 You can create a self-signed certificate using the &'req'& command provided
30062 with OpenSSL, like this:
30063 . ==== Do not shorten the duration here without reading and considering
30064 . ==== the text below.  Please leave it at 9999 days.
30065 .code
30066 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30067             -days 9999 -nodes
30068 .endd
30069 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30070 delimited and so can be identified independently. The &%-days%& option
30071 specifies a period for which the certificate is valid. The &%-nodes%& option is
30072 important: if you do not set it, the key is encrypted with a passphrase
30073 that you are prompted for, and any use that is made of the key causes more
30074 prompting for the passphrase. This is not helpful if you are going to use
30075 this certificate and key in an MTA, where prompting is not possible.
30076
30077 . ==== I expect to still be working 26 years from now.  The less technical
30078 . ==== debt I create, in terms of storing up trouble for my later years, the
30079 . ==== happier I will be then.  We really have reached the point where we
30080 . ==== should start, at the very least, provoking thought and making folks
30081 . ==== pause before proceeding, instead of leaving all the fixes until two
30082 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30083 . ==== -pdp, 2012
30084 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30085 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30086 the above command might produce a date in the past.  Think carefully about
30087 the lifetime of the systems you're deploying, and either reduce the duration
30088 of the certificate or reconsider your platform deployment.  (At time of
30089 writing, reducing the duration is the most likely choice, but the inexorable
30090 progression of time takes us steadily towards an era where this will not
30091 be a sensible resolution).
30092
30093 A self-signed certificate made in this way is sufficient for testing, and
30094 may be adequate for all your requirements if you are mainly interested in
30095 encrypting transfers, and not in secure identification.
30096
30097 However, many clients require that the certificate presented by the server be a
30098 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30099 certificate. In this situation, the self-signed certificate described above
30100 must be installed on the client host as a trusted root &'certification
30101 authority'& (CA), and the certificate used by Exim must be a user certificate
30102 signed with that self-signed certificate.
30103
30104 For information on creating self-signed CA certificates and using them to sign
30105 user certificates, see the &'General implementation overview'& chapter of the
30106 Open-source PKI book, available online at
30107 &url(https://sourceforge.net/projects/ospkibook/).
30108
30109
30110 .subsection "Revoked certificates"
30111 .cindex "TLS" "revoked certificates"
30112 .cindex "revocation list"
30113 .cindex "certificate" "revocation list"
30114 .cindex "OCSP" "stapling"
30115 There are three ways for a certificate to be made unusable
30116 before its expiry.
30117
30118 .ilist
30119 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30120 certificates are revoked. If you have such a list, you can pass it to an Exim
30121 server using the global option called &%tls_crl%& and to an Exim client using
30122 an identically named option for the &(smtp)& transport. In each case, the value
30123 of the option is expanded and must then be the name of a file that contains a
30124 CRL in PEM format.
30125 The downside is that clients have to periodically re-download a potentially huge
30126 file from every certificate authority they know of.
30127
30128 .next
30129 The way with most moving parts at query time is Online Certificate
30130 Status Protocol (OCSP), where the client verifies the certificate
30131 against an OCSP server run by the CA.  This lets the CA track all
30132 usage of the certs.  It requires running software with access to the
30133 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30134 is based on HTTP and can be proxied accordingly.
30135
30136 The only widespread OCSP server implementation (known to this writer)
30137 comes as part of OpenSSL and aborts on an invalid request, such as
30138 connecting to the port and then disconnecting.  This requires
30139 re-entering the passphrase each time some random client does this.
30140
30141 .next
30142 The third way is OCSP Stapling; in this, the server using a certificate
30143 issued by the CA periodically requests an OCSP proof of validity from
30144 the OCSP server, then serves it up inline as part of the TLS
30145 negotiation.   This approach adds no extra round trips, does not let the
30146 CA track users, scales well with number of certs issued by the CA and is
30147 resilient to temporary OCSP server failures, as long as the server
30148 starts retrying to fetch an OCSP proof some time before its current
30149 proof expires.  The downside is that it requires server support.
30150
30151 Unless Exim is built with the support disabled,
30152 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30153 support for OCSP stapling is included.
30154
30155 There is a global option called &%tls_ocsp_file%&.
30156 The file specified therein is expected to be in DER format, and contain
30157 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30158 option will be re-expanded for SNI, if the &%tls_certificate%& option
30159 contains &`tls_in_sni`&, as per other TLS options.
30160
30161 Exim does not at this time implement any support for fetching a new OCSP
30162 proof.  The burden is on the administrator to handle this, outside of
30163 Exim.  The file specified should be replaced atomically, so that the
30164 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30165 on each connection, so a new file will be handled transparently on the
30166 next connection.
30167
30168 When built with OpenSSL Exim will check for a valid next update timestamp
30169 in the OCSP proof; if not present, or if the proof has expired, it will be
30170 ignored.
30171
30172 For the client to be able to verify the stapled OCSP the server must
30173 also supply, in its stapled information, any intermediate
30174 certificates for the chain leading to the OCSP proof from the signer
30175 of the server certificate.  There may be zero or one such. These
30176 intermediate certificates should be added to the server OCSP stapling
30177 file named by &%tls_ocsp_file%&.
30178
30179 Note that the proof only covers the terminal server certificate,
30180 not any of the chain from CA to it.
30181
30182 There is no current way to staple a proof for a client certificate.
30183
30184 .code
30185   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30186   OCSP server is supplied.  The server URL may be included in the
30187   server certificate, if the CA is helpful.
30188
30189   One failure mode seen was the OCSP Signer cert expiring before the end
30190   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30191   noted this as invalid overall, but the re-fetch script did not.
30192 .endd
30193 .endlist
30194
30195
30196 .ecindex IIDencsmtp1
30197 .ecindex IIDencsmtp2
30198
30199
30200 .section "TLS Resumption" "SECTresumption"
30201 .cindex TLS resumption
30202 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30203 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30204 (or later).
30205
30206 Session resumption (this is the "stateless" variant) involves the server sending
30207 a "session ticket" to the client on one connection, which can be stored by the
30208 client and used for a later session.  The ticket contains sufficient state for
30209 the server to reconstruct the TLS session, avoiding some expensive crypto
30210 calculation and (on TLS1.2) one full packet roundtrip time.
30211
30212 .ilist
30213 Operational cost/benefit:
30214
30215  The extra data being transmitted costs a minor amount, and the client has
30216  extra costs in storing and retrieving the data.
30217
30218  In the Exim/Gnutls implementation the extra cost on an initial connection
30219  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30220  The saved cost on a subsequent connection is about 4ms; three or more
30221  connections become a net win.  On longer network paths, two or more
30222  connections will have an average lower startup time thanks to the one
30223  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30224  packet roundtrips.
30225
30226 .cindex "hints database" tls
30227  Since a new hints DB is used on the TLS client,
30228  the hints DB maintenance should be updated to additionally handle "tls".
30229
30230 .next
30231 Security aspects:
30232
30233  The session ticket is encrypted, but is obviously an additional security
30234  vulnarability surface.  An attacker able to decrypt it would have access
30235  all connections using the resumed session.
30236  The session ticket encryption key is not committed to storage by the server
30237  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30238  overlap; GnuTLS 6hr but does not specify any overlap).
30239  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30240  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30241
30242  There is a question-mark over the security of the Diffie-Helman parameters
30243  used for session negotiation.
30244
30245 .next
30246 Observability:
30247
30248  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30249  element.
30250
30251  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30252  have bits 0-4 indicating respectively
30253  support built, client requested ticket, client offered session,
30254  server issued ticket, resume used.  A suitable decode list is provided
30255  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30256
30257 .next
30258 Control:
30259
30260 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30261 exim, operating as a server, will offer resumption to clients.
30262 Current best practice is to not offer the feature to MUA connection.
30263 Commonly this can be done like this:
30264 .code
30265 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30266 .endd
30267 If the peer host matches the list after expansion then resumption
30268 is offered and/or accepted.
30269
30270 The &%tls_resumption_hosts%& smtp transport option performs the
30271 equivalent function for operation as a client.
30272 If the peer host matches the list after expansion then resumption
30273 is attempted (if a stored session is available) or the information
30274 stored (if supplied by the peer).
30275
30276
30277 .next
30278 Issues:
30279
30280  In a resumed session:
30281 .ilist
30282   The variables &$tls_{in,out}_cipher$& will have values different
30283  to the original (under GnuTLS).
30284 .next
30285   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30286  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30287 . XXX need to do something with that hosts_require_ocsp
30288 .endlist
30289
30290 .endlist
30291
30292
30293 .section DANE "SECDANE"
30294 .cindex DANE
30295 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30296 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30297 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30298 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30299 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30300 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30301
30302 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30303 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30304 by (a) is thought to be smaller than that of the set of root CAs.
30305
30306 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30307 fail to pass on a server's STARTTLS.
30308
30309 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30310 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30311 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30312
30313 DANE requires a server operator to do three things:
30314 .olist
30315 Run DNSSEC.  This provides assurance to clients
30316 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30317 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30318 DNSSEC.
30319 .next
30320 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30321 .next
30322 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30323 .endlist
30324
30325 There are no changes to Exim specific to server-side operation of DANE.
30326 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30327 in &_Local/Makefile_&.
30328 If it has been included, the macro "_HAVE_DANE" will be defined.
30329
30330 .subsection "DNS records"
30331 A TLSA record consist of 4 fields, the "Certificate Usage", the
30332 "Selector", the "Matching type", and the "Certificate Association Data".
30333 For a detailed description of the TLSA record see
30334 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30335
30336 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30337 These are the "Trust Anchor" and "End Entity" variants.
30338 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30339 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30340 this is appropriate for a single system, using a self-signed certificate.
30341 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30342 well-known one.
30343 A private CA at simplest is just a self-signed certificate (with certain
30344 attributes) which is used to sign server certificates, but running one securely
30345 does require careful arrangement.
30346 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30347 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30348 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30349 all of which point to a single TLSA record.
30350 DANE-TA and DANE-EE can both be used together.
30351
30352 Our recommendation is to use DANE with a certificate from a public CA,
30353 because this enables a variety of strategies for remote clients to verify
30354 your certificate.
30355 You can then publish information both via DANE and another technology,
30356 "MTA-STS", described below.
30357
30358 When you use DANE-TA to publish trust anchor information, you ask entities
30359 outside your administrative control to trust the Certificate Authority for
30360 connections to you.
30361 If using a private CA then you should expect others to still apply the
30362 technical criteria they'd use for a public CA to your certificates.
30363 In particular, you should probably try to follow current best practices for CA
30364 operation around hash algorithms and key sizes.
30365 Do not expect other organizations to lower their security expectations just
30366 because a particular profile might be reasonable for your own internal use.
30367
30368 When this text was last updated, this in practice means to avoid use of SHA-1
30369 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30370 than 4096, for interoperability); to use keyUsage fields correctly; to use
30371 random serial numbers.
30372 The list of requirements is subject to change as best practices evolve.
30373 If you're not already using a private CA, or it doesn't meet these
30374 requirements, then we encourage you to avoid all these issues and use a public
30375 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30376
30377 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30378 a "Matching Type" (3rd) field of SHA2-512(2).
30379
30380 For the "Certificate Authority Data" (4th) field, commands like
30381
30382 .code
30383   openssl x509 -pubkey -noout <certificate.pem \
30384   | openssl rsa -outform der -pubin 2>/dev/null \
30385   | openssl sha512 \
30386   | awk '{print $2}'
30387 .endd
30388
30389 are workable to create a hash of the certificate's public key.
30390
30391 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30392
30393 .code
30394   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30395 .endd
30396
30397 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30398 is useful for quickly generating TLSA records.
30399
30400
30401 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30402
30403 The Certificate issued by the CA published in the DANE-TA model should be
30404 issued using a strong hash algorithm.
30405 Exim, and importantly various other MTAs sending to you, will not
30406 re-enable hash algorithms which have been disabled by default in TLS
30407 libraries.
30408 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30409 interoperability (and probably the maximum too, in 2018).
30410
30411 .subsection "Interaction with OCSP"
30412 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30413 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30414 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30415
30416 .code
30417   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30418                                  {= {4}{$tls_out_tlsa_usage}} } \
30419                          {*}{}}
30420 .endd
30421
30422 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30423 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30424 found. If the definition of &%hosts_request_ocsp%& includes the
30425 string "tls_out_tlsa_usage", they are re-expanded in time to
30426 control the OCSP request.
30427
30428 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30429 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30430
30431
30432 .subsection "Client configuration"
30433 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30434 and &%dane_require_tls_ciphers%&.
30435 The &"require"& variant will result in failure if the target host is not
30436 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30437 the &%dnssec_request_domains%& router or transport option.
30438
30439 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30440
30441 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30442 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30443 will be required for the host.  If it does not, the host will not
30444 be used; there is no fallback to non-DANE or non-TLS.
30445
30446 If DANE is requested and usable, then the TLS cipher list configuration
30447 prefers to use the option &%dane_require_tls_ciphers%& and falls
30448 back to &%tls_require_ciphers%& only if that is unset.
30449 This lets you configure "decent crypto" for DANE and "better than nothing
30450 crypto" as the default.  Note though that while GnuTLS lets the string control
30451 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30452 limited to ciphersuite constraints.
30453
30454 If DANE is requested and useable (see above) the following transport options are ignored:
30455 .code
30456   hosts_require_tls
30457   tls_verify_hosts
30458   tls_try_verify_hosts
30459   tls_verify_certificates
30460   tls_crl
30461   tls_verify_cert_hostnames
30462   tls_sni
30463 .endd
30464
30465 If DANE is not usable, whether requested or not, and CA-anchored
30466 verification evaluation is wanted, the above variables should be set appropriately.
30467
30468 The router and transport option &%dnssec_request_domains%& must not be
30469 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30470
30471 .subsection Observability
30472 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30473
30474 There is a new variable &$tls_out_dane$& which will have "yes" if
30475 verification succeeded using DANE and "no" otherwise (only useful
30476 in combination with events; see &<<CHAPevents>>&),
30477 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30478
30479 .cindex DANE reporting
30480 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30481 to achieve DANE-verified connection, if one was either requested and offered, or
30482 required.  This is intended to support TLS-reporting as defined in
30483 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30484 The &$event_data$& will be one of the Result Types defined in
30485 Section 4.3 of that document.
30486
30487 .subsection General
30488 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30489
30490 DANE is specified in published RFCs and decouples certificate authority trust
30491 selection from a "race to the bottom" of "you must trust everything for mail
30492 to get through".
30493 There is an alternative technology called MTA-STS, which
30494 instead publishes MX trust anchor information on an HTTPS website.  At the
30495 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30496 Exim has no support for MTA-STS as a client, but Exim mail server operators
30497 can choose to publish information describing their TLS configuration using
30498 MTA-STS to let those clients who do use that protocol derive trust
30499 information.
30500
30501 The MTA-STS design requires a certificate from a public Certificate Authority
30502 which is recognized by clients sending to you.
30503 That selection of which CAs are trusted by others is outside your control.
30504
30505 The most interoperable course of action is probably to use
30506 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30507 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30508 records for DANE clients (such as Exim and Postfix) and to publish anchor
30509 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30510 domain itself (with caveats around occasionally broken MTA-STS because of
30511 incompatible specification changes prior to reaching RFC status).
30512
30513
30514
30515 . ////////////////////////////////////////////////////////////////////////////
30516 . ////////////////////////////////////////////////////////////////////////////
30517
30518 .chapter "Access control lists" "CHAPACL"
30519 .scindex IIDacl "&ACL;" "description"
30520 .cindex "control of incoming mail"
30521 .cindex "message" "controlling incoming"
30522 .cindex "policy control" "access control lists"
30523 Access Control Lists (ACLs) are defined in a separate section of the runtime
30524 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30525 name, terminated by a colon. Here is a complete ACL section that contains just
30526 one very small ACL:
30527 .code
30528 begin acl
30529 small_acl:
30530   accept   hosts = one.host.only
30531 .endd
30532 You can have as many lists as you like in the ACL section, and the order in
30533 which they appear does not matter. The lists are self-terminating.
30534
30535 The majority of ACLs are used to control Exim's behaviour when it receives
30536 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30537 when a local process submits a message using SMTP by specifying the &%-bs%&
30538 option. The most common use is for controlling which recipients are accepted
30539 in incoming messages. In addition, you can define an ACL that is used to check
30540 local non-SMTP messages. The default configuration file contains an example of
30541 a realistic ACL for checking RCPT commands. This is discussed in chapter
30542 &<<CHAPdefconfil>>&.
30543
30544
30545 .section "Testing ACLs" "SECID188"
30546 The &%-bh%& command line option provides a way of testing your ACL
30547 configuration locally by running a fake SMTP session with which you interact.
30548
30549
30550 .section "Specifying when ACLs are used" "SECID189"
30551 .cindex "&ACL;" "options for specifying"
30552 In order to cause an ACL to be used, you have to name it in one of the relevant
30553 options in the main part of the configuration. These options are:
30554 .cindex "AUTH" "ACL for"
30555 .cindex "DATA" "ACLs for"
30556 .cindex "ETRN" "ACL for"
30557 .cindex "EXPN" "ACL for"
30558 .cindex "HELO" "ACL for"
30559 .cindex "EHLO" "ACL for"
30560 .cindex "DKIM" "ACL for"
30561 .cindex "MAIL" "ACL for"
30562 .cindex "QUIT, ACL for"
30563 .cindex "RCPT" "ACL for"
30564 .cindex "STARTTLS, ACL for"
30565 .cindex "VRFY" "ACL for"
30566 .cindex "SMTP" "connection, ACL for"
30567 .cindex "non-SMTP messages" "ACLs for"
30568 .cindex "MIME content scanning" "ACL for"
30569 .cindex "PRDR" "ACL for"
30570
30571 .table2 140pt
30572 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30573 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30574 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30575 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30576 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30577 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30578 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30579 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30580 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30581 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30582 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30583 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30584 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30585 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30586 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30587 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30588 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30589 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30590 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30591 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30592 .endtable
30593
30594 For example, if you set
30595 .code
30596 acl_smtp_rcpt = small_acl
30597 .endd
30598 the little ACL defined above is used whenever Exim receives a RCPT command
30599 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30600 done when RCPT commands arrive. A rejection of RCPT should cause the
30601 sending MTA to give up on the recipient address contained in the RCPT
30602 command, whereas rejection at other times may cause the client MTA to keep on
30603 trying to deliver the message. It is therefore recommended that you do as much
30604 testing as possible at RCPT time.
30605
30606
30607 .subsection "The non-SMTP ACLs" SECID190
30608 .cindex "non-SMTP messages" "ACLs for"
30609 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30610 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30611 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30612 the state of the SMTP connection such as encryption and authentication) are not
30613 relevant and are forbidden in these ACLs. However, the sender and recipients
30614 are known, so the &%senders%& and &%sender_domains%& conditions and the
30615 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30616 &$authenticated_sender$& are also available. You can specify added header lines
30617 in any of these ACLs.
30618
30619 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30620 non-SMTP message, before any of the message has been read. (This is the
30621 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30622 batched SMTP input, it runs after the DATA command has been reached. The
30623 result of this ACL is ignored; it cannot be used to reject a message. If you
30624 really need to, you could set a value in an ACL variable here and reject based
30625 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30626 controls, and in particular, it can be used to set
30627 .code
30628 control = suppress_local_fixups
30629 .endd
30630 This cannot be used in the other non-SMTP ACLs because by the time they are
30631 run, it is too late.
30632
30633 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30634 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30635
30636 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30637 kind of rejection is treated as permanent, because there is no way of sending a
30638 temporary error for these kinds of message.
30639
30640
30641 .subsection "The SMTP connect ACL" SECID191
30642 .cindex "SMTP" "connection, ACL for"
30643 .oindex &%smtp_banner%&
30644 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30645 session, after the test specified by &%host_reject_connection%& (which is now
30646 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30647 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30648 the message override the banner message that is otherwise specified by the
30649 &%smtp_banner%& option.
30650
30651 .new
30652 For tls-on-connect connections, the ACL is run before the TLS connection
30653 is accepted; if the ACL does not accept then the TCP connection is dropped without
30654 any TLS startup attempt and without any SMTP response being transmitted.
30655 .wen
30656
30657
30658 .subsection "The EHLO/HELO ACL" SECID192
30659 .cindex "EHLO" "ACL for"
30660 .cindex "HELO" "ACL for"
30661 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30662 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30663 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30664 Note that a client may issue more than one EHLO or HELO command in an SMTP
30665 session, and indeed is required to issue a new EHLO or HELO after successfully
30666 setting up encryption following a STARTTLS command.
30667
30668 Note also that a deny neither forces the client to go away nor means that
30669 mail will be refused on the connection.  Consider checking for
30670 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30671
30672 If the command is accepted by an &%accept%& verb that has a &%message%&
30673 modifier, the message may not contain more than one line (it will be truncated
30674 at the first newline and a panic logged if it does). Such a message cannot
30675 affect the EHLO options that are listed on the second and subsequent lines of
30676 an EHLO response.
30677
30678
30679 .subsection "The DATA ACLs" SECID193
30680 .cindex "DATA" "ACLs for"
30681 Two ACLs are associated with the DATA command, because it is two-stage
30682 command, with two responses being sent to the client.
30683 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30684 is obeyed. This gives you control after all the RCPT commands, but before
30685 the message itself is received. It offers the opportunity to give a negative
30686 response to the DATA command before the data is transmitted. Header lines
30687 added by MAIL or RCPT ACLs are not visible at this time, but any that
30688 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30689
30690 You cannot test the contents of the message, for example, to verify addresses
30691 in the headers, at RCPT time or when the DATA command is received. Such
30692 tests have to appear in the ACL that is run after the message itself has been
30693 received, before the final response to the DATA command is sent. This is
30694 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30695 associated with the DATA command.
30696
30697 .cindex CHUNKING "BDAT command"
30698 .cindex BDAT "SMTP command"
30699 .cindex "RFC 3030" CHUNKING
30700 If CHUNKING was advertised and a BDAT command sequence is received,
30701 the &%acl_smtp_predata%& ACL is not run.
30702 . XXX why not?  It should be possible, for the first BDAT.
30703 The &%acl_smtp_data%& is run after the last BDAT command and all of
30704 the data specified is received.
30705
30706 For both of these ACLs, it is not possible to reject individual recipients. An
30707 error response rejects the entire message. Unfortunately, it is known that some
30708 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30709 before or after the data) correctly &-- they keep the message on their queues
30710 and try again later, but that is their problem, though it does waste some of
30711 your resources.
30712
30713 The &%acl_smtp_data%& ACL is run after
30714 the &%acl_smtp_data_prdr%&,
30715 the &%acl_smtp_dkim%&
30716 and the &%acl_smtp_mime%& ACLs.
30717
30718 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30719 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30720 enabled (which is the default).
30721
30722 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30723 received, and is executed for each DKIM signature found in a message.  If not
30724 otherwise specified, the default action is to accept.
30725
30726 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30727
30728 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30729
30730
30731 .subsection "The SMTP MIME ACL" SECID194
30732 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30733 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30734
30735 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30736
30737
30738 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30739 .cindex "PRDR" "ACL for"
30740 .oindex "&%prdr_enable%&"
30741 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30742 with PRDR support enabled (which is the default).
30743 It becomes active only when the PRDR feature is negotiated between
30744 client and server for a message, and more than one recipient
30745 has been accepted.
30746
30747 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30748 has been received, and is executed once for each recipient of the message
30749 with &$local_part$& and &$domain$& valid.
30750 The test may accept, defer or deny for individual recipients.
30751 The &%acl_smtp_data%& will still be called after this ACL and
30752 can reject the message overall, even if this ACL has accepted it
30753 for some or all recipients.
30754
30755 PRDR may be used to support per-user content filtering.  Without it
30756 one must defer any recipient after the first that has a different
30757 content-filter configuration.  With PRDR, the RCPT-time check
30758 .cindex "PRDR" "variable for"
30759 for this can be disabled when the variable &$prdr_requested$&
30760 is &"yes"&.
30761 Any required difference in behaviour of the main DATA-time
30762 ACL should however depend on the PRDR-time ACL having run, as Exim
30763 will avoid doing so in some situations (e.g. single-recipient mails).
30764
30765 See also the &%prdr_enable%& global option
30766 and the &%hosts_try_prdr%& smtp transport option.
30767
30768 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30769 If the ACL is not defined, processing completes as if
30770 the feature was not requested by the client.
30771
30772 .subsection "The QUIT ACL" SECTQUITACL
30773 .cindex "QUIT, ACL for"
30774 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30775 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30776 does not in fact control any access.
30777 For this reason, it may only accept
30778 or warn as its final result.
30779
30780 This ACL can be used for tasks such as custom logging at the end of an SMTP
30781 session. For example, you can use ACL variables in other ACLs to count
30782 messages, recipients, etc., and log the totals at QUIT time using one or
30783 more &%logwrite%& modifiers on a &%warn%& verb.
30784
30785 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30786 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30787
30788 You do not need to have a final &%accept%&, but if you do, you can use a
30789 &%message%& modifier to specify custom text that is sent as part of the 221
30790 response to QUIT.
30791
30792 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30793 failure (for example, failure to open a log file, or when Exim is bombing out
30794 because it has detected an unrecoverable error), all SMTP commands from the
30795 client are given temporary error responses until QUIT is received or the
30796 connection is closed. In these special cases, the QUIT ACL does not run.
30797
30798
30799 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30800 .vindex &$acl_smtp_notquit$&
30801 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30802 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30803 trouble, such as being unable to write to its log files, this ACL is not run,
30804 because it might try to do things (such as write to log files) that make the
30805 situation even worse.
30806
30807 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30808 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30809 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30810 and &%warn%&.
30811
30812 .vindex &$smtp_notquit_reason$&
30813 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30814 to a string that indicates the reason for the termination of the SMTP
30815 connection. The possible values are:
30816 .table2
30817 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30818 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30819 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30820 .irow &`connection-lost`&          "The SMTP connection has been lost"
30821 .irow &`data-timeout`&             "Timeout while reading message data"
30822 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30823 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30824 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30825 .irow &`synchronization-error`&    "SMTP synchronization error"
30826 .irow &`tls-failed`&               "TLS failed to start"
30827 .endtable
30828 In most cases when an SMTP connection is closed without having received QUIT,
30829 Exim sends an SMTP response message before actually closing the connection.
30830 With the exception of the &`acl-drop`& case, the default message can be
30831 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30832 &%drop%& verb in another ACL, it is the message from the other ACL that is
30833 used.
30834
30835
30836 .section "Finding an ACL to use" "SECID195"
30837 .cindex "&ACL;" "finding which to use"
30838 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30839 you can use different ACLs in different circumstances. For example,
30840 .code
30841 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30842                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30843 .endd
30844 In the default configuration file there are some example settings for
30845 providing an RFC 4409 message &"submission"& service on port 587 and
30846 an RFC 8314 &"submissions"& service on port 465. You can use a string
30847 expansion like this to choose an ACL for MUAs on these ports which is
30848 more appropriate for this purpose than the default ACL on port 25.
30849
30850 The expanded string does not have to be the name of an ACL in the
30851 configuration file; there are other possibilities. Having expanded the
30852 string, Exim searches for an ACL as follows:
30853
30854 .ilist
30855 If the string begins with a slash, Exim uses it as a filename, and reads its
30856 contents as an ACL. The lines are processed in the same way as lines in the
30857 Exim configuration file. In particular, continuation lines are supported, blank
30858 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30859 If the file does not exist or cannot be read, an error occurs (typically
30860 causing a temporary failure of whatever caused the ACL to be run). For example:
30861 .code
30862 acl_smtp_data = /etc/acls/\
30863   ${lookup{$sender_host_address}lsearch\
30864   {/etc/acllist}{$value}{default}}
30865 .endd
30866 This looks up an ACL file to use on the basis of the host's IP address, falling
30867 back to a default if the lookup fails. If an ACL is successfully read from a
30868 file, it is retained in memory for the duration of the Exim process, so that it
30869 can be re-used without having to re-read the file.
30870 .next
30871 If the string does not start with a slash, and does not contain any spaces,
30872 Exim searches the ACL section of the configuration for an ACL whose name
30873 matches the string.
30874 .next
30875 If no named ACL is found, or if the string contains spaces, Exim parses
30876 the string as an inline ACL. This can save typing in cases where you just
30877 want to have something like
30878 .code
30879 acl_smtp_vrfy = accept
30880 .endd
30881 in order to allow free use of the VRFY command. Such a string may contain
30882 newlines; it is processed in the same way as an ACL that is read from a file.
30883 .endlist
30884
30885
30886
30887
30888 .section "ACL return codes" "SECID196"
30889 .cindex "&ACL;" "return codes"
30890 Except for the QUIT ACL, which does not affect the SMTP return code (see
30891 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30892 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30893 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30894 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30895 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30896 This also causes a 4&'xx'& return code.
30897
30898 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30899 &"deny"&, because there is no mechanism for passing temporary errors to the
30900 submitters of non-SMTP messages.
30901
30902
30903 ACLs that are relevant to message reception may also return &"discard"&. This
30904 has the effect of &"accept"&, but causes either the entire message or an
30905 individual recipient address to be discarded. In other words, it is a
30906 blackholing facility. Use it with care.
30907
30908 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30909 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30910 RCPT ACL is to discard just the one recipient address. If there are no
30911 recipients left when the message's data is received, the DATA ACL is not
30912 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30913 remaining recipients. The &"discard"& return is not permitted for the
30914 &%acl_smtp_predata%& ACL.
30915
30916 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30917 is done on the address and the result determines the SMTP response.
30918
30919
30920 .cindex "&[local_scan()]& function" "when all recipients discarded"
30921 The &[local_scan()]& function is always run, even if there are no remaining
30922 recipients; it may create new recipients.
30923
30924
30925
30926 .section "Unset ACL options" "SECID197"
30927 .cindex "&ACL;" "unset options"
30928 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30929 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30930 not defined at all. For any defined ACL, the default action when control
30931 reaches the end of the ACL statements is &"deny"&.
30932
30933 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30934 these two are ACLs that are used only for their side effects. They cannot be
30935 used to accept or reject anything.
30936
30937 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30938 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30939 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30940 when the ACL is not defined is &"accept"&.
30941
30942 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30943 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30944 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30945 messages over an SMTP connection. For an example, see the ACL in the default
30946 configuration file.
30947
30948
30949
30950
30951 .section "Data for message ACLs" "SECID198"
30952 .cindex "&ACL;" "data for message ACL"
30953 .vindex &$domain$&
30954 .vindex &$local_part$&
30955 .vindex &$sender_address$&
30956 .vindex &$sender_host_address$&
30957 .vindex &$smtp_command$&
30958 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30959 that contain information about the host and the message's sender (for example,
30960 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30961 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30962 &$local_part$& are set from the argument address. The entire SMTP command
30963 is available in &$smtp_command$&.
30964
30965 When an ACL for the AUTH parameter of MAIL is running, the variables that
30966 contain information about the host are set, but &$sender_address$& is not yet
30967 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30968 how it is used.
30969
30970 .vindex "&$message_size$&"
30971 The &$message_size$& variable is set to the value of the SIZE parameter on
30972 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30973 that parameter is not given. The value is updated to the true message size by
30974 the time the final DATA ACL is run (after the message data has been
30975 received).
30976
30977 .vindex "&$rcpt_count$&"
30978 .vindex "&$recipients_count$&"
30979 The &$rcpt_count$& variable increases by one for each RCPT command received.
30980 The &$recipients_count$& variable increases by one each time a RCPT command is
30981 accepted, so while an ACL for RCPT is being processed, it contains the number
30982 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30983 &$rcpt_count$& contains the total number of RCPT commands, and
30984 &$recipients_count$& contains the total number of accepted recipients.
30985
30986
30987
30988
30989
30990 .section "Data for non-message ACLs" "SECTdatfornon"
30991 .cindex "&ACL;" "data for non-message ACL"
30992 .vindex &$smtp_command_argument$&
30993 .vindex &$smtp_command$&
30994 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30995 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30996 and the entire SMTP command is available in &$smtp_command$&.
30997 These variables can be tested using a &%condition%& condition. For example,
30998 here is an ACL for use with AUTH, which insists that either the session is
30999 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
31000 does not permit authentication methods that use cleartext passwords on
31001 unencrypted connections.
31002 .code
31003 acl_check_auth:
31004   accept encrypted = *
31005   accept condition = ${if eq{${uc:$smtp_command_argument}}\
31006                      {CRAM-MD5}}
31007   deny   message   = TLS encryption or CRAM-MD5 required
31008 .endd
31009 (Another way of applying this restriction is to arrange for the authenticators
31010 that use cleartext passwords not to be advertised when the connection is not
31011 encrypted. You can use the generic &%server_advertise_condition%& authenticator
31012 option to do this.)
31013
31014
31015
31016 .section "Format of an ACL" "SECID199"
31017 .cindex "&ACL;" "format of"
31018 .cindex "&ACL;" "verbs, definition of"
31019 An individual ACL consists of a number of statements. Each statement starts
31020 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31021 Modifiers can change the way the verb operates, define error and log messages,
31022 set variables, insert delays, and vary the processing of accepted messages.
31023
31024 If all the conditions are met, the verb is obeyed. The same condition may be
31025 used (with different arguments) more than once in the same statement. This
31026 provides a means of specifying an &"and"& conjunction between conditions. For
31027 example:
31028 .code
31029 deny  dnslists = list1.example
31030       dnslists = list2.example
31031 .endd
31032 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31033 the conditions and modifiers when it reaches a condition that fails. What
31034 happens then depends on the verb (and in one case, on a special modifier). Not
31035 all the conditions make sense at every testing point. For example, you cannot
31036 test a sender address in the ACL that is run for a VRFY command.
31037
31038
31039 .section "ACL verbs" "SECID200"
31040 The ACL verbs are as follows:
31041
31042 .ilist
31043 .cindex "&%accept%& ACL verb"
31044 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31045 of the conditions are not met, what happens depends on whether &%endpass%&
31046 appears among the conditions (for syntax see below). If the failing condition
31047 is before &%endpass%&, control is passed to the next ACL statement; if it is
31048 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31049 check a RCPT command:
31050 .code
31051 accept domains = +local_domains
31052        endpass
31053        verify = recipient
31054 .endd
31055 If the recipient domain does not match the &%domains%& condition, control
31056 passes to the next statement. If it does match, the recipient is verified, and
31057 the command is accepted if verification succeeds. However, if verification
31058 fails, the ACL yields &"deny"&, because the failing condition is after
31059 &%endpass%&.
31060
31061 The &%endpass%& feature has turned out to be confusing to many people, so its
31062 use is not recommended nowadays. It is always possible to rewrite an ACL so
31063 that &%endpass%& is not needed, and it is no longer used in the default
31064 configuration.
31065
31066 .cindex "&%message%& ACL modifier" "with &%accept%&"
31067 If a &%message%& modifier appears on an &%accept%& statement, its action
31068 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31069 (when an &%accept%& verb either accepts or passes control to the next
31070 statement), &%message%& can be used to vary the message that is sent when an
31071 SMTP command is accepted. For example, in a RCPT ACL you could have:
31072 .display
31073 &`accept  `&<&'some conditions'&>
31074 &`        message = OK, I will allow you through today`&
31075 .endd
31076 You can specify an SMTP response code, optionally followed by an &"extended
31077 response code"& at the start of the message, but the first digit must be the
31078 same as would be sent by default, which is 2 for an &%accept%& verb.
31079
31080 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31081 an error message that is used when access is denied. This behaviour is retained
31082 for backward compatibility, but current &"best practice"& is to avoid the use
31083 of &%endpass%&.
31084
31085
31086 .next
31087 .cindex "&%defer%& ACL verb"
31088 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31089 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31090 &%defer%& is the same as &%deny%&, because there is no way of sending a
31091 temporary error. For a RCPT command, &%defer%& is much the same as using a
31092 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31093 be used in any ACL, and even for a recipient it might be a simpler approach.
31094
31095
31096 .next
31097 .cindex "&%deny%& ACL verb"
31098 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31099 the conditions are not met, control is passed to the next ACL statement. For
31100 example,
31101 .code
31102 deny dnslists = blackholes.mail-abuse.org
31103 .endd
31104 rejects commands from hosts that are on a DNS black list.
31105
31106
31107 .next
31108 .cindex "&%discard%& ACL verb"
31109 &%discard%&: This verb behaves like &%accept%&, except that it returns
31110 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31111 that are concerned with receiving messages. When all the conditions are true,
31112 the sending entity receives a &"success"& response. However, &%discard%& causes
31113 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31114 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31115 message's recipients are discarded. Recipients that are discarded before DATA
31116 do not appear in the log line when the &%received_recipients%& log selector is set.
31117
31118 If the &%log_message%& modifier is set when &%discard%& operates,
31119 its contents are added to the line that is automatically written to the log.
31120 The &%message%& modifier operates exactly as it does for &%accept%&.
31121
31122
31123 .next
31124 .cindex "&%drop%& ACL verb"
31125 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31126 forcibly closed after the 5&'xx'& error message has been sent. For example:
31127 .code
31128 drop   condition = ${if > {$rcpt_count}{20}}
31129        message   = I don't take more than 20 RCPTs
31130 .endd
31131 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31132 The connection is always dropped after sending a 550 response.
31133
31134 .next
31135 .cindex "&%require%& ACL verb"
31136 &%require%&: If all the conditions are met, control is passed to the next ACL
31137 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31138 example, when checking a RCPT command,
31139 .code
31140 require message = Sender did not verify
31141         verify  = sender
31142 .endd
31143 passes control to subsequent statements only if the message's sender can be
31144 verified. Otherwise, it rejects the command. Note the positioning of the
31145 &%message%& modifier, before the &%verify%& condition. The reason for this is
31146 discussed in section &<<SECTcondmodproc>>&.
31147
31148 .next
31149 .cindex "&%warn%& ACL verb"
31150 &%warn%&: If all the conditions are true, a line specified by the
31151 &%log_message%& modifier is written to Exim's main log. Control always passes
31152 to the next ACL statement. If any condition is false, the log line is not
31153 written. If an identical log line is requested several times in the same
31154 message, only one copy is actually written to the log. If you want to force
31155 duplicates to be written, use the &%logwrite%& modifier instead.
31156
31157 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31158 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31159 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31160 first failing condition. There is more about adding header lines in section
31161 &<<SECTaddheadacl>>&.
31162
31163 If any condition on a &%warn%& statement cannot be completed (that is, there is
31164 some sort of defer), the log line specified by &%log_message%& is not written.
31165 This does not include the case of a forced failure from a lookup, which
31166 is considered to be a successful completion. After a defer, no further
31167 conditions or modifiers in the &%warn%& statement are processed. The incident
31168 is logged, and the ACL continues to be processed, from the next statement
31169 onwards.
31170
31171
31172 .vindex "&$acl_verify_message$&"
31173 When one of the &%warn%& conditions is an address verification that fails, the
31174 text of the verification failure message is in &$acl_verify_message$&. If you
31175 want this logged, you must set it up explicitly. For example:
31176 .code
31177 warn   !verify = sender
31178        log_message = sender verify failed: $acl_verify_message
31179 .endd
31180 .endlist
31181
31182 At the end of each ACL there is an implicit unconditional &%deny%&.
31183
31184 As you can see from the examples above, the conditions and modifiers are
31185 written one to a line, with the first one on the same line as the verb, and
31186 subsequent ones on following lines. If you have a very long condition, you can
31187 continue it onto several physical lines by the usual backslash continuation
31188 mechanism. It is conventional to align the conditions vertically.
31189
31190
31191
31192 .section "ACL variables" "SECTaclvariables"
31193 .cindex "&ACL;" "variables"
31194 There are some special variables that can be set during ACL processing. They
31195 can be used to pass information between different ACLs, different invocations
31196 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31197 transports, and filters that are used to deliver a message. The names of these
31198 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31199 an underscore, but the remainder of the name can be any sequence of
31200 alphanumeric characters and underscores that you choose. There is no limit on
31201 the number of ACL variables. The two sets act as follows:
31202 .ilist
31203 The values of those variables whose names begin with &$acl_c$& persist
31204 throughout an SMTP connection. They are never reset. Thus, a value that is set
31205 while receiving one message is still available when receiving the next message
31206 on the same SMTP connection.
31207 .next
31208 The values of those variables whose names begin with &$acl_m$& persist only
31209 while a message is being received. They are reset afterwards. They are also
31210 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31211 .endlist
31212
31213 When a message is accepted, the current values of all the ACL variables are
31214 preserved with the message and are subsequently made available at delivery
31215 time. The ACL variables are set by a modifier called &%set%&. For example:
31216 .code
31217 accept hosts = whatever
31218        set acl_m4 = some value
31219 accept authenticated = *
31220        set acl_c_auth = yes
31221 .endd
31222 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31223 be set. If you want to set a variable without taking any action, you can use a
31224 &%warn%& verb without any other modifiers or conditions.
31225
31226 .oindex &%strict_acl_vars%&
31227 What happens if a syntactically valid but undefined ACL variable is
31228 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31229 false (the default), an empty string is substituted; if it is true, an
31230 error is generated.
31231
31232 Versions of Exim before 4.64 have a limited set of numbered variables, but
31233 their names are compatible, so there is no problem with upgrading.
31234
31235
31236 .section "Condition and modifier processing" "SECTcondmodproc"
31237 .cindex "&ACL;" "conditions; processing"
31238 .cindex "&ACL;" "modifiers; processing"
31239 An exclamation mark preceding a condition negates its result. For example:
31240 .code
31241 deny   domains = *.dom.example
31242       !verify  = recipient
31243 .endd
31244 causes the ACL to return &"deny"& if the recipient domain ends in
31245 &'dom.example'& and the recipient address cannot be verified. Sometimes
31246 negation can be used on the right-hand side of a condition. For example, these
31247 two statements are equivalent:
31248 .code
31249 deny  hosts = !192.168.3.4
31250 deny !hosts =  192.168.3.4
31251 .endd
31252 However, for many conditions (&%verify%& being a good example), only left-hand
31253 side negation of the whole condition is possible.
31254
31255 The arguments of conditions and modifiers are expanded. A forced failure
31256 of an expansion causes a condition to be ignored, that is, it behaves as if the
31257 condition is true. Consider these two statements:
31258 .code
31259 accept  senders = ${lookup{$host_name}lsearch\
31260                   {/some/file}{$value}fail}
31261 accept  senders = ${lookup{$host_name}lsearch\
31262                   {/some/file}{$value}{}}
31263 .endd
31264 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31265 the returned list is searched, but if the lookup fails the behaviour is
31266 different in the two cases. The &%fail%& in the first statement causes the
31267 condition to be ignored, leaving no further conditions. The &%accept%& verb
31268 therefore succeeds. The second statement, however, generates an empty list when
31269 the lookup fails. No sender can match an empty list, so the condition fails,
31270 and therefore the &%accept%& also fails.
31271
31272 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31273 specify actions that are taken as the conditions for a statement are checked;
31274 others specify text for messages that are used when access is denied or a
31275 warning is generated. The &%control%& modifier affects the way an incoming
31276 message is handled.
31277
31278 The positioning of the modifiers in an ACL statement is important, because the
31279 processing of a verb ceases as soon as its outcome is known. Only those
31280 modifiers that have already been encountered will take effect. For example,
31281 consider this use of the &%message%& modifier:
31282 .code
31283 require message = Can't verify sender
31284         verify  = sender
31285         message = Can't verify recipient
31286         verify  = recipient
31287         message = This message cannot be used
31288 .endd
31289 If sender verification fails, Exim knows that the result of the statement is
31290 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31291 so its text is used as the error message. If sender verification succeeds, but
31292 recipient verification fails, the second message is used. If recipient
31293 verification succeeds, the third message becomes &"current"&, but is never used
31294 because there are no more conditions to cause failure.
31295
31296 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31297 modifier that is used, because all the conditions must be true for rejection to
31298 happen. Specifying more than one &%message%& modifier does not make sense, and
31299 the message can even be specified after all the conditions. For example:
31300 .code
31301 deny   hosts = ...
31302       !senders = *@my.domain.example
31303        message = Invalid sender from client host
31304 .endd
31305 The &"deny"& result does not happen until the end of the statement is reached,
31306 by which time Exim has set up the message.
31307
31308
31309
31310 .section "ACL modifiers" "SECTACLmodi"
31311 .cindex "&ACL;" "modifiers; list of"
31312 The ACL modifiers are as follows:
31313
31314 .vlist
31315 .vitem &*add_header*&&~=&~<&'text'&>
31316 This modifier specifies one or more header lines that are to be added to an
31317 incoming message, assuming, of course, that the message is ultimately
31318 accepted. For details, see section &<<SECTaddheadacl>>&.
31319
31320 .vitem &*continue*&&~=&~<&'text'&>
31321 .cindex "&%continue%& ACL modifier"
31322 .cindex "database" "updating in ACL"
31323 This modifier does nothing of itself, and processing of the ACL always
31324 continues with the next condition or modifier. The value of &%continue%& is in
31325 the side effects of expanding its argument. Typically this could be used to
31326 update a database. It is really just a syntactic tidiness, to avoid having to
31327 write rather ugly lines like this:
31328 .display
31329 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31330 .endd
31331 Instead, all you need is
31332 .display
31333 &`continue = `&<&'some expansion'&>
31334 .endd
31335
31336 .vitem &*control*&&~=&~<&'text'&>
31337 .cindex "&%control%& ACL modifier"
31338 This modifier affects the subsequent processing of the SMTP connection or of an
31339 incoming message that is accepted. The effect of the first type of control
31340 lasts for the duration of the connection, whereas the effect of the second type
31341 lasts only until the current message has been received. The message-specific
31342 controls always apply to the whole message, not to individual recipients,
31343 even if the &%control%& modifier appears in a RCPT ACL.
31344
31345 As there are now quite a few controls that can be applied, they are described
31346 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31347 in several different ways. For example:
31348
31349 . ==== As this is a nested list, any displays it contains must be indented
31350 . ==== as otherwise they are too far to the left. That comment applies only
31351 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31352 . ==== way.
31353
31354 .ilist
31355 It can be at the end of an &%accept%& statement:
31356 .code
31357     accept  ...some conditions
31358             control = queue
31359 .endd
31360 In this case, the control is applied when this statement yields &"accept"&, in
31361 other words, when the conditions are all true.
31362
31363 .next
31364 It can be in the middle of an &%accept%& statement:
31365 .code
31366     accept  ...some conditions...
31367             control = queue
31368             ...some more conditions...
31369 .endd
31370 If the first set of conditions are true, the control is applied, even if the
31371 statement does not accept because one of the second set of conditions is false.
31372 In this case, some subsequent statement must yield &"accept"& for the control
31373 to be relevant.
31374
31375 .next
31376 It can be used with &%warn%& to apply the control, leaving the
31377 decision about accepting or denying to a subsequent verb. For
31378 example:
31379 .code
31380     warn    ...some conditions...
31381             control = freeze
31382     accept  ...
31383 .endd
31384 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31385 &%logwrite%&, so it does not add anything to the message and does not write a
31386 log entry.
31387
31388 .next
31389 If you want to apply a control unconditionally, you can use it with a
31390 &%require%& verb. For example:
31391 .code
31392     require  control = no_multiline_responses
31393 .endd
31394 .endlist
31395
31396 .vitem &*delay*&&~=&~<&'time'&>
31397 .cindex "&%delay%& ACL modifier"
31398 .oindex "&%-bh%&"
31399 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31400 the time interval before proceeding. However, when testing Exim using the
31401 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31402 output instead). The time is given in the usual Exim notation, and the delay
31403 happens as soon as the modifier is processed. In an SMTP session, pending
31404 output is flushed before the delay is imposed.
31405
31406 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31407 example:
31408 .code
31409 deny    ...some conditions...
31410         delay = 30s
31411 .endd
31412 The delay happens if all the conditions are true, before the statement returns
31413 &"deny"&. Compare this with:
31414 .code
31415 deny    delay = 30s
31416         ...some conditions...
31417 .endd
31418 which waits for 30s before processing the conditions. The &%delay%& modifier
31419 can also be used with &%warn%& and together with &%control%&:
31420 .code
31421 warn    ...some conditions...
31422         delay = 2m
31423         control = freeze
31424 accept  ...
31425 .endd
31426
31427 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31428 responses to several commands are no longer buffered and sent in one packet (as
31429 they would normally be) because all output is flushed before imposing the
31430 delay. This optimization is disabled so that a number of small delays do not
31431 appear to the client as one large aggregated delay that might provoke an
31432 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31433 using a &%control%& modifier to set &%no_delay_flush%&.
31434
31435
31436 .vitem &*endpass*&
31437 .cindex "&%endpass%& ACL modifier"
31438 This modifier, which has no argument, is recognized only in &%accept%& and
31439 &%discard%& statements. It marks the boundary between the conditions whose
31440 failure causes control to pass to the next statement, and the conditions whose
31441 failure causes the ACL to return &"deny"&. This concept has proved to be
31442 confusing to some people, so the use of &%endpass%& is no longer recommended as
31443 &"best practice"&. See the description of &%accept%& above for more details.
31444
31445
31446 .vitem &*log_message*&&~=&~<&'text'&>
31447 .cindex "&%log_message%& ACL modifier"
31448 This modifier sets up a message that is used as part of the log message if the
31449 ACL denies access or a &%warn%& statement's conditions are true. For example:
31450 .code
31451 require log_message = wrong cipher suite $tls_in_cipher
31452         encrypted   = DES-CBC3-SHA
31453 .endd
31454 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31455 example:
31456 .display
31457 &`discard `&<&'some conditions'&>
31458 &`        log_message = Discarded $local_part@$domain because...`&
31459 .endd
31460 When access is denied, &%log_message%& adds to any underlying error message
31461 that may exist because of a condition failure. For example, while verifying a
31462 recipient address, a &':fail:'& redirection might have already set up a
31463 message.
31464
31465 The message may be defined before the conditions to which it applies, because
31466 the string expansion does not happen until Exim decides that access is to be
31467 denied. This means that any variables that are set by the condition are
31468 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31469 variables are set after a DNS black list lookup succeeds. If the expansion of
31470 &%log_message%& fails, or if the result is an empty string, the modifier is
31471 ignored.
31472
31473 .vindex "&$acl_verify_message$&"
31474 If you want to use a &%warn%& statement to log the result of an address
31475 verification, you can use &$acl_verify_message$& to include the verification
31476 error message.
31477
31478 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31479 the start of the logged message. If the same warning log message is requested
31480 more than once while receiving  a single email message, only one copy is
31481 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31482 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31483 is logged for a successful &%warn%& statement.
31484
31485 If &%log_message%& is not present and there is no underlying error message (for
31486 example, from the failure of address verification), but &%message%& is present,
31487 the &%message%& text is used for logging rejections. However, if any text for
31488 logging contains newlines, only the first line is logged. In the absence of
31489 both &%log_message%& and &%message%&, a default built-in message is used for
31490 logging rejections.
31491
31492
31493 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31494 .cindex "&%log_reject_target%& ACL modifier"
31495 .cindex "logging in ACL" "specifying which log"
31496 This modifier makes it possible to specify which logs are used for messages
31497 about ACL rejections. Its argument is a colon-separated list of words that can
31498 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31499 may be empty, in which case a rejection is not logged at all. For example, this
31500 ACL fragment writes no logging information when access is denied:
31501 .display
31502 &`deny `&<&'some conditions'&>
31503 &`     log_reject_target =`&
31504 .endd
31505 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31506 permanent and temporary rejections. Its effect lasts for the rest of the
31507 current ACL.
31508
31509
31510 .vitem &*logwrite*&&~=&~<&'text'&>
31511 .cindex "&%logwrite%& ACL modifier"
31512 .cindex "logging in ACL" "immediate"
31513 This modifier writes a message to a log file as soon as it is encountered when
31514 processing an ACL. (Compare &%log_message%&, which, except in the case of
31515 &%warn%& and &%discard%&, is used only if the ACL statement denies
31516 access.) The &%logwrite%& modifier can be used to log special incidents in
31517 ACLs. For example:
31518 .display
31519 &`accept `&<&'some special conditions'&>
31520 &`       control  = freeze`&
31521 &`       logwrite = froze message because ...`&
31522 .endd
31523 By default, the message is written to the main log. However, it may begin
31524 with a colon, followed by a comma-separated list of log names, and then
31525 another colon, to specify exactly which logs are to be written. For
31526 example:
31527 .code
31528 logwrite = :main,reject: text for main and reject logs
31529 logwrite = :panic: text for panic log only
31530 .endd
31531
31532
31533 .vitem &*message*&&~=&~<&'text'&>
31534 .cindex "&%message%& ACL modifier"
31535 This modifier sets up a text string that is expanded and used as a response
31536 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31537 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31538 there is some complication if &%endpass%& is involved; see the description of
31539 &%accept%& for details.)
31540
31541 The expansion of the message happens at the time Exim decides that the ACL is
31542 to end, not at the time it processes &%message%&. If the expansion fails, or
31543 generates an empty string, the modifier is ignored. Here is an example where
31544 &%message%& must be specified first, because the ACL ends with a rejection if
31545 the &%hosts%& condition fails:
31546 .code
31547 require  message = Host not recognized
31548          hosts = 10.0.0.0/8
31549 .endd
31550 (Once a condition has failed, no further conditions or modifiers are
31551 processed.)
31552
31553 .cindex "SMTP" "error codes"
31554 .oindex "&%smtp_banner%&
31555 For ACLs that are triggered by SMTP commands, the message is returned as part
31556 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31557 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31558 is accepted. In the case of the connect ACL, accepting with a message modifier
31559 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31560 accept message may not contain more than one line (otherwise it will be
31561 truncated at the first newline and a panic logged), and it cannot affect the
31562 EHLO options.
31563
31564 When SMTP is involved, the message may begin with an overriding response code,
31565 consisting of three digits optionally followed by an &"extended response code"&
31566 of the form &'n.n.n'&, each code being followed by a space. For example:
31567 .code
31568 deny  message = 599 1.2.3 Host not welcome
31569       hosts = 192.168.34.0/24
31570 .endd
31571 The first digit of the supplied response code must be the same as would be sent
31572 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31573 access, but for the predata ACL, note that the default success code is 354, not
31574 2&'xx'&.
31575
31576 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31577 the message modifier cannot override the 221 response code.
31578
31579 The text in a &%message%& modifier is literal; any quotes are taken as
31580 literals, but because the string is expanded, backslash escapes are processed
31581 anyway.
31582 If the message contains newlines, this gives rise to a multi-line SMTP
31583 response.
31584 A long message line will also be split into multi-line SMTP responses,
31585 on word boundaries if possible.
31586
31587 .vindex "&$acl_verify_message$&"
31588 While the text is being expanded, the &$acl_verify_message$& variable
31589 contains any message previously set.
31590 Afterwards, &$acl_verify_message$& is cleared.
31591
31592 If &%message%& is used on a statement that verifies an address, the message
31593 specified overrides any message that is generated by the verification process.
31594 However, the original message is available in the variable
31595 &$acl_verify_message$&, so you can incorporate it into your message if you
31596 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31597 routers to be passed back as part of the SMTP response, you should either not
31598 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31599
31600 For compatibility with previous releases of Exim, a &%message%& modifier that
31601 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31602 modifier, but this usage is now deprecated. However, &%message%& acts only when
31603 all the conditions are true, wherever it appears in an ACL command, whereas
31604 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31605 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31606 effect.
31607
31608
31609 .vitem &*queue*&&~=&~<&'text'&>
31610 .cindex "&%queue%& ACL modifier"
31611 .cindex "named queues" "selecting in ACL"
31612 This modifier specifies the use of a named queue for spool files
31613 for the message.
31614 It can only be used before the message is received (i.e. not in
31615 the DATA ACL).
31616 This could be used, for example, for known high-volume burst sources
31617 of traffic, or for quarantine of messages.
31618 Separate queue-runner processes will be needed for named queues.
31619 If the text after expansion is empty, the default queue is used.
31620
31621
31622 .vitem &*remove_header*&&~=&~<&'text'&>
31623 This modifier specifies one or more header names in a colon-separated list
31624  that are to be removed from an incoming message, assuming, of course, that
31625 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31626
31627
31628 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31629 .cindex "&%set%& ACL modifier"
31630 This modifier puts a value into one of the ACL variables (see section
31631 &<<SECTaclvariables>>&).
31632
31633
31634 .vitem &*udpsend*&&~=&~<&'parameters'&>
31635 .cindex "UDP communications"
31636 This modifier sends a UDP packet, for purposes such as statistics
31637 collection or behaviour monitoring. The parameters are expanded, and
31638 the result of the expansion must be a colon-separated list consisting
31639 of a destination server, port number, and the packet contents. The
31640 server can be specified as a host name or IPv4 or IPv6 address. The
31641 separator can be changed with the usual angle bracket syntax. For
31642 example, you might want to collect information on which hosts connect
31643 when:
31644 .code
31645 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31646              $tod_zulu $sender_host_address
31647 .endd
31648 .endlist
31649
31650
31651
31652
31653 .section "Use of the control modifier" "SECTcontrols"
31654 .cindex "&%control%& ACL modifier"
31655 The &%control%& modifier supports the following settings:
31656
31657 .vlist
31658 .vitem &*control&~=&~allow_auth_unadvertised*&
31659 This modifier allows a client host to use the SMTP AUTH command even when it
31660 has not been advertised in response to EHLO. Furthermore, because there are
31661 apparently some really broken clients that do this, Exim will accept AUTH after
31662 HELO (rather than EHLO) when this control is set. It should be used only if you
31663 really need it, and you should limit its use to those broken clients that do
31664 not work without it. For example:
31665 .code
31666 warn hosts   = 192.168.34.25
31667      control = allow_auth_unadvertised
31668 .endd
31669 Normally, when an Exim server receives an AUTH command, it checks the name of
31670 the authentication mechanism that is given in the command to ensure that it
31671 matches an advertised mechanism. When this control is set, the check that a
31672 mechanism has been advertised is bypassed. Any configured mechanism can be used
31673 by the client. This control is permitted only in the connection and HELO ACLs.
31674
31675
31676 .vitem &*control&~=&~caseful_local_part*& &&&
31677        &*control&~=&~caselower_local_part*&
31678 .cindex "&ACL;" "case of local part in"
31679 .cindex "case of local parts"
31680 .vindex "&$local_part$&"
31681 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31682 (that is, during RCPT processing). By default, the contents of &$local_part$&
31683 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31684 any uppercase letters in the original local part are restored in &$local_part$&
31685 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31686 is encountered.
31687
31688 These controls affect only the current recipient. Moreover, they apply only to
31689 local part handling that takes place directly in the ACL (for example, as a key
31690 in lookups). If a test to verify the recipient is obeyed, the case-related
31691 handling of the local part during the verification is controlled by the router
31692 configuration (see the &%caseful_local_part%& generic router option).
31693
31694 This facility could be used, for example, to add a spam score to local parts
31695 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31696 spam score:
31697 .code
31698 warn  control = caseful_local_part
31699       set acl_m4 = ${eval:\
31700                      $acl_m4 + \
31701                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31702                     }
31703       control = caselower_local_part
31704 .endd
31705 Notice that we put back the lower cased version afterwards, assuming that
31706 is what is wanted for subsequent tests.
31707
31708
31709 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31710 .cindex "&ACL;" "cutthrough routing"
31711 .cindex "cutthrough" "requesting"
31712 This option requests delivery be attempted while the item is being received.
31713
31714 The option is usable in the RCPT ACL.
31715 If enabled for a message received via smtp and routed to an smtp transport,
31716 and only one transport, interface, destination host and port combination
31717 is used for all recipients of the message,
31718 then the delivery connection is made while the receiving connection is open
31719 and data is copied from one to the other.
31720
31721 An attempt to set this option for any recipient but the first
31722 for a mail will be quietly ignored.
31723 If a recipient-verify callout
31724 (with use_sender)
31725 connection is subsequently
31726 requested in the same ACL it is held open and used for
31727 any subsequent recipients and the data,
31728 otherwise one is made after the initial RCPT ACL completes.
31729
31730 Note that routers are used in verify mode,
31731 and cannot depend on content of received headers.
31732 Note also that headers cannot be
31733 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31734 Headers may be modified by routers (subject to the above) and transports.
31735 The &'Received-By:'& header is generated as soon as the body reception starts,
31736 rather than the traditional time after the full message is received;
31737 this will affect the timestamp.
31738
31739 All the usual ACLs are called; if one results in the message being
31740 rejected, all effort spent in delivery (including the costs on
31741 the ultimate destination) will be wasted.
31742 Note that in the case of data-time ACLs this includes the entire
31743 message body.
31744
31745 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31746 of outgoing messages is done, because it sends data to the ultimate destination
31747 before the entire message has been received from the source.
31748 It is not supported for messages received with the SMTP PRDR
31749 or CHUNKING
31750 options in use.
31751
31752 Should the ultimate destination system positively accept or reject the mail,
31753 a corresponding indication is given to the source system and nothing is queued.
31754 If the item is successfully delivered in cutthrough mode
31755 the delivery log lines are tagged with ">>" rather than "=>" and appear
31756 before the acceptance "<=" line.
31757
31758 If there is a temporary error the item is queued for later delivery in the
31759 usual fashion.
31760 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31761 to the control; the default value is &"spool"& and the alternate value
31762 &"pass"& copies an SMTP defer response from the target back to the initiator
31763 and does not queue the message.
31764 Note that this is independent of any recipient verify conditions in the ACL.
31765
31766 Delivery in this mode avoids the generation of a bounce mail to a
31767 (possibly faked)
31768 sender when the destination system is doing content-scan based rejection.
31769
31770
31771 .vitem &*control&~=&~debug/*&<&'options'&>
31772 .cindex "&ACL;" "enabling debug logging"
31773 .cindex "debugging" "enabling from an ACL"
31774 This control turns on debug logging, almost as though Exim had been invoked
31775 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31776 by default called &'debuglog'&.
31777
31778 Logging set up by the control will be maintained across spool residency.
31779
31780 Options are a slash-separated list.
31781 If an option takes an argument, the option name and argument are separated by
31782 an equals character.
31783 Several options are supported:
31784 .display
31785 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31786                      The argument, which may access any variables already defined,
31787                      is appended to the default name.
31788
31789 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31790                      using the same values as the &`-d`& command-line option.
31791
31792 stop                 Logging started with this control may be
31793                      stopped by using this option.
31794
31795 kill                 Logging started with this control may be
31796                      stopped by using this option.
31797                      Additionally the debug file will be removed,
31798                      providing one means for speculative debug tracing.
31799
31800 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31801                      for pre-trigger debug capture.
31802                      Debug lines are recorded in the buffer until
31803                      and if) a trigger occurs; at which time they are
31804                      dumped to the debug file.  Newer lines displace the
31805                      oldest if the buffer is full.  After a trigger,
31806                      immediate writes to file are done as normal.
31807
31808 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31809                      see above) to be copied to file.  A reason of &*now*&
31810                      take effect immediately; one of &*paniclog*& triggers
31811                      on a write to the panic log.
31812 .endd
31813
31814 Some examples (which depend on variables that don't exist in all
31815 contexts):
31816 .code
31817       control = debug
31818       control = debug/tag=.$sender_host_address
31819       control = debug/opts=+expand+acl
31820       control = debug/tag=.$message_exim_id/opts=+expand
31821       control = debug/kill
31822       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31823       control = debug/trigger=now
31824 .endd
31825
31826
31827 .vitem &*control&~=&~dkim_disable_verify*&
31828 .cindex "disable DKIM verify"
31829 .cindex "DKIM" "disable verify"
31830 This control turns off DKIM verification processing entirely.  For details on
31831 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31832
31833
31834 .vitem &*control&~=&~dmarc_disable_verify*&
31835 .cindex "disable DMARC verify"
31836 .cindex "DMARC" "disable verify"
31837 This control turns off DMARC verification processing entirely.  For details on
31838 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31839
31840
31841 .vitem &*control&~=&~dscp/*&<&'value'&>
31842 .cindex "&ACL;" "setting DSCP value"
31843 .cindex "DSCP" "inbound"
31844 This option causes the DSCP value associated with the socket for the inbound
31845 connection to be adjusted to a given value, given as one of a number of fixed
31846 strings or to numeric value.
31847 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31848 Common values include &`throughput`&, &`mincost`&, and on newer systems
31849 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31850
31851 The outbound packets from Exim will be marked with this value in the header
31852 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31853 that these values will have any effect, not be stripped by networking
31854 equipment, or do much of anything without cooperation with your Network
31855 Engineer and those of all network operators between the source and destination.
31856
31857
31858 .vitem &*control&~=&~enforce_sync*& &&&
31859        &*control&~=&~no_enforce_sync*&
31860 .cindex "SMTP" "synchronization checking"
31861 .cindex "synchronization checking in SMTP"
31862 These controls make it possible to be selective about when SMTP synchronization
31863 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31864 state of the switch (it is true by default). See the description of this option
31865 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31866
31867 The effect of these two controls lasts for the remainder of the SMTP
31868 connection. They can appear in any ACL except the one for the non-SMTP
31869 messages. The most straightforward place to put them is in the ACL defined by
31870 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31871 before the first synchronization check. The expected use is to turn off the
31872 synchronization checks for badly-behaved hosts that you nevertheless need to
31873 work with.
31874
31875
31876 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31877 .cindex "fake defer"
31878 .cindex "defer, fake"
31879 .cindex fakedefer
31880 This control works in exactly the same way as &%fakereject%& (described below)
31881 except that it causes an SMTP 450 response after the message data instead of a
31882 550 response. You must take care when using &%fakedefer%& because it causes the
31883 messages to be duplicated when the sender retries. Therefore, you should not
31884 use &%fakedefer%& if the message is to be delivered normally.
31885
31886 .vitem &*control&~=&~fakereject/*&<&'message'&>
31887 .cindex "fake rejection"
31888 .cindex "rejection, fake"
31889 .cindex fakereject
31890 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31891 words, only when an SMTP message is being received. If Exim accepts the
31892 message, instead the final 250 response, a 550 rejection message is sent.
31893 However, Exim proceeds to deliver the message as normal. The control applies
31894 only to the current message, not to any subsequent ones that may be received in
31895 the same SMTP connection.
31896
31897 The text for the 550 response is taken from the &%control%& modifier. If no
31898 message is supplied, the following is used:
31899 .code
31900 550-Your message has been rejected but is being
31901 550-kept for evaluation.
31902 550-If it was a legitimate message, it may still be
31903 550 delivered to the target recipient(s).
31904 .endd
31905 This facility should be used with extreme caution.
31906
31907 .vitem &*control&~=&~freeze*&
31908 .cindex "frozen messages" "forcing in ACL"
31909 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31910 other words, only when a message is being received. If the message is accepted,
31911 it is placed on Exim's queue and frozen. The control applies only to the
31912 current message, not to any subsequent ones that may be received in the same
31913 SMTP connection.
31914
31915 This modifier can optionally be followed by &`/no_tell`&. If the global option
31916 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31917 is told about the freezing), provided all the &*control=freeze*& modifiers that
31918 are obeyed for the current message have the &`/no_tell`& option.
31919
31920 .vitem &*control&~=&~no_delay_flush*&
31921 .cindex "SMTP" "output flushing, disabling for delay"
31922 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31923 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31924 use. This control, as long as it is encountered before the &%delay%& modifier,
31925 disables such output flushing.
31926
31927 .vitem &*control&~=&~no_callout_flush*&
31928 .cindex "SMTP" "output flushing, disabling for callout"
31929 Exim normally flushes SMTP output before performing a callout in an ACL, to
31930 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31931 use. This control, as long as it is encountered before the &%verify%& condition
31932 that causes the callout, disables such output flushing.
31933
31934 .vitem &*control&~=&~no_mbox_unspool*&
31935 This control is available when Exim is compiled with the content scanning
31936 extension. Content scanning may require a copy of the current message, or parts
31937 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31938 or spam scanner. Normally, such copies are deleted when they are no longer
31939 needed. If this control is set, the copies are not deleted. The control applies
31940 only to the current message, not to any subsequent ones that may be received in
31941 the same SMTP connection. It is provided for debugging purposes and is unlikely
31942 to be useful in production.
31943
31944 .vitem &*control&~=&~no_multiline_responses*&
31945 .cindex "multiline responses, suppressing"
31946 This control is permitted for any ACL except the one for non-SMTP messages.
31947 It seems that there are broken clients in use that cannot handle multiline
31948 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31949
31950 If this control is set, multiline SMTP responses from ACL rejections are
31951 suppressed. One way of doing this would have been to put out these responses as
31952 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31953 (&"use multiline responses for more"& it says &-- ha!), and some of the
31954 responses might get close to that. So this facility, which is after all only a
31955 sop to broken clients, is implemented by doing two very easy things:
31956
31957 .ilist
31958 Extra information that is normally output as part of a rejection caused by
31959 sender verification failure is omitted. Only the final line (typically &"sender
31960 verification failed"&) is sent.
31961 .next
31962 If a &%message%& modifier supplies a multiline response, only the first
31963 line is output.
31964 .endlist
31965
31966 The setting of the switch can, of course, be made conditional on the
31967 calling host. Its effect lasts until the end of the SMTP connection.
31968
31969 .vitem &*control&~=&~no_pipelining*&
31970 .cindex "PIPELINING" "suppressing advertising"
31971 .cindex "ESMTP extensions" PIPELINING
31972 This control turns off the advertising of the PIPELINING extension to SMTP in
31973 the current session. To be useful, it must be obeyed before Exim sends its
31974 response to an EHLO command. Therefore, it should normally appear in an ACL
31975 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31976 &%pipelining_advertise_hosts%&.
31977
31978 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31979        &*control&~=&~queue_only*&
31980 .oindex "&%queue%&"
31981 .oindex "&%queue_only%&"
31982 .cindex "queueing incoming messages"
31983 .cindex queueing "forcing in ACL"
31984 .cindex "first pass routing"
31985 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31986 other words, only when a message is being received. If the message is accepted,
31987 it is placed on Exim's queue and left there for delivery by a subsequent queue
31988 runner.
31989 If used with no options set,
31990 no immediate delivery process is started. In other words, it has the
31991 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31992
31993 If the &'first_pass_route'& option is given then
31994 the behaviour is like the command-line &'-oqds'& option;
31995 a delivery process is started which stops short of making
31996 any SMTP delivery.  The benefit is that the hints database will be updated for
31997 the message being waiting for a specific host, and a later queue run will be
31998 able to send all such messages on a single connection.
31999
32000 The control only applies to the current message, not to any subsequent ones that
32001  may be received in the same SMTP connection.
32002
32003 .vitem &*control&~=&~submission/*&<&'options'&>
32004 .cindex "message" "submission"
32005 .cindex "submission mode"
32006 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
32007 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
32008 the current message is a submission from a local MUA. In this case, Exim
32009 operates in &"submission mode"&, and applies certain fixups to the message if
32010 necessary. For example, it adds a &'Date:'& header line if one is not present.
32011 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
32012 late (the message has already been created).
32013
32014 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32015 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32016 submission mode; the available options for this control are described there.
32017 The control applies only to the current message, not to any subsequent ones
32018 that may be received in the same SMTP connection.
32019
32020 .vitem &*control&~=&~suppress_local_fixups*&
32021 .cindex "submission fixups, suppressing"
32022 This control applies to locally submitted (non TCP/IP) messages, and is the
32023 complement of &`control = submission`&. It disables the fixups that are
32024 normally applied to locally-submitted messages. Specifically:
32025
32026 .ilist
32027 Any &'Sender:'& header line is left alone (in this respect, it is a
32028 dynamic version of &%local_sender_retain%&).
32029 .next
32030 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32031 .next
32032 There is no check that &'From:'& corresponds to the actual sender.
32033 .endlist ilist
32034
32035 This control may be useful when a remotely-originated message is accepted,
32036 passed to some scanning program, and then re-submitted for delivery. It can be
32037 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32038 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32039 data is read.
32040
32041 &*Note:*& This control applies only to the current message, not to any others
32042 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32043
32044 .vitem &*control&~=&~utf8_downconvert*&
32045 This control enables conversion of UTF-8 in message envelope addresses
32046 to a-label form.
32047 For details see section &<<SECTi18nMTA>>&.
32048 .endlist vlist
32049
32050
32051 .section "Summary of message fixup control" "SECTsummesfix"
32052 All four possibilities for message fixups can be specified:
32053
32054 .ilist
32055 Locally submitted, fixups applied: the default.
32056 .next
32057 Locally submitted, no fixups applied: use
32058 &`control = suppress_local_fixups`&.
32059 .next
32060 Remotely submitted, no fixups applied: the default.
32061 .next
32062 Remotely submitted, fixups applied: use &`control = submission`&.
32063 .endlist
32064
32065
32066
32067 .section "Adding header lines in ACLs" "SECTaddheadacl"
32068 .cindex "header lines" "adding in an ACL"
32069 .cindex "header lines" "position of added lines"
32070 .cindex "&%add_header%& ACL modifier"
32071 The &%add_header%& modifier can be used to add one or more extra header lines
32072 to an incoming message, as in this example:
32073 .code
32074 warn dnslists = sbl.spamhaus.org : \
32075                 dialup.mail-abuse.org
32076      add_header = X-blacklisted-at: $dnslist_domain
32077 .endd
32078 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32079 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32080 receiving a message). The message must ultimately be accepted for
32081 &%add_header%& to have any significant effect. You can use &%add_header%& with
32082 any ACL verb, including &%deny%& (though this is potentially useful only in a
32083 RCPT ACL).
32084
32085 Headers will not be added to the message if the modifier is used in
32086 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32087
32088 Leading and trailing newlines are removed from
32089 the data for the &%add_header%& modifier; if it then
32090 contains one or more newlines that
32091 are not followed by a space or a tab, it is assumed to contain multiple header
32092 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32093 front of any line that is not a valid header line.
32094
32095 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32096 They are added to the message before processing the DATA and MIME ACLs.
32097 However, if an identical header line is requested more than once, only one copy
32098 is actually added to the message. Further header lines may be accumulated
32099 during the DATA and MIME ACLs, after which they are added to the message, again
32100 with duplicates suppressed. Thus, it is possible to add two identical header
32101 lines to an SMTP message, but only if one is added before DATA and one after.
32102 In the case of non-SMTP messages, new headers are accumulated during the
32103 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32104 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32105 are included in the entry that is written to the reject log.
32106
32107 .cindex "header lines" "added; visibility of"
32108 Header lines are not visible in string expansions
32109 of message headers
32110 until they are added to the
32111 message. It follows that header lines defined in the MAIL, RCPT, and predata
32112 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32113 header lines that are added by the DATA or MIME ACLs are not visible in those
32114 ACLs. Because of this restriction, you cannot use header lines as a way of
32115 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32116 this, you can use ACL variables, as described in section
32117 &<<SECTaclvariables>>&.
32118
32119 The list of headers yet to be added is given by the &%$headers_added%& variable.
32120
32121 The &%add_header%& modifier acts immediately as it is encountered during the
32122 processing of an ACL. Notice the difference between these two cases:
32123 .display
32124 &`accept add_header = ADDED: some text`&
32125 &`       `&<&'some condition'&>
32126
32127 &`accept `&<&'some condition'&>
32128 &`       add_header = ADDED: some text`&
32129 .endd
32130 In the first case, the header line is always added, whether or not the
32131 condition is true. In the second case, the header line is added only if the
32132 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32133 ACL statement. All those that are encountered before a condition fails are
32134 honoured.
32135
32136 .cindex "&%warn%& ACL verb"
32137 For compatibility with previous versions of Exim, a &%message%& modifier for a
32138 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32139 effect only if all the conditions are true, even if it appears before some of
32140 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32141 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32142 are present on a &%warn%& verb, both are processed according to their
32143 specifications.
32144
32145 By default, new header lines are added to a message at the end of the existing
32146 header lines. However, you can specify that any particular header line should
32147 be added right at the start (before all the &'Received:'& lines), immediately
32148 after the first block of &'Received:'& lines, or immediately before any line
32149 that is not a &'Received:'& or &'Resent-something:'& header.
32150
32151 This is done by specifying &":at_start:"&, &":after_received:"&, or
32152 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32153 header line, respectively. (Header text cannot start with a colon, as there has
32154 to be a header name first.) For example:
32155 .code
32156 warn add_header = \
32157        :after_received:X-My-Header: something or other...
32158 .endd
32159 If more than one header line is supplied in a single &%add_header%& modifier,
32160 each one is treated independently and can therefore be placed differently. If
32161 you add more than one line at the start, or after the Received: block, they end
32162 up in reverse order.
32163
32164 &*Warning*&: This facility currently applies only to header lines that are
32165 added in an ACL. It does NOT work for header lines that are added in a
32166 system filter or in a router or transport.
32167
32168
32169
32170 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32171 .cindex "header lines" "removing in an ACL"
32172 .cindex "header lines" "position of removed lines"
32173 .cindex "&%remove_header%& ACL modifier"
32174 The &%remove_header%& modifier can be used to remove one or more header lines
32175 from an incoming message, as in this example:
32176 .code
32177 warn   message        = Remove internal headers
32178        remove_header  = x-route-mail1 : x-route-mail2
32179 .endd
32180 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32181 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32182 receiving a message). The message must ultimately be accepted for
32183 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32184 with any ACL verb, including &%deny%&, though this is really not useful for
32185 any verb that doesn't result in a delivered message.
32186
32187 Headers will not be removed from the message if the modifier is used in
32188 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32189
32190 More than one header can be removed at the same time by using a colon separated
32191 list of header specifiers.
32192 .new
32193 If a specifier does not start with a circumflex (^)
32194 then it is treated as a header name.
32195 The header name matching is case insensitive.
32196 If it does, then it is treated as a (front-anchored)
32197 regular expression applied to the whole header.
32198
32199 &*Note*&: The colon terminating a header name will need to be doubled
32200 if used in an RE, and there can legitimately be whitepace before it.
32201
32202 Example:
32203 .code
32204 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32205 .endd
32206 .wen
32207
32208 List expansion is not performed, so you cannot use hostlists to
32209 create a list of headers, however both connection and message variable expansion
32210 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32211 .code
32212 warn   hosts           = +internal_hosts
32213        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32214 warn   message         = Remove internal headers
32215        remove_header   = $acl_c_ihdrs
32216 .endd
32217 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32218 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32219 If multiple header lines match, all are removed.
32220 There is no harm in attempting to remove the same header twice nor in removing
32221 a non-existent header. Further header specifiers for removal may be accumulated
32222 during the DATA and MIME ACLs, after which matching headers are removed
32223 if present. In the case of non-SMTP messages, remove specifiers are
32224 accumulated during the non-SMTP ACLs, and are acted on after
32225 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32226 ACL, there really is no effect because there is no logging of what headers
32227 would have been removed.
32228
32229 .cindex "header lines" "removed; visibility of"
32230 Header lines are not visible in string expansions until the DATA phase when it
32231 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32232 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32233 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32234 this restriction, you cannot use header lines as a way of controlling data
32235 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32236 you should instead use ACL variables, as described in section
32237 &<<SECTaclvariables>>&.
32238
32239 The &%remove_header%& modifier acts immediately as it is encountered during the
32240 processing of an ACL. Notice the difference between these two cases:
32241 .display
32242 &`accept remove_header = X-Internal`&
32243 &`       `&<&'some condition'&>
32244
32245 &`accept `&<&'some condition'&>
32246 &`       remove_header = X-Internal`&
32247 .endd
32248 In the first case, the header line is always removed, whether or not the
32249 condition is true. In the second case, the header line is removed only if the
32250 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32251 same ACL statement. All those that are encountered before a condition fails
32252 are honoured.
32253
32254 &*Warning*&: This facility currently applies only to header lines that are
32255 present during ACL processing. It does NOT remove header lines that are added
32256 in a system filter or in a router or transport.
32257
32258
32259
32260
32261 .section "ACL conditions" "SECTaclconditions"
32262 .cindex "&ACL;" "conditions; list of"
32263 Some of the conditions listed in this section are available only when Exim is
32264 compiled with the content-scanning extension. They are included here briefly
32265 for completeness. More detailed descriptions can be found in the discussion on
32266 content scanning in chapter &<<CHAPexiscan>>&.
32267
32268 Not all conditions are relevant in all circumstances. For example, testing
32269 senders and recipients does not make sense in an ACL that is being run as the
32270 result of the arrival of an ETRN command, and checks on message headers can be
32271 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32272 can use the same condition (with different parameters) more than once in the
32273 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32274 The conditions are as follows:
32275
32276
32277 .vlist
32278 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32279 .cindex "&ACL;" "nested"
32280 .cindex "&ACL;" "indirect"
32281 .cindex "&ACL;" "arguments"
32282 .cindex "&%acl%& ACL condition"
32283 The possible values of the argument are the same as for the
32284 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32285 &"accept"& the condition is true; if it returns &"deny"& the condition is
32286 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32287 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32288 condition false. This means that further processing of the &%warn%& verb
32289 ceases, but processing of the ACL continues.
32290
32291 If the argument is a named ACL, up to nine space-separated optional values
32292 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32293 and $acl_narg is set to the count of values.
32294 Previous values of these variables are restored after the call returns.
32295 The name and values are expanded separately.
32296 Note that spaces in complex expansions which are used as arguments
32297 will act as argument separators.
32298
32299 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32300 the connection is dropped. If it returns &"discard"&, the verb must be
32301 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32302 conditions are tested.
32303
32304 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32305 loops. This condition allows you to use different ACLs in different
32306 circumstances. For example, different ACLs can be used to handle RCPT commands
32307 for different local users or different local domains.
32308
32309 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32310 .cindex "&%authenticated%& ACL condition"
32311 .cindex "authentication" "ACL checking"
32312 .cindex "&ACL;" "testing for authentication"
32313 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32314 the name of the authenticator is tested against the list. To test for
32315 authentication by any authenticator, you can set
32316 .code
32317 authenticated = *
32318 .endd
32319
32320 .vitem &*condition&~=&~*&<&'string'&>
32321 .cindex "&%condition%& ACL condition"
32322 .cindex "customizing" "ACL condition"
32323 .cindex "&ACL;" "customized test"
32324 .cindex "&ACL;" "testing, customized"
32325 This feature allows you to make up custom conditions. If the result of
32326 expanding the string is an empty string, the number zero, or one of the strings
32327 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32328 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32329 any other value, some error is assumed to have occurred, and the ACL returns
32330 &"defer"&. However, if the expansion is forced to fail, the condition is
32331 ignored. The effect is to treat it as true, whether it is positive or
32332 negative.
32333
32334 .vitem &*decode&~=&~*&<&'location'&>
32335 .cindex "&%decode%& ACL condition"
32336 This condition is available only when Exim is compiled with the
32337 content-scanning extension, and it is allowed only in the ACL defined by
32338 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32339 If all goes well, the condition is true. It is false only if there are
32340 problems such as a syntax error or a memory shortage. For more details, see
32341 chapter &<<CHAPexiscan>>&.
32342
32343 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32344 .cindex "&%dnslists%& ACL condition"
32345 .cindex "DNS list" "in ACL"
32346 .cindex "black list (DNS)"
32347 .cindex "&ACL;" "testing a DNS list"
32348 This condition checks for entries in DNS black lists. These are also known as
32349 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32350 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32351 different variants of this condition to describe briefly here. See sections
32352 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32353
32354 .vitem &*domains&~=&~*&<&'domain&~list'&>
32355 .cindex "&%domains%& ACL condition"
32356 .cindex "domain" "ACL checking"
32357 .cindex "&ACL;" "testing a recipient domain"
32358 .vindex "&$domain_data$&"
32359 This condition is relevant only in a RCPT ACL. It checks that the domain
32360 of the recipient address is in the domain list. If percent-hack processing is
32361 enabled, it is done before this test is done. If the check succeeds with a
32362 lookup, the result of the lookup is placed in &$domain_data$& until the next
32363 &%domains%& test.
32364
32365 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32366 use &%domains%& in a DATA ACL.
32367
32368
32369 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32370 .cindex "&%encrypted%& ACL condition"
32371 .cindex "encryption" "checking in an ACL"
32372 .cindex "&ACL;" "testing for encryption"
32373 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32374 name of the cipher suite in use is tested against the list. To test for
32375 encryption without testing for any specific cipher suite(s), set
32376 .code
32377 encrypted = *
32378 .endd
32379
32380
32381 .vitem &*hosts&~=&~*&<&'host&~list'&>
32382 .cindex "&%hosts%& ACL condition"
32383 .cindex "host" "ACL checking"
32384 .cindex "&ACL;" "testing the client host"
32385 This condition tests that the calling host matches the host list. If you have
32386 name lookups or wildcarded host names and IP addresses in the same host list,
32387 you should normally put the IP addresses first. For example, you could have:
32388 .code
32389 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32390 .endd
32391 The lookup in this example uses the host name for its key. This is implied by
32392 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32393 and it wouldn't matter which way round you had these two items.)
32394
32395 The reason for the problem with host names lies in the left-to-right way that
32396 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32397 but when it reaches an item that requires a host name, it fails if it cannot
32398 find a host name to compare with the pattern. If the above list is given in the
32399 opposite order, the &%accept%& statement fails for a host whose name cannot be
32400 found, even if its IP address is 10.9.8.7.
32401
32402 If you really do want to do the name check first, and still recognize the IP
32403 address even if the name lookup fails, you can rewrite the ACL like this:
32404 .code
32405 accept hosts = dbm;/etc/friendly/hosts
32406 accept hosts = 10.9.8.7
32407 .endd
32408 The default action on failing to find the host name is to assume that the host
32409 is not in the list, so the first &%accept%& statement fails. The second
32410 statement can then check the IP address.
32411
32412 .vindex "&$host_data$&"
32413 If a &%hosts%& condition is satisfied by means of a lookup, the result
32414 of the lookup is made available in the &$host_data$& variable. This
32415 allows you, for example, to set up a statement like this:
32416 .code
32417 deny  hosts = net-lsearch;/some/file
32418       message = $host_data
32419 .endd
32420 which gives a custom error message for each denied host.
32421
32422 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32423 .cindex "&%local_parts%& ACL condition"
32424 .cindex "local part" "ACL checking"
32425 .cindex "&ACL;" "testing a local part"
32426 .vindex "&$local_part_data$&"
32427 This condition is relevant only in a RCPT ACL. It checks that the local
32428 part of the recipient address is in the list. If percent-hack processing is
32429 enabled, it is done before this test. If the check succeeds with a lookup, the
32430 result of the lookup is placed in &$local_part_data$&, which remains set until
32431 the next &%local_parts%& test.
32432
32433 .vitem &*malware&~=&~*&<&'option'&>
32434 .cindex "&%malware%& ACL condition"
32435 .cindex "&ACL;" "virus scanning"
32436 .cindex "&ACL;" "scanning for viruses"
32437 This condition is available only when Exim is compiled with the
32438 content-scanning extension
32439 and only after a DATA command.
32440 It causes the incoming message to be scanned for
32441 viruses. For details, see chapter &<<CHAPexiscan>>&.
32442
32443 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32444 .cindex "&%mime_regex%& ACL condition"
32445 .cindex "&ACL;" "testing by regex matching"
32446 This condition is available only when Exim is compiled with the
32447 content-scanning extension, and it is allowed only in the ACL defined by
32448 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32449 with any of the regular expressions. For details, see chapter
32450 &<<CHAPexiscan>>&.
32451
32452 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32453 .cindex "rate limiting"
32454 This condition can be used to limit the rate at which a user or host submits
32455 messages. Details are given in section &<<SECTratelimiting>>&.
32456
32457 .vitem &*recipients&~=&~*&<&'address&~list'&>
32458 .cindex "&%recipients%& ACL condition"
32459 .cindex "recipient" "ACL checking"
32460 .cindex "&ACL;" "testing a recipient"
32461 This condition is relevant only in a RCPT ACL. It checks the entire
32462 recipient address against a list of recipients.
32463
32464 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32465 .cindex "&%regex%& ACL condition"
32466 .cindex "&ACL;" "testing by regex matching"
32467 This condition is available only when Exim is compiled with the
32468 content-scanning extension, and is available only in the DATA, MIME, and
32469 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32470 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32471
32472 .vitem &*seen&~=&~*&<&'parameters'&>
32473 .cindex "&%seen%& ACL condition"
32474 This condition can be used to test if a situation has been previously met,
32475 for example for greylisting.
32476 Details are given in section &<<SECTseen>>&.
32477
32478 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32479 .cindex "&%sender_domains%& ACL condition"
32480 .cindex "sender" "ACL checking"
32481 .cindex "&ACL;" "testing a sender domain"
32482 .vindex "&$domain$&"
32483 .vindex "&$sender_address_domain$&"
32484 This condition tests the domain of the sender of the message against the given
32485 domain list. &*Note*&: The domain of the sender address is in
32486 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32487 of this condition. This is an exception to the general rule for testing domain
32488 lists. It is done this way so that, if this condition is used in an ACL for a
32489 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32490 influence the sender checking.
32491
32492 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32493 relaying, because sender addresses are easily, and commonly, forged.
32494
32495 .vitem &*senders&~=&~*&<&'address&~list'&>
32496 .cindex "&%senders%& ACL condition"
32497 .cindex "sender" "ACL checking"
32498 .cindex "&ACL;" "testing a sender"
32499 This condition tests the sender of the message against the given list. To test
32500 for a bounce message, which has an empty sender, set
32501 .code
32502 senders = :
32503 .endd
32504 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32505 relaying, because sender addresses are easily, and commonly, forged.
32506
32507 .vitem &*spam&~=&~*&<&'username'&>
32508 .cindex "&%spam%& ACL condition"
32509 .cindex "&ACL;" "scanning for spam"
32510 This condition is available only when Exim is compiled with the
32511 content-scanning extension. It causes the incoming message to be scanned by
32512 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32513
32514 .vitem &*verify&~=&~certificate*&
32515 .cindex "&%verify%& ACL condition"
32516 .cindex "TLS" "client certificate verification"
32517 .cindex "certificate" "verification of client"
32518 .cindex "&ACL;" "certificate verification"
32519 .cindex "&ACL;" "testing a TLS certificate"
32520 This condition is true in an SMTP session if the session is encrypted, and a
32521 certificate was received from the client, and the certificate was verified. The
32522 server requests a certificate only if the client matches &%tls_verify_hosts%&
32523 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32524
32525 .vitem &*verify&~=&~csa*&
32526 .cindex "CSA verification"
32527 This condition checks whether the sending host (the client) is authorized to
32528 send email. Details of how this works are given in section
32529 &<<SECTverifyCSA>>&.
32530
32531 .vitem &*verify&~=&~header_names_ascii*&
32532 .cindex "&%verify%& ACL condition"
32533 .cindex "&ACL;" "verifying header names only ASCII"
32534 .cindex "header lines" "verifying header names only ASCII"
32535 .cindex "verifying" "header names only ASCII"
32536 This condition is relevant only in an ACL that is run after a message has been
32537 received.
32538 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32539 It checks all header names (not the content) to make sure
32540 there are no non-ASCII characters, also excluding control characters.  The
32541 allowable characters are decimal ASCII values 33 through 126.
32542
32543 Exim itself will handle headers with non-ASCII characters, but it can cause
32544 problems for downstream applications, so this option will allow their
32545 detection and rejection in the DATA ACL's.
32546
32547 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32548 .cindex "&%verify%& ACL condition"
32549 .cindex "&ACL;" "verifying sender in the header"
32550 .cindex "header lines" "verifying the sender in"
32551 .cindex "sender" "verifying in header"
32552 .cindex "verifying" "sender in header"
32553 This condition is relevant only in an ACL that is run after a message has been
32554 received, that is, in an ACL specified by &%acl_smtp_data%& or
32555 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32556 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32557 is loosely thought of as a &"sender"& address (hence the name of the test).
32558 However, an address that appears in one of these headers need not be an address
32559 that accepts bounce messages; only sender addresses in envelopes are required
32560 to accept bounces. Therefore, if you use the callout option on this check, you
32561 might want to arrange for a non-empty address in the MAIL command.
32562
32563 Details of address verification and the options are given later, starting at
32564 section &<<SECTaddressverification>>& (callouts are described in section
32565 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32566 condition to restrict it to bounce messages only:
32567 .code
32568 deny    senders = :
32569        !verify  = header_sender
32570         message = A valid sender header is required for bounces
32571 .endd
32572
32573 .vitem &*verify&~=&~header_syntax*&
32574 .cindex "&%verify%& ACL condition"
32575 .cindex "&ACL;" "verifying header syntax"
32576 .cindex "header lines" "verifying syntax"
32577 .cindex "verifying" "header syntax"
32578 This condition is relevant only in an ACL that is run after a message has been
32579 received, that is, in an ACL specified by &%acl_smtp_data%& or
32580 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32581 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32582 and &'Bcc:'&), returning true if there are no problems.
32583 Unqualified addresses (local parts without domains) are
32584 permitted only in locally generated messages and from hosts that match
32585 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32586 appropriate.
32587
32588 Note that this condition is a syntax check only. However, a common spamming
32589 ploy used to be to send syntactically invalid headers such as
32590 .code
32591 To: @
32592 .endd
32593 and this condition can be used to reject such messages, though they are not as
32594 common as they used to be.
32595
32596 .vitem &*verify&~=&~helo*&
32597 .cindex "&%verify%& ACL condition"
32598 .cindex "&ACL;" "verifying HELO/EHLO"
32599 .cindex "HELO" "verifying"
32600 .cindex "EHLO" "verifying"
32601 .cindex "verifying" "EHLO"
32602 .cindex "verifying" "HELO"
32603 This condition is true if a HELO or EHLO command has been received from the
32604 client host, and its contents have been verified. If there has been no previous
32605 attempt to verify the HELO/EHLO contents, it is carried out when this
32606 condition is encountered. See the description of the &%helo_verify_hosts%& and
32607 &%helo_try_verify_hosts%& options for details of how to request verification
32608 independently of this condition, and for detail of the verification.
32609
32610 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32611 option), this condition is always true.
32612
32613
32614 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32615 .cindex "verifying" "not blind"
32616 .cindex "bcc recipients, verifying none"
32617 This condition checks that there are no blind (bcc) recipients in the message.
32618 Every envelope recipient must appear either in a &'To:'& header line or in a
32619 &'Cc:'& header line for this condition to be true. Local parts are checked
32620 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32621 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32622 used only in a DATA or non-SMTP ACL.
32623
32624 There is one possible option, &`case_insensitive`&.  If this is present then
32625 local parts are checked case-insensitively.
32626
32627 There are, of course, many legitimate messages that make use of blind (bcc)
32628 recipients. This check should not be used on its own for blocking messages.
32629
32630
32631 .vitem &*verify&~=&~recipient/*&<&'options'&>
32632 .cindex "&%verify%& ACL condition"
32633 .cindex "&ACL;" "verifying recipient"
32634 .cindex "recipient" "verifying"
32635 .cindex "verifying" "recipient"
32636 .vindex "&$address_data$&"
32637 This condition is relevant only after a RCPT command. It verifies the current
32638 recipient. Details of address verification are given later, starting at section
32639 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32640 of &$address_data$& is the last value that was set while routing the address.
32641 This applies even if the verification fails. When an address that is being
32642 verified is redirected to a single address, verification continues with the new
32643 address, and in that case, the subsequent value of &$address_data$& is the
32644 value for the child address.
32645
32646 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32647 .cindex "&%verify%& ACL condition"
32648 .cindex "&ACL;" "verifying host reverse lookup"
32649 .cindex "host" "verifying reverse lookup"
32650 This condition ensures that a verified host name has been looked up from the IP
32651 address of the client host. (This may have happened already if the host name
32652 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32653 Verification ensures that the host name obtained from a reverse DNS lookup, or
32654 one of its aliases, does, when it is itself looked up in the DNS, yield the
32655 original IP address.
32656
32657 There is one possible option, &`defer_ok`&.  If this is present and a
32658 DNS operation returns a temporary error, the verify condition succeeds.
32659
32660 If this condition is used for a locally generated message (that is, when there
32661 is no client host involved), it always succeeds.
32662
32663 .vitem &*verify&~=&~sender/*&<&'options'&>
32664 .cindex "&%verify%& ACL condition"
32665 .cindex "&ACL;" "verifying sender"
32666 .cindex "sender" "verifying"
32667 .cindex "verifying" "sender"
32668 This condition is relevant only after a MAIL or RCPT command, or after a
32669 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32670 the message's sender is empty (that is, this is a bounce message), the
32671 condition is true. Otherwise, the sender address is verified.
32672
32673 .vindex "&$address_data$&"
32674 .vindex "&$sender_address_data$&"
32675 If there is data in the &$address_data$& variable at the end of routing, its
32676 value is placed in &$sender_address_data$& at the end of verification. This
32677 value can be used in subsequent conditions and modifiers in the same ACL
32678 statement. It does not persist after the end of the current statement. If you
32679 want to preserve the value for longer, you can save it in an ACL variable.
32680
32681 Details of verification are given later, starting at section
32682 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32683 to avoid doing it more than once per message.
32684
32685 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32686 .cindex "&%verify%& ACL condition"
32687 This is a variation of the previous option, in which a modified address is
32688 verified as a sender.
32689
32690 Note that '/' is legal in local-parts; if the address may have such
32691 (eg. is generated from the received message)
32692 they must be protected from the options parsing by doubling:
32693 .code
32694 verify = sender=${listquote{/}{${address:$h_sender:}}}
32695 .endd
32696 .endlist
32697
32698
32699
32700 .section "Using DNS lists" "SECTmorednslists"
32701 .cindex "DNS list" "in ACL"
32702 .cindex "black list (DNS)"
32703 .cindex "&ACL;" "testing a DNS list"
32704 In its simplest form, the &%dnslists%& condition tests whether the calling host
32705 is on at least one of a number of DNS lists by looking up the inverted IP
32706 address in one or more DNS domains. (Note that DNS list domains are not mail
32707 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32708 special options instead.) For example, if the calling host's IP
32709 address is 192.168.62.43, and the ACL statement is
32710 .code
32711 deny dnslists = blackholes.mail-abuse.org : \
32712                 dialups.mail-abuse.org
32713 .endd
32714 the following records are looked up:
32715 .code
32716 43.62.168.192.blackholes.mail-abuse.org
32717 43.62.168.192.dialups.mail-abuse.org
32718 .endd
32719 As soon as Exim finds an existing DNS record, processing of the list stops.
32720 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32721 to test that a host is on more than one list (an &"and"& conjunction), you can
32722 use two separate conditions:
32723 .code
32724 deny dnslists = blackholes.mail-abuse.org
32725      dnslists = dialups.mail-abuse.org
32726 .endd
32727 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32728 behaves as if the host does not match the list item, that is, as if the DNS
32729 record does not exist. If there are further items in the DNS list, they are
32730 processed.
32731
32732 This is usually the required action when &%dnslists%& is used with &%deny%&
32733 (which is the most common usage), because it prevents a DNS failure from
32734 blocking mail. However, you can change this behaviour by putting one of the
32735 following special items in the list:
32736 .itable none 0 0 2 25* left 75* left
32737 .irow "+include_unknown"   "behave as if the item is on the list"
32738 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32739 .irow "+defer_unknown  "   "give a temporary error"
32740 .endtable
32741 .cindex "&`+include_unknown`&"
32742 .cindex "&`+exclude_unknown`&"
32743 .cindex "&`+defer_unknown`&"
32744 Each of these applies to any subsequent items on the list. For example:
32745 .code
32746 deny dnslists = +defer_unknown : foo.bar.example
32747 .endd
32748 Testing the list of domains stops as soon as a match is found. If you want to
32749 warn for one list and block for another, you can use two different statements:
32750 .code
32751 deny  dnslists = blackholes.mail-abuse.org
32752 warn  dnslists = dialups.mail-abuse.org
32753       message  = X-Warn: sending host is on dialups list
32754 .endd
32755 .cindex caching "of dns lookup"
32756 .cindex DNS TTL
32757 DNS list lookups are cached by Exim for the duration of the SMTP session
32758 (but limited by the DNS return TTL value),
32759 so a lookup based on the IP address is done at most once for any incoming
32760 connection (assuming long-enough TTL).
32761 Exim does not share information between multiple incoming
32762 connections (but your local name server cache should be active).
32763
32764 There are a number of DNS lists to choose from, some commercial, some free,
32765 or free for small deployments.  An overview can be found at
32766 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32767
32768
32769
32770 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32771 .cindex "DNS list" "keyed by explicit IP address"
32772 By default, the IP address that is used in a DNS list lookup is the IP address
32773 of the calling host. However, you can specify another IP address by listing it
32774 after the domain name, introduced by a slash. For example:
32775 .code
32776 deny dnslists = black.list.tld/192.168.1.2
32777 .endd
32778 This feature is not very helpful with explicit IP addresses; it is intended for
32779 use with IP addresses that are looked up, for example, the IP addresses of the
32780 MX hosts or nameservers of an email sender address. For an example, see section
32781 &<<SECTmulkeyfor>>& below.
32782
32783
32784
32785
32786 .subsection "DNS lists keyed on domain names" SECID202
32787 .cindex "DNS list" "keyed by domain name"
32788 There are some lists that are keyed on domain names rather than inverted IP
32789 addresses (see, e.g., the &'domain based zones'& link at
32790 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32791 with these lists. You can change the name that is looked up in a DNS list by
32792 listing it after the domain name, introduced by a slash. For example,
32793 .code
32794 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32795       message  = Sender's domain is listed at $dnslist_domain
32796 .endd
32797 This particular example is useful only in ACLs that are obeyed after the
32798 RCPT or DATA commands, when a sender address is available. If (for
32799 example) the message's sender is &'user@tld.example'& the name that is looked
32800 up by this example is
32801 .code
32802 tld.example.dsn.rfc-ignorant.org
32803 .endd
32804 A single &%dnslists%& condition can contain entries for both names and IP
32805 addresses. For example:
32806 .code
32807 deny dnslists = sbl.spamhaus.org : \
32808                 dsn.rfc-ignorant.org/$sender_address_domain
32809 .endd
32810 The first item checks the sending host's IP address; the second checks a domain
32811 name. The whole condition is true if either of the DNS lookups succeeds.
32812
32813
32814
32815
32816 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32817 .cindex "DNS list" "multiple keys for"
32818 The syntax described above for looking up explicitly-defined values (either
32819 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32820 name for the DNS list, what follows the slash can in fact be a list of items.
32821 As with all lists in Exim, the default separator is a colon. However, because
32822 this is a sublist within the list of DNS blacklist domains, it is necessary
32823 either to double the separators like this:
32824 .code
32825 dnslists = black.list.tld/name.1::name.2
32826 .endd
32827 or to change the separator character, like this:
32828 .code
32829 dnslists = black.list.tld/<;name.1;name.2
32830 .endd
32831 If an item in the list is an IP address, it is inverted before the DNS
32832 blacklist domain is appended. If it is not an IP address, no inversion
32833 occurs. Consider this condition:
32834 .code
32835 dnslists = black.list.tld/<;192.168.1.2;a.domain
32836 .endd
32837 The DNS lookups that occur are:
32838 .code
32839 2.1.168.192.black.list.tld
32840 a.domain.black.list.tld
32841 .endd
32842 Once a DNS record has been found (that matches a specific IP return
32843 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32844 are done. If there is a temporary DNS error, the rest of the sublist of domains
32845 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32846 only if no other DNS lookup in this sublist succeeds. In other words, a
32847 successful lookup for any of the items in the sublist overrides a temporary
32848 error for a previous item.
32849
32850 The ability to supply a list of items after the slash is in some sense just a
32851 syntactic convenience. These two examples have the same effect:
32852 .code
32853 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32854 dnslists = black.list.tld/a.domain::b.domain
32855 .endd
32856 However, when the data for the list is obtained from a lookup, the second form
32857 is usually much more convenient. Consider this example:
32858 .code
32859 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32860                                    ${lookup dnsdb {>|mxh=\
32861                                    $sender_address_domain} }} }
32862      message  = The mail servers for the domain \
32863                 $sender_address_domain \
32864                 are listed at $dnslist_domain ($dnslist_value); \
32865                 see $dnslist_text.
32866 .endd
32867 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32868 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32869 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32870 of expanding the condition might be something like this:
32871 .code
32872 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32873 .endd
32874 Thus, this example checks whether or not the IP addresses of the sender
32875 domain's mail servers are on the Spamhaus black list.
32876
32877 The key that was used for a successful DNS list lookup is put into the variable
32878 &$dnslist_matched$& (see section &<<SECID204>>&).
32879
32880
32881
32882
32883 .subsection "Data returned by DNS lists" SECID203
32884 .cindex "DNS list" "data returned from"
32885 DNS lists are constructed using address records in the DNS. The original RBL
32886 just used the address 127.0.0.1 on the right hand side of each record, but the
32887 RBL+ list and some other lists use a number of values with different meanings.
32888 The values used on the RBL+ list are:
32889 .itable none 0 0 2 20* left 80* left
32890 .irow 127.1.0.1  "RBL"
32891 .irow 127.1.0.2  "DUL"
32892 .irow 127.1.0.3  "DUL and RBL"
32893 .irow 127.1.0.4  "RSS"
32894 .irow 127.1.0.5  "RSS and RBL"
32895 .irow 127.1.0.6  "RSS and DUL"
32896 .irow 127.1.0.7  "RSS and DUL and RBL"
32897 .endtable
32898 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32899 different values. Some DNS lists may return more than one address record;
32900 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32901
32902 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32903 range. If a DNSBL operator loses control of the domain, lookups on it
32904 may start returning other addresses.  Because of this, Exim now ignores
32905 returned values outside the 127/8 region.
32906
32907
32908 .subsection "Variables set from DNS lists" SECID204
32909 .cindex "expansion" "variables, set from DNS list"
32910 .cindex "DNS list" "variables set from"
32911 .vindex "&$dnslist_domain$&"
32912 .vindex "&$dnslist_matched$&"
32913 .vindex "&$dnslist_text$&"
32914 .vindex "&$dnslist_value$&"
32915 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32916 the name of the overall domain that matched (for example,
32917 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32918 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32919 the DNS record. When the key is an IP address, it is not reversed in
32920 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32921 cases, for example:
32922 .code
32923 deny dnslists = spamhaus.example
32924 .endd
32925 the key is also available in another variable (in this case,
32926 &$sender_host_address$&). In more complicated cases, however, this is not true.
32927 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32928 might generate a dnslists lookup like this:
32929 .code
32930 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32931 .endd
32932 If this condition succeeds, the value in &$dnslist_matched$& might be
32933 &`192.168.6.7`& (for example).
32934
32935 If more than one address record is returned by the DNS lookup, all the IP
32936 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32937 The variable &$dnslist_text$& contains the contents of any associated TXT
32938 record. For lists such as RBL+ the TXT record for a merged entry is often not
32939 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32940 information.
32941
32942 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32943 &-- even if these appear before the condition in the ACL, they are not
32944 expanded until after it has failed. For example:
32945 .code
32946 deny    hosts = !+local_networks
32947         message = $sender_host_address is listed \
32948                   at $dnslist_domain
32949         dnslists = rbl-plus.mail-abuse.example
32950 .endd
32951
32952
32953
32954 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32955 .cindex "DNS list" "matching specific returned data"
32956 You can add an equals sign and an IP address after a &%dnslists%& domain name
32957 in order to restrict its action to DNS records with a matching right hand side.
32958 For example,
32959 .code
32960 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32961 .endd
32962 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32963 any address record is considered to be a match. For the moment, we assume
32964 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32965 describes how multiple records are handled.
32966
32967 More than one IP address may be given for checking, using a comma as a
32968 separator. These are alternatives &-- if any one of them matches, the
32969 &%dnslists%& condition is true. For example:
32970 .code
32971 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32972 .endd
32973 If you want to specify a constraining address list and also specify names or IP
32974 addresses to be looked up, the constraining address list must be specified
32975 first. For example:
32976 .code
32977 deny dnslists = dsn.rfc-ignorant.org\
32978                 =127.0.0.2/$sender_address_domain
32979 .endd
32980
32981 If the character &`&&`& is used instead of &`=`&, the comparison for each
32982 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32983 In other words, the listed addresses are used as bit masks. The comparison is
32984 true if all the bits in the mask are present in the address that is being
32985 tested. For example:
32986 .code
32987 dnslists = a.b.c&0.0.0.3
32988 .endd
32989 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32990 want to test whether one bit or another bit is present (as opposed to both
32991 being present), you must use multiple values. For example:
32992 .code
32993 dnslists = a.b.c&0.0.0.1,0.0.0.2
32994 .endd
32995 matches if the final component of the address is an odd number or two times
32996 an odd number.
32997
32998
32999
33000 .subsection "Negated DNS matching conditions" SECID205
33001 You can supply a negative list of IP addresses as part of a &%dnslists%&
33002 condition. Whereas
33003 .code
33004 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33005 .endd
33006 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33007 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
33008 .code
33009 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
33010 .endd
33011 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33012 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
33013 words, the result of the test is inverted if an exclamation mark appears before
33014 the &`=`& (or the &`&&`&) sign.
33015
33016 &*Note*&: This kind of negation is not the same as negation in a domain,
33017 host, or address list (which is why the syntax is different).
33018
33019 If you are using just one list, the negation syntax does not gain you much. The
33020 previous example is precisely equivalent to
33021 .code
33022 deny  dnslists = a.b.c
33023      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33024 .endd
33025 However, if you are using multiple lists, the negation syntax is clearer.
33026 Consider this example:
33027 .code
33028 deny  dnslists = sbl.spamhaus.org : \
33029                  list.dsbl.org : \
33030                  dnsbl.njabl.org!=127.0.0.3 : \
33031                  relays.ordb.org
33032 .endd
33033 Using only positive lists, this would have to be:
33034 .code
33035 deny  dnslists = sbl.spamhaus.org : \
33036                  list.dsbl.org
33037 deny  dnslists = dnsbl.njabl.org
33038      !dnslists = dnsbl.njabl.org=127.0.0.3
33039 deny  dnslists = relays.ordb.org
33040 .endd
33041 which is less clear, and harder to maintain.
33042
33043 Negation can also be used with a bitwise-and restriction.
33044 The dnslists condition with only be trus if a result is returned
33045 by the lookup which, anded with the restriction, is all zeroes.
33046 For example:
33047 .code
33048 deny dnslists = zen.spamhaus.org!&0.255.255.0
33049 .endd
33050
33051
33052
33053
33054 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33055 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33056 thereby providing more than one IP address. When an item in a &%dnslists%& list
33057 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33058 the match to specific results from the DNS lookup, there are two ways in which
33059 the checking can be handled. For example, consider the condition:
33060 .code
33061 dnslists = a.b.c=127.0.0.1
33062 .endd
33063 What happens if the DNS lookup for the incoming IP address yields both
33064 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33065 condition true because at least one given value was found, or is it false
33066 because at least one of the found values was not listed? And how does this
33067 affect negated conditions? Both possibilities are provided for with the help of
33068 additional separators &`==`& and &`=&&`&.
33069
33070 .ilist
33071 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33072 IP addresses matches one of the listed addresses. For the example above, the
33073 condition is true because 127.0.0.1 matches.
33074 .next
33075 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33076 looked up IP addresses matches one of the listed addresses. If the condition is
33077 changed to:
33078 .code
33079 dnslists = a.b.c==127.0.0.1
33080 .endd
33081 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33082 false because 127.0.0.2 is not listed. You would need to have:
33083 .code
33084 dnslists = a.b.c==127.0.0.1,127.0.0.2
33085 .endd
33086 for the condition to be true.
33087 .endlist
33088
33089 When &`!`& is used to negate IP address matching, it inverts the result, giving
33090 the precise opposite of the behaviour above. Thus:
33091 .ilist
33092 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33093 addresses matches one of the listed addresses. Consider:
33094 .code
33095 dnslists = a.b.c!&0.0.0.1
33096 .endd
33097 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33098 false because 127.0.0.1 matches.
33099 .next
33100 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33101 looked up IP address that does not match. Consider:
33102 .code
33103 dnslists = a.b.c!=&0.0.0.1
33104 .endd
33105 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33106 true, because 127.0.0.2 does not match. You would need to have:
33107 .code
33108 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33109 .endd
33110 for the condition to be false.
33111 .endlist
33112 When the DNS lookup yields only a single IP address, there is no difference
33113 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33114
33115
33116
33117
33118 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33119 .cindex "DNS list" "information from merged"
33120 When the facility for restricting the matching IP values in a DNS list is used,
33121 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33122 the true reason for rejection. This happens when lists are merged and the IP
33123 address in the A record is used to distinguish them; unfortunately there is
33124 only one TXT record. One way round this is not to use merged lists, but that
33125 can be inefficient because it requires multiple DNS lookups where one would do
33126 in the vast majority of cases when the host of interest is not on any of the
33127 lists.
33128
33129 A less inefficient way of solving this problem is available. If
33130 two domain names, comma-separated, are given, the second is used first to
33131 do an initial check, making use of any IP value restrictions that are set.
33132 If there is a match, the first domain is used, without any IP value
33133 restrictions, to get the TXT record. As a byproduct of this, there is also
33134 a check that the IP being tested is indeed on the first list. The first
33135 domain is the one that is put in &$dnslist_domain$&. For example:
33136 .code
33137 deny   dnslists = \
33138          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33139          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33140        message  = \
33141          rejected because $sender_host_address is blacklisted \
33142          at $dnslist_domain\n$dnslist_text
33143 .endd
33144 For the first blacklist item, this starts by doing a lookup in
33145 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33146 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33147 value, and as long as something is found, it looks for the corresponding TXT
33148 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33149 The second blacklist item is processed similarly.
33150
33151 If you are interested in more than one merged list, the same list must be
33152 given several times, but because the results of the DNS lookups are cached,
33153 the DNS calls themselves are not repeated. For example:
33154 .code
33155 deny dnslists = \
33156          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33157          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33158          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33159          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33160 .endd
33161 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33162 values matches (or if no record is found), this is the only lookup that is
33163 done. Only if there is a match is one of the more specific lists consulted.
33164
33165
33166
33167 .subsection "DNS lists and IPv6" SECTmorednslistslast
33168 .cindex "IPv6" "DNS black lists"
33169 .cindex "DNS list" "IPv6 usage"
33170 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33171 nibble by nibble. For example, if the calling host's IP address is
33172 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33173 .code
33174 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33175   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33176 .endd
33177 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33178 lists contain wildcard records, intended for IPv4, that interact badly with
33179 IPv6. For example, the DNS entry
33180 .code
33181 *.3.some.list.example.    A    127.0.0.1
33182 .endd
33183 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33184 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33185
33186 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33187 &%condition%& condition, as in this example:
33188 .code
33189 deny   condition = ${if isip4{$sender_host_address}}
33190        dnslists  = some.list.example
33191 .endd
33192
33193 If an explicit key is being used for a DNS lookup and it may be an IPv6
33194 address you should specify alternate list separators for both the outer
33195 (DNS list name) list and inner (lookup keys) list:
33196 .code
33197        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33198 .endd
33199
33200
33201 .section "Previously seen user and hosts" "SECTseen"
33202 .cindex "&%seen%& ACL condition"
33203 .cindex greylisting
33204 The &%seen%& ACL condition can be used to test whether a
33205 situation has been previously met.
33206 It uses a hints database to record a timestamp against a key.
33207 The syntax of the condition is:
33208 .display
33209 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33210 .endd
33211
33212 For example,
33213 .code
33214 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33215 .endd
33216 in a RCPT ACL will implement simple greylisting.
33217
33218 The parameters for the condition are
33219 a possible minus sign,
33220 then an interval,
33221 then, slash-separated, a list of options.
33222 The interval is taken as an offset before the current time,
33223 and used for the test.
33224 If the interval is preceded by a minus sign then the condition returns
33225 whether a record is found which is before the test time.
33226 Otherwise, the condition returns whether one is found which is since the
33227 test time.
33228
33229 Options are read in order with later ones overriding earlier ones.
33230
33231 The default key is &$sender_host_address$&.
33232 An explicit key can be set using a &%key=value%& option.
33233
33234 If a &%readonly%& option is given then
33235 no record create or update is done.
33236 If a &%write%& option is given then
33237 a record create or update is always done.
33238 An update is done if the test is for &"since"&.
33239 If none of those hold and there was no existing record,
33240 a record is created.
33241
33242 Creates and updates are marked with the current time.
33243
33244 Finally, a &"before"& test which succeeds, and for which the record
33245 is old enough, will be refreshed with a timestamp of the test time.
33246 This can prevent tidying of the database from removing the entry.
33247 The interval for this is, by default, 10 days.
33248 An explicit interval can be set using a
33249 &%refresh=value%& option.
33250
33251 Note that &"seen"& should be added to the list of hints databases
33252 for maintenance if this ACL condition is used.
33253
33254
33255 .section "Rate limiting incoming messages" "SECTratelimiting"
33256 .cindex "rate limiting" "client sending"
33257 .cindex "limiting client sending rates"
33258 .oindex "&%smtp_ratelimit_*%&"
33259 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33260 which clients can send email. This is more powerful than the
33261 &%smtp_ratelimit_*%& options, because those options control the rate of
33262 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33263 works across all connections (concurrent and sequential) from the same client
33264 host. The syntax of the &%ratelimit%& condition is:
33265 .display
33266 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33267 .endd
33268 If the average client sending rate is less than &'m'& messages per time
33269 period &'p'& then the condition is false; otherwise it is true.
33270
33271 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33272 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33273 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33274 of &'p'&.
33275
33276 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33277 time interval, for example, &`8h`& for eight hours. A larger time constant
33278 means that it takes Exim longer to forget a client's past behaviour. The
33279 parameter &'m'& is the maximum number of messages that a client is permitted to
33280 send in each time interval. It also specifies the number of messages permitted
33281 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33282 constant, you can allow a client to send more messages in a burst without
33283 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33284 both small, messages must be sent at an even rate.
33285
33286 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33287 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33288 when deploying the &%ratelimit%& ACL condition. The script prints usage
33289 instructions when it is run with no arguments.
33290
33291 The key is used to look up the data for calculating the client's average
33292 sending rate. This data is stored in Exim's spool directory, alongside the
33293 retry and other hints databases. The default key is &$sender_host_address$&,
33294 which means Exim computes the sending rate of each client host IP address.
33295 By changing the key you can change how Exim identifies clients for the purpose
33296 of ratelimiting. For example, to limit the sending rate of each authenticated
33297 user, independent of the computer they are sending from, set the key to
33298 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33299 example, &$authenticated_id$& is only meaningful if the client has
33300 authenticated (which you can check with the &%authenticated%& ACL condition).
33301
33302 The lookup key does not have to identify clients: If you want to limit the
33303 rate at which a recipient receives messages, you can use the key
33304 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33305 ACL.
33306
33307 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33308 specifies what Exim measures the rate of, for example, messages or recipients
33309 or bytes. You can adjust the measurement using the &%unique=%& and/or
33310 &%count=%& options. You can also control when Exim updates the recorded rate
33311 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33312 separated by a slash, like the other parameters. They may appear in any order.
33313
33314 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33315 any options that alter the meaning of the stored data. The limit &'m'& is not
33316 stored, so you can alter the configured maximum rate and Exim will still
33317 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33318 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33319 behaviour. The lookup key is not affected by changes to the update mode and
33320 the &%count=%& option.
33321
33322
33323 .subsection "Ratelimit options for what is being measured" ratoptmea
33324 .cindex "rate limiting" "per_* options"
33325 .vlist
33326 .vitem per_conn
33327 .cindex "rate limiting" per_conn
33328 This option limits the client's connection rate. It is not
33329 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33330 &%acl_not_smtp_start%& ACLs.
33331
33332 .vitem per_mail
33333 .cindex "rate limiting" per_conn
33334 This option limits the client's rate of sending messages. This is
33335 the default if none of the &%per_*%& options is specified. It can be used in
33336 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33337 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33338
33339 .vitem per_byte
33340 .cindex "rate limiting" per_conn
33341 This option limits the sender's email bandwidth. It can be used in
33342 the same ACLs as the &%per_mail%& option, though it is best to use this option
33343 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33344 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33345 in its MAIL command, which may be inaccurate or completely missing. You can
33346 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33347 in kilobytes, megabytes, or gigabytes, respectively.
33348
33349 .vitem per_rcpt
33350 .cindex "rate limiting" per_rcpt
33351 This option causes Exim to limit the rate at which recipients are
33352 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33353 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33354 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33355 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33356 in either case the rate limiting engine will see a message with many
33357 recipients as a large high-speed burst.
33358
33359 .vitem per_addr
33360 .cindex "rate limiting" per_addr
33361 This option is like the &%per_rcpt%& option, except it counts the
33362 number of different recipients that the client has sent messages to in the
33363 last time period. That is, if the client repeatedly sends messages to the same
33364 recipient, its measured rate is not increased. This option can only be used in
33365 &%acl_smtp_rcpt%&.
33366
33367 .vitem per_cmd
33368 .cindex "rate limiting" per_cmd
33369 This option causes Exim to recompute the rate every time the
33370 condition is processed. This can be used to limit the rate of any SMTP
33371 command. If it is used in multiple ACLs it can limit the aggregate rate of
33372 multiple different commands.
33373
33374 .vitem count
33375 .cindex "rate limiting" count
33376 This option can be used to alter how much Exim adds to the client's
33377 measured rate.
33378 A value is required, after an equals sign.
33379 For example, the &%per_byte%& option is equivalent to
33380 &`per_mail/count=$message_size`&.
33381 If there is no &%count=%& option, Exim
33382 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33383 other than &%acl_smtp_rcpt%&).
33384 The count does not have to be an integer.
33385
33386 .vitem unique
33387 .cindex "rate limiting" unique
33388 This option is described in section &<<ratoptuniq>>& below.
33389 .endlist
33390
33391
33392 .subsection "Ratelimit update modes" ratoptupd
33393 .cindex "rate limiting" "reading data without updating"
33394 You can specify one of three options with the &%ratelimit%& condition to
33395 control when its database is updated. This section describes the &%readonly%&
33396 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33397
33398 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33399 previously-computed rate to check against the limit.
33400
33401 For example, you can test the client's sending rate and deny it access (when
33402 it is too fast) in the connect ACL. If the client passes this check then it
33403 can go on to send a message, in which case its recorded rate will be updated
33404 in the MAIL ACL. Subsequent connections from the same client will check this
33405 new rate.
33406 .code
33407 acl_check_connect:
33408  deny ratelimit = 100 / 5m / readonly
33409       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33410                   (max $sender_rate_limit)
33411 # ...
33412 acl_check_mail:
33413  warn ratelimit = 100 / 5m / strict
33414       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33415                   (max $sender_rate_limit)
33416 .endd
33417
33418 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33419 processing a message then it may increase the client's measured rate more than
33420 it should. For example, this will happen if you check the &%per_rcpt%& option
33421 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33422 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33423 multiple update problems by using the &%readonly%& option on later ratelimit
33424 checks.
33425
33426 The &%per_*%& options described above do not make sense in some ACLs. If you
33427 use a &%per_*%& option in an ACL where it is not normally permitted then the
33428 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33429 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33430 next section) so you must specify the &%readonly%& option explicitly.
33431
33432
33433 .subsection "Ratelimit options for handling fast clients" ratoptfast
33434 .cindex "rate limiting" "strict and leaky modes"
33435 If a client's average rate is greater than the maximum, the rate limiting
33436 engine can react in two possible ways, depending on the presence of the
33437 &%strict%& or &%leaky%& update modes. This is independent of the other
33438 counter-measures (such as rejecting the message) that may be specified by the
33439 rest of the ACL.
33440
33441 The &%leaky%& (default) option means that the client's recorded rate is not
33442 updated if it is above the limit. The effect of this is that Exim measures the
33443 client's average rate of successfully sent email,
33444 up to the given limit.
33445 This is appropriate if the countermeasure when the condition is true
33446 consists of refusing the message, and
33447 is generally the better choice if you have clients that retry automatically.
33448 If the action when true is anything more complex then this option is
33449 likely not what is wanted.
33450
33451 The &%strict%& option means that the client's recorded rate is always
33452 updated. The effect of this is that Exim measures the client's average rate
33453 of attempts to send email, which can be much higher than the maximum it is
33454 actually allowed. If the client is over the limit it may be subjected to
33455 counter-measures by the ACL. It must slow down and allow sufficient time to
33456 pass that its computed rate falls below the maximum before it can send email
33457 again. The time (the number of smoothing periods) it must wait and not
33458 attempt to send mail can be calculated with this formula:
33459 .code
33460         ln(peakrate/maxrate)
33461 .endd
33462
33463
33464 .subsection "Limiting the rate of different events" ratoptuniq
33465 .cindex "rate limiting" "counting unique events"
33466 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33467 rate of different events. For example, the &%per_addr%& option uses this
33468 mechanism to count the number of different recipients that the client has
33469 sent messages to in the last time period; it is equivalent to
33470 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33471 measure the rate that a client uses different sender addresses with the
33472 options &`per_mail/unique=$sender_address`&.
33473
33474 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33475 has seen for that key. The whole set is thrown away when it is older than the
33476 rate smoothing period &'p'&, so each different event is counted at most once
33477 per period. In the &%leaky%& update mode, an event that causes the client to
33478 go over the limit is not added to the set, in the same way that the client's
33479 recorded rate is not updated in the same situation.
33480
33481 When you combine the &%unique=%& and &%readonly%& options, the specific
33482 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33483 rate.
33484
33485 The &%unique=%& mechanism needs more space in the ratelimit database than the
33486 other &%ratelimit%& options in order to store the event set. The number of
33487 unique values is potentially as large as the rate limit, so the extra space
33488 required increases with larger limits.
33489
33490 The uniqueification is not perfect: there is a small probability that Exim
33491 will think a new event has happened before. If the sender's rate is less than
33492 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33493 the measured rate can go above the limit, in which case Exim may under-count
33494 events by a significant margin. Fortunately, if the rate is high enough (2.7
33495 times the limit) that the false positive rate goes above 9%, then Exim will
33496 throw away the over-full event set before the measured rate falls below the
33497 limit. Therefore the only harm should be that exceptionally high sending rates
33498 are logged incorrectly; any countermeasures you configure will be as effective
33499 as intended.
33500
33501
33502 .subsection "Using rate limiting" useratlim
33503 Exim's other ACL facilities are used to define what counter-measures are taken
33504 when the rate limit is exceeded. This might be anything from logging a warning
33505 (for example, while measuring existing sending rates in order to define
33506 policy), through time delays to slow down fast senders, up to rejecting the
33507 message. For example:
33508 .code
33509 # Log all senders' rates
33510 warn ratelimit = 0 / 1h / strict
33511      log_message = Sender rate $sender_rate / $sender_rate_period
33512
33513 # Slow down fast senders; note the need to truncate $sender_rate
33514 # at the decimal point.
33515 warn ratelimit = 100 / 1h / per_rcpt / strict
33516      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33517                    $sender_rate_limit }s
33518
33519 # Keep authenticated users under control
33520 deny authenticated = *
33521      ratelimit = 100 / 1d / strict / $authenticated_id
33522
33523 # System-wide rate limit
33524 defer ratelimit = 10 / 1s / $primary_hostname
33525       message = Sorry, too busy. Try again later.
33526
33527 # Restrict incoming rate from each host, with a default
33528 # set using a macro and special cases looked up in a table.
33529 defer ratelimit = ${lookup {$sender_host_address} \
33530                    cdb {DB/ratelimits.cdb} \
33531                    {$value} {RATELIMIT} }
33532       message = Sender rate exceeds $sender_rate_limit \
33533                messages per $sender_rate_period
33534 .endd
33535 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33536 especially with the &%per_rcpt%& option, you may suffer from a performance
33537 bottleneck caused by locking on the ratelimit hints database. Apart from
33538 making your ACLs less complicated, you can reduce the problem by using a
33539 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33540 this means that Exim will lose its hints data after a reboot (including retry
33541 hints, the callout cache, and ratelimit data).
33542
33543
33544
33545 .section "Address verification" "SECTaddressverification"
33546 .cindex "verifying address" "options for"
33547 .cindex "policy control" "address verification"
33548 Several of the &%verify%& conditions described in section
33549 &<<SECTaclconditions>>& cause addresses to be verified. Section
33550 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33551 The verification conditions can be followed by options that modify the
33552 verification process. The options are separated from the keyword and from each
33553 other by slashes, and some of them contain parameters. For example:
33554 .code
33555 verify = sender/callout
33556 verify = recipient/defer_ok/callout=10s,defer_ok
33557 .endd
33558 The first stage of address verification, which always happens, is to run the
33559 address through the routers, in &"verify mode"&. Routers can detect the
33560 difference between verification and routing for delivery, and their actions can
33561 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33562 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33563 The available options are as follows:
33564
33565 .ilist
33566 If the &%callout%& option is specified, successful routing to one or more
33567 remote hosts is followed by a &"callout"& to those hosts as an additional
33568 check. Callouts and their sub-options are discussed in the next section.
33569 .next
33570 If there is a defer error while doing verification routing, the ACL
33571 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33572 options, the condition is forced to be true instead. Note that this is a main
33573 verification option as well as a suboption for callouts.
33574 .next
33575 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33576 discusses the reporting of sender address verification failures.
33577 .next
33578 The &%success_on_redirect%& option causes verification always to succeed
33579 immediately after a successful redirection. By default, if a redirection
33580 generates just one address, that address is also verified. See further
33581 discussion in section &<<SECTredirwhilveri>>&.
33582 .next
33583 If the &%quota%& option is specified for recipient verify,
33584 successful routing to an appendfile transport is followed by a call into
33585 the transport to evaluate the quota status for the recipient.
33586 No actual delivery is done, but verification will succeed if the quota
33587 is sufficient for the message (if the sender gave a message size) or
33588 not already exceeded (otherwise).
33589 .endlist
33590
33591 .cindex "verifying address" "differentiating failures"
33592 .vindex "&$recipient_verify_failure$&"
33593 .vindex "&$sender_verify_failure$&"
33594 .vindex "&$acl_verify_message$&"
33595 After an address verification failure, &$acl_verify_message$& contains the
33596 error message that is associated with the failure. It can be preserved by
33597 coding like this:
33598 .code
33599 warn  !verify = sender
33600        set acl_m0 = $acl_verify_message
33601 .endd
33602 If you are writing your own custom rejection message or log message when
33603 denying access, you can use this variable to include information about the
33604 verification failure.
33605 This variable is cleared at the end of processing the ACL verb.
33606
33607 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33608 appropriate) contains one of the following words:
33609
33610 .ilist
33611 &%qualify%&: The address was unqualified (no domain), and the message
33612 was neither local nor came from an exempted host.
33613 .next
33614 &%route%&: Routing failed.
33615 .next
33616 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33617 occurred at or before the MAIL command (that is, on initial
33618 connection, HELO, or MAIL).
33619 .next
33620 &%recipient%&: The RCPT command in a callout was rejected.
33621 .next
33622 &%postmaster%&: The postmaster check in a callout was rejected.
33623 .next
33624 &%quota%&: The quota check for a local recipient did non pass.
33625 .endlist
33626
33627 The main use of these variables is expected to be to distinguish between
33628 rejections of MAIL and rejections of RCPT in callouts.
33629
33630 The above variables may also be set after a &*successful*&
33631 address verification to:
33632
33633 .ilist
33634 &%random%&: A random local-part callout succeeded
33635 .endlist
33636
33637
33638
33639
33640 .section "Callout verification" "SECTcallver"
33641 .cindex "verifying address" "by callout"
33642 .cindex "callout" "verification"
33643 .cindex "SMTP" "callout verification"
33644 For non-local addresses, routing verifies the domain, but is unable to do any
33645 checking of the local part. There are situations where some means of verifying
33646 the local part is desirable. One way this can be done is to make an SMTP
33647 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33648 a subsequent host for a recipient address, to see if the host accepts the
33649 address. We use the term &'callout'& to cover both cases. Note that for a
33650 sender address, the callback is not to the client host that is trying to
33651 deliver the message, but to one of the hosts that accepts incoming mail for the
33652 sender's domain.
33653
33654 Exim does not do callouts by default. If you want them to happen, you must
33655 request them by setting appropriate options on the &%verify%& condition, as
33656 described below. This facility should be used with care, because it can add a
33657 lot of resource usage to the cost of verifying an address. However, Exim does
33658 cache the results of callouts, which helps to reduce the cost. Details of
33659 caching are in section &<<SECTcallvercache>>&.
33660
33661 Recipient callouts are usually used only between hosts that are controlled by
33662 the same administration. For example, a corporate gateway host could use
33663 callouts to check for valid recipients on an internal mailserver. A successful
33664 callout does not guarantee that a real delivery to the address would succeed;
33665 on the other hand, a failing callout does guarantee that a delivery would fail.
33666
33667 If the &%callout%& option is present on a condition that verifies an address, a
33668 second stage of verification occurs if the address is successfully routed to
33669 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33670 &(manualroute)& router, where the router specifies the hosts. However, if a
33671 router that does not set up hosts routes to an &(smtp)& transport with a
33672 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33673 &%hosts_override%& set, its hosts are always used, whether or not the router
33674 supplies a host list.
33675 Callouts are only supported on &(smtp)& transports.
33676
33677 The port that is used is taken from the transport, if it is specified and is a
33678 remote transport. (For routers that do verification only, no transport need be
33679 specified.) Otherwise, the default SMTP port is used. If a remote transport
33680 specifies an outgoing interface, this is used; otherwise the interface is not
33681 specified. Likewise, the text that is used for the HELO command is taken from
33682 the transport's &%helo_data%& option; if there is no transport, the value of
33683 &$smtp_active_hostname$& is used.
33684
33685 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33686 test whether a bounce message could be delivered to the sender address. The
33687 following SMTP commands are sent:
33688 .display
33689 &`HELO `&<&'local host name'&>
33690 &`MAIL FROM:<>`&
33691 &`RCPT TO:`&<&'the address to be tested'&>
33692 &`QUIT`&
33693 .endd
33694 LHLO is used instead of HELO if the transport's &%protocol%& option is
33695 set to &"lmtp"&.
33696
33697 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33698 settings.
33699
33700 A recipient callout check is similar. By default, it also uses an empty address
33701 for the sender. This default is chosen because most hosts do not make use of
33702 the sender address when verifying a recipient. Using the same address means
33703 that a single cache entry can be used for each recipient. Some sites, however,
33704 do make use of the sender address when verifying. These are catered for by the
33705 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33706
33707 If the response to the RCPT command is a 2&'xx'& code, the verification
33708 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33709 Exim tries the next host, if any. If there is a problem with all the remote
33710 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33711 &%callout%& option is given, in which case the condition is forced to succeed.
33712
33713 .cindex "SMTP" "output flushing, disabling for callout"
33714 A callout may take a little time. For this reason, Exim normally flushes SMTP
33715 output before performing a callout in an ACL, to avoid unexpected timeouts in
33716 clients when the SMTP PIPELINING extension is in use. The flushing can be
33717 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33718
33719 .cindex "tainted data" "de-tainting"
33720 .cindex "de-tainting" "using recipient verify"
33721 A recipient callout which gets a 2&'xx'& code
33722 will assign untainted values to the
33723 &$domain_data$& and &$local_part_data$& variables,
33724 corresponding to the domain and local parts of the recipient address.
33725
33726
33727
33728
33729 .subsection "Additional parameters for callouts" CALLaddparcall
33730 .cindex "callout" "additional parameters for"
33731 The &%callout%& option can be followed by an equals sign and a number of
33732 optional parameters, separated by commas. For example:
33733 .code
33734 verify = recipient/callout=10s,defer_ok
33735 .endd
33736 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33737 separate verify options, is retained for backwards compatibility, but is now
33738 deprecated. The additional parameters for &%callout%& are as follows:
33739
33740
33741 .vlist
33742 .vitem <&'a&~time&~interval'&>
33743 .cindex "callout" "timeout, specifying"
33744 This specifies the timeout that applies for the callout attempt to each host.
33745 For example:
33746 .code
33747 verify = sender/callout=5s
33748 .endd
33749 The default is 30 seconds. The timeout is used for each response from the
33750 remote host. It is also used for the initial connection, unless overridden by
33751 the &%connect%& parameter.
33752
33753
33754 .vitem &*connect&~=&~*&<&'time&~interval'&>
33755 .cindex "callout" "connection timeout, specifying"
33756 This parameter makes it possible to set a different (usually smaller) timeout
33757 for making the SMTP connection. For example:
33758 .code
33759 verify = sender/callout=5s,connect=1s
33760 .endd
33761 If not specified, this timeout defaults to the general timeout value.
33762
33763 .vitem &*defer_ok*&
33764 .cindex "callout" "defer, action on"
33765 When this parameter is present, failure to contact any host, or any other kind
33766 of temporary error, is treated as success by the ACL. However, the cache is not
33767 updated in this circumstance.
33768
33769 .vitem &*fullpostmaster*&
33770 .cindex "callout" "full postmaster check"
33771 This operates like the &%postmaster%& option (see below), but if the check for
33772 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33773 accordance with the specification in RFC 2821. The RFC states that the
33774 unqualified address &'postmaster'& should be accepted.
33775
33776
33777 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33778 .cindex "callout" "sender when verifying header"
33779 When verifying addresses in header lines using the &%header_sender%&
33780 verification option, Exim behaves by default as if the addresses are envelope
33781 sender addresses from a message. Callout verification therefore tests to see
33782 whether a bounce message could be delivered, by using an empty address in the
33783 MAIL command. However, it is arguable that these addresses might never be used
33784 as envelope senders, and could therefore justifiably reject bounce messages
33785 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33786 address to use in the MAIL command. For example:
33787 .code
33788 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33789 .endd
33790 This parameter is available only for the &%header_sender%& verification option.
33791
33792
33793 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33794 .cindex "callout" "overall timeout, specifying"
33795 This parameter sets an overall timeout for performing a callout verification.
33796 For example:
33797 .code
33798 verify = sender/callout=5s,maxwait=30s
33799 .endd
33800 This timeout defaults to four times the callout timeout for individual SMTP
33801 commands. The overall timeout applies when there is more than one host that can
33802 be tried. The timeout is checked before trying the next host. This prevents
33803 very long delays if there are a large number of hosts and all are timing out
33804 (for example, when network connections are timing out).
33805
33806
33807 .vitem &*no_cache*&
33808 .cindex "callout" "cache, suppressing"
33809 .cindex "caching callout, suppressing"
33810 When this parameter is given, the callout cache is neither read nor updated.
33811
33812 .vitem &*postmaster*&
33813 .cindex "callout" "postmaster; checking"
33814 When this parameter is set, a successful callout check is followed by a similar
33815 check for the local part &'postmaster'& at the same domain. If this address is
33816 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33817 the postmaster check is recorded in a cache record; if it is a failure, this is
33818 used to fail subsequent callouts for the domain without a connection being
33819 made, until the cache record expires.
33820
33821 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33822 The postmaster check uses an empty sender in the MAIL command by default.
33823 You can use this parameter to do a postmaster check using a different address.
33824 For example:
33825 .code
33826 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33827 .endd
33828 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33829 one overrides. The &%postmaster%& parameter is equivalent to this example:
33830 .code
33831 require  verify = sender/callout=postmaster_mailfrom=
33832 .endd
33833 &*Warning*&: The caching arrangements for postmaster checking do not take
33834 account of the sender address. It is assumed that either the empty address or
33835 a fixed non-empty address will be used. All that Exim remembers is that the
33836 postmaster check for the domain succeeded or failed.
33837
33838
33839 .vitem &*random*&
33840 .cindex "callout" "&""random""& check"
33841 When this parameter is set, before doing the normal callout check, Exim does a
33842 check for a &"random"& local part at the same domain. The local part is not
33843 really random &-- it is defined by the expansion of the option
33844 &%callout_random_local_part%&, which defaults to
33845 .code
33846 $primary_hostname-$tod_epoch-testing
33847 .endd
33848 The idea here is to try to determine whether the remote host accepts all local
33849 parts without checking. If it does, there is no point in doing callouts for
33850 specific local parts. If the &"random"& check succeeds, the result is saved in
33851 a cache record, and used to force the current and subsequent callout checks to
33852 succeed without a connection being made, until the cache record expires.
33853
33854 .vitem &*use_postmaster*&
33855 .cindex "callout" "sender for recipient check"
33856 This parameter applies to recipient callouts only. For example:
33857 .code
33858 deny  !verify = recipient/callout=use_postmaster
33859 .endd
33860 .vindex "&$qualify_domain$&"
33861 It causes a non-empty postmaster address to be used in the MAIL command when
33862 performing the callout for the recipient, and also for a &"random"& check if
33863 that is configured. The local part of the address is &`postmaster`& and the
33864 domain is the contents of &$qualify_domain$&.
33865
33866 .vitem &*use_sender*&
33867 This option applies to recipient callouts only. For example:
33868 .code
33869 require  verify = recipient/callout=use_sender
33870 .endd
33871 It causes the message's actual sender address to be used in the MAIL
33872 command when performing the callout, instead of an empty address. There is no
33873 need to use this option unless you know that the called hosts make use of the
33874 sender when checking recipients. If used indiscriminately, it reduces the
33875 usefulness of callout caching.
33876
33877 .vitem &*hold*&
33878 This option applies to recipient callouts only. For example:
33879 .code
33880 require  verify = recipient/callout=use_sender,hold
33881 .endd
33882 It causes the connection to be held open and used for any further recipients
33883 and for eventual delivery (should that be done quickly).
33884 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33885 when that is used for the connections.
33886 The advantage is only gained if there are no callout cache hits
33887 (which could be enforced by the no_cache option),
33888 if the use_sender option is used,
33889 if neither the random nor the use_postmaster option is used,
33890 and if no other callouts intervene.
33891 .endlist
33892
33893 If you use any of the parameters that set a non-empty sender for the MAIL
33894 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33895 &%use_sender%&), you should think about possible loops. Recipient checking is
33896 usually done between two hosts that are under the same management, and the host
33897 that receives the callouts is not normally configured to do callouts itself.
33898 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33899 these circumstances.
33900
33901 However, if you use a non-empty sender address for a callout to an arbitrary
33902 host, there is the likelihood that the remote host will itself initiate a
33903 callout check back to your host. As it is checking what appears to be a message
33904 sender, it is likely to use an empty address in MAIL, thus avoiding a
33905 callout loop. However, to be on the safe side it would be best to set up your
33906 own ACLs so that they do not do sender verification checks when the recipient
33907 is the address you use for header sender or postmaster callout checking.
33908
33909 Another issue to think about when using non-empty senders for callouts is
33910 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33911 by the sender/recipient combination; thus, for any given recipient, many more
33912 actual callouts are performed than when an empty sender or postmaster is used.
33913
33914
33915
33916
33917 .subsection "Callout caching" SECTcallvercache
33918 .cindex "hints database" "callout cache"
33919 .cindex "callout" "cache, description of"
33920 .cindex "caching" "callout"
33921 Exim caches the results of callouts in order to reduce the amount of resources
33922 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33923 option. A hints database called &"callout"& is used for the cache. Two
33924 different record types are used: one records the result of a callout check for
33925 a specific address, and the other records information that applies to the
33926 entire domain (for example, that it accepts the local part &'postmaster'&).
33927
33928 When an original callout fails, a detailed SMTP error message is given about
33929 the failure. However, for subsequent failures that use the cache data, this message
33930 is not available.
33931
33932 The expiry times for negative and positive address cache records are
33933 independent, and can be set by the global options &%callout_negative_expire%&
33934 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33935
33936 If a host gives a negative response to an SMTP connection, or rejects any
33937 commands up to and including
33938 .code
33939 MAIL FROM:<>
33940 .endd
33941 (but not including the MAIL command with a non-empty address),
33942 any callout attempt is bound to fail. Exim remembers such failures in a
33943 domain cache record, which it uses to fail callouts for the domain without
33944 making new connections, until the domain record times out. There are two
33945 separate expiry times for domain cache records:
33946 &%callout_domain_negative_expire%& (default 3h) and
33947 &%callout_domain_positive_expire%& (default 7d).
33948
33949 Domain records expire when the negative expiry time is reached if callouts
33950 cannot be made for the domain, or if the postmaster check failed.
33951 Otherwise, they expire when the positive expiry time is reached. This
33952 ensures that, for example, a host that stops accepting &"random"& local parts
33953 will eventually be noticed.
33954
33955 The callout caching mechanism is based on the domain of the address that is
33956 being tested. If the domain routes to several hosts, it is assumed that their
33957 behaviour will be the same.
33958
33959
33960
33961 .section "Quota caching" "SECTquotacache"
33962 .cindex "hints database" "quota cache"
33963 .cindex "quota" "cache, description of"
33964 .cindex "caching" "quota"
33965 Exim caches the results of quota verification
33966 in order to reduce the amount of resources used.
33967 The &"callout"& hints database is used.
33968
33969 The default cache periods are five minutes for a positive (good) result
33970 and one hour for a negative result.
33971 To change the periods the &%quota%& option can be followed by an equals sign
33972 and a number of optional paramemters, separated by commas.
33973 For example:
33974 .code
33975 verify = recipient/quota=cachepos=1h,cacheneg=1d
33976 .endd
33977 Possible parameters are:
33978 .vlist
33979 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33980 .cindex "quota cache" "positive entry expiry, specifying"
33981 Set the lifetime for a positive cache entry.
33982 A value of zero seconds is legitimate.
33983
33984 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33985 .cindex "quota cache" "negative entry expiry, specifying"
33986 As above, for a negative entry.
33987
33988 .vitem &*no_cache*&
33989 Set both positive and negative lifetimes to zero.
33990
33991 .section "Sender address verification reporting" "SECTsenaddver"
33992 .cindex "verifying" "suppressing error details"
33993 See section &<<SECTaddressverification>>& for a general discussion of
33994 verification. When sender verification fails in an ACL, the details of the
33995 failure are given as additional output lines before the 550 response to the
33996 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33997 you might see:
33998 .code
33999 MAIL FROM:<xyz@abc.example>
34000 250 OK
34001 RCPT TO:<pqr@def.example>
34002 550-Verification failed for <xyz@abc.example>
34003 550-Called:   192.168.34.43
34004 550-Sent:     RCPT TO:<xyz@abc.example>
34005 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
34006 550 Sender verification failed
34007 .endd
34008 If more than one RCPT command fails in the same way, the details are given
34009 only for the first of them. However, some administrators do not want to send
34010 out this much information. You can suppress the details by adding
34011 &`/no_details`& to the ACL statement that requests sender verification. For
34012 example:
34013 .code
34014 verify = sender/no_details
34015 .endd
34016
34017 .section "Redirection while verifying" "SECTredirwhilveri"
34018 .cindex "verifying" "redirection while"
34019 .cindex "address redirection" "while verifying"
34020 A dilemma arises when a local address is redirected by aliasing or forwarding
34021 during verification: should the generated addresses themselves be verified,
34022 or should the successful expansion of the original address be enough to verify
34023 it? By default, Exim takes the following pragmatic approach:
34024
34025 .ilist
34026 When an incoming address is redirected to just one child address, verification
34027 continues with the child address, and if that fails to verify, the original
34028 verification also fails.
34029 .next
34030 When an incoming address is redirected to more than one child address,
34031 verification does not continue. A success result is returned.
34032 .endlist
34033
34034 This seems the most reasonable behaviour for the common use of aliasing as a
34035 way of redirecting different local parts to the same mailbox. It means, for
34036 example, that a pair of alias entries of the form
34037 .code
34038 A.Wol:   aw123
34039 aw123:   :fail: Gone away, no forwarding address
34040 .endd
34041 work as expected, with both local parts causing verification failure. When a
34042 redirection generates more than one address, the behaviour is more like a
34043 mailing list, where the existence of the alias itself is sufficient for
34044 verification to succeed.
34045
34046 It is possible, however, to change the default behaviour so that all successful
34047 redirections count as successful verifications, however many new addresses are
34048 generated. This is specified by the &%success_on_redirect%& verification
34049 option. For example:
34050 .code
34051 require verify = recipient/success_on_redirect/callout=10s
34052 .endd
34053 In this example, verification succeeds if a router generates a new address, and
34054 the callout does not occur, because no address was routed to a remote host.
34055
34056 When verification is being tested via the &%-bv%& option, the treatment of
34057 redirections is as just described, unless the &%-v%& or any debugging option is
34058 also specified. In that case, full verification is done for every generated
34059 address and a report is output for each of them.
34060
34061
34062
34063 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34064 .cindex "CSA" "verifying"
34065 Client SMTP Authorization is a system that allows a site to advertise
34066 which machines are and are not permitted to send email. This is done by placing
34067 special SRV records in the DNS; these are looked up using the client's HELO
34068 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34069 Authorization checks in Exim are performed by the ACL condition:
34070 .code
34071 verify = csa
34072 .endd
34073 This fails if the client is not authorized. If there is a DNS problem, or if no
34074 valid CSA SRV record is found, or if the client is authorized, the condition
34075 succeeds. These three cases can be distinguished using the expansion variable
34076 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34077 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34078 be likely to cause problems for legitimate email.
34079
34080 The error messages produced by the CSA code include slightly more
34081 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34082 looking up the CSA SRV record, or problems looking up the CSA target
34083 address record. There are four reasons for &$csa_status$& being &"fail"&:
34084
34085 .ilist
34086 The client's host name is explicitly not authorized.
34087 .next
34088 The client's IP address does not match any of the CSA target IP addresses.
34089 .next
34090 The client's host name is authorized but it has no valid target IP addresses
34091 (for example, the target's addresses are IPv6 and the client is using IPv4).
34092 .next
34093 The client's host name has no CSA SRV record but a parent domain has asserted
34094 that all subdomains must be explicitly authorized.
34095 .endlist
34096
34097 The &%csa%& verification condition can take an argument which is the domain to
34098 use for the DNS query. The default is:
34099 .code
34100 verify = csa/$sender_helo_name
34101 .endd
34102 This implementation includes an extension to CSA. If the query domain
34103 is an address literal such as [192.0.2.95], or if it is a bare IP
34104 address, Exim searches for CSA SRV records in the reverse DNS as if
34105 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34106 meaningful to say:
34107 .code
34108 verify = csa/$sender_host_address
34109 .endd
34110 In fact, this is the check that Exim performs if the client does not say HELO.
34111 This extension can be turned off by setting the main configuration option
34112 &%dns_csa_use_reverse%& to be false.
34113
34114 If a CSA SRV record is not found for the domain itself, a search
34115 is performed through its parent domains for a record which might be
34116 making assertions about subdomains. The maximum depth of this search is limited
34117 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34118 default. Exim does not look for CSA SRV records in a top level domain, so the
34119 default settings handle HELO domains as long as seven
34120 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34121 of legitimate HELO domains.
34122
34123 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34124 direct SRV lookups, this is not sufficient because of the extra parent domain
34125 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34126 addresses into lookups in the reverse DNS space. The result of a successful
34127 lookup such as:
34128 .code
34129 ${lookup dnsdb {csa=$sender_helo_name}}
34130 .endd
34131 has two space-separated fields: an authorization code and a target host name.
34132 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34133 authorization required but absent, or &"?"& for unknown.
34134
34135
34136
34137
34138 .section "Bounce address tag validation" "SECTverifyPRVS"
34139 .cindex "BATV, verifying"
34140 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34141 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34142 Genuine incoming bounce messages should therefore always be addressed to
34143 recipients that have a valid tag. This scheme is a way of detecting unwanted
34144 bounce messages caused by sender address forgeries (often called &"collateral
34145 spam"&), because the recipients of such messages do not include valid tags.
34146
34147 There are two expansion items to help with the implementation of the BATV
34148 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34149 the original envelope sender address by using a simple key to add a hash of the
34150 address and some time-based randomizing information. The &%prvs%& expansion
34151 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34152 The syntax of these expansion items is described in section
34153 &<<SECTexpansionitems>>&.
34154 The validity period on signed addresses is seven days.
34155
34156 As an example, suppose the secret per-address keys are stored in an MySQL
34157 database. A query to look up the key for an address could be defined as a macro
34158 like this:
34159 .code
34160 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34161                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34162                 }{$value}}
34163 .endd
34164 Suppose also that the senders who make use of BATV are defined by an address
34165 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34166 use this:
34167 .code
34168 # Bounces: drop unsigned addresses for BATV senders
34169 deny senders = :
34170      recipients = +batv_senders
34171      message = This address does not send an unsigned reverse path
34172
34173 # Bounces: In case of prvs-signed address, check signature.
34174 deny senders = :
34175      condition  = ${prvscheck {$local_part@$domain}\
34176                   {PRVSCHECK_SQL}{1}}
34177      !condition = $prvscheck_result
34178      message = Invalid reverse path signature.
34179 .endd
34180 The first statement rejects recipients for bounce messages that are addressed
34181 to plain BATV sender addresses, because it is known that BATV senders do not
34182 send out messages with plain sender addresses. The second statement rejects
34183 recipients that are prvs-signed, but with invalid signatures (either because
34184 the key is wrong, or the signature has timed out).
34185
34186 A non-prvs-signed address is not rejected by the second statement, because the
34187 &%prvscheck%& expansion yields an empty string if its first argument is not a
34188 prvs-signed address, thus causing the &%condition%& condition to be false. If
34189 the first argument is a syntactically valid prvs-signed address, the yield is
34190 the third string (in this case &"1"&), whether or not the cryptographic and
34191 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34192 of the checks (empty for failure, &"1"& for success).
34193
34194 There is one more issue you must consider when implementing prvs-signing:
34195 you have to ensure that the routers accept prvs-signed addresses and
34196 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34197 router to remove the signature with a configuration along these lines:
34198 .code
34199 batv_redirect:
34200   driver = redirect
34201   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34202 .endd
34203 This works because, if the third argument of &%prvscheck%& is empty, the result
34204 of the expansion of a prvs-signed address is the decoded value of the original
34205 address. This router should probably be the first of your routers that handles
34206 local addresses.
34207
34208 To create BATV-signed addresses in the first place, a transport of this form
34209 can be used:
34210 .code
34211 external_smtp_batv:
34212   driver = smtp
34213   return_path = ${prvs {$return_path} \
34214                        {${lookup mysql{SELECT \
34215                        secret FROM batv_prvs WHERE \
34216                        sender='${quote_mysql:$sender_address}'} \
34217                        {$value}fail}}}
34218 .endd
34219 If no key can be found for the existing return path, no signing takes place.
34220
34221
34222
34223 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34224 .cindex "&ACL;" "relay control"
34225 .cindex "relaying" "control by ACL"
34226 .cindex "policy control" "relay control"
34227 An MTA is said to &'relay'& a message if it receives it from some host and
34228 delivers it directly to another host as a result of a remote address contained
34229 within it. Redirecting a local address via an alias or forward file and then
34230 passing the message on to another host is not relaying,
34231 .cindex "&""percent hack""&"
34232 but a redirection as a result of the &"percent hack"& is.
34233
34234 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34235 A host which is acting as a gateway or an MX backup is concerned with incoming
34236 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34237 a host which is acting as a smart host for a number of clients is concerned
34238 with outgoing relaying from those clients to the Internet at large. Often the
34239 same host is fulfilling both functions,
34240 . ///
34241 . as illustrated in the diagram below,
34242 . ///
34243 but in principle these two kinds of relaying are entirely independent. What is
34244 not wanted is the transmission of mail from arbitrary remote hosts through your
34245 system to arbitrary domains.
34246
34247
34248 You can implement relay control by means of suitable statements in the ACL that
34249 runs for each RCPT command. For convenience, it is often easiest to use
34250 Exim's named list facility to define the domains and hosts involved. For
34251 example, suppose you want to do the following:
34252
34253 .ilist
34254 Deliver a number of domains to mailboxes on the local host (or process them
34255 locally in some other way). Let's say these are &'my.dom1.example'& and
34256 &'my.dom2.example'&.
34257 .next
34258 Relay mail for a number of other domains for which you are the secondary MX.
34259 These might be &'friend1.example'& and &'friend2.example'&.
34260 .next
34261 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34262 Suppose your LAN is 192.168.45.0/24.
34263 .endlist
34264
34265
34266 In the main part of the configuration, you put the following definitions:
34267 .code
34268 domainlist local_domains    = my.dom1.example : my.dom2.example
34269 domainlist relay_to_domains = friend1.example : friend2.example
34270 hostlist   relay_from_hosts = 192.168.45.0/24
34271 .endd
34272 Now you can use these definitions in the ACL that is run for every RCPT
34273 command:
34274 .code
34275 acl_check_rcpt:
34276   accept domains = +local_domains : +relay_to_domains
34277   accept hosts   = +relay_from_hosts
34278 .endd
34279 The first statement accepts any RCPT command that contains an address in
34280 the local or relay domains. For any other domain, control passes to the second
34281 statement, which accepts the command only if it comes from one of the relay
34282 hosts. In practice, you will probably want to make your ACL more sophisticated
34283 than this, for example, by including sender and recipient verification. The
34284 default configuration includes a more comprehensive example, which is described
34285 in chapter &<<CHAPdefconfil>>&.
34286
34287
34288
34289 .section "Checking a relay configuration" "SECTcheralcon"
34290 .cindex "relaying" "checking control of"
34291 You can check the relay characteristics of your configuration in the same way
34292 that you can test any ACL behaviour for an incoming SMTP connection, by using
34293 the &%-bh%& option to run a fake SMTP session with which you interact.
34294 .ecindex IIDacl
34295
34296
34297
34298 . ////////////////////////////////////////////////////////////////////////////
34299 . ////////////////////////////////////////////////////////////////////////////
34300
34301 .chapter "Content scanning at ACL time" "CHAPexiscan"
34302 .scindex IIDcosca "content scanning" "at ACL time"
34303 The extension of Exim to include content scanning at ACL time, formerly known
34304 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34305 was integrated into the main source for Exim release 4.50, and Tom continues to
34306 maintain it. Most of the wording of this chapter is taken from Tom's
34307 specification.
34308
34309 It is also possible to scan the content of messages at other times. The
34310 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34311 scanning after all the ACLs have run. A transport filter can be used to scan
34312 messages at delivery time (see the &%transport_filter%& option, described in
34313 chapter &<<CHAPtransportgeneric>>&).
34314
34315 If you want to include the ACL-time content-scanning features when you compile
34316 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34317 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34318
34319 .ilist
34320 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34321 for all MIME parts for SMTP and non-SMTP messages, respectively.
34322 .next
34323 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34324 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34325 run at the end of message reception (the &%acl_smtp_data%& ACL).
34326 .next
34327 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34328 of messages, or parts of messages, for debugging purposes.
34329 .next
34330 Additional expansion variables that are set in the new ACL and by the new
34331 conditions.
34332 .next
34333 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34334 .endlist
34335
34336 Content-scanning is continually evolving, and new features are still being
34337 added. While such features are still unstable and liable to incompatible
34338 changes, they are made available in Exim by setting options whose names begin
34339 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34340 this manual. You can find out about them by reading the file called
34341 &_doc/experimental.txt_&.
34342
34343 All the content-scanning facilities work on a MBOX copy of the message that is
34344 temporarily created in a file called:
34345 .display
34346 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34347 .endd
34348 The &_.eml_& extension is a friendly hint to virus scanners that they can
34349 expect an MBOX-like structure inside that file. The file is created when the
34350 first content scanning facility is called. Subsequent calls to content
34351 scanning conditions open the same file again. The directory is recursively
34352 removed when the &%acl_smtp_data%& ACL has finished running, unless
34353 .code
34354 control = no_mbox_unspool
34355 .endd
34356 has been encountered. When the MIME ACL decodes files, they are put into the
34357 same directory by default.
34358
34359
34360
34361 .section "Scanning for viruses" "SECTscanvirus"
34362 .cindex "virus scanning"
34363 .cindex "content scanning" "for viruses"
34364 .cindex "content scanning" "the &%malware%& condition"
34365 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34366 It supports a &"generic"& interface to scanners called via the shell, and
34367 specialized interfaces for &"daemon"& type virus scanners, which are resident
34368 in memory and thus are much faster.
34369
34370 Since message data needs to have arrived,
34371 the condition may be only called in ACL defined by
34372 &%acl_smtp_data%&,
34373 &%acl_smtp_data_prdr%&,
34374 &%acl_smtp_mime%& or
34375 &%acl_smtp_dkim%&
34376
34377 A timeout of 2 minutes is applied to a scanner call (by default);
34378 if it expires then a defer action is taken.
34379
34380 .oindex "&%av_scanner%&"
34381 You can set the &%av_scanner%& option in the main part of the configuration
34382 to specify which scanner to use, together with any additional options that
34383 are needed. The basic syntax is as follows:
34384 .display
34385 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34386 .endd
34387 If you do not set &%av_scanner%&, it defaults to
34388 .code
34389 av_scanner = sophie:/var/run/sophie
34390 .endd
34391 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34392 before use.
34393 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34394 The following scanner types are supported in this release,
34395 though individual ones can be included or not at build time:
34396
34397 .vlist
34398 .vitem &%avast%&
34399 .cindex "virus scanners" "avast"
34400 This is the scanner daemon of Avast. It has been tested with Avast Core
34401 Security (currently at version 2.2.0).
34402 You can get a trial version at &url(https://www.avast.com) or for Linux
34403 at &url(https://www.avast.com/linux-server-antivirus).
34404 This scanner type takes one option,
34405 which can be either a full path to a UNIX socket,
34406 or host and port specifiers separated by white space.
34407 The host may be a name or an IP address; the port is either a
34408 single number or a pair of numbers with a dash between.
34409 A list of options may follow. These options are interpreted on the
34410 Exim's side of the malware scanner, or are given on separate lines to
34411 the daemon as options before the main scan command.
34412
34413 .cindex &`pass_unscanned`& "avast"
34414 If &`pass_unscanned`&
34415 is set, any files the Avast scanner can't scan (e.g.
34416 decompression bombs, or invalid archives) are considered clean. Use with
34417 care.
34418
34419 For example:
34420 .code
34421 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34422 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34423 av_scanner = avast:192.168.2.22 5036
34424 .endd
34425 If you omit the argument, the default path
34426 &_/var/run/avast/scan.sock_&
34427 is used.
34428 If you use a remote host,
34429 you need to make Exim's spool directory available to it,
34430 as the scanner is passed a file path, not file contents.
34431 For information about available commands and their options you may use
34432 .code
34433 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34434     FLAGS
34435     SENSITIVITY
34436     PACK
34437 .endd
34438
34439 If the scanner returns a temporary failure (e.g. license issues, or
34440 permission problems), the message is deferred and a paniclog entry is
34441 written.  The usual &`defer_ok`& option is available.
34442
34443 .vitem &%aveserver%&
34444 .cindex "virus scanners" "Kaspersky"
34445 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34446 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34447 which is the path to the daemon's UNIX socket. The default is shown in this
34448 example:
34449 .code
34450 av_scanner = aveserver:/var/run/aveserver
34451 .endd
34452
34453
34454 .vitem &%clamd%&
34455 .cindex "virus scanners" "clamd"
34456 This daemon-type scanner is GPL and free. You can get it at
34457 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34458 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34459 in the MIME ACL. This is no longer believed to be necessary.
34460
34461 The options are a list of server specifiers, which may be
34462 a UNIX socket specification,
34463 a TCP socket specification,
34464 or a (global) option.
34465
34466 A socket specification consists of a space-separated list.
34467 For a Unix socket the first element is a full path for the socket,
34468 for a TCP socket the first element is the IP address
34469 and the second a port number,
34470 Any further elements are per-server (non-global) options.
34471 These per-server options are supported:
34472 .code
34473 retry=<timespec>        Retry on connect fail
34474 .endd
34475
34476 The &`retry`& option specifies a time after which a single retry for
34477 a failed connect is made.  The default is to not retry.
34478
34479 If a Unix socket file is specified, only one server is supported.
34480
34481 Examples:
34482 .code
34483 av_scanner = clamd:/opt/clamd/socket
34484 av_scanner = clamd:192.0.2.3 1234
34485 av_scanner = clamd:192.0.2.3 1234:local
34486 av_scanner = clamd:192.0.2.3 1234 retry=10s
34487 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34488 .endd
34489 If the value of av_scanner points to a UNIX socket file or contains the
34490 &`local`&
34491 option, then the ClamAV interface will pass a filename containing the data
34492 to be scanned, which should normally result in less I/O happening and be
34493 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34494 Exim does not assume that there is a common filesystem with the remote host.
34495
34496 The final example shows that multiple TCP targets can be specified.  Exim will
34497 randomly use one for each incoming email (i.e. it load balances them).  Note
34498 that only TCP targets may be used if specifying a list of scanners; a UNIX
34499 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34500 unavailable, Exim will try the remaining one(s) until it finds one that works.
34501 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34502 not keep track of scanner state between multiple messages, and the scanner
34503 selection is random, so the message will get logged in the mainlog for each
34504 email that the down scanner gets chosen first (message wrapped to be readable):
34505 .code
34506 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34507    clamd: connection to localhost, port 3310 failed
34508    (Connection refused)
34509 .endd
34510
34511 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34512 contributing the code for this scanner.
34513
34514 .vitem &%cmdline%&
34515 .cindex "virus scanners" "command line interface"
34516 This is the keyword for the generic command line scanner interface. It can be
34517 used to attach virus scanners that are invoked from the shell. This scanner
34518 type takes 3 mandatory options:
34519
34520 .olist
34521 The full path and name of the scanner binary, with all command line options,
34522 and a placeholder (&`%s`&) for the directory to scan.
34523
34524 .next
34525 A regular expression to match against the STDOUT and STDERR output of the
34526 virus scanner. If the expression matches, a virus was found. You must make
34527 absolutely sure that this expression matches on &"virus found"&. This is called
34528 the &"trigger"& expression.
34529
34530 .next
34531 Another regular expression, containing exactly one pair of parentheses, to
34532 match the name of the virus found in the scanners output. This is called the
34533 &"name"& expression.
34534 .endlist olist
34535
34536 For example, Sophos Sweep reports a virus on a line like this:
34537 .code
34538 Virus 'W32/Magistr-B' found in file ./those.bat
34539 .endd
34540 For the trigger expression, we can match the phrase &"found in file"&. For the
34541 name expression, we want to extract the W32/Magistr-B string, so we can match
34542 for the single quotes left and right of it. Altogether, this makes the
34543 configuration setting:
34544 .code
34545 av_scanner = cmdline:\
34546              /path/to/sweep -ss -all -rec -archive %s:\
34547              found in file:'(.+)'
34548 .endd
34549 .vitem &%drweb%&
34550 .cindex "virus scanners" "DrWeb"
34551 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34552 takes one option,
34553 either a full path to a UNIX socket,
34554 or host and port specifiers separated by white space.
34555 The host may be a name or an IP address; the port is either a
34556 single number or a pair of numbers with a dash between.
34557 For example:
34558 .code
34559 av_scanner = drweb:/var/run/drwebd.sock
34560 av_scanner = drweb:192.168.2.20 31337
34561 .endd
34562 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34563 is used. Thanks to Alex Miller for contributing the code for this scanner.
34564
34565 .vitem &%f-protd%&
34566 .cindex "virus scanners" "f-protd"
34567 The f-protd scanner is accessed via HTTP over TCP.
34568 One argument is taken, being a space-separated hostname and port number
34569 (or port-range).
34570 For example:
34571 .code
34572 av_scanner = f-protd:localhost 10200-10204
34573 .endd
34574 If you omit the argument, the default values shown above are used.
34575
34576 .vitem &%f-prot6d%&
34577 .cindex "virus scanners" "f-prot6d"
34578 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34579 One argument is taken, being a space-separated hostname and port number.
34580 For example:
34581 .code
34582 av_scanner = f-prot6d:localhost 10200
34583 .endd
34584 If you omit the argument, the default values show above are used.
34585
34586 .vitem &%fsecure%&
34587 .cindex "virus scanners" "F-Secure"
34588 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34589 argument which is the path to a UNIX socket. For example:
34590 .code
34591 av_scanner = fsecure:/path/to/.fsav
34592 .endd
34593 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34594 Thelmen for contributing the code for this scanner.
34595
34596 .vitem &%kavdaemon%&
34597 .cindex "virus scanners" "Kaspersky"
34598 This is the scanner daemon of Kaspersky Version 4. This version of the
34599 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34600 scanner type takes one option, which is the path to the daemon's UNIX socket.
34601 For example:
34602 .code
34603 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34604 .endd
34605 The default path is &_/var/run/AvpCtl_&.
34606
34607 .vitem &%mksd%&
34608 .cindex "virus scanners" "mksd"
34609 This was a daemon type scanner that is aimed mainly at Polish users,
34610 though some documentation was available in English.
34611 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34612 and this appears to be a candidate for removal from Exim, unless
34613 we are informed of other virus scanners which use the same protocol
34614 to integrate.
34615 The only option for this scanner type is
34616 the maximum number of processes used simultaneously to scan the attachments,
34617 provided that mksd has
34618 been run with at least the same number of child processes. For example:
34619 .code
34620 av_scanner = mksd:2
34621 .endd
34622 You can safely omit this option (the default value is 1).
34623
34624 .vitem &%sock%&
34625 .cindex "virus scanners" "simple socket-connected"
34626 This is a general-purpose way of talking to simple scanner daemons
34627 running on the local machine.
34628 There are four options:
34629 an address (which may be an IP address and port, or the path of a Unix socket),
34630 a commandline to send (may include a single %s which will be replaced with
34631 the path to the mail file to be scanned),
34632 an RE to trigger on from the returned data,
34633 and an RE to extract malware_name from the returned data.
34634 For example:
34635 .code
34636 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34637 .endd
34638 Note that surrounding whitespace is stripped from each option, meaning
34639 there is no way to specify a trailing newline.
34640 The socket specifier and both regular-expressions are required.
34641 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34642 specify an empty element to get this.
34643
34644 .vitem &%sophie%&
34645 .cindex "virus scanners" "Sophos and Sophie"
34646 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34647 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34648 for this scanner type is the path to the UNIX socket that Sophie uses for
34649 client communication. For example:
34650 .code
34651 av_scanner = sophie:/tmp/sophie
34652 .endd
34653 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34654 the option.
34655 .endlist
34656
34657 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34658 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34659 ACL.
34660
34661 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34662 makes it possible to use different scanners. See further below for an example.
34663 The &%malware%& condition caches its results, so when you use it multiple times
34664 for the same message, the actual scanning process is only carried out once.
34665 However, using expandable items in &%av_scanner%& disables this caching, in
34666 which case each use of the &%malware%& condition causes a new scan of the
34667 message.
34668
34669 The &%malware%& condition takes a right-hand argument that is expanded before
34670 use and taken as a list, slash-separated by default.
34671 The first element can then be one of
34672
34673 .ilist
34674 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34675 The condition succeeds if a virus was found, and fail otherwise. This is the
34676 recommended usage.
34677 .next
34678 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34679 the condition fails immediately.
34680 .next
34681 A regular expression, in which case the message is scanned for viruses. The
34682 condition succeeds if a virus is found and its name matches the regular
34683 expression. This allows you to take special actions on certain types of virus.
34684 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34685 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34686 .endlist
34687
34688 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34689 messages even if there is a problem with the virus scanner.
34690 Otherwise, such a problem causes the ACL to defer.
34691
34692 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34693 specify a non-default timeout.  The default is two minutes.
34694 For example:
34695 .code
34696 malware = * / defer_ok / tmo=10s
34697 .endd
34698 A timeout causes the ACL to defer.
34699
34700 .vindex "&$callout_address$&"
34701 When a connection is made to the scanner the expansion variable &$callout_address$&
34702 is set to record the actual address used.
34703
34704 .vindex "&$malware_name$&"
34705 When a virus is found, the condition sets up an expansion variable called
34706 &$malware_name$& that contains the name of the virus. You can use it in a
34707 &%message%& modifier that specifies the error returned to the sender, and/or in
34708 logging data.
34709
34710 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34711 imposed by your anti-virus scanner.
34712
34713 Here is a very simple scanning example:
34714 .code
34715 deny malware = *
34716      message = This message contains malware ($malware_name)
34717 .endd
34718 The next example accepts messages when there is a problem with the scanner:
34719 .code
34720 deny malware = */defer_ok
34721      message = This message contains malware ($malware_name)
34722 .endd
34723 The next example shows how to use an ACL variable to scan with both sophie and
34724 aveserver. It assumes you have set:
34725 .code
34726 av_scanner = $acl_m0
34727 .endd
34728 in the main Exim configuration.
34729 .code
34730 deny set acl_m0 = sophie
34731      malware = *
34732      message = This message contains malware ($malware_name)
34733
34734 deny set acl_m0 = aveserver
34735      malware = *
34736      message = This message contains malware ($malware_name)
34737 .endd
34738
34739
34740 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34741 .cindex "content scanning" "for spam"
34742 .cindex "spam scanning"
34743 .cindex "SpamAssassin"
34744 .cindex "Rspamd"
34745 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34746 score and a report for the message.
34747 Support is also provided for Rspamd.
34748
34749 For more information about installation and configuration of SpamAssassin or
34750 Rspamd refer to their respective websites at
34751 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34752
34753 SpamAssassin can be installed with CPAN by running:
34754 .code
34755 perl -MCPAN -e 'install Mail::SpamAssassin'
34756 .endd
34757 SpamAssassin has its own set of configuration files. Please review its
34758 documentation to see how you can tweak it. The default installation should work
34759 nicely, however.
34760
34761 .oindex "&%spamd_address%&"
34762 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34763 intend to use an instance running on the local host you do not need to set
34764 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34765 you must set the &%spamd_address%& option in the global part of the Exim
34766 configuration as follows (example):
34767 .code
34768 spamd_address = 192.168.99.45 783
34769 .endd
34770 The SpamAssassin protocol relies on a TCP half-close from the client.
34771 If your SpamAssassin client side is running a Linux system with an
34772 iptables firewall, consider setting
34773 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34774 timeout, Exim uses when waiting for a response from the SpamAssassin
34775 server (currently defaulting to 120s).  With a lower value the Linux
34776 connection tracking may consider your half-closed connection as dead too
34777 soon.
34778
34779
34780 To use Rspamd (which by default listens on all local addresses
34781 on TCP port 11333)
34782 you should add &%variant=rspamd%& after the address/port pair, for example:
34783 .code
34784 spamd_address = 127.0.0.1 11333 variant=rspamd
34785 .endd
34786
34787 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34788 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34789 filename instead of an address/port pair:
34790 .code
34791 spamd_address = /var/run/spamd_socket
34792 .endd
34793 You can have multiple &%spamd%& servers to improve scalability. These can
34794 reside on other hardware reachable over the network. To specify multiple
34795 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34796 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34797 .code
34798 spamd_address = 192.168.2.10 783 : \
34799                 192.168.2.11 783 : \
34800                 192.168.2.12 783
34801 .endd
34802 Up to 32 &%spamd%& servers are supported.
34803 When a server fails to respond to the connection attempt, all other
34804 servers are tried until one succeeds. If no server responds, the &%spam%&
34805 condition defers.
34806
34807 Unix and TCP socket specifications may be mixed in any order.
34808 Each element of the list is a list itself, space-separated by default
34809 and changeable in the usual way (&<<SECTlistsepchange>>&);
34810 take care to not double the separator.
34811
34812 For TCP socket specifications a host name or IP (v4 or v6, but
34813 subject to list-separator quoting rules) address can be used,
34814 and the port can be one or a dash-separated pair.
34815 In the latter case, the range is tried in strict order.
34816
34817 Elements after the first for Unix sockets, or second for TCP socket,
34818 are options.
34819 The supported options are:
34820 .code
34821 pri=<priority>      Selection priority
34822 weight=<value>      Selection bias
34823 time=<start>-<end>  Use only between these times of day
34824 retry=<timespec>    Retry on connect fail
34825 tmo=<timespec>      Connection time limit
34826 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34827 .endd
34828
34829 The &`pri`& option specifies a priority for the server within the list,
34830 higher values being tried first.
34831 The default priority is 1.
34832
34833 The &`weight`& option specifies a selection bias.
34834 Within a priority set
34835 servers are queried in a random fashion, weighted by this value.
34836 The default value for selection bias is 1.
34837
34838 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34839 in the local time zone; each element being one or more digits.
34840 Either the seconds or both minutes and seconds, plus the leading &`.`&
34841 characters, may be omitted and will be taken as zero.
34842
34843 Timeout specifications for the &`retry`& and &`tmo`& options
34844 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34845
34846 The &`tmo`& option specifies an overall timeout for communication.
34847 The default value is two minutes.
34848
34849 The &`retry`& option specifies a time after which a single retry for
34850 a failed connect is made.
34851 The default is to not retry.
34852
34853 The &%spamd_address%& variable is expanded before use if it starts with
34854 a dollar sign. In this case, the expansion may return a string that is
34855 used as the list so that multiple spamd servers can be the result of an
34856 expansion.
34857
34858 .vindex "&$callout_address$&"
34859 When a connection is made to the server the expansion variable &$callout_address$&
34860 is set to record the actual address used.
34861
34862 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34863 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34864 .code
34865 deny spam = joe
34866      message = This message was classified as SPAM
34867 .endd
34868 The right-hand side of the &%spam%& condition specifies a name. This is
34869 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34870 to scan using a specific profile, but rather use the SpamAssassin system-wide
34871 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34872 Rspamd does not use this setting. However, you must put something on the
34873 right-hand side.
34874
34875 The name allows you to use per-domain or per-user antispam profiles in
34876 principle, but this is not straightforward in practice, because a message may
34877 have multiple recipients, not necessarily all in the same domain. Because the
34878 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34879 read the contents of the message, the variables &$local_part$& and &$domain$&
34880 are not set.
34881 Careful enforcement of single-recipient messages
34882 (e.g. by responding with defer in the recipient ACL for all recipients
34883 after the first),
34884 or the use of PRDR,
34885 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34886 are needed to use this feature.
34887
34888 The right-hand side of the &%spam%& condition is expanded before being used, so
34889 you can put lookups or conditions there. When the right-hand side evaluates to
34890 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34891
34892
34893 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34894 large ones may cause significant performance degradation. As most spam messages
34895 are quite small, it is recommended that you do not scan the big ones. For
34896 example:
34897 .code
34898 deny condition = ${if < {$message_size}{10K}}
34899      spam = nobody
34900      message = This message was classified as SPAM
34901 .endd
34902
34903 The &%spam%& condition returns true if the threshold specified in the user's
34904 SpamAssassin profile has been matched or exceeded. If you want to use the
34905 &%spam%& condition for its side effects (see the variables below), you can make
34906 it always return &"true"& by appending &`:true`& to the username.
34907
34908 .cindex "spam scanning" "returned variables"
34909 When the &%spam%& condition is run, it sets up a number of expansion
34910 variables.
34911 Except for &$spam_report$&,
34912 these variables are saved with the received message so are
34913 available for use at delivery time.
34914
34915 .vlist
34916 .vitem &$spam_score$&
34917 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34918 for inclusion in log or reject messages.
34919
34920 .vitem &$spam_score_int$&
34921 The spam score of the message, multiplied by ten, as an integer value. For
34922 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34923 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34924 The integer value is useful for numeric comparisons in conditions.
34925
34926 .vitem &$spam_bar$&
34927 A string consisting of a number of &"+"& or &"-"& characters, representing the
34928 integer part of the spam score value. A spam score of 4.4 would have a
34929 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34930 headers, since MUAs can match on such strings. The maximum length of the
34931 spam bar is 50 characters.
34932
34933 .vitem &$spam_report$&
34934 A multiline text table, containing the full SpamAssassin report for the
34935 message. Useful for inclusion in headers or reject messages.
34936 This variable is only usable in a DATA-time ACL.
34937 Beware that SpamAssassin may return non-ASCII characters, especially
34938 when running in country-specific locales, which are not legal
34939 unencoded in headers.
34940
34941 .vitem &$spam_action$&
34942 For SpamAssassin either 'reject' or 'no action' depending on the
34943 spam score versus threshold.
34944 For Rspamd, the recommended action.
34945
34946 .endlist
34947
34948 The &%spam%& condition caches its results unless expansion in
34949 spamd_address was used. If you call it again with the same user name, it
34950 does not scan again, but rather returns the same values as before.
34951
34952 The &%spam%& condition returns DEFER if there is any error while running
34953 the message through SpamAssassin or if the expansion of spamd_address
34954 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34955 statement block), append &`/defer_ok`& to the right-hand side of the
34956 spam condition, like this:
34957 .code
34958 deny spam    = joe/defer_ok
34959      message = This message was classified as SPAM
34960 .endd
34961 This causes messages to be accepted even if there is a problem with &%spamd%&.
34962
34963 Here is a longer, commented example of the use of the &%spam%&
34964 condition:
34965 .code
34966 # put headers in all messages (no matter if spam or not)
34967 warn  spam = nobody:true
34968       add_header = X-Spam-Score: $spam_score ($spam_bar)
34969       add_header = X-Spam-Report: $spam_report
34970
34971 # add second subject line with *SPAM* marker when message
34972 # is over threshold
34973 warn  spam = nobody
34974       add_header = Subject: *SPAM* $h_Subject:
34975
34976 # reject spam at high scores (> 12)
34977 deny  spam = nobody:true
34978       condition = ${if >{$spam_score_int}{120}{1}{0}}
34979       message = This message scored $spam_score spam points.
34980 .endd
34981
34982
34983
34984 .section "Scanning MIME parts" "SECTscanmimepart"
34985 .cindex "content scanning" "MIME parts"
34986 .cindex "MIME content scanning"
34987 .oindex "&%acl_smtp_mime%&"
34988 .oindex "&%acl_not_smtp_mime%&"
34989 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34990 each MIME part of an SMTP message, including multipart types, in the sequence
34991 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34992 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34993 options may both refer to the same ACL if you want the same processing in both
34994 cases.
34995
34996 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34997 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34998 the case of a non-SMTP message. However, a MIME ACL is called only if the
34999 message contains a &'Content-Type:'& header line. When a call to a MIME
35000 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
35001 result code is sent to the client. In the case of an SMTP message, the
35002 &%acl_smtp_data%& ACL is not called when this happens.
35003
35004 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
35005 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
35006 condition to match against the raw MIME part. You can also use the
35007 &%mime_regex%& condition to match against the decoded MIME part (see section
35008 &<<SECTscanregex>>&).
35009
35010 At the start of a MIME ACL, a number of variables are set from the header
35011 information for the relevant MIME part. These are described below. The contents
35012 of the MIME part are not by default decoded into a disk file except for MIME
35013 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
35014 part into a disk file, you can use the &%decode%& condition. The general
35015 syntax is:
35016 .display
35017 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35018 .endd
35019 The right hand side is expanded before use. After expansion,
35020 the value can be:
35021
35022 .olist
35023 &"0"& or &"false"&, in which case no decoding is done.
35024 .next
35025 The string &"default"&. In that case, the file is put in the temporary
35026 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35027 a sequential filename consisting of the message id and a sequence number. The
35028 full path and name is available in &$mime_decoded_filename$& after decoding.
35029 .next
35030 A full path name starting with a slash. If the full name is an existing
35031 directory, it is used as a replacement for the default directory. The filename
35032 is then sequentially assigned. If the path does not exist, it is used as
35033 the full path and filename.
35034 .next
35035 If the string does not start with a slash, it is used as the
35036 filename, and the default path is then used.
35037 .endlist
35038 The &%decode%& condition normally succeeds. It is only false for syntax
35039 errors or unusual circumstances such as memory shortages. You can easily decode
35040 a file with its original, proposed filename using
35041 .code
35042 decode = $mime_filename
35043 .endd
35044 However, you should keep in mind that &$mime_filename$& might contain
35045 anything. If you place files outside of the default path, they are not
35046 automatically unlinked.
35047
35048 For RFC822 attachments (these are messages attached to messages, with a
35049 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35050 as for the primary message, only that the &$mime_is_rfc822$& expansion
35051 variable is set (see below). Attached messages are always decoded to disk
35052 before being checked, and the files are unlinked once the check is done.
35053
35054 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35055 used to match regular expressions against raw and decoded MIME parts,
35056 respectively. They are described in section &<<SECTscanregex>>&.
35057
35058 .cindex "MIME content scanning" "returned variables"
35059 The following list describes all expansion variables that are
35060 available in the MIME ACL:
35061
35062 .vlist
35063 .vitem &$mime_anomaly_level$& &&&
35064        &$mime_anomaly_text$&
35065 .vindex &$mime_anomaly_level$&
35066 .vindex &$mime_anomaly_text$&
35067 If there are problems decoding, these variables contain information on
35068 the detected issue.
35069
35070 .vitem &$mime_boundary$&
35071 .vindex &$mime_boundary$&
35072 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35073 have a boundary string, which is stored in this variable. If the current part
35074 has no boundary parameter in the &'Content-Type:'& header, this variable
35075 contains the empty string.
35076
35077 .vitem &$mime_charset$&
35078 .vindex &$mime_charset$&
35079 This variable contains the character set identifier, if one was found in the
35080 &'Content-Type:'& header. Examples for charset identifiers are:
35081 .code
35082 us-ascii
35083 gb2312 (Chinese)
35084 iso-8859-1
35085 .endd
35086 Please note that this value is not normalized, so you should do matches
35087 case-insensitively.
35088
35089 .vitem &$mime_content_description$&
35090 .vindex &$mime_content_description$&
35091 This variable contains the normalized content of the &'Content-Description:'&
35092 header. It can contain a human-readable description of the parts content. Some
35093 implementations repeat the filename for attachments here, but they are usually
35094 only used for display purposes.
35095
35096 .vitem &$mime_content_disposition$&
35097 .vindex &$mime_content_disposition$&
35098 This variable contains the normalized content of the &'Content-Disposition:'&
35099 header. You can expect strings like &"attachment"& or &"inline"& here.
35100
35101 .vitem &$mime_content_id$&
35102 .vindex &$mime_content_id$&
35103 This variable contains the normalized content of the &'Content-ID:'& header.
35104 This is a unique ID that can be used to reference a part from another part.
35105
35106 .vitem &$mime_content_size$&
35107 .vindex &$mime_content_size$&
35108 This variable is set only after the &%decode%& modifier (see above) has been
35109 successfully run. It contains the size of the decoded part in kilobytes. The
35110 size is always rounded up to full kilobytes, so only a completely empty part
35111 has a &$mime_content_size$& of zero.
35112
35113 .vitem &$mime_content_transfer_encoding$&
35114 .vindex &$mime_content_transfer_encoding$&
35115 This variable contains the normalized content of the
35116 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35117 type. Typical values are &"base64"& and &"quoted-printable"&.
35118
35119 .vitem &$mime_content_type$&
35120 .vindex &$mime_content_type$&
35121 If the MIME part has a &'Content-Type:'& header, this variable contains its
35122 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35123 are some examples of popular MIME types, as they may appear in this variable:
35124 .code
35125 text/plain
35126 text/html
35127 application/octet-stream
35128 image/jpeg
35129 audio/midi
35130 .endd
35131 If the MIME part has no &'Content-Type:'& header, this variable contains the
35132 empty string.
35133
35134 .vitem &$mime_decoded_filename$&
35135 .vindex &$mime_decoded_filename$&
35136 This variable is set only after the &%decode%& modifier (see above) has been
35137 successfully run. It contains the full path and filename of the file
35138 containing the decoded data.
35139 .endlist
35140
35141 .cindex "RFC 2047"
35142 .vlist
35143 .vitem &$mime_filename$&
35144 .vindex &$mime_filename$&
35145 This is perhaps the most important of the MIME variables. It contains a
35146 proposed filename for an attachment, if one was found in either the
35147 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35148 RFC2047
35149 or RFC2231
35150 decoded, but no additional sanity checks are done.
35151  If no filename was
35152 found, this variable contains the empty string.
35153
35154 .vitem &$mime_is_coverletter$&
35155 .vindex &$mime_is_coverletter$&
35156 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35157 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35158 content in the cover letter, while not restricting attachments at all.
35159
35160 The variable contains 1 (true) for a MIME part believed to be part of the
35161 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35162 follows:
35163
35164 .olist
35165 The outermost MIME part of a message is always a cover letter.
35166
35167 .next
35168 If a multipart/alternative or multipart/related MIME part is a cover letter,
35169 so are all MIME subparts within that multipart.
35170
35171 .next
35172 If any other multipart is a cover letter, the first subpart is a cover letter,
35173 and the rest are attachments.
35174
35175 .next
35176 All parts contained within an attachment multipart are attachments.
35177 .endlist olist
35178
35179 As an example, the following will ban &"HTML mail"& (including that sent with
35180 alternative plain text), while allowing HTML files to be attached. HTML
35181 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35182 .code
35183 deny !condition = $mime_is_rfc822
35184      condition = $mime_is_coverletter
35185      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35186      message = HTML mail is not accepted here
35187 .endd
35188
35189 .vitem &$mime_is_multipart$&
35190 .vindex &$mime_is_multipart$&
35191 This variable has the value 1 (true) when the current part has the main type
35192 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35193 Since multipart entities only serve as containers for other parts, you may not
35194 want to carry out specific actions on them.
35195
35196 .vitem &$mime_is_rfc822$&
35197 .vindex &$mime_is_rfc822$&
35198 This variable has the value 1 (true) if the current part is not a part of the
35199 checked message itself, but part of an attached message. Attached message
35200 decoding is fully recursive.
35201
35202 .vitem &$mime_part_count$&
35203 .vindex &$mime_part_count$&
35204 This variable is a counter that is raised for each processed MIME part. It
35205 starts at zero for the very first part (which is usually a multipart). The
35206 counter is per-message, so it is reset when processing RFC822 attachments (see
35207 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35208 complete, so you can use it in the DATA ACL to determine the number of MIME
35209 parts of a message. For non-MIME messages, this variable contains the value -1.
35210 .endlist
35211
35212
35213
35214 .section "Scanning with regular expressions" "SECTscanregex"
35215 .cindex "content scanning" "with regular expressions"
35216 .cindex "regular expressions" "content scanning with"
35217 You can specify your own custom regular expression matches on the full body of
35218 the message, or on individual MIME parts.
35219
35220 The &%regex%& condition takes one or more regular expressions as arguments and
35221 matches them against the full message (when called in the DATA ACL) or a raw
35222 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35223 linewise, with a maximum line length of 32K characters. That means you cannot
35224 have multiline matches with the &%regex%& condition.
35225
35226 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35227 to 32K of decoded content (the whole content at once, not linewise). If the
35228 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35229 is decoded automatically when &%mime_regex%& is executed (using default path
35230 and filename values). If the decoded data is larger than  32K, only the first
35231 32K characters are checked.
35232
35233 The regular expressions are passed as a colon-separated list. To include a
35234 literal colon, you must double it. Since the whole right-hand side string is
35235 expanded before being used, you must also escape dollar signs and backslashes
35236 with more backslashes, or use the &`\N`& facility to disable expansion.
35237 Here is a simple example that contains two regular expressions:
35238 .code
35239 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35240      message = contains blacklisted regex ($regex_match_string)
35241 .endd
35242 The conditions returns true if any one of the regular expressions matches. The
35243 &$regex_match_string$& expansion variable is then set up and contains the
35244 matching regular expression.
35245 The expansion variables &$regex1$& &$regex2$& etc
35246 are set to any substrings captured by the regular expression.
35247
35248 &*Warning*&: With large messages, these conditions can be fairly
35249 CPU-intensive.
35250
35251 .ecindex IIDcosca
35252
35253
35254
35255
35256 . ////////////////////////////////////////////////////////////////////////////
35257 . ////////////////////////////////////////////////////////////////////////////
35258
35259 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35260          "Local scan function"
35261 .scindex IIDlosca "&[local_scan()]& function" "description of"
35262 .cindex "customizing" "input scan using C function"
35263 .cindex "policy control" "by local scan function"
35264 In these days of email worms, viruses, and ever-increasing spam, some sites
35265 want to apply a lot of checking to messages before accepting them.
35266
35267 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35268 passing messages to external virus and spam scanning software. You can also do
35269 a certain amount in Exim itself through string expansions and the &%condition%&
35270 condition in the ACL that runs after the SMTP DATA command or the ACL for
35271 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35272
35273 To allow for further customization to a site's own requirements, there is the
35274 possibility of linking Exim with a private message scanning function, written
35275 in C. If you want to run code that is written in something other than C, you
35276 can of course use a little C stub to call it.
35277
35278 The local scan function is run once for every incoming message, at the point
35279 when Exim is just about to accept the message.
35280 It can therefore be used to control non-SMTP messages from local processes as
35281 well as messages arriving via SMTP.
35282
35283 Exim applies a timeout to calls of the local scan function, and there is an
35284 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35285 Zero means &"no timeout"&.
35286 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35287 before calling the local scan function, so that the most common types of crash
35288 are caught. If the timeout is exceeded or one of those signals is caught, the
35289 incoming message is rejected with a temporary error if it is an SMTP message.
35290 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35291 code. The incident is logged on the main and reject logs.
35292
35293
35294
35295 .section "Building Exim to use a local scan function" "SECID207"
35296 .cindex "&[local_scan()]& function" "building Exim to use"
35297 To make use of the local scan function feature, you must tell Exim where your
35298 function is before building Exim, by setting
35299 both HAVE_LOCAL_SCAN and
35300 LOCAL_SCAN_SOURCE in your
35301 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35302 directory, so you might set
35303 .code
35304 HAVE_LOCAL_SCAN=yes
35305 LOCAL_SCAN_SOURCE=Local/local_scan.c
35306 .endd
35307 for example. The function must be called &[local_scan()]&;
35308 the source file(s) for it should first #define LOCAL_SCAN
35309 and then #include "local_scan.h".
35310 It is called by
35311 Exim after it has received a message, when the success return code is about to
35312 be sent. This is after all the ACLs have been run. The return code from your
35313 function controls whether the message is actually accepted or not. There is a
35314 commented template function (that just accepts the message) in the file
35315 _src/local_scan.c_.
35316
35317 If you want to make use of Exim's runtime configuration file to set options
35318 for your &[local_scan()]& function, you must also set
35319 .code
35320 LOCAL_SCAN_HAS_OPTIONS=yes
35321 .endd
35322 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35323
35324
35325
35326
35327 .section "API for local_scan()" "SECTapiforloc"
35328 .cindex "&[local_scan()]& function" "API description"
35329 .cindex &%dlfunc%& "API description"
35330 You must include this line near the start of your code:
35331 .code
35332 #define LOCAL_SCAN
35333 #include "local_scan.h"
35334 .endd
35335 This header file defines a number of variables and other values, and the
35336 prototype for the function itself. Exim is coded to use unsigned char values
35337 almost exclusively, and one of the things this header defines is a shorthand
35338 for &`unsigned char`& called &`uschar`&.
35339 It also makes available the following macro definitions, to simplify casting character
35340 strings and pointers to character strings:
35341 .code
35342 #define CS   (char *)
35343 #define CCS  (const char *)
35344 #define CSS  (char **)
35345 #define US   (unsigned char *)
35346 #define CUS  (const unsigned char *)
35347 #define USS  (unsigned char **)
35348 .endd
35349 The function prototype for &[local_scan()]& is:
35350 .code
35351 extern int local_scan(int fd, uschar **return_text);
35352 .endd
35353 The arguments are as follows:
35354
35355 .ilist
35356 &%fd%& is a file descriptor for the file that contains the body of the message
35357 (the -D file). The file is open for reading and writing, but updating it is not
35358 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35359
35360 The descriptor is positioned at character 19 of the file, which is the first
35361 character of the body itself, because the first 19 characters are the message
35362 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35363 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35364 case this changes in some future version.
35365 .next
35366 &%return_text%& is an address which you can use to return a pointer to a text
35367 string at the end of the function. The value it points to on entry is NULL.
35368 .endlist
35369
35370 The function must return an &%int%& value which is one of the following macros:
35371
35372 .vlist
35373 .vitem &`LOCAL_SCAN_ACCEPT`&
35374 .vindex "&$local_scan_data$&"
35375 The message is accepted. If you pass back a string of text, it is saved with
35376 the message, and made available in the variable &$local_scan_data$&. No
35377 newlines are permitted (if there are any, they are turned into spaces) and the
35378 maximum length of text is 1000 characters.
35379
35380 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35381 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35382 queued without immediate delivery, and is frozen.
35383
35384 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35385 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35386 queued without immediate delivery.
35387
35388 .vitem &`LOCAL_SCAN_REJECT`&
35389 The message is rejected; the returned text is used as an error message which is
35390 passed back to the sender and which is also logged. Newlines are permitted &--
35391 they cause a multiline response for SMTP rejections, but are converted to
35392 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35393 used.
35394
35395 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35396 The message is temporarily rejected; the returned text is used as an error
35397 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35398 problem"& is used.
35399
35400 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35401 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35402 message is not written to the reject log. It has the effect of unsetting the
35403 &%rejected_header%& log selector for just this rejection. If
35404 &%rejected_header%& is already unset (see the discussion of the
35405 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35406 same as LOCAL_SCAN_REJECT.
35407
35408 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35409 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35410 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35411 .endlist
35412
35413 If the message is not being received by interactive SMTP, rejections are
35414 reported by writing to &%stderr%& or by sending an email, as configured by the
35415 &%-oe%& command line options.
35416
35417
35418
35419 .section "Configuration options for local_scan()" "SECTconoptloc"
35420 .cindex "&[local_scan()]& function" "configuration options"
35421 It is possible to have option settings in the main configuration file
35422 that set values in static variables in the &[local_scan()]& module. If you
35423 want to do this, you must have the line
35424 .code
35425 LOCAL_SCAN_HAS_OPTIONS=yes
35426 .endd
35427 in your &_Local/Makefile_& when you build Exim. (This line is in
35428 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35429 file, you must define static variables to hold the option values, and a table
35430 to define them.
35431
35432 The table must be a vector called &%local_scan_options%&, of type
35433 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35434 and a pointer to the variable that holds the value. The entries must appear in
35435 alphabetical order. Following &%local_scan_options%& you must also define a
35436 variable called &%local_scan_options_count%& that contains the number of
35437 entries in the table. Here is a short example, showing two kinds of option:
35438 .code
35439 static int my_integer_option = 42;
35440 static uschar *my_string_option = US"a default string";
35441
35442 optionlist local_scan_options[] = {
35443   { "my_integer", opt_int,       &my_integer_option },
35444   { "my_string",  opt_stringptr, &my_string_option }
35445 };
35446
35447 int local_scan_options_count =
35448   sizeof(local_scan_options)/sizeof(optionlist);
35449 .endd
35450 The values of the variables can now be changed from Exim's runtime
35451 configuration file by including a local scan section as in this example:
35452 .code
35453 begin local_scan
35454 my_integer = 99
35455 my_string = some string of text...
35456 .endd
35457 The available types of option data are as follows:
35458
35459 .vlist
35460 .vitem &*opt_bool*&
35461 This specifies a boolean (true/false) option. The address should point to a
35462 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35463 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35464 whether such a variable has been set at all, you can initialize it to
35465 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35466 values.)
35467
35468 .vitem &*opt_fixed*&
35469 This specifies a fixed point number, such as is used for load averages.
35470 The address should point to a variable of type &`int`&. The value is stored
35471 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35472
35473 .vitem &*opt_int*&
35474 This specifies an integer; the address should point to a variable of type
35475 &`int`&. The value may be specified in any of the integer formats accepted by
35476 Exim.
35477
35478 .vitem &*opt_mkint*&
35479 This is the same as &%opt_int%&, except that when such a value is output in a
35480 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35481 printed with the suffix K or M.
35482
35483 .vitem &*opt_octint*&
35484 This also specifies an integer, but the value is always interpreted as an
35485 octal integer, whether or not it starts with the digit zero, and it is
35486 always output in octal.
35487
35488 .vitem &*opt_stringptr*&
35489 This specifies a string value; the address must be a pointer to a
35490 variable that points to a string (for example, of type &`uschar *`&).
35491
35492 .vitem &*opt_time*&
35493 This specifies a time interval value. The address must point to a variable of
35494 type &`int`&. The value that is placed there is a number of seconds.
35495 .endlist
35496
35497 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35498 out the values of all the &[local_scan()]& options.
35499
35500
35501
35502 .section "Available Exim variables" "SECID208"
35503 .cindex "&[local_scan()]& function" "available Exim variables"
35504 The header &_local_scan.h_& gives you access to a number of C variables. These
35505 are the only ones that are guaranteed to be maintained from release to release.
35506 Note, however, that you can obtain the value of any Exim expansion variable,
35507 including &$recipients$&, by calling &'expand_string()'&. The exported
35508 C variables are as follows:
35509
35510 .vlist
35511 .vitem &*int&~body_linecount*&
35512 This variable contains the number of lines in the message's body.
35513 It is not valid if the &%spool_wireformat%& option is used.
35514
35515 .vitem &*int&~body_zerocount*&
35516 This variable contains the number of binary zero bytes in the message's body.
35517 It is not valid if the &%spool_wireformat%& option is used.
35518
35519 .vitem &*unsigned&~int&~debug_selector*&
35520 This variable is set to zero when no debugging is taking place. Otherwise, it
35521 is a bitmap of debugging selectors. Two bits are identified for use in
35522 &[local_scan()]&; they are defined as macros:
35523
35524 .ilist
35525 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35526 testing option that is not privileged &-- any caller may set it. All the
35527 other selector bits can be set only by admin users.
35528
35529 .next
35530 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35531 by the &`+local_scan`& debug selector. It is not included in the default set
35532 of debugging bits.
35533 .endlist ilist
35534
35535 Thus, to write to the debugging output only when &`+local_scan`& has been
35536 selected, you should use code like this:
35537 .code
35538 if ((debug_selector & D_local_scan) != 0)
35539   debug_printf("xxx", ...);
35540 .endd
35541 .vitem &*uschar&~*expand_string_message*&
35542 After a failing call to &'expand_string()'& (returned value NULL), the
35543 variable &%expand_string_message%& contains the error message, zero-terminated.
35544
35545 .vitem &*header_line&~*header_list*&
35546 A pointer to a chain of header lines. The &%header_line%& structure is
35547 discussed below.
35548
35549 .vitem &*header_line&~*header_last*&
35550 A pointer to the last of the header lines.
35551
35552 .vitem &*const&~uschar&~*headers_charset*&
35553 The value of the &%headers_charset%& configuration option.
35554
35555 .vitem &*BOOL&~host_checking*&
35556 This variable is TRUE during a host checking session that is initiated by the
35557 &%-bh%& command line option.
35558
35559 .vitem &*uschar&~*interface_address*&
35560 The IP address of the interface that received the message, as a string. This
35561 is NULL for locally submitted messages.
35562
35563 .vitem &*int&~interface_port*&
35564 The port on which this message was received. When testing with the &%-bh%&
35565 command line option, the value of this variable is -1 unless a port has been
35566 specified via the &%-oMi%& option.
35567
35568 .vitem &*uschar&~*message_id*&
35569 This variable contains Exim's message id for the incoming message (the value of
35570 &$message_exim_id$&) as a zero-terminated string.
35571
35572 .vitem &*uschar&~*received_protocol*&
35573 The name of the protocol by which the message was received.
35574
35575 .vitem &*int&~recipients_count*&
35576 The number of accepted recipients.
35577
35578 .vitem &*recipient_item&~*recipients_list*&
35579 .cindex "recipient" "adding in local scan"
35580 .cindex "recipient" "removing in local scan"
35581 The list of accepted recipients, held in a vector of length
35582 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35583 can add additional recipients by calling &'receive_add_recipient()'& (see
35584 below). You can delete recipients by removing them from the vector and
35585 adjusting the value in &%recipients_count%&. In particular, by setting
35586 &%recipients_count%& to zero you remove all recipients. If you then return the
35587 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35588 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35589 and then call &'receive_add_recipient()'& as often as needed.
35590
35591 .vitem &*uschar&~*sender_address*&
35592 The envelope sender address. For bounce messages this is the empty string.
35593
35594 .vitem &*uschar&~*sender_host_address*&
35595 The IP address of the sending host, as a string. This is NULL for
35596 locally-submitted messages.
35597
35598 .vitem &*uschar&~*sender_host_authenticated*&
35599 The name of the authentication mechanism that was used, or NULL if the message
35600 was not received over an authenticated SMTP connection.
35601
35602 .vitem &*uschar&~*sender_host_name*&
35603 The name of the sending host, if known.
35604
35605 .vitem &*int&~sender_host_port*&
35606 The port on the sending host.
35607
35608 .vitem &*BOOL&~smtp_input*&
35609 This variable is TRUE for all SMTP input, including BSMTP.
35610
35611 .vitem &*BOOL&~smtp_batched_input*&
35612 This variable is TRUE for BSMTP input.
35613
35614 .vitem &*int&~store_pool*&
35615 The contents of this variable control which pool of memory is used for new
35616 requests. See section &<<SECTmemhanloc>>& for details.
35617 .endlist
35618
35619
35620 .section "Structure of header lines" "SECID209"
35621 The &%header_line%& structure contains the members listed below.
35622 You can add additional header lines by calling the &'header_add()'& function
35623 (see below). You can cause header lines to be ignored (deleted) by setting
35624 their type to *.
35625
35626
35627 .vlist
35628 .vitem &*struct&~header_line&~*next*&
35629 A pointer to the next header line, or NULL for the last line.
35630
35631 .vitem &*int&~type*&
35632 A code identifying certain headers that Exim recognizes. The codes are printing
35633 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35634 Notice in particular that any header line whose type is * is not transmitted
35635 with the message. This flagging is used for header lines that have been
35636 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35637 lines.) Effectively, * means &"deleted"&.
35638
35639 .vitem &*int&~slen*&
35640 The number of characters in the header line, including the terminating and any
35641 internal newlines.
35642
35643 .vitem &*uschar&~*text*&
35644 A pointer to the text of the header. It always ends with a newline, followed by
35645 a zero byte. Internal newlines are preserved.
35646 .endlist
35647
35648
35649
35650 .section "Structure of recipient items" "SECID210"
35651 The &%recipient_item%& structure contains these members:
35652
35653 .vlist
35654 .vitem &*uschar&~*address*&
35655 This is a pointer to the recipient address as it was received.
35656
35657 .vitem &*int&~pno*&
35658 This is used in later Exim processing when top level addresses are created by
35659 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35660 and must always contain -1 at this stage.
35661
35662 .vitem &*uschar&~*errors_to*&
35663 If this value is not NULL, bounce messages caused by failing to deliver to the
35664 recipient are sent to the address it contains. In other words, it overrides the
35665 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35666 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35667 an unqualified address, Exim qualifies it using the domain from
35668 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35669 is NULL for all recipients.
35670 .endlist
35671
35672
35673
35674 .section "Available Exim functions" "SECID211"
35675 .cindex "&[local_scan()]& function" "available Exim functions"
35676 The header &_local_scan.h_& gives you access to a number of Exim functions.
35677 These are the only ones that are guaranteed to be maintained from release to
35678 release:
35679
35680 .vlist
35681 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35682        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35683
35684 This function creates a child process that runs the command specified by
35685 &%argv%&. The environment for the process is specified by &%envp%&, which can
35686 be NULL if no environment variables are to be passed. A new umask is supplied
35687 for the process in &%newumask%&.
35688
35689 Pipes to the standard input and output of the new process are set up
35690 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35691 standard error is cloned to the standard output. If there are any file
35692 descriptors &"in the way"& in the new process, they are closed. If the final
35693 argument is TRUE, the new process is made into a process group leader.
35694
35695 The function returns the pid of the new process, or -1 if things go wrong.
35696
35697 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35698 This function waits for a child process to terminate, or for a timeout (in
35699 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35700 return value is as follows:
35701
35702 .ilist
35703 >= 0
35704
35705 The process terminated by a normal exit and the value is the process
35706 ending status.
35707
35708 .next
35709 < 0 and > &--256
35710
35711 The process was terminated by a signal and the value is the negation of the
35712 signal number.
35713
35714 .next
35715 &--256
35716
35717 The process timed out.
35718 .next
35719 &--257
35720
35721 The was some other error in wait(); &%errno%& is still set.
35722 .endlist
35723
35724 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35725 This function provide you with a means of submitting a new message to
35726 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35727 want, but this packages it all up for you.) The function creates a pipe,
35728 forks a subprocess that is running
35729 .code
35730 exim -t -oem -oi -f <>
35731 .endd
35732 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35733 that is connected to the standard input. The yield of the function is the PID
35734 of the subprocess. You can then write a message to the file descriptor, with
35735 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35736
35737 When you have finished, call &'child_close()'& to wait for the process to
35738 finish and to collect its ending status. A timeout value of zero is usually
35739 fine in this circumstance. Unless you have made a mistake with the recipient
35740 addresses, you should get a return code of zero.
35741
35742
35743 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35744        *sender_authentication)*&
35745 This function is a more sophisticated version of &'child_open()'&. The command
35746 that it runs is:
35747 .display
35748 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35749 .endd
35750 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35751
35752
35753 .vitem &*void&~debug_printf(char&~*,&~...)*&
35754 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35755 output is written to the standard error stream. If no debugging is selected,
35756 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35757 conditional on the &`local_scan`& debug selector by coding like this:
35758 .code
35759 if ((debug_selector & D_local_scan) != 0)
35760   debug_printf("xxx", ...);
35761 .endd
35762
35763 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35764 This is an interface to Exim's string expansion code. The return value is the
35765 expanded string, or NULL if there was an expansion failure.
35766 The C variable &%expand_string_message%& contains an error message after an
35767 expansion failure. If expansion does not change the string, the return value is
35768 the pointer to the input string. Otherwise, the return value points to a new
35769 block of memory that was obtained by a call to &'store_get()'&. See section
35770 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35771
35772 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35773 This function allows you to an add additional header line at the end of the
35774 existing ones. The first argument is the type, and should normally be a space
35775 character. The second argument is a format string and any number of
35776 substitution arguments as for &[sprintf()]&. You may include internal newlines
35777 if you want, and you must ensure that the string ends with a newline.
35778
35779 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35780         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35781 This function adds a new header line at a specified point in the header
35782 chain. The header itself is specified as for &'header_add()'&.
35783
35784 If &%name%& is NULL, the new header is added at the end of the chain if
35785 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35786 NULL, the header lines are searched for the first non-deleted header that
35787 matches the name. If one is found, the new header is added before it if
35788 &%after%& is false. If &%after%& is true, the new header is added after the
35789 found header and any adjacent subsequent ones with the same name (even if
35790 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35791 option controls where the header is added. If it is true, addition is at the
35792 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35793 headers, or at the top if there are no &'Received:'& headers, you could use
35794 .code
35795 header_add_at_position(TRUE, US"Received", TRUE,
35796   ' ', "X-xxx: ...");
35797 .endd
35798 Normally, there is always at least one non-deleted &'Received:'& header, but
35799 there may not be if &%received_header_text%& expands to an empty string.
35800
35801
35802 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35803 This function removes header lines. If &%occurrence%& is zero or negative, all
35804 occurrences of the header are removed. If occurrence is greater than zero, that
35805 particular instance of the header is removed. If no header(s) can be found that
35806 match the specification, the function does nothing.
35807
35808
35809 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35810         int&~length,&~BOOL&~notdel)*&"
35811 This function tests whether the given header has the given name. It is not just
35812 a string comparison, because white space is permitted between the name and the
35813 colon. If the &%notdel%& argument is true, a false return is forced for all
35814 &"deleted"& headers; otherwise they are not treated specially. For example:
35815 .code
35816 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35817 .endd
35818 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35819 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35820 This function base64-encodes a string, which is passed by address and length.
35821 The text may contain bytes of any value, including zero. The result is passed
35822 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35823 zero-terminated.
35824
35825 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35826 This function decodes a base64-encoded string. Its arguments are a
35827 zero-terminated base64-encoded string and the address of a variable that is set
35828 to point to the result, which is in dynamic memory. The length of the decoded
35829 string is the yield of the function. If the input is invalid base64 data, the
35830 yield is -1. A zero byte is added to the end of the output string to make it
35831 easy to interpret as a C string (assuming it contains no zeros of its own). The
35832 added zero byte is not included in the returned count.
35833
35834 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35835 This function checks for a match in a domain list. Domains are always
35836 matched caselessly. The return value is one of the following:
35837 .itable none 0 0 2 15* left 85* left
35838 .irow &`OK`&    "match succeeded"
35839 .irow &`FAIL`&  "match failed"
35840 .irow &`DEFER`& "match deferred"
35841 .endtable
35842 DEFER is usually caused by some kind of lookup defer, such as the
35843 inability to contact a database.
35844
35845 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35846         BOOL&~caseless)*&"
35847 This function checks for a match in a local part list. The third argument
35848 controls case-sensitivity. The return values are as for
35849 &'lss_match_domain()'&.
35850
35851 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35852         BOOL&~caseless)*&"
35853 This function checks for a match in an address list. The third argument
35854 controls the case-sensitivity of the local part match. The domain is always
35855 matched caselessly. The return values are as for &'lss_match_domain()'&.
35856
35857 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35858         uschar&~*list)*&"
35859 This function checks for a match in a host list. The most common usage is
35860 expected to be
35861 .code
35862 lss_match_host(sender_host_name, sender_host_address, ...)
35863 .endd
35864 .vindex "&$sender_host_address$&"
35865 An empty address field matches an empty item in the host list. If the host name
35866 is NULL, the name corresponding to &$sender_host_address$& is automatically
35867 looked up if a host name is required to match an item in the list. The return
35868 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35869 returns ERROR in the case when it had to look up a host name, but the lookup
35870 failed.
35871
35872 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35873         *format,&~...)*&"
35874 This function writes to Exim's log files. The first argument should be zero (it
35875 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35876 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35877 them. It specifies to which log or logs the message is written. The remaining
35878 arguments are a format and relevant insertion arguments. The string should not
35879 contain any newlines, not even at the end.
35880
35881
35882 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35883 This function adds an additional recipient to the message. The first argument
35884 is the recipient address. If it is unqualified (has no domain), it is qualified
35885 with the &%qualify_recipient%& domain. The second argument must always be -1.
35886
35887 This function does not allow you to specify a private &%errors_to%& address (as
35888 described with the structure of &%recipient_item%& above), because it pre-dates
35889 the addition of that field to the structure. However, it is easy to add such a
35890 value afterwards. For example:
35891 .code
35892  receive_add_recipient(US"monitor@mydom.example", -1);
35893  recipients_list[recipients_count-1].errors_to =
35894    US"postmaster@mydom.example";
35895 .endd
35896
35897 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35898 This is a convenience function to remove a named recipient from the list of
35899 recipients. It returns true if a recipient was removed, and false if no
35900 matching recipient could be found. The argument must be a complete email
35901 address.
35902 .endlist
35903
35904
35905 .cindex "RFC 2047"
35906 .vlist
35907 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35908   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35909 This function decodes strings that are encoded according to RFC 2047. Typically
35910 these are the contents of header lines. First, each &"encoded word"& is decoded
35911 from the Q or B encoding into a byte-string. Then, if provided with the name of
35912 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35913 made  to translate the result to the named character set. If this fails, the
35914 binary string is returned with an error message.
35915
35916 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35917 maximum MIME word length is enforced. The third argument is the target
35918 encoding, or NULL if no translation is wanted.
35919
35920 .cindex "binary zero" "in RFC 2047 decoding"
35921 .cindex "RFC 2047" "binary zero in"
35922 If a binary zero is encountered in the decoded string, it is replaced by the
35923 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35924 not be 0 because header lines are handled as zero-terminated strings.
35925
35926 The function returns the result of processing the string, zero-terminated; if
35927 &%lenptr%& is not NULL, the length of the result is set in the variable to
35928 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35929
35930 If an error is encountered, the function returns NULL and uses the &%error%&
35931 argument to return an error message. The variable pointed to by &%error%& is
35932 set to NULL if there is no error; it may be set non-NULL even when the function
35933 returns a non-NULL value if decoding was successful, but there was a problem
35934 with translation.
35935
35936
35937 .vitem &*int&~smtp_fflush(void)*&
35938 This function is used in conjunction with &'smtp_printf()'&, as described
35939 below.
35940
35941 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35942 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35943 output stream. You should use this function only when there is an SMTP output
35944 stream, that is, when the incoming message is being received via interactive
35945 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35946 is FALSE. If you want to test for an incoming message from another host (as
35947 opposed to a local process that used the &%-bs%& command line option), you can
35948 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35949 is involved.
35950
35951 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35952 output function, so it can be used for all forms of SMTP connection.
35953
35954 The second argument is used to request that the data be buffered
35955 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35956 This is advisory only, but likely to save on system-calls and packets
35957 sent when a sequence of calls to the function are made.
35958
35959 The argument was added in Exim version 4.90 - changing the API/ABI.
35960 Nobody noticed until 4.93 was imminent, at which point the
35961 ABI version number was incremented.
35962
35963 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35964 must start with an appropriate response code: 550 if you are going to return
35965 LOCAL_SCAN_REJECT, 451 if you are going to return
35966 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35967 initial lines of a multi-line response, the code must be followed by a hyphen
35968 to indicate that the line is not the final response line. You must also ensure
35969 that the lines you write terminate with CRLF. For example:
35970 .code
35971 smtp_printf("550-this is some extra info\r\n");
35972 return LOCAL_SCAN_REJECT;
35973 .endd
35974 Note that you can also create multi-line responses by including newlines in
35975 the data returned via the &%return_text%& argument. The added value of using
35976 &'smtp_printf()'& is that, for instance, you could introduce delays between
35977 multiple output lines.
35978
35979 The &'smtp_printf()'& function does not return any error indication, because it
35980 does not
35981 guarantee a flush of
35982 pending output, and therefore does not test
35983 the state of the stream. (In the main code of Exim, flushing and error
35984 detection is done when Exim is ready for the next SMTP input command.) If
35985 you want to flush the output and check for an error (for example, the
35986 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35987 arguments. It flushes the output stream, and returns a non-zero value if there
35988 is an error.
35989
35990 .vitem &*void&~*store_get(int,BOOL)*&
35991 This function accesses Exim's internal store (memory) manager. It gets a new
35992 chunk of memory whose size is given by the first argument.
35993 The second argument should be given as TRUE if the memory will be used for
35994 data possibly coming from an attacker (eg. the message content),
35995 FALSE if it is locally-sourced.
35996 Exim bombs out if it ever
35997 runs out of memory. See the next section for a discussion of memory handling.
35998
35999 .vitem &*void&~*store_get_perm(int,BOOL)*&
36000 This function is like &'store_get()'&, but it always gets memory from the
36001 permanent pool. See the next section for a discussion of memory handling.
36002
36003 .vitem &*uschar&~*string_copy(uschar&~*string)*&
36004 See below.
36005
36006 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
36007 See below.
36008
36009 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
36010 These three functions create strings using Exim's dynamic memory facilities.
36011 The first makes a copy of an entire string. The second copies up to a maximum
36012 number of characters, indicated by the second argument. The third uses a format
36013 and insertion arguments to create a new string. In each case, the result is a
36014 pointer to a new string in the current memory pool. See the next section for
36015 more discussion.
36016 .endlist
36017
36018
36019
36020 .section "More about Exim's memory handling" "SECTmemhanloc"
36021 .cindex "&[local_scan()]& function" "memory handling"
36022 No function is provided for freeing memory, because that is never needed.
36023 The dynamic memory that Exim uses when receiving a message is automatically
36024 recycled if another message is received by the same process (this applies only
36025 to incoming SMTP connections &-- other input methods can supply only one
36026 message at a time). After receiving the last message, a reception process
36027 terminates.
36028
36029 Because it is recycled, the normal dynamic memory cannot be used for holding
36030 data that must be preserved over a number of incoming messages on the same SMTP
36031 connection. However, Exim in fact uses two pools of dynamic memory; the second
36032 one is not recycled, and can be used for this purpose.
36033
36034 If you want to allocate memory that remains available for subsequent messages
36035 in the same SMTP connection, you should set
36036 .code
36037 store_pool = POOL_PERM
36038 .endd
36039 before calling the function that does the allocation. There is no need to
36040 restore the value if you do not need to; however, if you do want to revert to
36041 the normal pool, you can either restore the previous value of &%store_pool%& or
36042 set it explicitly to POOL_MAIN.
36043
36044 The pool setting applies to all functions that get dynamic memory, including
36045 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36046 There is also a convenience function called &'store_get_perm()'& that gets a
36047 block of memory from the permanent pool while preserving the value of
36048 &%store_pool%&.
36049 .ecindex IIDlosca
36050
36051
36052
36053
36054 . ////////////////////////////////////////////////////////////////////////////
36055 . ////////////////////////////////////////////////////////////////////////////
36056
36057 .chapter "System-wide message filtering" "CHAPsystemfilter"
36058 .scindex IIDsysfil1 "filter" "system filter"
36059 .scindex IIDsysfil2 "filtering all mail"
36060 .scindex IIDsysfil3 "system filter"
36061 The previous chapters (on ACLs and the local scan function) describe checks
36062 that can be applied to messages before they are accepted by a host. There is
36063 also a mechanism for checking messages once they have been received, but before
36064 they are delivered. This is called the &'system filter'&.
36065
36066 The system filter operates in a similar manner to users' filter files, but it
36067 is run just once per message (however many recipients the message has).
36068 It should not normally be used as a substitute for routing, because &%deliver%&
36069 commands in a system router provide new envelope recipient addresses.
36070 The system filter must be an Exim filter. It cannot be a Sieve filter.
36071
36072 The system filter is run at the start of a delivery attempt, before any routing
36073 is done. If a message fails to be completely delivered at the first attempt,
36074 the system filter is run again at the start of every retry.
36075 If you want your filter to do something only once per message, you can make use
36076 .cindex retry condition
36077 of the &%first_delivery%& condition in an &%if%& command in the filter to
36078 prevent it happening on retries.
36079
36080 .vindex "&$domain$&"
36081 .vindex "&$local_part$&"
36082 &*Warning*&: Because the system filter runs just once, variables that are
36083 specific to individual recipient addresses, such as &$local_part$& and
36084 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36085 you want to run a centrally-specified filter for each recipient address
36086 independently, you can do so by setting up a suitable &(redirect)& router, as
36087 described in section &<<SECTperaddfil>>& below.
36088
36089
36090 .section "Specifying a system filter" "SECID212"
36091 .cindex "uid (user id)" "system filter"
36092 .cindex "gid (group id)" "system filter"
36093 The name of the file that contains the system filter must be specified by
36094 setting &%system_filter%&. If you want the filter to run under a uid and gid
36095 other than root, you must also set &%system_filter_user%& and
36096 &%system_filter_group%& as appropriate. For example:
36097 .code
36098 system_filter = /etc/mail/exim.filter
36099 system_filter_user = exim
36100 .endd
36101 If a system filter generates any deliveries directly to files or pipes (via the
36102 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36103 specified by setting &%system_filter_file_transport%& and
36104 &%system_filter_pipe_transport%&, respectively. Similarly,
36105 &%system_filter_reply_transport%& must be set to handle any messages generated
36106 by the &%reply%& command.
36107
36108
36109 .section "Testing a system filter" "SECID213"
36110 You can run simple tests of a system filter in the same way as for a user
36111 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36112 are permitted only in system filters are recognized.
36113
36114 If you want to test the combined effect of a system filter and a user filter,
36115 you can use both &%-bF%& and &%-bf%& on the same command line.
36116
36117
36118
36119 .section "Contents of a system filter" "SECID214"
36120 The language used to specify system filters is the same as for users' filter
36121 files. It is described in the separate end-user document &'Exim's interface to
36122 mail filtering'&. However, there are some additional features that are
36123 available only in system filters; these are described in subsequent sections.
36124 If they are encountered in a user's filter file or when testing with &%-bf%&,
36125 they cause errors.
36126
36127 .cindex "frozen messages" "manual thaw; testing in filter"
36128 There are two special conditions which, though available in users' filter
36129 files, are designed for use in system filters. The condition &%first_delivery%&
36130 is true only for the first attempt at delivering a message, and
36131 &%manually_thawed%& is true only if the message has been frozen, and
36132 subsequently thawed by an admin user. An explicit forced delivery counts as a
36133 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36134
36135 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36136 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36137 succeed, it will not be tried again.
36138 If you want Exim to retry an unseen delivery until it succeeds, you should
36139 arrange to set it up every time the filter runs.
36140
36141 When a system filter finishes running, the values of the variables &$n0$& &--
36142 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36143 users' filter files. Thus a system filter can, for example, set up &"scores"&
36144 to which users' filter files can refer.
36145
36146
36147
36148 .section "Additional variable for system filters" "SECID215"
36149 .vindex "&$recipients$&"
36150 The expansion variable &$recipients$&, containing a list of all the recipients
36151 of the message (separated by commas and white space), is available in system
36152 filters. It is not available in users' filters for privacy reasons.
36153
36154
36155
36156 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36157 .cindex "freezing messages"
36158 .cindex "message" "freezing"
36159 .cindex "message" "forced failure"
36160 .cindex "&%fail%&" "in system filter"
36161 .cindex "&%freeze%& in system filter"
36162 .cindex "&%defer%& in system filter"
36163 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36164 always available in system filters, but are not normally enabled in users'
36165 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36166 for the &(redirect)& router.) These commands can optionally be followed by the
36167 word &%text%& and a string containing an error message, for example:
36168 .code
36169 fail text "this message looks like spam to me"
36170 .endd
36171 The keyword &%text%& is optional if the next character is a double quote.
36172
36173 The &%defer%& command defers delivery of the original recipients of the
36174 message. The &%fail%& command causes all the original recipients to be failed,
36175 and a bounce message to be created. The &%freeze%& command suspends all
36176 delivery attempts for the original recipients. In all cases, any new deliveries
36177 that are specified by the filter are attempted as normal after the filter has
36178 run.
36179
36180 The &%freeze%& command is ignored if the message has been manually unfrozen and
36181 not manually frozen since. This means that automatic freezing by a system
36182 filter can be used as a way of checking out suspicious messages. If a message
36183 is found to be all right, manually unfreezing it allows it to be delivered.
36184
36185 .cindex "log" "&%fail%& command log line"
36186 .cindex "&%fail%&" "log line; reducing"
36187 The text given with a fail command is used as part of the bounce message as
36188 well as being written to the log. If the message is quite long, this can fill
36189 up a lot of log space when such failures are common. To reduce the size of the
36190 log message, Exim interprets the text in a special way if it starts with the
36191 two characters &`<<`& and contains &`>>`& later. The text between these two
36192 strings is written to the log, and the rest of the text is used in the bounce
36193 message. For example:
36194 .code
36195 fail "<<filter test 1>>Your message is rejected \
36196      because it contains attachments that we are \
36197      not prepared to receive."
36198 .endd
36199
36200 .cindex "loop" "caused by &%fail%&"
36201 Take great care with the &%fail%& command when basing the decision to fail on
36202 the contents of the message, because the bounce message will of course include
36203 the contents of the original message and will therefore trigger the &%fail%&
36204 command again (causing a mail loop) unless steps are taken to prevent this.
36205 Testing the &%error_message%& condition is one way to prevent this. You could
36206 use, for example
36207 .code
36208 if $message_body contains "this is spam" and not error_message
36209 then fail text "spam is not wanted here" endif
36210 .endd
36211 though of course that might let through unwanted bounce messages. The
36212 alternative is clever checking of the body and/or headers to detect bounces
36213 generated by the filter.
36214
36215 The interpretation of a system filter file ceases after a
36216 &%defer%&,
36217 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36218 set up earlier in the filter file are honoured, so you can use a sequence such
36219 as
36220 .code
36221 mail ...
36222 freeze
36223 .endd
36224 to send a specified message when the system filter is freezing (or deferring or
36225 failing) a message. The normal deliveries for the message do not, of course,
36226 take place.
36227
36228
36229
36230 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36231 .cindex "header lines" "adding; in system filter"
36232 .cindex "header lines" "removing; in system filter"
36233 .cindex "filter" "header lines; adding/removing"
36234 Two filter commands that are available only in system filters are:
36235 .code
36236 headers add <string>
36237 headers remove <string>
36238 .endd
36239 The argument for the &%headers add%& is a string that is expanded and then
36240 added to the end of the message's headers. It is the responsibility of the
36241 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36242 space is ignored, and if the string is otherwise empty, or if the expansion is
36243 forced to fail, the command has no effect.
36244
36245 You can use &"\n"& within the string, followed by white space, to specify
36246 continued header lines. More than one header may be added in one command by
36247 including &"\n"& within the string without any following white space. For
36248 example:
36249 .code
36250 headers add "X-header-1: ....\n  \
36251              continuation of X-header-1 ...\n\
36252              X-header-2: ...."
36253 .endd
36254 Note that the header line continuation white space after the first newline must
36255 be placed before the backslash that continues the input string, because white
36256 space after input continuations is ignored.
36257
36258 The argument for &%headers remove%& is a colon-separated list of header names.
36259 This command applies only to those headers that are stored with the message;
36260 those that are added at delivery time (such as &'Envelope-To:'& and
36261 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36262 header with the same name, they are all removed.
36263
36264 The &%headers%& command in a system filter makes an immediate change to the set
36265 of header lines that was received with the message (with possible additions
36266 from ACL processing). Subsequent commands in the system filter operate on the
36267 modified set, which also forms the basis for subsequent message delivery.
36268 Unless further modified during routing or transporting, this set of headers is
36269 used for all recipients of the message.
36270
36271 During routing and transporting, the variables that refer to the contents of
36272 header lines refer only to those lines that are in this set. Thus, header lines
36273 that are added by a system filter are visible to users' filter files and to all
36274 routers and transports. This contrasts with the manipulation of header lines by
36275 routers and transports, which is not immediate, but which instead is saved up
36276 until the message is actually being written (see section
36277 &<<SECTheadersaddrem>>&).
36278
36279 If the message is not delivered at the first attempt, header lines that were
36280 added by the system filter are stored with the message, and so are still
36281 present at the next delivery attempt. Header lines that were removed are still
36282 present, but marked &"deleted"& so that they are not transported with the
36283 message. For this reason, it is usual to make the &%headers%& command
36284 conditional on &%first_delivery%& so that the set of header lines is not
36285 modified more than once.
36286
36287 Because header modification in a system filter acts immediately, you have to
36288 use an indirect approach if you want to modify the contents of a header line.
36289 For example:
36290 .code
36291 headers add "Old-Subject: $h_subject:"
36292 headers remove "Subject"
36293 headers add "Subject: new subject (was: $h_old-subject:)"
36294 headers remove "Old-Subject"
36295 .endd
36296
36297
36298
36299 .section "Setting an errors address in a system filter" "SECID217"
36300 .cindex "envelope from"
36301 .cindex "envelope sender"
36302 In a system filter, if a &%deliver%& command is followed by
36303 .code
36304 errors_to <some address>
36305 .endd
36306 in order to change the envelope sender (and hence the error reporting) for that
36307 delivery, any address may be specified. (In a user filter, only the current
36308 user's address can be set.) For example, if some mail is being monitored, you
36309 might use
36310 .code
36311 unseen deliver monitor@spying.example errors_to root@local.example
36312 .endd
36313 to take a copy which would not be sent back to the normal error reporting
36314 address if its delivery failed.
36315
36316
36317
36318 .section "Per-address filtering" "SECTperaddfil"
36319 .vindex "&$domain_data$&"
36320 .vindex "&$local_part_data$&"
36321 In contrast to the system filter, which is run just once per message for each
36322 delivery attempt, it is also possible to set up a system-wide filtering
36323 operation that runs once for each recipient address. In this case, variables
36324 such as &$local_part_data$& and &$domain_data$& can be used,
36325 and indeed, the choice of filter file could be made dependent on them.
36326 This is an example of a router which implements such a filter:
36327 .code
36328 central_filter:
36329   check_local_user
36330   driver = redirect
36331   domains = +local_domains
36332   file = /central/filters/$local_part_data
36333   no_verify
36334   allow_filter
36335   allow_freeze
36336 .endd
36337 The filter is run in a separate process under its own uid. Therefore, either
36338 &%check_local_user%& must be set (as above), in which case the filter is run as
36339 the local user, or the &%user%& option must be used to specify which user to
36340 use. If both are set, &%user%& overrides.
36341
36342 Care should be taken to ensure that none of the commands in the filter file
36343 specify a significant delivery if the message is to go on to be delivered to
36344 its intended recipient. The router will not then claim to have dealt with the
36345 address, so it will be passed on to subsequent routers to be delivered in the
36346 normal way.
36347 .ecindex IIDsysfil1
36348 .ecindex IIDsysfil2
36349 .ecindex IIDsysfil3
36350
36351
36352
36353
36354
36355
36356 . ////////////////////////////////////////////////////////////////////////////
36357 . ////////////////////////////////////////////////////////////////////////////
36358
36359 .chapter "Message processing" "CHAPmsgproc"
36360 .scindex IIDmesproc "message" "general processing"
36361 Exim performs various transformations on the sender and recipient addresses of
36362 all messages that it handles, and also on the messages' header lines. Some of
36363 these are optional and configurable, while others always take place. All of
36364 this processing, except rewriting as a result of routing, and the addition or
36365 removal of header lines while delivering, happens when a message is received,
36366 before it is placed on Exim's queue.
36367
36368 Some of the automatic processing takes place by default only for
36369 &"locally-originated"& messages. This adjective is used to describe messages
36370 that are not received over TCP/IP, but instead are passed to an Exim process on
36371 its standard input. This includes the interactive &"local SMTP"& case that is
36372 set up by the &%-bs%& command line option.
36373
36374 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36375 or ::1) are not considered to be locally-originated. Exim does not treat the
36376 loopback interface specially in any way.
36377
36378 If you want the loopback interface to be treated specially, you must ensure
36379 that there are appropriate entries in your ACLs.
36380
36381
36382
36383
36384 .section "Submission mode for non-local messages" "SECTsubmodnon"
36385 .cindex "message" "submission"
36386 .cindex "submission mode"
36387 Processing that happens automatically for locally-originated messages (unless
36388 &%suppress_local_fixups%& is set) can also be requested for messages that are
36389 received over TCP/IP. The term &"submission mode"& is used to describe this
36390 state. Submission mode is set by the modifier
36391 .code
36392 control = submission
36393 .endd
36394 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36395 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36396 a local submission, and is normally used when the source of the message is
36397 known to be an MUA running on a client host (as opposed to an MTA). For
36398 example, to set submission mode for messages originating on the IPv4 loopback
36399 interface, you could include the following in the MAIL ACL:
36400 .code
36401 warn  hosts = 127.0.0.1
36402       control = submission
36403 .endd
36404 .cindex "&%sender_retain%& submission option"
36405 There are some options that can be used when setting submission mode. A slash
36406 is used to separate options. For example:
36407 .code
36408 control = submission/sender_retain
36409 .endd
36410 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36411 true and &%local_from_check%& false for the current incoming message. The first
36412 of these allows an existing &'Sender:'& header in the message to remain, and
36413 the second suppresses the check to ensure that &'From:'& matches the
36414 authenticated sender. With this setting, Exim still fixes up messages by adding
36415 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36416 attempt to check sender authenticity in header lines.
36417
36418 When &%sender_retain%& is not set, a submission mode setting may specify a
36419 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36420 example:
36421 .code
36422 control = submission/domain=some.domain
36423 .endd
36424 The domain may be empty. How this value is used is described in sections
36425 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36426 that allows you to specify the user's full name for inclusion in a created
36427 &'Sender:'& or &'From:'& header line. For example:
36428 .code
36429 accept authenticated = *
36430        control = submission/domain=wonderland.example/\
36431                             name=${lookup {$authenticated_id} \
36432                                    lsearch {/etc/exim/namelist}}
36433 .endd
36434 Because the name may contain any characters, including slashes, the &%name%&
36435 option must be given last. The remainder of the string is used as the name. For
36436 the example above, if &_/etc/exim/namelist_& contains:
36437 .code
36438 bigegg:  Humpty Dumpty
36439 .endd
36440 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36441 line would be:
36442 .code
36443 Sender: Humpty Dumpty <bigegg@wonderland.example>
36444 .endd
36445 .cindex "return path" "in submission mode"
36446 By default, submission mode forces the return path to the same address as is
36447 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36448 specified, the return path is also left unchanged.
36449
36450 &*Note*&: The changes caused by submission mode take effect after the predata
36451 ACL. This means that any sender checks performed before the fix-ups use the
36452 untrusted sender address specified by the user, not the trusted sender address
36453 specified by submission mode. Although this might be slightly unexpected, it
36454 does mean that you can configure ACL checks to spot that a user is trying to
36455 spoof another's address.
36456
36457 .section "Line endings" "SECTlineendings"
36458 .cindex "line endings"
36459 .cindex "carriage return"
36460 .cindex "linefeed"
36461 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36462 linefeed) is the line ending for messages transmitted over the Internet using
36463 SMTP over TCP/IP. However, within individual operating systems, different
36464 conventions are used. For example, Unix-like systems use just LF, but others
36465 use CRLF or just CR.
36466
36467 Exim was designed for Unix-like systems, and internally, it stores messages
36468 using the system's convention of a single LF as a line terminator. When
36469 receiving a message, all line endings are translated to this standard format.
36470 Originally, it was thought that programs that passed messages directly to an
36471 MTA within an operating system would use that system's convention. Experience
36472 has shown that this is not the case; for example, there are Unix applications
36473 that use CRLF in this circumstance. For this reason, and for compatibility with
36474 other MTAs, the way Exim handles line endings for all messages is now as
36475 follows:
36476
36477 .ilist
36478 LF not preceded by CR is treated as a line ending.
36479 .next
36480 CR is treated as a line ending; if it is immediately followed by LF, the LF
36481 is ignored.
36482 .next
36483 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36484 nor a local message in the state where a line containing only a dot is a
36485 terminator.
36486 .next
36487 If a bare CR is encountered within a header line, an extra space is added after
36488 the line terminator so as not to end the header line. The reasoning behind this
36489 is that bare CRs in header lines are most likely either to be mistakes, or
36490 people trying to play silly games.
36491 .next
36492 If the first header line received in a message ends with CRLF, a subsequent
36493 bare LF in a header line is treated in the same way as a bare CR in a header
36494 line.
36495 .endlist
36496
36497
36498
36499
36500
36501 .section "Unqualified addresses" "SECID218"
36502 .cindex "unqualified addresses"
36503 .cindex "address" "qualification"
36504 By default, Exim expects every envelope address it receives from an external
36505 host to be fully qualified. Unqualified addresses cause negative responses to
36506 SMTP commands. However, because SMTP is used as a means of transporting
36507 messages from MUAs running on personal workstations, there is sometimes a
36508 requirement to accept unqualified addresses from specific hosts or IP networks.
36509
36510 Exim has two options that separately control which hosts may send unqualified
36511 sender or recipient addresses in SMTP commands, namely
36512 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36513 cases, if an unqualified address is accepted, it is qualified by adding the
36514 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36515
36516 .oindex "&%qualify_domain%&"
36517 .oindex "&%qualify_recipient%&"
36518 Unqualified addresses in header lines are automatically qualified for messages
36519 that are locally originated, unless the &%-bnq%& option is given on the command
36520 line. For messages received over SMTP, unqualified addresses in header lines
36521 are qualified only if unqualified addresses are permitted in SMTP commands. In
36522 other words, such qualification is also controlled by
36523 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36524
36525
36526
36527
36528 .section "The UUCP From line" "SECID219"
36529 .cindex "&""From""& line"
36530 .cindex "UUCP" "&""From""& line"
36531 .cindex "sender" "address"
36532 .oindex "&%uucp_from_pattern%&"
36533 .oindex "&%uucp_from_sender%&"
36534 .cindex "envelope from"
36535 .cindex "envelope sender"
36536 .cindex "Sendmail compatibility" "&""From""& line"
36537 Messages that have come from UUCP (and some other applications) often begin
36538 with a line containing the envelope sender and a timestamp, following the word
36539 &"From"&. Examples of two common formats are:
36540 .code
36541 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36542 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36543 .endd
36544 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36545 Exim recognizes such lines at the start of messages that are submitted to it
36546 via the command line (that is, on the standard input). It does not recognize
36547 such lines in incoming SMTP messages, unless the sending host matches
36548 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36549 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36550 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36551 default value matches the two common cases shown above and puts the address
36552 that follows &"From"& into &$1$&.
36553
36554 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36555 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36556 a trusted user, the message's sender address is constructed by expanding the
36557 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36558 then parsed as an RFC 2822 address. If there is no domain, the local part is
36559 qualified with &%qualify_domain%& unless it is the empty string. However, if
36560 the command line &%-f%& option is used, it overrides the &"From"& line.
36561
36562 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36563 sender address is not changed. This is also the case for incoming SMTP messages
36564 that are permitted to contain &"From"& lines.
36565
36566 Only one &"From"& line is recognized. If there is more than one, the second is
36567 treated as a data line that starts the body of the message, as it is not valid
36568 as a header line. This also happens if a &"From"& line is present in an
36569 incoming SMTP message from a source that is not permitted to send them.
36570
36571
36572
36573 .section "Header lines"
36574 .subsection "Resent- header lines" SECID220
36575 .chindex Resent-
36576 RFC 2822 makes provision for sets of header lines starting with the string
36577 &`Resent-`& to be added to a message when it is resent by the original
36578 recipient to somebody else. These headers are &'Resent-Date:'&,
36579 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36580 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36581
36582 .blockquote
36583 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36584 processing of replies or other such automatic actions on messages.'&
36585 .endblockquote
36586
36587 This leaves things a bit vague as far as other processing actions such as
36588 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36589 follows:
36590
36591 .ilist
36592 A &'Resent-From:'& line that just contains the login id of the submitting user
36593 is automatically rewritten in the same way as &'From:'& (see below).
36594 .next
36595 If there's a rewriting rule for a particular header line, it is also applied to
36596 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36597 &'From:'& also rewrites &'Resent-From:'&.
36598 .next
36599 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36600 also removed.
36601 .next
36602 For a locally-submitted message,
36603 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36604 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36605 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36606 included in log lines in this case.
36607 .next
36608 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36609 &%Resent-%& header lines are present.
36610 .endlist
36611
36612
36613
36614
36615 .subsection Auto-Submitted: SECID221
36616 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36617 includes the header line:
36618 .code
36619 Auto-Submitted: auto-replied
36620 .endd
36621
36622 .subsection Bcc: SECID222
36623 .cindex "&'Bcc:'& header line"
36624 If Exim is called with the &%-t%& option, to take recipient addresses from a
36625 message's header, it removes any &'Bcc:'& header line that may exist (after
36626 extracting its addresses). If &%-t%& is not present on the command line, any
36627 existing &'Bcc:'& is not removed.
36628
36629
36630 .subsection Date: SECID223
36631 .cindex Date:
36632 If a locally-generated or submission-mode message has no &'Date:'& header line,
36633 Exim adds one, using the current date and time, unless the
36634 &%suppress_local_fixups%& control has been specified.
36635
36636 .subsection Delivery-date: SECID224
36637 .cindex "&'Delivery-date:'& header line"
36638 .oindex "&%delivery_date_remove%&"
36639 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36640 set. Exim can be configured to add them to the final delivery of messages. (See
36641 the generic &%delivery_date_add%& transport option.) They should not be present
36642 in messages in transit. If the &%delivery_date_remove%& configuration option is
36643 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36644 messages.
36645
36646
36647 .subsection Envelope-to: SECID225
36648 .chindex Envelope-to:
36649 .oindex "&%envelope_to_remove%&"
36650 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36651 Exim can be configured to add them to the final delivery of messages. (See the
36652 generic &%envelope_to_add%& transport option.) They should not be present in
36653 messages in transit. If the &%envelope_to_remove%& configuration option is set
36654 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36655 messages.
36656
36657
36658 .subsection From: SECTthefrohea
36659 .chindex From:
36660 .cindex "Sendmail compatibility" "&""From""& line"
36661 .cindex "message" "submission"
36662 .cindex "submission mode"
36663 If a submission-mode message does not contain a &'From:'& header line, Exim
36664 adds one if either of the following conditions is true:
36665
36666 .ilist
36667 The envelope sender address is not empty (that is, this is not a bounce
36668 message). The added header line copies the envelope sender address.
36669 .next
36670 .vindex "&$authenticated_id$&"
36671 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36672 .olist
36673 .vindex "&$qualify_domain$&"
36674 If no domain is specified by the submission control, the local part is
36675 &$authenticated_id$& and the domain is &$qualify_domain$&.
36676 .next
36677 If a non-empty domain is specified by the submission control, the local
36678 part is &$authenticated_id$&, and the domain is the specified domain.
36679 .next
36680 If an empty domain is specified by the submission control,
36681 &$authenticated_id$& is assumed to be the complete address.
36682 .endlist
36683 .endlist
36684
36685 A non-empty envelope sender takes precedence.
36686
36687 If a locally-generated incoming message does not contain a &'From:'& header
36688 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36689 containing the sender's address. The calling user's login name and full name
36690 are used to construct the address, as described in section &<<SECTconstr>>&.
36691 They are obtained from the password data by calling &[getpwuid()]& (but see the
36692 &%unknown_login%& configuration option). The address is qualified with
36693 &%qualify_domain%&.
36694
36695 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36696 &'From:'& header line containing just the unqualified login name of the calling
36697 user, this is replaced by an address containing the user's login name and full
36698 name as described in section &<<SECTconstr>>&.
36699
36700
36701 .subsection Message-ID: SECID226
36702 .chindex Message-ID:
36703 .cindex "message" "submission"
36704 .oindex "&%message_id_header_text%&"
36705 If a locally-generated or submission-mode incoming message does not contain a
36706 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36707 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36708 to the message. If there are any &'Resent-:'& headers in the message, it
36709 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36710 message id, preceded by the letter E to ensure it starts with a letter, and
36711 followed by @ and the primary host name. Additional information can be included
36712 in this header line by setting the &%message_id_header_text%& and/or
36713 &%message_id_header_domain%& options.
36714
36715
36716 .subsection Received: SECID227
36717 .chindex Received:
36718 A &'Received:'& header line is added at the start of every message. The
36719 contents are defined by the &%received_header_text%& configuration option, and
36720 Exim automatically adds a semicolon and a timestamp to the configured string.
36721
36722 The &'Received:'& header is generated as soon as the message's header lines
36723 have been received. At this stage, the timestamp in the &'Received:'& header
36724 line is the time that the message started to be received. This is the value
36725 that is seen by the DATA ACL and by the &[local_scan()]& function.
36726
36727 Once a message is accepted, the timestamp in the &'Received:'& header line is
36728 changed to the time of acceptance, which is (apart from a small delay while the
36729 -H spool file is written) the earliest time at which delivery could start.
36730
36731
36732 .subsection References: SECID228
36733 .chindex References:
36734 Messages created by the &(autoreply)& transport include a &'References:'&
36735 header line. This is constructed according to the rules that are described in
36736 section 3.64 of RFC 2822 (which states that replies should contain such a
36737 header line), and section 3.14 of RFC 3834 (which states that automatic
36738 responses are not different in this respect). However, because some mail
36739 processing software does not cope well with very long header lines, no more
36740 than 12 message IDs are copied from the &'References:'& header line in the
36741 incoming message. If there are more than 12, the first one and then the final
36742 11 are copied, before adding the message ID of the incoming message.
36743
36744
36745
36746 .subsection Return-path: SECID229
36747 .chindex Return-path:
36748 .oindex "&%return_path_remove%&"
36749 &'Return-path:'& header lines are defined as something an MTA may insert when
36750 it does the final delivery of messages. (See the generic &%return_path_add%&
36751 transport option.) Therefore, they should not be present in messages in
36752 transit. If the &%return_path_remove%& configuration option is set (the
36753 default), Exim removes &'Return-path:'& header lines from incoming messages.
36754
36755
36756
36757 .subsection Sender: SECTthesenhea
36758 .cindex "&'Sender:'& header line"
36759 .cindex "message" "submission"
36760 .chindex Sender:
36761 For a locally-originated message from an untrusted user, Exim may remove an
36762 existing &'Sender:'& header line, and it may add a new one. You can modify
36763 these actions by setting the &%local_sender_retain%& option true, the
36764 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36765 control setting.
36766
36767 When a local message is received from an untrusted user and
36768 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36769 control has not been set, a check is made to see if the address given in the
36770 &'From:'& header line is the correct (local) sender of the message. The address
36771 that is expected has the login name as the local part and the value of
36772 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36773 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36774 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36775 line is added to the message.
36776
36777 If you set &%local_from_check%& false, this checking does not occur. However,
36778 the removal of an existing &'Sender:'& line still happens, unless you also set
36779 &%local_sender_retain%& to be true. It is not possible to set both of these
36780 options true at the same time.
36781
36782 .cindex "submission mode"
36783 By default, no processing of &'Sender:'& header lines is done for messages
36784 received over TCP/IP or for messages submitted by trusted users. However, when
36785 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36786 not specified on the submission control, the following processing takes place:
36787
36788 .vindex "&$authenticated_id$&"
36789 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36790 authenticated, and &$authenticated_id$& is not empty, a sender address is
36791 created as follows:
36792
36793 .ilist
36794 .vindex "&$qualify_domain$&"
36795 If no domain is specified by the submission control, the local part is
36796 &$authenticated_id$& and the domain is &$qualify_domain$&.
36797 .next
36798 If a non-empty domain is specified by the submission control, the local part
36799 is &$authenticated_id$&, and the domain is the specified domain.
36800 .next
36801 If an empty domain is specified by the submission control,
36802 &$authenticated_id$& is assumed to be the complete address.
36803 .endlist
36804
36805 This address is compared with the address in the &'From:'& header line. If they
36806 are different, a &'Sender:'& header line containing the created address is
36807 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36808 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36809
36810 .cindex "return path" "created from &'Sender:'&"
36811 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36812 the message (the envelope sender address) is changed to be the same address,
36813 except in the case of submission mode when &%sender_retain%& is specified.
36814
36815
36816
36817 .section "Adding and removing header lines in routers and transports" &&&
36818          "SECTheadersaddrem"
36819 .cindex "header lines" "adding; in router or transport"
36820 .cindex "header lines" "removing; in router or transport"
36821 When a message is delivered, the addition and removal of header lines can be
36822 specified in a system filter, or on any of the routers and transports that
36823 process the message. Section &<<SECTaddremheasys>>& contains details about
36824 modifying headers in a system filter. Header lines can also be added in an ACL
36825 as a message is received (see section &<<SECTaddheadacl>>&).
36826
36827 In contrast to what happens in a system filter, header modifications that are
36828 specified on routers and transports apply only to the particular recipient
36829 addresses that are being processed by those routers and transports. These
36830 changes do not actually take place until a copy of the message is being
36831 transported. Therefore, they do not affect the basic set of header lines, and
36832 they do not affect the values of the variables that refer to header lines.
36833
36834 &*Note*&: In particular, this means that any expansions in the configuration of
36835 the transport cannot refer to the modified header lines, because such
36836 expansions all occur before the message is actually transported.
36837
36838 For both routers and transports, the argument of a &%headers_add%&
36839 option must be in the form of one or more RFC 2822 header lines, separated by
36840 newlines (coded as &"\n"&). For example:
36841 .code
36842 headers_add = X-added-header: added by $primary_hostname\n\
36843               X-added-second: another added header line
36844 .endd
36845 Exim does not check the syntax of these added header lines.
36846
36847 Multiple &%headers_add%& options for a single router or transport can be
36848 specified; the values will append to a single list of header lines.
36849 Each header-line is separately expanded.
36850
36851 The argument of a &%headers_remove%& option must consist of a colon-separated
36852 list of header names. This is confusing, because header names themselves are
36853 often terminated by colons. In this case, the colons are the list separators,
36854 not part of the names. For example:
36855 .code
36856 headers_remove = return-receipt-to:acknowledge-to
36857 .endd
36858
36859 Multiple &%headers_remove%& options for a single router or transport can be
36860 specified; the arguments will append to a single header-names list.
36861 Each item is separately expanded.
36862 Note that colons in complex expansions which are used to
36863 form all or part of a &%headers_remove%& list
36864 will act as list separators.
36865
36866 When &%headers_add%& or &%headers_remove%& is specified on a router,
36867 items are expanded at routing time,
36868 and then associated with all addresses that are
36869 accepted by that router, and also with any new addresses that it generates. If
36870 an address passes through several routers as a result of aliasing or
36871 forwarding, the changes are cumulative.
36872
36873 .oindex "&%unseen%&"
36874 However, this does not apply to multiple routers that result from the use of
36875 the &%unseen%& option. Any header modifications that were specified by the
36876 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36877
36878 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36879 settings cannot be delivered together in a batch, so a transport is always
36880 dealing with a set of addresses that have the same header-processing
36881 requirements.
36882
36883 The transport starts by writing the original set of header lines that arrived
36884 with the message, possibly modified by the system filter. As it writes out
36885 these lines, it consults the list of header names that were attached to the
36886 recipient address(es) by &%headers_remove%& options in routers, and it also
36887 consults the transport's own &%headers_remove%& option. Header lines whose
36888 names are on either of these lists are not written out. If there are multiple
36889 instances of any listed header, they are all skipped.
36890
36891 After the remaining original header lines have been written, new header
36892 lines that were specified by routers' &%headers_add%& options are written, in
36893 the order in which they were attached to the address. These are followed by any
36894 header lines specified by the transport's &%headers_add%& option.
36895
36896 This way of handling header line modifications in routers and transports has
36897 the following consequences:
36898
36899 .ilist
36900 The original set of header lines, possibly modified by the system filter,
36901 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36902 to it, at all times.
36903 .next
36904 Header lines that are added by a router's
36905 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36906 expansion syntax in subsequent routers or the transport.
36907 .next
36908 Conversely, header lines that are specified for removal by &%headers_remove%&
36909 in a router remain visible to subsequent routers and the transport.
36910 .next
36911 Headers added to an address by &%headers_add%& in a router cannot be removed by
36912 a later router or by a transport.
36913 .next
36914 An added header can refer to the contents of an original header that is to be
36915 removed, even it has the same name as the added header. For example:
36916 .code
36917 headers_remove = subject
36918 headers_add = Subject: new subject (was: $h_subject:)
36919 .endd
36920 .endlist
36921
36922 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36923 for a &(redirect)& router that has the &%one_time%& option set.
36924
36925
36926
36927
36928
36929 .section "Constructed addresses" "SECTconstr"
36930 .cindex "address" "constructed"
36931 .cindex "constructed address"
36932 When Exim constructs a sender address for a locally-generated message, it uses
36933 the form
36934 .display
36935 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36936 .endd
36937 For example:
36938 .code
36939 Zaphod Beeblebrox <zaphod@end.univ.example>
36940 .endd
36941 The user name is obtained from the &%-F%& command line option if set, or
36942 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36943 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36944 ampersand character, this is replaced by the login name with the first letter
36945 upper cased, as is conventional in a number of operating systems. See the
36946 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36947 The &%unknown_username%& option can be used to specify user names in cases when
36948 there is no password file entry.
36949
36950 .cindex "RFC 2047"
36951 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36952 parts of it if necessary. In addition, if it contains any non-printing
36953 characters, it is encoded as described in RFC 2047, which defines a way of
36954 including non-ASCII characters in header lines. The value of the
36955 &%headers_charset%& option specifies the name of the encoding that is used (the
36956 characters are assumed to be in this encoding). The setting of
36957 &%print_topbitchars%& controls whether characters with the top bit set (that
36958 is, with codes greater than 127) count as printing characters or not.
36959
36960
36961
36962 .section "Case of local parts" "SECID230"
36963 .cindex "case of local parts"
36964 .cindex "local part" "case of"
36965 RFC 2822 states that the case of letters in the local parts of addresses cannot
36966 be assumed to be non-significant. Exim preserves the case of local parts of
36967 addresses, but by default it uses a lower-cased form when it is routing,
36968 because on most Unix systems, usernames are in lower case and case-insensitive
36969 routing is required. However, any particular router can be made to use the
36970 original case for local parts by setting the &%caseful_local_part%& generic
36971 router option.
36972
36973 .cindex "mixed-case login names"
36974 If you must have mixed-case user names on your system, the best way to proceed,
36975 assuming you want case-independent handling of incoming email, is to set up
36976 your first router to convert incoming local parts in your domains to the
36977 correct case by means of a file lookup. For example:
36978 .code
36979 correct_case:
36980   driver = redirect
36981   domains = +local_domains
36982   data = ${lookup{$local_part}cdb\
36983               {/etc/usercased.cdb}{$value}fail}\
36984               @$domain
36985 .endd
36986 For this router, the local part is forced to lower case by the default action
36987 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36988 up a new local part in the correct case. If you then set &%caseful_local_part%&
36989 on any subsequent routers which process your domains, they will operate on
36990 local parts with the correct case in a case-sensitive manner.
36991
36992
36993
36994 .section "Dots in local parts" "SECID231"
36995 .cindex "dot" "in local part"
36996 .cindex "local part" "dots in"
36997 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36998 part may not begin or end with a dot, nor have two consecutive dots in the
36999 middle. However, it seems that many MTAs do not enforce this, so Exim permits
37000 empty components for compatibility.
37001
37002
37003
37004 .section "Rewriting addresses" "SECID232"
37005 .cindex "rewriting" "addresses"
37006 Rewriting of sender and recipient addresses, and addresses in headers, can
37007 happen automatically, or as the result of configuration options, as described
37008 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
37009 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
37010
37011 Automatic rewriting includes qualification, as mentioned above. The other case
37012 in which it can happen is when an incomplete non-local domain is given. The
37013 routing process may cause this to be expanded into the full domain name. For
37014 example, a header such as
37015 .code
37016 To: hare@teaparty
37017 .endd
37018 might get rewritten as
37019 .code
37020 To: hare@teaparty.wonderland.fict.example
37021 .endd
37022 Rewriting as a result of routing is the one kind of message processing that
37023 does not happen at input time, as it cannot be done until the address has
37024 been routed.
37025
37026 Strictly, one should not do &'any'& deliveries of a message until all its
37027 addresses have been routed, in case any of the headers get changed as a
37028 result of routing. However, doing this in practice would hold up many
37029 deliveries for unreasonable amounts of time, just because one address could not
37030 immediately be routed. Exim therefore does not delay other deliveries when
37031 routing of one or more addresses is deferred.
37032 .ecindex IIDmesproc
37033
37034
37035
37036 . ////////////////////////////////////////////////////////////////////////////
37037 . ////////////////////////////////////////////////////////////////////////////
37038
37039 .chapter "SMTP processing" "CHAPSMTP"
37040 .scindex IIDsmtpproc1 "SMTP" "processing details"
37041 .scindex IIDsmtpproc2 "LMTP" "processing details"
37042 Exim supports a number of different ways of using the SMTP protocol, and its
37043 LMTP variant, which is an interactive protocol for transferring messages into a
37044 closed mail store application. This chapter contains details of how SMTP is
37045 processed. For incoming mail, the following are available:
37046
37047 .ilist
37048 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37049 .next
37050 SMTP over the standard input and output (the &%-bs%& option);
37051 .next
37052 Batched SMTP on the standard input (the &%-bS%& option).
37053 .endlist
37054
37055 For mail delivery, the following are available:
37056
37057 .ilist
37058 SMTP over TCP/IP (the &(smtp)& transport);
37059 .next
37060 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37061 &"lmtp"&);
37062 .next
37063 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37064 transport);
37065 .next
37066 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37067 the &%use_bsmtp%& option set).
37068 .endlist
37069
37070 &'Batched SMTP'& is the name for a process in which batches of messages are
37071 stored in or read from files (or pipes), in a format in which SMTP commands are
37072 used to contain the envelope information.
37073
37074
37075
37076 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37077 .cindex "SMTP" "outgoing over TCP/IP"
37078 .cindex "outgoing SMTP over TCP/IP"
37079 .cindex "LMTP" "over TCP/IP"
37080 .cindex "outgoing LMTP over TCP/IP"
37081 .cindex "EHLO"
37082 .cindex "HELO"
37083 .cindex "SIZE" "option on MAIL command"
37084 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37085 The &%protocol%& option selects which protocol is to be used, but the actual
37086 processing is the same in both cases.
37087
37088 .cindex "ESMTP extensions" SIZE
37089 If, in response to its EHLO command, Exim is told that the SIZE
37090 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37091 command. The value of <&'n'&> is the message size plus the value of the
37092 &%size_addition%& option (default 1024) to allow for additions to the message
37093 such as per-transport header lines, or changes made in a
37094 .cindex "transport" "filter"
37095 .cindex "filter" "transport filter"
37096 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37097 suppressed.
37098
37099 If the remote server advertises support for PIPELINING, Exim uses the
37100 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37101 required for the transaction.
37102
37103 If the remote server advertises support for the STARTTLS command, and Exim
37104 was built to support TLS encryption, it tries to start a TLS session unless the
37105 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37106 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37107 is called for verification.
37108
37109 If the remote server advertises support for the AUTH command, Exim scans
37110 the authenticators configuration for any suitable client settings, as described
37111 in chapter &<<CHAPSMTPAUTH>>&.
37112
37113 .cindex "carriage return"
37114 .cindex "linefeed"
37115 Responses from the remote host are supposed to be terminated by CR followed by
37116 LF. However, there are known to be hosts that do not send CR characters, so in
37117 order to be able to interwork with such hosts, Exim treats LF on its own as a
37118 line terminator.
37119
37120 If a message contains a number of different addresses, all those with the same
37121 characteristics (for example, the same envelope sender) that resolve to the
37122 same set of hosts, in the same order, are sent in a single SMTP transaction,
37123 even if they are for different domains, unless there are more than the setting
37124 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37125 they are split into groups containing no more than &%max_rcpt%&s addresses
37126 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37127 in parallel sessions. The order of hosts with identical MX values is not
37128 significant when checking whether addresses can be batched in this way.
37129
37130 When the &(smtp)& transport suffers a temporary failure that is not
37131 message-related, Exim updates its transport-specific database, which contains
37132 records indexed by host name that remember which messages are waiting for each
37133 particular host. It also updates the retry database with new retry times.
37134
37135 .cindex "hints database" "retry keys"
37136 Exim's retry hints are based on host name plus IP address, so if one address of
37137 a multi-homed host is broken, it will soon be skipped most of the time.
37138 See the next section for more detail about error handling.
37139
37140 .cindex "SMTP" "passed connection"
37141 .cindex "SMTP" "batching over TCP/IP"
37142 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37143 looks in the hints database for the transport to see if there are any queued
37144 messages waiting for the host to which it is connected. If it finds one, it
37145 creates a new Exim process using the &%-MC%& option (which can only be used by
37146 a process running as root or the Exim user) and passes the TCP/IP socket to it
37147 so that it can deliver another message using the same socket. The new process
37148 does only those deliveries that are routed to the connected host, and may in
37149 turn pass the socket on to a third process, and so on.
37150
37151 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37152 limit the number of messages sent down a single TCP/IP connection.
37153
37154 .cindex "asterisk" "after IP address"
37155 The second and subsequent messages delivered down an existing connection are
37156 identified in the main log by the addition of an asterisk after the closing
37157 square bracket of the IP address.
37158
37159
37160
37161
37162 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37163 .cindex "error" "in outgoing SMTP"
37164 .cindex "SMTP" "errors in outgoing"
37165 .cindex "host" "error"
37166 Three different kinds of error are recognized for outgoing SMTP: host errors,
37167 message errors, and recipient errors.
37168
37169 .vlist
37170 .vitem "&*Host errors*&"
37171 A host error is not associated with a particular message or with a
37172 particular recipient of a message. The host errors are:
37173
37174 .ilist
37175 Connection refused or timed out,
37176 .next
37177 Any error response code on connection,
37178 .next
37179 Any error response code to EHLO or HELO,
37180 .next
37181 Loss of connection at any time, except after &"."&,
37182 .next
37183 I/O errors at any time,
37184 .next
37185 Timeouts during the session, other than in response to MAIL, RCPT or
37186 the &"."& at the end of the data.
37187 .endlist ilist
37188
37189 For a host error, a permanent error response on connection, or in response to
37190 EHLO, causes all addresses routed to the host to be failed. Any other host
37191 error causes all addresses to be deferred, and retry data to be created for the
37192 host. It is not tried again, for any message, until its retry time arrives. If
37193 the current set of addresses are not all delivered in this run (to some
37194 alternative host), the message is added to the list of those waiting for this
37195 host, so if it is still undelivered when a subsequent successful delivery is
37196 made to the host, it will be sent down the same SMTP connection.
37197
37198 .vitem "&*Message errors*&"
37199 .cindex "message" "error"
37200 A message error is associated with a particular message when sent to a
37201 particular host, but not with a particular recipient of the message. The
37202 message errors are:
37203
37204 .ilist
37205 Any error response code to MAIL, DATA, or the &"."& that terminates
37206 the data,
37207 .next
37208 Timeout after MAIL,
37209 .next
37210 Timeout or loss of connection after the &"."& that terminates the data. A
37211 timeout after the DATA command itself is treated as a host error, as is loss of
37212 connection at any other time.
37213 .endlist ilist
37214
37215 For a message error, a permanent error response (5&'xx'&) causes all addresses
37216 to be failed, and a delivery error report to be returned to the sender. A
37217 temporary error response (4&'xx'&), or one of the timeouts, causes all
37218 addresses to be deferred. Retry data is not created for the host, but instead,
37219 a retry record for the combination of host plus message id is created. The
37220 message is not added to the list of those waiting for this host. This ensures
37221 that the failing message will not be sent to this host again until the retry
37222 time arrives. However, other messages that are routed to the host are not
37223 affected, so if it is some property of the message that is causing the error,
37224 it will not stop the delivery of other mail.
37225
37226 If the remote host specified support for the SIZE parameter in its response
37227 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37228 over-large message will cause a message error because the error arrives as a
37229 response to MAIL.
37230
37231 .vitem "&*Recipient errors*&"
37232 .cindex "recipient" "error"
37233 A recipient error is associated with a particular recipient of a message. The
37234 recipient errors are:
37235
37236 .ilist
37237 Any error response to RCPT,
37238 .next
37239 Timeout after RCPT.
37240 .endlist
37241
37242 For a recipient error, a permanent error response (5&'xx'&) causes the
37243 recipient address to be failed, and a bounce message to be returned to the
37244 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37245 address to be deferred, and routing retry data to be created for it. This is
37246 used to delay processing of the address in subsequent queue runs, until its
37247 routing retry time arrives. This applies to all messages, but because it
37248 operates only in queue runs, one attempt will be made to deliver a new message
37249 to the failing address before the delay starts to operate. This ensures that,
37250 if the failure is really related to the message rather than the recipient
37251 (&"message too big for this recipient"& is a possible example), other messages
37252 have a chance of getting delivered. If a delivery to the address does succeed,
37253 the retry information gets cleared, so all stuck messages get tried again, and
37254 the retry clock is reset.
37255
37256 The message is not added to the list of those waiting for this host. Use of the
37257 host for other messages is unaffected, and except in the case of a timeout,
37258 other recipients are processed independently, and may be successfully delivered
37259 in the current SMTP session. After a timeout it is of course impossible to
37260 proceed with the session, so all addresses get deferred. However, those other
37261 than the one that failed do not suffer any subsequent retry delays. Therefore,
37262 if one recipient is causing trouble, the others have a chance of getting
37263 through when a subsequent delivery attempt occurs before the failing
37264 recipient's retry time.
37265 .endlist
37266
37267 In all cases, if there are other hosts (or IP addresses) available for the
37268 current set of addresses (for example, from multiple MX records), they are
37269 tried in this run for any undelivered addresses, subject of course to their
37270 own retry data. In other words, recipient error retry data does not take effect
37271 until the next delivery attempt.
37272
37273 Some hosts have been observed to give temporary error responses to every
37274 MAIL command at certain times (&"insufficient space"& has been seen). It
37275 would be nice if such circumstances could be recognized, and defer data for the
37276 host itself created, but this is not possible within the current Exim design.
37277 What actually happens is that retry data for every (host, message) combination
37278 is created.
37279
37280 The reason that timeouts after MAIL and RCPT are treated specially is that
37281 these can sometimes arise as a result of the remote host's verification
37282 procedures. Exim makes this assumption, and treats them as if a temporary error
37283 response had been received. A timeout after &"."& is treated specially because
37284 it is known that some broken implementations fail to recognize the end of the
37285 message if the last character of the last line is a binary zero. Thus, it is
37286 helpful to treat this case as a message error.
37287
37288 Timeouts at other times are treated as host errors, assuming a problem with the
37289 host, or the connection to it. If a timeout after MAIL, RCPT,
37290 or &"."& is really a connection problem, the assumption is that at the next try
37291 the timeout is likely to occur at some other point in the dialogue, causing it
37292 then to be treated as a host error.
37293
37294 There is experimental evidence that some MTAs drop the connection after the
37295 terminating &"."& if they do not like the contents of the message for some
37296 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37297 should be given. That is why Exim treats this case as a message rather than a
37298 host error, in order not to delay other messages to the same host.
37299
37300
37301
37302
37303 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37304 .cindex "SMTP" "incoming over TCP/IP"
37305 .cindex "incoming SMTP over TCP/IP"
37306 .cindex "inetd"
37307 .cindex "daemon"
37308 Incoming SMTP messages can be accepted in one of two ways: by running a
37309 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37310 &_/etc/inetd.conf_& should be like this:
37311 .code
37312 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37313 .endd
37314 Exim distinguishes between this case and the case of a locally running user
37315 agent using the &%-bs%& option by checking whether or not the standard input is
37316 a socket. When it is, either the port must be privileged (less than 1024), or
37317 the caller must be root or the Exim user. If any other user passes a socket
37318 with an unprivileged port number, Exim prints a message on the standard error
37319 stream and exits with an error code.
37320
37321 By default, Exim does not make a log entry when a remote host connects or
37322 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37323 unexpected. It can be made to write such log entries by setting the
37324 &%smtp_connection%& log selector.
37325
37326 .cindex "carriage return"
37327 .cindex "linefeed"
37328 Commands from the remote host are supposed to be terminated by CR followed by
37329 LF. However, there are known to be hosts that do not send CR characters. In
37330 order to be able to interwork with such hosts, Exim treats LF on its own as a
37331 line terminator.
37332 Furthermore, because common code is used for receiving messages from all
37333 sources, a CR on its own is also interpreted as a line terminator. However, the
37334 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37335
37336 .cindex "EHLO" "invalid data"
37337 .cindex "HELO" "invalid data"
37338 One area that sometimes gives rise to problems concerns the EHLO or
37339 HELO commands. Some clients send syntactically invalid versions of these
37340 commands, which Exim rejects by default. (This is nothing to do with verifying
37341 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37342 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37343 match the broken hosts that send invalid commands.
37344
37345 .cindex "SIZE option on MAIL command"
37346 .cindex "MAIL" "SIZE option"
37347 The amount of disk space available is checked whenever SIZE is received on
37348 a MAIL command, independently of whether &%message_size_limit%& or
37349 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37350 false. A temporary error is given if there is not enough space. If
37351 &%check_spool_space%& is set, the check is for that amount of space plus the
37352 value given with SIZE, that is, it checks that the addition of the incoming
37353 message will not reduce the space below the threshold.
37354
37355 When a message is successfully received, Exim includes the local message id in
37356 its response to the final &"."& that terminates the data. If the remote host
37357 logs this text it can help with tracing what has happened to a message.
37358
37359 The Exim daemon can limit the number of simultaneous incoming connections it is
37360 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37361 number of simultaneous incoming connections from a single remote host (see the
37362 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37363 rejected using the SMTP temporary error code 421.
37364
37365 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37366 subprocess has finished, as this can get lost at busy times. Instead, it looks
37367 for completed subprocesses every time it wakes up. Provided there are other
37368 things happening (new incoming calls, starts of queue runs), completed
37369 processes will be noticed and tidied away. On very quiet systems you may
37370 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37371 it will be noticed when the daemon next wakes up.
37372
37373 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37374 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37375 high system load &-- for details see the &%smtp_accept_reserve%&,
37376 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37377 applies in both the daemon and &'inetd'& cases.
37378
37379 Exim normally starts a delivery process for each message received, though this
37380 can be varied by means of the &%-odq%& command line option and the
37381 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37382 number of simultaneously running delivery processes started in this way from
37383 SMTP input can be limited by the &%smtp_accept_queue%& and
37384 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37385 subsequently received messages are just put on the input queue without starting
37386 a delivery process.
37387
37388 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37389 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37390 started up from the &'inetd'& daemon, because in that case each connection is
37391 handled by an entirely independent Exim process. Control by load average is,
37392 however, available with &'inetd'&.
37393
37394 Exim can be configured to verify addresses in incoming SMTP commands as they
37395 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37396 to rewrite addresses at this time &-- before any syntax checking is done. See
37397 section &<<SSECTrewriteS>>&.
37398
37399 Exim can also be configured to limit the rate at which a client host submits
37400 MAIL and RCPT commands in a single SMTP session. See the
37401 &%smtp_ratelimit_hosts%& option.
37402
37403
37404
37405 .subsection "Unrecognized SMTP commands" SECID234
37406 .cindex "SMTP" "unrecognized commands"
37407 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37408 commands during a single SMTP connection, it drops the connection after sending
37409 the error response to the last command. The default value for
37410 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37411 abuse that subvert web servers into making connections to SMTP ports; in these
37412 circumstances, a number of non-SMTP lines are sent first.
37413
37414
37415 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37416 .cindex "SMTP" "syntax errors"
37417 .cindex "SMTP" "protocol errors"
37418 A syntax error is detected if an SMTP command is recognized, but there is
37419 something syntactically wrong with its data, for example, a malformed email
37420 address in a RCPT command. Protocol errors include invalid command
37421 sequencing such as RCPT before MAIL. If Exim receives more than
37422 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37423 drops the connection after sending the error response to the last command. The
37424 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37425 broken clients that loop sending bad commands (yes, it has been seen).
37426
37427
37428
37429 .subsection "Use of non-mail SMTP commands" SECID236
37430 .cindex "SMTP" "non-mail commands"
37431 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37432 DATA. Exim counts such commands, and drops the connection if there are too
37433 many of them in a single SMTP session. This action catches some
37434 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37435 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37436 defines what &"too many"& means. Its default value is 10.
37437
37438 When a new message is expected, one occurrence of RSET is not counted. This
37439 allows a client to send one RSET between messages (this is not necessary,
37440 but some clients do it). Exim also allows one uncounted occurrence of HELO
37441 or EHLO, and one occurrence of STARTTLS between messages. After
37442 starting up a TLS session, another EHLO is expected, and so it too is not
37443 counted.
37444
37445 The first occurrence of AUTH in a connection, or immediately following
37446 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37447 RCPT, DATA, and QUIT are counted.
37448
37449 You can control which hosts are subject to the limit set by
37450 &%smtp_accept_max_nonmail%& by setting
37451 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37452 the limit apply to all hosts. This option means that you can exclude any
37453 specific badly-behaved hosts that you have to live with.
37454
37455
37456
37457
37458 .subsection "The VRFY and EXPN commands" SECID237
37459 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37460 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37461 appropriate) in order to decide whether the command should be accepted or not.
37462
37463 .cindex "VRFY" "processing"
37464 When no ACL is defined for VRFY, or if it rejects without
37465 setting an explicit response code, the command is accepted
37466 (with a 252 SMTP response code)
37467 in order to support awkward clients that do a VRFY before every RCPT.
37468 When VRFY is accepted, it runs exactly the same code as when Exim is
37469 called with the &%-bv%& option, and returns 250/451/550
37470 SMTP response codes.
37471
37472 .cindex "EXPN" "processing"
37473 If no ACL for EXPN is defined, the command is rejected.
37474 When EXPN is accepted, a single-level expansion of the address is done.
37475 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37476 than a verification (the &%-bv%& option). If an unqualified local part is given
37477 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37478 of VRFY and EXPN commands are logged on the main and reject logs, and
37479 VRFY verification failures are logged in the main log for consistency with
37480 RCPT failures.
37481
37482
37483
37484 .subsection "The ETRN command" SECTETRN
37485 .cindex "ETRN" "processing"
37486 .cindex "ESMTP extensions" ETRN
37487 RFC 1985 describes an ESMTP command called ETRN that is designed to
37488 overcome the security problems of the TURN command (which has fallen into
37489 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37490 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37491 should be accepted or not. If no ACL is defined, the command is rejected.
37492
37493 The ETRN command is concerned with &"releasing"& messages that are awaiting
37494 delivery to certain hosts. As Exim does not organize its message queue by host,
37495 the only form of ETRN that is supported by default is the one where the
37496 text starts with the &"#"& prefix, in which case the remainder of the text is
37497 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37498 the &%-R%& option to happen, with the remainder of the ETRN text as its
37499 argument. For example,
37500 .code
37501 ETRN #brigadoon
37502 .endd
37503 runs the command
37504 .code
37505 exim -R brigadoon
37506 .endd
37507 which causes a delivery attempt on all messages with undelivered addresses
37508 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37509 default), Exim prevents the simultaneous execution of more than one queue run
37510 for the same argument string as a result of an ETRN command. This stops
37511 a misbehaving client from starting more than one queue runner at once.
37512
37513 .cindex "hints database" "ETRN serialization"
37514 Exim implements the serialization by means of a hints database in which a
37515 record is written whenever a process is started by ETRN, and deleted when
37516 the process completes. However, Exim does not keep the SMTP session waiting for
37517 the ETRN process to complete. Once ETRN is accepted, the client is sent
37518 a &"success"& return code. Obviously there is scope for hints records to get
37519 left lying around if there is a system or program crash. To guard against this,
37520 Exim ignores any records that are more than six hours old.
37521
37522 .oindex "&%smtp_etrn_command%&"
37523 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37524 used. This specifies a command that is run whenever ETRN is received,
37525 whatever the form of its argument. For
37526 example:
37527 .code
37528 smtp_etrn_command = /etc/etrn_command $domain \
37529                     $sender_host_address
37530 .endd
37531 .vindex "&$domain$&"
37532 The string is split up into arguments which are independently expanded. The
37533 expansion variable &$domain$& is set to the argument of the ETRN command,
37534 and no syntax checking is done on the contents of this argument. Exim does not
37535 wait for the command to complete, so its status code is not checked. Exim runs
37536 under its own uid and gid when receiving incoming SMTP, so it is not possible
37537 for it to change them before running the command.
37538
37539
37540
37541 .section "Incoming local SMTP" "SECID238"
37542 .cindex "SMTP" "local incoming"
37543 Some user agents use SMTP to pass messages to their local MTA using the
37544 standard input and output, as opposed to passing the envelope on the command
37545 line and writing the message to the standard input. This is supported by the
37546 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37547 messages over TCP/IP (including the use of ACLs), except that the envelope
37548 sender given in a MAIL command is ignored unless the caller is trusted. In
37549 an ACL you can detect this form of SMTP input by testing for an empty host
37550 identification. It is common to have this as the first line in the ACL that
37551 runs for RCPT commands:
37552 .code
37553 accept hosts = :
37554 .endd
37555 This accepts SMTP messages from local processes without doing any other tests.
37556
37557
37558
37559 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37560 .cindex "SMTP" "batched outgoing"
37561 .cindex "batched SMTP output"
37562 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37563 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37564 be output in BSMTP format. No SMTP responses are possible for this form of
37565 delivery. All it is doing is using SMTP commands as a way of transmitting the
37566 envelope along with the message.
37567
37568 The message is written to the file or pipe preceded by the SMTP commands
37569 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37570 the message that start with a dot have an extra dot added. The SMTP command
37571 HELO is not normally used. If it is required, the &%message_prefix%& option
37572 can be used to specify it.
37573
37574 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37575 one recipient address at a time by default. However, you can arrange for them
37576 to handle several addresses at once by setting the &%batch_max%& option. When
37577 this is done for BSMTP, messages may contain multiple RCPT commands. See
37578 chapter &<<CHAPbatching>>& for more details.
37579
37580 .vindex "&$host$&"
37581 When one or more addresses are routed to a BSMTP transport by a router that
37582 sets up a host list, the name of the first host on the list is available to the
37583 transport in the variable &$host$&. Here is an example of such a transport and
37584 router:
37585 .code
37586 begin routers
37587 route_append:
37588   driver = manualroute
37589   transport = smtp_appendfile
37590   route_list = domain.example  batch.host.example
37591
37592 begin transports
37593 smtp_appendfile:
37594   driver = appendfile
37595   directory = /var/bsmtp/$host
37596   batch_max = 1000
37597   use_bsmtp
37598   user = exim
37599 .endd
37600 This causes messages addressed to &'domain.example'& to be written in BSMTP
37601 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37602 message (unless there are more than 1000 recipients).
37603
37604
37605
37606 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37607 .cindex "SMTP" "batched incoming"
37608 .cindex "batched SMTP input"
37609 The &%-bS%& command line option causes Exim to accept one or more messages by
37610 reading SMTP on the standard input, but to generate no responses. If the caller
37611 is trusted, the senders in the MAIL commands are believed; otherwise the
37612 sender is always the caller of Exim. Unqualified senders and receivers are not
37613 rejected (there seems little point) but instead just get qualified. HELO
37614 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37615 as NOOP; QUIT quits.
37616
37617 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37618 ACL is run in the same way as for non-SMTP local input.
37619
37620 If an error is detected while reading a message, including a missing &"."& at
37621 the end, Exim gives up immediately. It writes details of the error to the
37622 standard output in a stylized way that the calling program should be able to
37623 make some use of automatically, for example:
37624 .code
37625 554 Unexpected end of file
37626 Transaction started in line 10
37627 Error detected in line 14
37628 .endd
37629 It writes a more verbose version, for human consumption, to the standard error
37630 file, for example:
37631 .code
37632 An error was detected while processing a file of BSMTP input.
37633 The error message was:
37634
37635 501 '>' missing at end of address
37636
37637 The SMTP transaction started in line 10.
37638 The error was detected in line 12.
37639 The SMTP command at fault was:
37640
37641 rcpt to:<malformed@in.com.plete
37642
37643 1 previous message was successfully processed.
37644 The rest of the batch was abandoned.
37645 .endd
37646 The return code from Exim is zero only if there were no errors. It is 1 if some
37647 messages were accepted before an error was detected, and 2 if no messages were
37648 accepted.
37649 .ecindex IIDsmtpproc1
37650 .ecindex IIDsmtpproc2
37651
37652
37653
37654 . ////////////////////////////////////////////////////////////////////////////
37655 . ////////////////////////////////////////////////////////////////////////////
37656
37657 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37658          "Customizing messages"
37659 When a message fails to be delivered, or remains in the queue for more than a
37660 configured amount of time, Exim sends a message to the original sender, or
37661 to an alternative configured address. The text of these messages is built into
37662 the code of Exim, but it is possible to change it, either by adding a single
37663 string, or by replacing each of the paragraphs by text supplied in a file.
37664
37665 The &'From:'& and &'To:'& header lines are automatically generated; you can
37666 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37667 option. Exim also adds the line
37668 .code
37669 Auto-Submitted: auto-generated
37670 .endd
37671 to all warning and bounce messages,
37672
37673
37674 .section "Customizing bounce messages" "SECID239"
37675 .cindex "customizing" "bounce message"
37676 .cindex "bounce message" "customizing"
37677 If &%bounce_message_text%& is set, its contents are included in the default
37678 message immediately after &"This message was created automatically by mail
37679 delivery software."& The string is not expanded. It is not used if
37680 &%bounce_message_file%& is set.
37681
37682 When &%bounce_message_file%& is set, it must point to a template file for
37683 constructing error messages. The file consists of a series of text items,
37684 separated by lines consisting of exactly four asterisks. If the file cannot be
37685 opened, default text is used and a message is written to the main and panic
37686 logs. If any text item in the file is empty, default text is used for that
37687 item.
37688
37689 .vindex "&$bounce_recipient$&"
37690 .vindex "&$bounce_return_size_limit$&"
37691 Each item of text that is read from the file is expanded, and there are two
37692 expansion variables which can be of use here: &$bounce_recipient$& is set to
37693 the recipient of an error message while it is being created, and
37694 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37695 option, rounded to a whole number.
37696
37697 The items must appear in the file in the following order:
37698
37699 .ilist
37700 The first item is included in the headers, and should include at least a
37701 &'Subject:'& header. Exim does not check the syntax of these headers.
37702 .next
37703 The second item forms the start of the error message. After it, Exim lists the
37704 failing addresses with their error messages.
37705 .next
37706 The third item is used to introduce any text from pipe transports that is to be
37707 returned to the sender. It is omitted if there is no such text.
37708 .next
37709 The fourth, fifth and sixth items will be ignored and may be empty.
37710 The fields exist for back-compatibility
37711 .endlist
37712
37713 The default state (&%bounce_message_file%& unset) is equivalent to the
37714 following file, in which the sixth item is empty. The &'Subject:'& and some
37715 other lines have been split in order to fit them on the page:
37716 .code
37717 Subject: Mail delivery failed
37718   ${if eq{$sender_address}{$bounce_recipient}
37719   {: returning message to sender}}
37720 ****
37721 This message was created automatically by mail delivery software.
37722
37723 A message ${if eq{$sender_address}{$bounce_recipient}
37724   {that you sent }{sent by
37725
37726 <$sender_address>
37727
37728 }}could not be delivered to all of its recipients.
37729 This is a permanent error. The following address(es) failed:
37730 ****
37731 The following text was generated during the delivery attempt(s):
37732 ****
37733 ------ This is a copy of the message, including all the headers.
37734   ------
37735 ****
37736 ------ The body of the message is $message_size characters long;
37737   only the first
37738 ------ $bounce_return_size_limit or so are included here.
37739 ****
37740 .endd
37741 .section "Customizing warning messages" "SECTcustwarn"
37742 .cindex "customizing" "warning message"
37743 .cindex "warning of delay" "customizing the message"
37744 The option &%warn_message_file%& can be pointed at a template file for use when
37745 warnings about message delays are created. In this case there are only three
37746 text sections:
37747
37748 .ilist
37749 The first item is included in the headers, and should include at least a
37750 &'Subject:'& header. Exim does not check the syntax of these headers.
37751 .next
37752 The second item forms the start of the warning message. After it, Exim lists
37753 the delayed addresses.
37754 .next
37755 The third item then ends the message.
37756 .endlist
37757
37758 The default state is equivalent to the following file, except that some lines
37759 have been split here, in order to fit them on the page:
37760 .code
37761 Subject: Warning: message $message_exim_id delayed
37762   $warn_message_delay
37763 ****
37764 This message was created automatically by mail delivery software.
37765
37766 A message ${if eq{$sender_address}{$warn_message_recipients}
37767 {that you sent }{sent by
37768
37769 <$sender_address>
37770
37771 }}has not been delivered to all of its recipients after
37772 more than $warn_message_delay in the queue on $primary_hostname.
37773
37774 The message identifier is:     $message_exim_id
37775 The subject of the message is: $h_subject
37776 The date of the message is:    $h_date
37777
37778 The following address(es) have not yet been delivered:
37779 ****
37780 No action is required on your part. Delivery attempts will
37781 continue for some time, and this warning may be repeated at
37782 intervals if the message remains undelivered. Eventually the
37783 mail delivery software will give up, and when that happens,
37784 the message will be returned to you.
37785 .endd
37786 .vindex "&$warn_message_delay$&"
37787 .vindex "&$warn_message_recipients$&"
37788 However, in the default state the subject and date lines are omitted if no
37789 appropriate headers exist. During the expansion of this file,
37790 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37791 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37792 of recipients for the warning message. There may be more than one if there are
37793 multiple addresses with different &%errors_to%& settings on the routers that
37794 handled them.
37795
37796
37797
37798
37799 . ////////////////////////////////////////////////////////////////////////////
37800 . ////////////////////////////////////////////////////////////////////////////
37801
37802 .chapter "Some common configuration settings" "CHAPcomconreq"
37803 This chapter discusses some configuration settings that seem to be fairly
37804 common. More examples and discussion can be found in the Exim book.
37805
37806
37807
37808 .section "Sending mail to a smart host" "SECID240"
37809 .cindex "smart host" "example router"
37810 If you want to send all mail for non-local domains to a &"smart host"&, you
37811 should replace the default &(dnslookup)& router with a router which does the
37812 routing explicitly:
37813 .code
37814 send_to_smart_host:
37815   driver = manualroute
37816   route_list = !+local_domains smart.host.name
37817   transport = remote_smtp
37818 .endd
37819 You can use the smart host's IP address instead of the name if you wish.
37820 If you are using Exim only to submit messages to a smart host, and not for
37821 receiving incoming messages, you can arrange for it to do the submission
37822 synchronously by setting the &%mua_wrapper%& option (see chapter
37823 &<<CHAPnonqueueing>>&).
37824
37825
37826
37827
37828 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37829 .cindex "mailing lists"
37830 Exim can be used to run simple mailing lists, but for large and/or complicated
37831 requirements, the use of additional specialized mailing list software such as
37832 Majordomo or Mailman is recommended.
37833
37834 The &(redirect)& router can be used to handle mailing lists where each list
37835 is maintained in a separate file, which can therefore be managed by an
37836 independent manager. The &%domains%& router option can be used to run these
37837 lists in a separate domain from normal mail. For example:
37838 .code
37839 lists:
37840   driver = redirect
37841   domains = lists.example
37842   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37843   forbid_pipe
37844   forbid_file
37845   errors_to = ${quote_local_part:$local_part-request}@lists.example
37846   no_more
37847 .endd
37848 This router is skipped for domains other than &'lists.example'&. For addresses
37849 in that domain, it looks for a file that matches the local part. If there is no
37850 such file, the router declines, but because &%no_more%& is set, no subsequent
37851 routers are tried, and so the whole delivery fails.
37852
37853 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37854 expanded into a filename or a pipe delivery, which is usually inappropriate in
37855 a mailing list.
37856
37857 .oindex "&%errors_to%&"
37858 The &%errors_to%& option specifies that any delivery errors caused by addresses
37859 taken from a mailing list are to be sent to the given address rather than the
37860 original sender of the message. However, before acting on this, Exim verifies
37861 the error address, and ignores it if verification fails.
37862
37863 For example, using the configuration above, mail sent to
37864 &'dicts@lists.example'& is passed on to those addresses contained in
37865 &_/usr/lists/dicts_&, with error reports directed to
37866 &'dicts-request@lists.example'&, provided that this address can be verified.
37867 There could be a file called &_/usr/lists/dicts-request_& containing
37868 the address(es) of this particular list's manager(s), but other approaches,
37869 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37870 or &%local_part_suffix%& options) to handle addresses of the form
37871 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37872
37873
37874
37875 .section "Syntax errors in mailing lists" "SECID241"
37876 .cindex "mailing lists" "syntax errors in"
37877 If an entry in redirection data contains a syntax error, Exim normally defers
37878 delivery of the original address. That means that a syntax error in a mailing
37879 list holds up all deliveries to the list. This may not be appropriate when a
37880 list is being maintained automatically from data supplied by users, and the
37881 addresses are not rigorously checked.
37882
37883 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37884 entries that fail to parse, noting the incident in the log. If in addition
37885 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37886 whenever a broken address is skipped. It is usually appropriate to set
37887 &%syntax_errors_to%& to the same address as &%errors_to%&.
37888
37889
37890
37891 .section "Re-expansion of mailing lists" "SECID242"
37892 .cindex "mailing lists" "re-expansion of"
37893 Exim remembers every individual address to which a message has been delivered,
37894 in order to avoid duplication, but it normally stores only the original
37895 recipient addresses with a message. If all the deliveries to a mailing list
37896 cannot be done at the first attempt, the mailing list is re-expanded when the
37897 delivery is next tried. This means that alterations to the list are taken into
37898 account at each delivery attempt, so addresses that have been added to
37899 the list since the message arrived will therefore receive a copy of the
37900 message, even though it pre-dates their subscription.
37901
37902 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37903 on the &(redirect)& router. If this is done, any addresses generated by the
37904 router that fail to deliver at the first attempt are added to the message as
37905 &"top level"& addresses, and the parent address that generated them is marked
37906 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37907 subsequent delivery attempts. The disadvantage of this is that if any of the
37908 failing addresses are incorrect, correcting them in the file has no effect on
37909 pre-existing messages.
37910
37911 The original top-level address is remembered with each of the generated
37912 addresses, and is output in any log messages. However, any intermediate parent
37913 addresses are not recorded. This makes a difference to the log only if the
37914 &%all_parents%& selector is set, but for mailing lists there is normally only
37915 one level of expansion anyway.
37916
37917
37918
37919 .section "Closed mailing lists" "SECID243"
37920 .cindex "mailing lists" "closed"
37921 The examples so far have assumed open mailing lists, to which anybody may
37922 send mail. It is also possible to set up closed lists, where mail is accepted
37923 from specified senders only. This is done by making use of the generic
37924 &%senders%& option to restrict the router that handles the list.
37925
37926 The following example uses the same file as a list of recipients and as a list
37927 of permitted senders. It requires three routers:
37928 .code
37929 lists_request:
37930   driver = redirect
37931   domains = lists.example
37932   local_part_suffix = -request
37933   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37934   file = /usr/lists/${local_part_data}-request
37935   no_more
37936
37937 lists_post:
37938   driver = redirect
37939   domains = lists.example
37940   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37941   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37942   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37943   forbid_pipe
37944   forbid_file
37945   errors_to = ${quote_local_part:$local_part-request}@lists.example
37946   no_more
37947
37948 lists_closed:
37949   driver = redirect
37950   domains = lists.example
37951   allow_fail
37952   data = :fail: $local_part@lists.example is a closed mailing list
37953 .endd
37954 All three routers have the same &%domains%& setting, so for any other domains,
37955 they are all skipped. The first router runs only if the local part ends in
37956 &%-request%&. It handles messages to the list manager(s) by means of an open
37957 mailing list.
37958
37959 The second router runs only if the &%senders%& precondition is satisfied. It
37960 checks for the existence of a list that corresponds to the local part, and then
37961 checks that the sender is on the list by means of a linear search. It is
37962 necessary to check for the existence of the file before trying to search it,
37963 because otherwise Exim thinks there is a configuration error. If the file does
37964 not exist, the expansion of &%senders%& is *, which matches all senders. This
37965 means that the router runs, but because there is no list, declines, and
37966 &%no_more%& ensures that no further routers are run. The address fails with an
37967 &"unrouteable address"& error.
37968
37969 The third router runs only if the second router is skipped, which happens when
37970 a mailing list exists, but the sender is not on it. This router forcibly fails
37971 the address, giving a suitable error message.
37972
37973
37974
37975
37976 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37977 .cindex "VERP"
37978 .cindex "Variable Envelope Return Paths"
37979 .cindex "envelope from"
37980 .cindex "envelope sender"
37981 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37982 are a way of helping mailing list administrators discover which subscription
37983 address is the cause of a particular delivery failure. The idea is to encode
37984 the original recipient address in the outgoing envelope sender address, so that
37985 if the message is forwarded by another host and then subsequently bounces, the
37986 original recipient can be extracted from the recipient address of the bounce.
37987
37988 .oindex &%errors_to%&
37989 .oindex &%return_path%&
37990 Envelope sender addresses can be modified by Exim using two different
37991 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37992 list examples), or the &%return_path%& option on a transport. The second of
37993 these is effective only if the message is successfully delivered to another
37994 host; it is not used for errors detected on the local host (see the description
37995 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37996 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37997 .code
37998 verp_smtp:
37999   driver = smtp
38000   max_rcpt = 1
38001   return_path = \
38002     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38003       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38004 .endd
38005 This has the effect of rewriting the return path (envelope sender) on outgoing
38006 SMTP messages, if the local part of the original return path ends in
38007 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
38008 local part and domain of the recipient into the return path. Suppose, for
38009 example, that a message whose return path has been set to
38010 &'somelist-request@your.dom.example'& is sent to
38011 &'subscriber@other.dom.example'&. In the transport, the return path is
38012 rewritten as
38013 .code
38014 somelist-request+subscriber=other.dom.example@your.dom.example
38015 .endd
38016 .vindex "&$local_part$&"
38017 For this to work, you must tell Exim to send multiple copies of messages that
38018 have more than one recipient, so that each copy has just one recipient. This is
38019 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38020 might be sent to several different recipients in the same domain, in which case
38021 &$local_part$& is not available in the transport, because it is not unique.
38022
38023 Unless your host is doing nothing but mailing list deliveries, you should
38024 probably use a separate transport for the VERP deliveries, so as not to use
38025 extra resources in making one-per-recipient copies for other deliveries. This
38026 can easily be done by expanding the &%transport%& option in the router:
38027 .code
38028 dnslookup:
38029   driver = dnslookup
38030   domains = ! +local_domains
38031   transport = \
38032     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38033       {verp_smtp}{remote_smtp}}
38034   no_more
38035 .endd
38036 If you want to change the return path using &%errors_to%& in a router instead
38037 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38038 routers that handle mailing list addresses. This will ensure that all delivery
38039 errors, including those detected on the local host, are sent to the VERP
38040 address.
38041
38042 On a host that does no local deliveries and has no manual routing, only the
38043 &(dnslookup)& router needs to be changed. A special transport is not needed for
38044 SMTP deliveries. Every mailing list recipient has its own return path value,
38045 and so Exim must hand them to the transport one at a time. Here is an example
38046 of a &(dnslookup)& router that implements VERP:
38047 .code
38048 verp_dnslookup:
38049   driver = dnslookup
38050   domains = ! +local_domains
38051   transport = remote_smtp
38052   errors_to = \
38053     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38054      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38055   no_more
38056 .endd
38057 Before you start sending out messages with VERPed return paths, you must also
38058 configure Exim to accept the bounce messages that come back to those paths.
38059 Typically this is done by setting a &%local_part_suffix%& option for a
38060 router, and using this to route the messages to wherever you want to handle
38061 them.
38062
38063 The overhead incurred in using VERP depends very much on the size of the
38064 message, the number of recipient addresses that resolve to the same remote
38065 host, and the speed of the connection over which the message is being sent. If
38066 a lot of addresses resolve to the same host and the connection is slow, sending
38067 a separate copy of the message for each address may take substantially longer
38068 than sending a single copy with many recipients (for which VERP cannot be
38069 used).
38070
38071
38072
38073
38074
38075
38076 .section "Virtual domains" "SECTvirtualdomains"
38077 .cindex "virtual domains"
38078 .cindex "domain" "virtual"
38079 The phrase &'virtual domain'& is unfortunately used with two rather different
38080 meanings:
38081
38082 .ilist
38083 A domain for which there are no real mailboxes; all valid local parts are
38084 aliases for other email addresses. Common examples are organizational
38085 top-level domains and &"vanity"& domains.
38086 .next
38087 One of a number of independent domains that are all handled by the same host,
38088 with mailboxes on that host, but where the mailbox owners do not necessarily
38089 have login accounts on that host.
38090 .endlist
38091
38092 The first usage is probably more common, and does seem more &"virtual"& than
38093 the second. This kind of domain can be handled in Exim with a straightforward
38094 aliasing router. One approach is to create a separate alias file for each
38095 virtual domain. Exim can test for the existence of the alias file to determine
38096 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38097 to a router of this form:
38098 .code
38099 virtual:
38100   driver = redirect
38101   domains = dsearch;/etc/mail/virtual
38102   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38103   no_more
38104 .endd
38105 The &%domains%& option specifies that the router is to be skipped, unless there
38106 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38107 domain that is being processed.
38108 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38109 being placed into the &$domain_data$& variable.
38110
38111 When the router runs, it looks up the local
38112 part in the file to find a new address (or list of addresses). The &%no_more%&
38113 setting ensures that if the lookup fails (leading to &%data%& being an empty
38114 string), Exim gives up on the address without trying any subsequent routers.
38115
38116 This one router can handle all the virtual domains because the alias filenames
38117 follow a fixed pattern. Permissions can be arranged so that appropriate people
38118 can edit the different alias files. A successful aliasing operation results in
38119 a new envelope recipient address, which is then routed from scratch.
38120
38121 The other kind of &"virtual"& domain can also be handled in a straightforward
38122 way. One approach is to create a file for each domain containing a list of
38123 valid local parts, and use it in a router like this:
38124 .code
38125 my_domains:
38126   driver = accept
38127   domains = dsearch;/etc/mail/domains
38128   local_parts = lsearch;/etc/mail/domains/$domain
38129   transport = my_mailboxes
38130 .endd
38131 The address is accepted if there is a file for the domain, and the local part
38132 can be found in the file. The &%domains%& option is used to check for the
38133 file's existence because &%domains%& is tested before the &%local_parts%&
38134 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38135 because that option is tested after &%local_parts%&. The transport is as
38136 follows:
38137 .code
38138 my_mailboxes:
38139   driver = appendfile
38140   file = /var/mail/$domain_data/$local_part_data
38141   user = mail
38142 .endd
38143 This uses a directory of mailboxes for each domain. The &%user%& setting is
38144 required, to specify which uid is to be used for writing to the mailboxes.
38145
38146 The configuration shown here is just one example of how you might support this
38147 requirement. There are many other ways this kind of configuration can be set
38148 up, for example, by using a database instead of separate files to hold all the
38149 information about the domains.
38150
38151
38152
38153 .section "Multiple user mailboxes" "SECTmulbox"
38154 .cindex "multiple mailboxes"
38155 .cindex "mailbox" "multiple"
38156 .cindex "local part" "prefix"
38157 .cindex "local part" "suffix"
38158 Heavy email users often want to operate with multiple mailboxes, into which
38159 incoming mail is automatically sorted. A popular way of handling this is to
38160 allow users to use multiple sender addresses, so that replies can easily be
38161 identified. Users are permitted to add prefixes or suffixes to their local
38162 parts for this purpose. The wildcard facility of the generic router options
38163 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38164 example, consider this router:
38165 .code
38166 userforward:
38167   driver = redirect
38168   check_local_user
38169   file = $home/.forward
38170   local_part_suffix = -*
38171   local_part_suffix_optional
38172   allow_filter
38173 .endd
38174 .vindex "&$local_part_suffix$&"
38175 It runs a user's &_.forward_& file for all local parts of the form
38176 &'username-*'&. Within the filter file the user can distinguish different
38177 cases by testing the variable &$local_part_suffix$&. For example:
38178 .code
38179 if $local_part_suffix contains -special then
38180 save /home/$local_part_data/Mail/special
38181 endif
38182 .endd
38183 If the filter file does not exist, or does not deal with such addresses, they
38184 fall through to subsequent routers, and, assuming no subsequent use of the
38185 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38186 control over which suffixes are valid.
38187
38188 Alternatively, a suffix can be used to trigger the use of a different
38189 &_.forward_& file &-- which is the way a similar facility is implemented in
38190 another MTA:
38191 .code
38192 userforward:
38193   driver = redirect
38194   check_local_user
38195   local_part_suffix = -*
38196   local_part_suffix_optional
38197   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38198   allow_filter
38199 .endd
38200 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38201 example, &_.forward-special_& is used. Once again, if the appropriate file
38202 does not exist, or does not deal with the address, it is passed on to
38203 subsequent routers, which could, if required, look for an unqualified
38204 &_.forward_& file to use as a default.
38205
38206
38207
38208 .section "Simplified vacation processing" "SECID244"
38209 .cindex "vacation processing"
38210 The traditional way of running the &'vacation'& program is for a user to set up
38211 a pipe command in a &_.forward_& file
38212 (see section &<<SECTspecitredli>>& for syntax details).
38213 This is prone to error by inexperienced users. There are two features of Exim
38214 that can be used to make this process simpler for users:
38215
38216 .ilist
38217 A local part prefix such as &"vacation-"& can be specified on a router which
38218 can cause the message to be delivered directly to the &'vacation'& program, or
38219 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38220 &_.forward_& file are then much simpler. For example:
38221 .code
38222 spqr, vacation-spqr
38223 .endd
38224 .next
38225 The &%require_files%& generic router option can be used to trigger a
38226 vacation delivery by checking for the existence of a certain file in the
38227 user's home directory. The &%unseen%& generic option should also be used, to
38228 ensure that the original delivery also proceeds. In this case, all the user has
38229 to do is to create a file called, say, &_.vacation_&, containing a vacation
38230 message.
38231 .endlist
38232
38233 Another advantage of both these methods is that they both work even when the
38234 use of arbitrary pipes by users is locked out.
38235
38236
38237
38238 .section "Taking copies of mail" "SECID245"
38239 .cindex "message" "copying every"
38240 Some installations have policies that require archive copies of all messages to
38241 be made. A single copy of each message can easily be taken by an appropriate
38242 command in a system filter, which could, for example, use a different file for
38243 each day's messages.
38244
38245 There is also a shadow transport mechanism that can be used to take copies of
38246 messages that are successfully delivered by local transports, one copy per
38247 delivery. This could be used, &'inter alia'&, to implement automatic
38248 notification of delivery by sites that insist on doing such things.
38249
38250
38251
38252 .section "Intermittently connected hosts" "SECID246"
38253 .cindex "intermittently connected hosts"
38254 It has become quite common (because it is cheaper) for hosts to connect to the
38255 Internet periodically rather than remain connected all the time. The normal
38256 arrangement is that mail for such hosts accumulates on a system that is
38257 permanently connected.
38258
38259 Exim was designed for use on permanently connected hosts, and so it is not
38260 particularly well-suited to use in an intermittently connected environment.
38261 Nevertheless there are some features that can be used.
38262
38263
38264 .section "Exim on the upstream server host" "SECID247"
38265 It is tempting to arrange for incoming mail for the intermittently connected
38266 host to remain in Exim's queue until the client connects. However, this
38267 approach does not scale very well. Two different kinds of waiting message are
38268 being mixed up in the same queue &-- those that cannot be delivered because of
38269 some temporary problem, and those that are waiting for their destination host
38270 to connect. This makes it hard to manage the queue, as well as wasting
38271 resources, because each queue runner scans the entire queue.
38272
38273 A better approach is to separate off those messages that are waiting for an
38274 intermittently connected host. This can be done by delivering these messages
38275 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38276 format, from where they are transmitted by other software when their
38277 destination connects. This makes it easy to collect all the mail for one host
38278 in a single directory, and to apply local timeout rules on a per-message basis
38279 if required.
38280
38281 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38282 you are doing this, you should configure Exim with a long retry period for the
38283 intermittent host. For example:
38284 .code
38285 cheshire.wonderland.fict.example    *   F,5d,24h
38286 .endd
38287 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38288 which messages it has queued up for that host. Once the intermittent host comes
38289 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38290 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38291 causes all the queued up messages to be delivered, often down a single SMTP
38292 connection. While the host remains connected, any new messages get delivered
38293 immediately.
38294
38295 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38296 issued with a different IP address each time it connects, Exim's retry
38297 mechanisms on the holding host get confused, because the IP address is normally
38298 used as part of the key string for holding retry information. This can be
38299 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38300 Since this has disadvantages for permanently connected hosts, it is best to
38301 arrange a separate transport for the intermittently connected ones.
38302
38303
38304
38305 .section "Exim on the intermittently connected client host" "SECID248"
38306 The value of &%smtp_accept_queue_per_connection%& should probably be
38307 increased, or even set to zero (that is, disabled) on the intermittently
38308 connected host, so that all incoming messages down a single connection get
38309 delivered immediately.
38310
38311 .cindex "SMTP" "passed connection"
38312 .cindex "SMTP" "multiple deliveries"
38313 .cindex "multiple SMTP deliveries"
38314 .cindex "first pass routing"
38315 Mail waiting to be sent from an intermittently connected host will probably
38316 not have been routed, because without a connection DNS lookups are not
38317 possible. This means that if a normal queue run is done at connection time,
38318 each message is likely to be sent in a separate SMTP session. This can be
38319 avoided by starting the queue run with a command line option beginning with
38320 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38321 first pass, routing is done but no deliveries take place. The second pass is a
38322 normal queue run; since all the messages have been previously routed, those
38323 destined for the same host are likely to get sent as multiple deliveries in a
38324 single SMTP connection.
38325
38326
38327
38328 . ////////////////////////////////////////////////////////////////////////////
38329 . ////////////////////////////////////////////////////////////////////////////
38330
38331 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38332          "Exim as a non-queueing client"
38333 .cindex "client, non-queueing"
38334 .cindex "smart host" "suppressing queueing"
38335 On a personal computer, it is a common requirement for all
38336 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38337 configured to operate that way, for all the popular operating systems.
38338 However, there are some MUAs for Unix-like systems that cannot be so
38339 configured: they submit messages using the command line interface of
38340 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38341 messages this way.
38342
38343 If the personal computer runs continuously, there is no problem, because it can
38344 run a conventional MTA that handles delivery to the smart host, and deal with
38345 any delays via its queueing mechanism. However, if the computer does not run
38346 continuously or runs different operating systems at different times, queueing
38347 email is not desirable.
38348
38349 There is therefore a requirement for something that can provide the
38350 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38351 any queueing or retrying facilities. Furthermore, the delivery to the smart
38352 host should be synchronous, so that if it fails, the sending MUA is immediately
38353 informed. In other words, we want something that extends an MUA that submits
38354 to a local MTA via the command line so that it behaves like one that submits
38355 to a remote smart host using TCP/SMTP.
38356
38357 There are a number of applications (for example, there is one called &'ssmtp'&)
38358 that do this job. However, people have found them to be lacking in various
38359 ways. For instance, you might want to allow aliasing and forwarding to be done
38360 before sending a message to the smart host.
38361
38362 Exim already had the necessary infrastructure for doing this job. Just a few
38363 tweaks were needed to make it behave as required, though it is somewhat of an
38364 overkill to use a fully-featured MTA for this purpose.
38365
38366 .oindex "&%mua_wrapper%&"
38367 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38368 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38369 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38370 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38371 compatible router and transport configuration. Typically there will be just one
38372 router and one transport, sending everything to a smart host.
38373
38374 When run in MUA wrapping mode, the behaviour of Exim changes in the
38375 following ways:
38376
38377 .ilist
38378 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38379 In other words, the only way to submit messages is via the command line.
38380 .next
38381 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38382 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38383 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38384 does not finish until the delivery attempt is complete. If the delivery is
38385 successful, a zero return code is given.
38386 .next
38387 Address redirection is permitted, but the final routing for all addresses must
38388 be to the same remote transport, and to the same list of hosts. Furthermore,
38389 the return address (envelope sender) must be the same for all recipients, as
38390 must any added or deleted header lines. In other words, it must be possible to
38391 deliver the message in a single SMTP transaction, however many recipients there
38392 are.
38393 .next
38394 If these conditions are not met, or if routing any address results in a
38395 failure or defer status, or if Exim is unable to deliver all the recipients
38396 successfully to one of the smart hosts, delivery of the entire message fails.
38397 .next
38398 Because no queueing is allowed, all failures are treated as permanent; there
38399 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38400 smart host. Furthermore, because only a single yes/no response can be given to
38401 the caller, it is not possible to deliver to some recipients and not others. If
38402 there is an error (temporary or permanent) for any recipient, all are failed.
38403 .next
38404 If more than one smart host is listed, Exim will try another host after a
38405 connection failure or a timeout, in the normal way. However, if this kind of
38406 failure happens for all the hosts, the delivery fails.
38407 .next
38408 When delivery fails, an error message is written to the standard error stream
38409 (as well as to Exim's log), and Exim exits to the caller with a return code
38410 value 1. The message is expunged from Exim's spool files. No bounce messages
38411 are ever generated.
38412 .next
38413 No retry data is maintained, and any retry rules are ignored.
38414 .next
38415 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38416 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38417 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38418 .endlist
38419
38420 The overall effect is that Exim makes a single synchronous attempt to deliver
38421 the message, failing if there is any kind of problem. Because no local
38422 deliveries are done and no daemon can be run, Exim does not need root
38423 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38424 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38425 the advantages and disadvantages of running without root privilege.
38426
38427
38428
38429
38430 . ////////////////////////////////////////////////////////////////////////////
38431 . ////////////////////////////////////////////////////////////////////////////
38432
38433 .chapter "Log files" "CHAPlog"
38434 .scindex IIDloggen "log" "general description"
38435 .cindex "log" "types of"
38436 Exim writes three different logs, referred to as the main log, the reject log,
38437 and the panic log:
38438
38439 .ilist
38440 .cindex "main log"
38441 The main log records the arrival of each message and each delivery in a single
38442 line in each case. The format is as compact as possible, in an attempt to keep
38443 down the size of log files. Two-character flag sequences make it easy to pick
38444 out these lines. A number of other events are recorded in the main log. Some of
38445 them are optional, in which case the &%log_selector%& option controls whether
38446 they are included or not. A Perl script called &'eximstats'&, which does simple
38447 analysis of main log files, is provided in the Exim distribution (see section
38448 &<<SECTmailstat>>&).
38449 .next
38450 .cindex "reject log"
38451 The reject log records information from messages that are rejected as a result
38452 of a configuration option (that is, for policy reasons).
38453 The first line of each rejection is a copy of the line that is also written to
38454 the main log. Then, if the message's header has been read at the time the log
38455 is written, its contents are written to this log. Only the original header
38456 lines are available; header lines added by ACLs are not logged. You can use the
38457 reject log to check that your policy controls are working correctly; on a busy
38458 host this may be easier than scanning the main log for rejection messages. You
38459 can suppress the writing of the reject log by setting &%write_rejectlog%&
38460 false.
38461 .next
38462 .cindex "panic log"
38463 .cindex "system log"
38464 When certain serious errors occur, Exim writes entries to its panic log. If the
38465 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38466 are usually written to the main log as well, but can get lost amid the mass of
38467 other entries. The panic log should be empty under normal circumstances. It is
38468 therefore a good idea to check it (or to have a &'cron'& script check it)
38469 regularly, in order to become aware of any problems. When Exim cannot open its
38470 panic log, it tries as a last resort to write to the system log (syslog). This
38471 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38472 message itself is written at priority LOG_CRIT.
38473 .endlist
38474
38475 Every log line starts with a timestamp, in the format shown in the following
38476 example. Note that many of the examples shown in this chapter are line-wrapped.
38477 In the log file, this would be all on one line:
38478 .code
38479 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38480   by QUIT
38481 .endd
38482 By default, the timestamps are in the local timezone. There are two
38483 ways of changing this:
38484
38485 .ilist
38486 You can set the &%timezone%& option to a different time zone; in particular, if
38487 you set
38488 .code
38489 timezone = UTC
38490 .endd
38491 the timestamps will be in UTC (aka GMT).
38492 .next
38493 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38494 example:
38495 .code
38496 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38497 .endd
38498 .endlist
38499
38500 .cindex "log" "process ids in"
38501 .cindex "pid (process id)" "in log lines"
38502 Exim does not include its process id in log lines by default, but you can
38503 request that it does so by specifying the &`pid`& log selector (see section
38504 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38505 brackets, immediately after the time and date.
38506
38507
38508
38509
38510 .section "Where the logs are written" "SECTwhelogwri"
38511 .cindex "log" "destination"
38512 .cindex "log" "to file"
38513 .cindex "log" "to syslog"
38514 .cindex "syslog"
38515 The logs may be written to local files, or to syslog, or both. However, it
38516 should be noted that many syslog implementations use UDP as a transport, and
38517 are therefore unreliable in the sense that messages are not guaranteed to
38518 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38519 It has also been reported that on large log files (tens of megabytes) you may
38520 need to tweak syslog to prevent it syncing the file with each write &-- on
38521 Linux this has been seen to make syslog take 90% plus of CPU time.
38522
38523 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38524 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38525 configuration. This latter string is expanded, so it can contain, for example,
38526 references to the host name:
38527 .code
38528 log_file_path = /var/log/$primary_hostname/exim_%slog
38529 .endd
38530 It is generally advisable, however, to set the string in &_Local/Makefile_&
38531 rather than at runtime, because then the setting is available right from the
38532 start of Exim's execution. Otherwise, if there's something it wants to log
38533 before it has read the configuration file (for example, an error in the
38534 configuration file) it will not use the path you want, and may not be able to
38535 log at all.
38536
38537 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38538 list, currently limited to at most two items. This is one option where the
38539 facility for changing a list separator may not be used. The list must always be
38540 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38541 otherwise the item must either be an absolute path, containing &`%s`& at the
38542 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38543 implying the use of a default path.
38544
38545 When Exim encounters an empty item in the list, it searches the list defined by
38546 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38547 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38548 mean &"use the path specified at build time"&. If no such item exists, log
38549 files are written in the &_log_& subdirectory of the spool directory. This is
38550 equivalent to the configuration file setting:
38551 .code
38552 log_file_path = $spool_directory/log/%slog
38553 .endd
38554 If you do not specify anything at build time or runtime,
38555 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38556 that is where the logs are written.
38557
38558 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38559 are in use &-- see section &<<SECTdatlogfil>>& below.
38560
38561 Here are some examples of possible Makefile settings:
38562 .display
38563 &`LOG_FILE_PATH=syslog                    `& syslog only
38564 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38565 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38566 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38567 .endd
38568 If there are more than two paths in the list, the first is used and a panic
38569 error is logged.
38570
38571
38572
38573 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38574 .cindex "log" "cycling local files"
38575 .cindex "cycling logs"
38576 .cindex "&'exicyclog'&"
38577 .cindex "log" "local files; writing to"
38578 Some operating systems provide centralized and standardized methods for cycling
38579 log files. For those that do not, a utility script called &'exicyclog'& is
38580 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38581 main and reject logs each time it is called. The maximum number of old logs to
38582 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38583
38584 An Exim delivery process opens the main log when it first needs to write to it,
38585 and it keeps the file open in case subsequent entries are required &-- for
38586 example, if a number of different deliveries are being done for the same
38587 message. However, remote SMTP deliveries can take a long time, and this means
38588 that the file may be kept open long after it is renamed if &'exicyclog'& or
38589 something similar is being used to rename log files on a regular basis. To
38590 ensure that a switch of log files is noticed as soon as possible, Exim calls
38591 &[stat()]& on the main log's name before reusing an open file, and if the file
38592 does not exist, or its inode has changed, the old file is closed and Exim
38593 tries to open the main log from scratch. Thus, an old log file may remain open
38594 for quite some time, but no Exim processes should write to it once it has been
38595 renamed.
38596
38597
38598
38599 .section "Datestamped log files" "SECTdatlogfil"
38600 .cindex "log" "datestamped files"
38601 Instead of cycling the main and reject log files by renaming them
38602 periodically, some sites like to use files whose names contain a datestamp,
38603 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38604 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38605 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38606 point where the datestamp is required. For example:
38607 .code
38608 log_file_path = /var/spool/exim/log/%slog-%D
38609 log_file_path = /var/log/exim-%s-%D.log
38610 log_file_path = /var/spool/exim/log/%D-%slog
38611 log_file_path = /var/log/exim/%s.%M
38612 .endd
38613 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38614 examples of names generated by the above examples:
38615 .code
38616 /var/spool/exim/log/mainlog-20021225
38617 /var/log/exim-reject-20021225.log
38618 /var/spool/exim/log/20021225-mainlog
38619 /var/log/exim/main.200212
38620 .endd
38621 When this form of log file is specified, Exim automatically switches to new
38622 files at midnight. It does not make any attempt to compress old logs; you
38623 will need to write your own script if you require this. You should not
38624 run &'exicyclog'& with this form of logging.
38625
38626 The location of the panic log is also determined by &%log_file_path%&, but it
38627 is not datestamped, because rotation of the panic log does not make sense.
38628 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38629 the string. In addition, if it immediately follows a slash, a following
38630 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38631 character is removed. Thus, the four examples above would give these panic
38632 log names:
38633 .code
38634 /var/spool/exim/log/paniclog
38635 /var/log/exim-panic.log
38636 /var/spool/exim/log/paniclog
38637 /var/log/exim/panic
38638 .endd
38639
38640
38641 .section "Logging to syslog" "SECID249"
38642 .cindex "log" "syslog; writing to"
38643 The use of syslog does not change what Exim logs or the format of its messages,
38644 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38645 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38646 that, the same strings are written to syslog as to log files. The syslog
38647 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38648 by default, but you can change these by setting the &%syslog_facility%& and
38649 &%syslog_processname%& options, respectively. If Exim was compiled with
38650 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38651 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38652 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38653 the time and host name to each line.
38654 The three log streams are mapped onto syslog priorities as follows:
38655
38656 .ilist
38657 &'mainlog'& is mapped to LOG_INFO
38658 .next
38659 &'rejectlog'& is mapped to LOG_NOTICE
38660 .next
38661 &'paniclog'& is mapped to LOG_ALERT
38662 .endlist
38663
38664 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38665 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38666 these are routed by syslog to the same place. You can suppress this duplication
38667 by setting &%syslog_duplication%& false.
38668
38669 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38670 entries contain multiple lines when headers are included. To cope with both
38671 these cases, entries written to syslog are split into separate &[syslog()]&
38672 calls at each internal newline, and also after a maximum of
38673 870 data characters. (This allows for a total syslog line length of 1024, when
38674 additions such as timestamps are added.) If you are running a syslog
38675 replacement that can handle lines longer than the 1024 characters allowed by
38676 RFC 3164, you should set
38677 .code
38678 SYSLOG_LONG_LINES=yes
38679 .endd
38680 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38681 lines, but it still splits at internal newlines in &'reject'& log entries.
38682
38683 To make it easy to re-assemble split lines later, each component of a split
38684 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38685 where <&'n'&> is the component number and <&'m'&> is the total number of
38686 components in the entry. The / delimiter is used when the line was split
38687 because it was too long; if it was split because of an internal newline, the \
38688 delimiter is used. For example, supposing the length limit to be 50 instead of
38689 870, the following would be the result of a typical rejection message to
38690 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38691 name, and pid as added by syslog:
38692 .code
38693 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38694 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38695 [3/5]  when scanning for sender: missing or malformed lo
38696 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38697 [5/5] mple>)
38698 .endd
38699 The same error might cause the following lines to be written to &"rejectlog"&
38700 (LOG_NOTICE):
38701 .code
38702 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38703 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38704 [3/18] er when scanning for sender: missing or malformed
38705 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38706 [5\18] .example>)
38707 [6\18] Recipients: ph10@some.domain.cam.example
38708 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38709 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38710 [9\18]        id 16RdAL-0006pc-00
38711 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38712 [11\18] 09:43 +0100
38713 [12\18] F From: <>
38714 [13\18]   Subject: this is a test header
38715 [18\18]   X-something: this is another header
38716 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38717 [16\18] le>
38718 [17\18] B Bcc:
38719 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38720 .endd
38721 Log lines that are neither too long nor contain newlines are written to syslog
38722 without modification.
38723
38724 If only syslog is being used, the Exim monitor is unable to provide a log tail
38725 display, unless syslog is routing &'mainlog'& to a file on the local host and
38726 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38727 where it is.
38728
38729
38730
38731 .section "Log line flags" "SECID250"
38732 One line is written to the main log for each message received, and for each
38733 successful, unsuccessful, and delayed delivery. These lines can readily be
38734 picked out by the distinctive two-character flags that immediately follow the
38735 timestamp. The flags are:
38736 .itable none 0 0 2 10* left 90* left
38737 .irow &%<=%&     "message arrival"
38738 .irow &%(=%&     "message fakereject"
38739 .irow &%=>%&     "normal message delivery"
38740 .irow &%->%&     "additional address in same delivery"
38741 .irow &%>>%&     "cutthrough message delivery"
38742 .irow &%*>%&     "delivery suppressed by &%-N%&"
38743 .irow &%**%&     "delivery failed; address bounced"
38744 .irow &%==%&     "delivery deferred; temporary problem"
38745 .endtable
38746
38747
38748 .section "Logging message reception" "SECID251"
38749 .cindex "log" "reception line"
38750 The format of the single-line entry in the main log that is written for every
38751 message received is shown in the basic example below, which is split over
38752 several lines in order to fit it on the page:
38753 .code
38754 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38755   H=mailer.fict.example [192.168.123.123] U=exim
38756   P=smtp S=5678 id=<incoming message id>
38757 .endd
38758 The address immediately following &"<="& is the envelope sender address. A
38759 bounce message is shown with the sender address &"<>"&, and if it is locally
38760 generated, this is followed by an item of the form
38761 .code
38762 R=<message id>
38763 .endd
38764 which is a reference to the message that caused the bounce to be sent.
38765
38766 .cindex "HELO"
38767 .cindex "EHLO"
38768 For messages from other hosts, the H and U fields identify the remote host and
38769 record the RFC 1413 identity of the user that sent the message, if one was
38770 received. The number given in square brackets is the IP address of the sending
38771 host. If there is a single, unparenthesized  host name in the H field, as
38772 above, it has been verified to correspond to the IP address (see the
38773 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38774 by the remote host in the SMTP HELO or EHLO command, and has not been
38775 verified. If verification yields a different name to that given for HELO or
38776 EHLO, the verified name appears first, followed by the HELO or EHLO
38777 name in parentheses.
38778
38779 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38780 without brackets, in the HELO or EHLO command, leading to entries in
38781 the log containing text like these examples:
38782 .code
38783 H=(10.21.32.43) [192.168.8.34]
38784 H=([10.21.32.43]) [192.168.8.34]
38785 .endd
38786 This can be confusing. Only the final address in square brackets can be relied
38787 on.
38788
38789 For locally generated messages (that is, messages not received over TCP/IP),
38790 the H field is omitted, and the U field contains the login name of the caller
38791 of Exim.
38792
38793 .cindex "authentication" "logging"
38794 .cindex "AUTH" "logging"
38795 For all messages, the P field specifies the protocol used to receive the
38796 message. This is the value that is stored in &$received_protocol$&. In the case
38797 of incoming SMTP messages, the value indicates whether or not any SMTP
38798 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38799 session was encrypted, there is an additional X field that records the cipher
38800 suite that was used.
38801
38802 .cindex log protocol
38803 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38804 hosts that have authenticated themselves using the SMTP AUTH command. The first
38805 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38806 there is an additional item A= followed by the name of the authenticator that
38807 was used. If an authenticated identification was set up by the authenticator's
38808 &%server_set_id%& option, this is logged too, separated by a colon from the
38809 authenticator name.
38810
38811 .cindex "size" "of message"
38812 The id field records the existing message id, if present. The size of the
38813 received message is given by the S field. When the message is delivered,
38814 headers may be removed or added, so that the size of delivered copies of the
38815 message may not correspond with this value (and indeed may be different to each
38816 other).
38817
38818 The &%log_selector%& option can be used to request the logging of additional
38819 data when a message is received. See section &<<SECTlogselector>>& below.
38820
38821
38822
38823 .section "Logging deliveries" "SECID252"
38824 .cindex "log" "delivery line"
38825 The format of the single-line entry in the main log that is written for every
38826 delivery is shown in one of the examples below, for local and remote
38827 deliveries, respectively. Each example has been split into multiple lines in order
38828 to fit it on the page:
38829 .code
38830 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38831   <marv@hitch.fict.example> R=localuser T=local_delivery
38832 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38833   monk@holistic.fict.example R=dnslookup T=remote_smtp
38834   H=holistic.fict.example [192.168.234.234]
38835 .endd
38836 For ordinary local deliveries, the original address is given in angle brackets
38837 after the final delivery address, which might be a pipe or a file. If
38838 intermediate address(es) exist between the original and the final address, the
38839 last of these is given in parentheses after the final address. The R and T
38840 fields record the router and transport that were used to process the address.
38841
38842 If SMTP AUTH was used for the delivery there is an additional item A=
38843 followed by the name of the authenticator that was used.
38844 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38845 option, this is logged too, as a second colon-separated list item.
38846 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38847
38848 If a shadow transport was run after a successful local delivery, the log line
38849 for the successful delivery has an item added on the end, of the form
38850 .display
38851 &`ST=<`&&'shadow transport name'&&`>`&
38852 .endd
38853 If the shadow transport did not succeed, the error message is put in
38854 parentheses afterwards.
38855
38856 .cindex "asterisk" "after IP address"
38857 When more than one address is included in a single delivery (for example, two
38858 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38859 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38860 down a single SMTP connection, an asterisk follows the
38861 remote IP address (and port if enabled)
38862 in the log lines for the second and subsequent messages.
38863 When two or more messages are delivered down a single TLS connection, the
38864 DNS and some TLS-related information logged for the first message delivered
38865 will not be present in the log lines for the second and subsequent messages.
38866 TLS cipher information is still available.
38867
38868 .cindex "delivery" "cutthrough; logging"
38869 .cindex "cutthrough" "logging"
38870 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38871 line precedes the reception line, since cutthrough waits for a possible
38872 rejection from the destination in case it can reject the sourced item.
38873
38874 The generation of a reply message by a filter file gets logged as a
38875 &"delivery"& to the addressee, preceded by &">"&.
38876
38877 The &%log_selector%& option can be used to request the logging of additional
38878 data when a message is delivered. See section &<<SECTlogselector>>& below.
38879
38880
38881 .section "Discarded deliveries" "SECID253"
38882 .cindex "discarded messages"
38883 .cindex "message" "discarded"
38884 .cindex "delivery" "discarded; logging"
38885 When a message is discarded as a result of the command &"seen finish"& being
38886 obeyed in a filter file which generates no deliveries, a log entry of the form
38887 .code
38888 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38889   <low.club@bridge.example> R=userforward
38890 .endd
38891 is written, to record why no deliveries are logged. When a message is discarded
38892 because it is aliased to &":blackhole:"& the log line is like this:
38893 .code
38894 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38895   <hole@nowhere.example> R=blackhole_router
38896 .endd
38897
38898
38899 .section "Deferred deliveries" "SECID254"
38900 When a delivery is deferred, a line of the following form is logged:
38901 .code
38902 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38903   R=dnslookup T=smtp defer (146): Connection refused
38904 .endd
38905 In the case of remote deliveries, the error is the one that was given for the
38906 last IP address that was tried. Details of individual SMTP failures are also
38907 written to the log, so the above line would be preceded by something like
38908 .code
38909 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38910   mail1.endrest.example [192.168.239.239]: Connection refused
38911 .endd
38912 When a deferred address is skipped because its retry time has not been reached,
38913 a message is written to the log, but this can be suppressed by setting an
38914 appropriate value in &%log_selector%&.
38915
38916
38917
38918 .section "Delivery failures" "SECID255"
38919 .cindex "delivery" "failure; logging"
38920 If a delivery fails because an address cannot be routed, a line of the
38921 following form is logged:
38922 .code
38923 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38924   <jim@trek99.example>: unknown mail domain
38925 .endd
38926 If a delivery fails at transport time, the router and transport are shown, and
38927 the response from the remote host is included, as in this example:
38928 .code
38929 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38930   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38931   after pipelined RCPT TO:<ace400@pb.example>: host
38932   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38933   <ace400@pb.example>...Addressee unknown
38934 .endd
38935 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38936 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38937 disabling PIPELINING. The log lines for all forms of delivery failure are
38938 flagged with &`**`&.
38939
38940
38941
38942 .section "Fake deliveries" "SECID256"
38943 .cindex "delivery" "fake; logging"
38944 If a delivery does not actually take place because the &%-N%& option has been
38945 used to suppress it, a normal delivery line is written to the log, except that
38946 &"=>"& is replaced by &"*>"&.
38947
38948
38949
38950 .section "Completion" "SECID257"
38951 A line of the form
38952 .code
38953 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38954 .endd
38955 is written to the main log when a message is about to be removed from the spool
38956 at the end of its processing.
38957
38958
38959
38960
38961 .section "Summary of Fields in Log Lines" "SECID258"
38962 .cindex "log" "summary of fields"
38963 A summary of the field identifiers that are used in log lines is shown in
38964 the following table:
38965 .display
38966 &`A   `&        authenticator name (and optional id and sender)
38967 &`C   `&        SMTP confirmation on delivery
38968 &`Ci  `&        connection identifier
38969 &`    `&        command list for &"no mail in SMTP session"&
38970 &`CV  `&        certificate verification status
38971 &`D   `&        duration of &"no mail in SMTP session"&
38972 &`DKIM`&        domain verified in incoming message
38973 &`DN  `&        distinguished name from peer certificate
38974 &`DS  `&        DNSSEC secured lookups
38975 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38976 &`F   `&        sender address (on delivery lines)
38977 &`H   `&        host name and IP address
38978 &`I   `&        local interface used
38979 &`id  `&        message id (from header) for incoming message
38980 &`K   `&        CHUNKING extension used
38981 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38982 &`M8S `&        8BITMIME status for incoming message
38983 &`P   `&        on &`<=`& lines: protocol used
38984 &`    `&        on &`=>`& and &`**`& lines: return path
38985 &`PRDR`&        PRDR extension used
38986 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38987 &`Q   `&        alternate queue name
38988 &`QT  `&        on &`=>`& lines: time spent on queue so far
38989 &`    `&        on &"Completed"& lines: time spent on queue
38990 &`R   `&        on &`<=`& lines: reference for local bounce
38991 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38992 &`RT  `&        on &`<=`& lines: time taken for reception
38993 &`S   `&        size of message in bytes
38994 &`SNI `&        server name indication from TLS client hello
38995 &`ST  `&        shadow transport name
38996 &`T   `&        on &`<=`& lines: message subject (topic)
38997 &`TFO `&        connection took advantage of TCP Fast Open
38998 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38999 &`U   `&        local user or RFC 1413 identity
39000 &`X   `&        TLS cipher suite
39001 .endd
39002
39003
39004 .section "Other log entries" "SECID259"
39005 Various other types of log entry are written from time to time. Most should be
39006 self-explanatory. Among the more common are:
39007
39008 .ilist
39009 .cindex "retry" "time not reached"
39010 &'retry time not reached'&&~&~An address previously suffered a temporary error
39011 during routing or local delivery, and the time to retry has not yet arrived.
39012 This message is not written to an individual message log file unless it happens
39013 during the first delivery attempt.
39014 .next
39015 &'retry time not reached for any host'&&~&~An address previously suffered
39016 temporary errors during remote delivery, and the retry time has not yet arrived
39017 for any of the hosts to which it is routed.
39018 .next
39019 .cindex "spool directory" "file locked"
39020 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39021 some other Exim process is already working on the message. This can be quite
39022 common if queue running processes are started at frequent intervals. The
39023 &'exiwhat'& utility script can be used to find out what Exim processes are
39024 doing.
39025 .next
39026 .cindex "error" "ignored"
39027 &'error ignored'&&~&~There are several circumstances that give rise to this
39028 message:
39029 .olist
39030 Exim failed to deliver a bounce message whose age was greater than
39031 &%ignore_bounce_errors_after%&. The bounce was discarded.
39032 .next
39033 A filter file set up a delivery using the &"noerror"& option, and the delivery
39034 failed. The delivery was discarded.
39035 .next
39036 A delivery set up by a router configured with
39037 . ==== As this is a nested list, any displays it contains must be indented
39038 . ==== as otherwise they are too far to the left.
39039 .code
39040     errors_to = <>
39041 .endd
39042 failed. The delivery was discarded.
39043 .endlist olist
39044 .next
39045 .cindex DKIM "log line"
39046 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39047 logging and the message has a DKIM signature header.
39048 .endlist ilist
39049
39050
39051
39052
39053
39054 .section "Reducing or increasing what is logged" "SECTlogselector"
39055 .cindex "log" "selectors"
39056 By setting the &%log_selector%& global option, you can disable some of Exim's
39057 default logging to the main log, or you can request additional logging. The value of
39058 &%log_selector%& is made up of names preceded by plus or minus characters. For
39059 example:
39060 .code
39061 log_selector = +arguments -retry_defer
39062 .endd
39063 The list of optional log items is in the following table, with the default
39064 selection marked by asterisks:
39065 .itable none 0 0 3 2.8in left 10pt center 3in left
39066 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39067 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39068 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39069 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39070 .irow &`arguments`&                     &nbsp; "command line arguments"
39071 .irow &`connection_id`&                 &nbsp;  "connection identifier"
39072 .irow &`connection_reject`&             *       "connection rejections"
39073 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39074 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39075 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39076 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39077 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
39078 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39079 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39080 .irow &`etrn`&                          *       "ETRN commands"
39081 .irow &`host_lookup_failed`&            *       "as it says"
39082 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39083 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39084 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39085 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39086 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39087 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39088 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39089 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39090 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39091 .irow &`queue_run`&                     *       "start and end queue runs"
39092 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39093 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39094 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39095 .irow &`pid`&                           &nbsp; "Exim process id"
39096 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39097 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39098 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39099 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39100 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39101 .irow &`rejected_header`&               *       "header contents on reject log"
39102 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39103 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39104 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39105 .irow &`sender_verify_fail`&            *       "sender verification failures"
39106 .irow &`size_reject`&                   *       "rejection because too big"
39107 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39108 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39109 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39110 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39111 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39112 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39113 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39114 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39115 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39116 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39117 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39118 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39119 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39120 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39121 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39122 .irow &`all`&                           &nbsp; "&*all of the above*&"
39123 .endtable
39124 See also the &%slow_lookup_log%& main configuration option,
39125 section &<<SECID99>>&
39126
39127 More details on each of these items follows:
39128
39129 .ilist
39130 .cindex "8BITMIME"
39131 .cindex "log" "8BITMIME"
39132 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39133 which may help in tracking down interoperability issues with ancient MTAs
39134 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39135 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39136 &`7BIT`& and &`8BITMIME`& respectively.
39137 .next
39138 .cindex "&%warn%& ACL verb" "log when skipping"
39139 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39140 its conditions cannot be evaluated, a log line to this effect is written if
39141 this log selector is set.
39142 .next
39143 .cindex "log" "rewriting"
39144 .cindex "rewriting" "logging"
39145 &%address_rewrite%&: This applies both to global rewrites and per-transport
39146 rewrites, but not to rewrites in filters run as an unprivileged user (because
39147 such users cannot access the log).
39148 .next
39149 .cindex "log" "full parentage"
39150 &%all_parents%&: Normally only the original and final addresses are logged on
39151 delivery lines; with this selector, intermediate parents are given in
39152 parentheses between them.
39153 .next
39154 .cindex "log" "Exim arguments"
39155 .cindex "Exim arguments, logging"
39156 &%arguments%&: This causes Exim to write the arguments with which it was called
39157 to the main log, preceded by the current working directory. This is a debugging
39158 feature, added to make it easier to find out how certain MUAs call
39159 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39160 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39161 that are empty or that contain white space are quoted. Non-printing characters
39162 are shown as escape sequences. This facility cannot log unrecognized arguments,
39163 because the arguments are checked before the configuration file is read. The
39164 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39165 between the caller and Exim.
39166 .next
39167 .cindex "log" "connection identifier"
39168 .new
39169 &%connection_identifier%&: An identifier for the accepted connection is added to
39170 connection start and end lines and to message accept lines.
39171 The identifier is tagged by Ci=.
39172 The value is PID-based, so will reset on reboot and will wrap.
39173 .wen
39174 .next
39175 .cindex "log" "connection rejections"
39176 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39177 connection is rejected, for whatever reason.
39178 .next
39179 .cindex "log" "delayed delivery"
39180 .cindex "delayed delivery, logging"
39181 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39182 started for an incoming message because the load is too high or too many
39183 messages were received on one connection. Logging does not occur if no delivery
39184 process is started because &%queue_only%& is set or &%-odq%& was used.
39185 .next
39186 .cindex "log" "delivery duration"
39187 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39188 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39189 If millisecond logging is enabled, short times will be shown with greater
39190 precision, eg. &`DT=0.304s`&.
39191 .next
39192 .cindex "log" "message size on delivery"
39193 .cindex "size" "of message"
39194 &%delivery_size%&: For each delivery, the size of message delivered is added to
39195 the &"=>"& line, tagged with S=.
39196 .next
39197 .cindex log "DKIM verification"
39198 .cindex DKIM "verification logging"
39199 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39200 verifies successfully a tag of DKIM is added, with one of the verified domains.
39201 .next
39202 .cindex log "DKIM verification"
39203 .cindex DKIM "verification logging"
39204 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39205 .next
39206 .cindex "log" "dnslist defer"
39207 .cindex "DNS list" "logging defer"
39208 .cindex "black list (DNS)"
39209 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39210 DNS black list suffers a temporary error.
39211 .next
39212 .cindex log dnssec
39213 .cindex dnssec logging
39214 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39215 dns lookups gave secure results a tag of DS is added.
39216 For acceptance this covers the reverse and forward lookups for host name verification.
39217 It does not cover helo-name verification.
39218 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39219 .next
39220 .cindex "log" "ETRN commands"
39221 .cindex "ETRN" "logging"
39222 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39223 is run to determine whether or not it is actually accepted. An invalid ETRN
39224 command, or one received within a message transaction is not logged by this
39225 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39226 .next
39227 .cindex "log" "host lookup failure"
39228 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39229 any addresses, or when a lookup of an IP address fails to find a host name, a
39230 log line is written. This logging does not apply to direct DNS lookups when
39231 routing email addresses, but it does apply to &"byname"& lookups.
39232 .next
39233 .cindex "log" "ident timeout"
39234 .cindex "RFC 1413" "logging timeout"
39235 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39236 client's ident port times out.
39237 .next
39238 .cindex "log" "incoming interface"
39239 .cindex "log" "outgoing interface"
39240 .cindex "log" "local interface"
39241 .cindex "log" "local address and port"
39242 .cindex "TCP/IP" "logging local address and port"
39243 .cindex "interface" "logging"
39244 &%incoming_interface%&: The interface on which a message was received is added
39245 to the &"<="& line as an IP address in square brackets, tagged by I= and
39246 followed by a colon and the port number. The local interface and port are also
39247 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39248 rejection lines, and (despite the name) to outgoing
39249 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39250 The latter can be disabled by turning off the &%outgoing_interface%& option.
39251 .next
39252 .cindex log "incoming proxy address"
39253 .cindex proxy "logging proxy address"
39254 .cindex "TCP/IP" "logging proxy address"
39255 &%proxy%&: The internal (closest to the system running Exim) IP address
39256 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39257 on a proxied connection
39258 or the &"=>"& line for a message delivered on a proxied connection.
39259 See &<<SECTproxyInbound>>& for more information.
39260 .next
39261 .cindex "log" "incoming remote port"
39262 .cindex "port" "logging remote"
39263 .cindex "TCP/IP" "logging incoming remote port"
39264 .vindex "&$sender_fullhost$&"
39265 .vindex "&$sender_rcvhost$&"
39266 &%incoming_port%&: The remote port number from which a message was received is
39267 added to log entries and &'Received:'& header lines, following the IP address
39268 in square brackets, and separated from it by a colon. This is implemented by
39269 changing the value that is put in the &$sender_fullhost$& and
39270 &$sender_rcvhost$& variables. Recording the remote port number has become more
39271 important with the widening use of NAT (see RFC 2505).
39272 .next
39273 .cindex "log" "dropped connection"
39274 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39275 connection is unexpectedly dropped.
39276 .next
39277 .cindex "log" "millisecond timestamps"
39278 .cindex millisecond logging
39279 .cindex timestamps "millisecond, in logs"
39280 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39281 appended to the seconds value.
39282 .next
39283 .cindex "log" "message id"
39284 &%msg_id%&: The value of the Message-ID: header.
39285 .next
39286 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39287 This will be either because the message is a bounce, or was submitted locally
39288 (submission mode) without one.
39289 The field identifier will have an asterix appended: &"id*="&.
39290 .next
39291 .cindex "log" "outgoing interface"
39292 .cindex "log" "local interface"
39293 .cindex "log" "local address and port"
39294 .cindex "TCP/IP" "logging local address and port"
39295 .cindex "interface" "logging"
39296 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39297 interface on which a message was sent is added to delivery lines as an I= tag
39298 followed by IP address in square brackets. You can disable this by turning
39299 off the &%outgoing_interface%& option.
39300 .next
39301 .cindex "log" "outgoing remote port"
39302 .cindex "port" "logging outgoing remote"
39303 .cindex "TCP/IP" "logging outgoing remote port"
39304 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39305 containing => tags) following the IP address.
39306 The local port is also added if &%incoming_interface%& and
39307 &%outgoing_interface%& are both enabled.
39308 This option is not included in the default setting, because for most ordinary
39309 configurations, the remote port number is always 25 (the SMTP port), and the
39310 local port is a random ephemeral port.
39311 .next
39312 .cindex "log" "process ids in"
39313 .cindex "pid (process id)" "in log lines"
39314 &%pid%&: The current process id is added to every log line, in square brackets,
39315 immediately after the time and date.
39316 .next
39317 .cindex log pipelining
39318 .cindex pipelining "logging outgoing"
39319 &%pipelining%&: A field is added to delivery and accept
39320 log lines when the ESMTP PIPELINING extension was used.
39321 The field is a single "L".
39322
39323 On accept lines, where PIPELINING was offered but not used by the client,
39324 the field has a minus appended.
39325
39326 .cindex "pipelining" "early connection"
39327 If Exim is built without the DISABLE_PIPE_CONNECT build option
39328 accept "L" fields have a period appended if the feature was
39329 offered but not used, or an asterisk appended if used.
39330 Delivery "L" fields have an asterisk appended if used.
39331
39332 .next
39333 .cindex "log" "queue run"
39334 .cindex "queue runner" "logging"
39335 &%queue_run%&: The start and end of every queue run are logged.
39336 .next
39337 .cindex "log" "queue time"
39338 &%queue_time%&: The amount of time the message has been in the queue on the
39339 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39340 &`QT=3m45s`&.
39341 If millisecond logging is enabled, short times will be shown with greater
39342 precision, eg. &`QT=1.578s`&.
39343 .next
39344 &%queue_time_overall%&: The amount of time the message has been in the queue on
39345 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39346 example, &`QT=3m45s`&.
39347 .next
39348 .cindex "log" "receive duration"
39349 &%receive_time%&: For each message, the amount of real time it has taken to
39350 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39351 If millisecond logging is enabled, short times will be shown with greater
39352 precision, eg. &`RT=0.204s`&.
39353 .next
39354 .cindex "log" "recipients"
39355 &%received_recipients%&: The recipients of a message are listed in the main log
39356 as soon as the message is received. The list appears at the end of the log line
39357 that is written when a message is received, preceded by the word &"for"&. The
39358 addresses are listed after they have been qualified, but before any rewriting
39359 has taken place.
39360 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39361 in the list.
39362 .next
39363 .cindex "log" "sender reception"
39364 &%received_sender%&: The unrewritten original sender of a message is added to
39365 the end of the log line that records the message's arrival, after the word
39366 &"from"& (before the recipients if &%received_recipients%& is also set).
39367 .next
39368 .cindex "log" "header lines for rejection"
39369 &%rejected_header%&: If a message's header has been received at the time a
39370 rejection is written to the reject log, the complete header is added to the
39371 log. Header logging can be turned off individually for messages that are
39372 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39373 .next
39374 .cindex "log" "retry defer"
39375 &%retry_defer%&: A log line is written if a delivery is deferred because a
39376 retry time has not yet been reached. However, this &"retry time not reached"&
39377 message is always omitted from individual message logs after the first delivery
39378 attempt.
39379 .next
39380 .cindex "log" "return path"
39381 &%return_path_on_delivery%&: The return path that is being transmitted with
39382 the message is included in delivery and bounce lines, using the tag P=.
39383 This is omitted if no delivery actually happens, for example, if routing fails,
39384 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39385 .next
39386 .cindex "log" "sender on delivery"
39387 &%sender_on_delivery%&: The message's sender address is added to every delivery
39388 and bounce line, tagged by F= (for &"from"&).
39389 This is the original sender that was received with the message; it is not
39390 necessarily the same as the outgoing return path.
39391 .next
39392 .cindex "log" "sender verify failure"
39393 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39394 gives details of a sender verification failure is not written. Log lines for
39395 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39396 detail is lost.
39397 .next
39398 .cindex "log" "size rejection"
39399 &%size_reject%&: A log line is written whenever a message is rejected because
39400 it is too big.
39401 .next
39402 .cindex "log" "frozen messages; skipped"
39403 .cindex "frozen messages" "logging skipping"
39404 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39405 queue run because it another process is already delivering it or because
39406 it is frozen.
39407 .cindex "&""spool file is locked""&"
39408 .cindex "&""message is frozen""&"
39409 The message that is written is either &"spool file is locked"& or
39410 &"message is frozen"&.
39411 .next
39412 .cindex "log" "smtp confirmation"
39413 .cindex "SMTP" "logging confirmation"
39414 .cindex "LMTP" "logging confirmation"
39415 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39416 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39417 A number of MTAs (including Exim) return an identifying string in this
39418 response.
39419 .next
39420 .cindex "log" "SMTP connections"
39421 .cindex "SMTP" "logging connections"
39422 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39423 established or closed, unless the connection is from a host that matches
39424 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39425 only when the closure is unexpected.) This applies to connections from local
39426 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39427 dropped in the middle of a message, a log line is always written, whether or
39428 not this selector is set, but otherwise nothing is written at the start and end
39429 of connections unless this selector is enabled.
39430
39431 For TCP/IP connections to an Exim daemon, the current number of connections is
39432 included in the log message for each new connection, but note that the count is
39433 reset if the daemon is restarted.
39434 Also, because connections are closed (and the closure is logged) in
39435 subprocesses, the count may not include connections that have been closed but
39436 whose termination the daemon has not yet noticed. Thus, while it is possible to
39437 match up the opening and closing of connections in the log, the value of the
39438 logged counts may not be entirely accurate.
39439 .next
39440 .cindex "log" "SMTP transaction; incomplete"
39441 .cindex "SMTP" "logging incomplete transactions"
39442 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39443 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39444 and the message sender plus any accepted recipients are included in the log
39445 line. This can provide evidence of dictionary attacks.
39446 .next
39447 .cindex "log" "non-MAIL SMTP sessions"
39448 .cindex "MAIL" "logging session without"
39449 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39450 connection terminates without having issued a MAIL command. This includes both
39451 the case when the connection is dropped, and the case when QUIT is used. It
39452 does not include cases where the connection is rejected right at the start (by
39453 an ACL, or because there are too many connections, or whatever). These cases
39454 already have their own log lines.
39455
39456 The log line that is written contains the identity of the client in the usual
39457 way, followed by D= and a time, which records the duration of the connection.
39458 If the connection was authenticated, this fact is logged exactly as it is for
39459 an incoming message, with an A= item. If the connection was encrypted, CV=,
39460 DN=, and X= items may appear as they do for an incoming message, controlled by
39461 the same logging options.
39462
39463 Finally, if any SMTP commands were issued during the connection, a C= item
39464 is added to the line, listing the commands that were used. For example,
39465 .code
39466 C=EHLO,QUIT
39467 .endd
39468 shows that the client issued QUIT straight after EHLO. If there were fewer
39469 than 20 commands, they are all listed. If there were more than 20 commands,
39470 the last 20 are listed, preceded by &"..."&. However, with the default
39471 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39472 have been aborted before 20 non-mail commands are processed.
39473 .next
39474 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39475 colon-separated, is appended to the A= item for a message arrival or delivery
39476 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39477 was accepted or used.
39478 .next
39479 .cindex "log" "SMTP protocol error"
39480 .cindex "SMTP" "logging protocol error"
39481 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39482 encountered. Exim does not have perfect detection of all protocol errors
39483 because of transmission delays and the use of pipelining. If PIPELINING has
39484 been advertised to a client, an Exim server assumes that the client will use
39485 it, and therefore it does not count &"expected"& errors (for example, RCPT
39486 received after rejecting MAIL) as protocol errors.
39487 .next
39488 .cindex "SMTP" "logging syntax errors"
39489 .cindex "SMTP" "syntax errors; logging"
39490 .cindex "SMTP" "unknown command; logging"
39491 .cindex "log" "unknown SMTP command"
39492 .cindex "log" "SMTP syntax error"
39493 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39494 encountered. An unrecognized command is treated as a syntax error. For an
39495 external connection, the host identity is given; for an internal connection
39496 using &%-bs%& the sender identification (normally the calling user) is given.
39497 .next
39498 .cindex "log" "subject"
39499 .cindex "subject, logging"
39500 &%subject%&: The subject of the message is added to the arrival log line,
39501 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39502 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39503 specifies whether characters with values greater than 127 should be logged
39504 unchanged, or whether they should be rendered as escape sequences.
39505 .next
39506 .cindex "log" "certificate verification"
39507 .cindex log DANE
39508 .cindex DANE logging
39509 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39510 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39511 verified
39512 using a CA trust anchor,
39513 &`CV=dane`& if using a DNS trust anchor,
39514 and &`CV=no`& if not.
39515 .next
39516 .cindex "log" "TLS cipher"
39517 .cindex "TLS" "logging cipher"
39518 &%tls_cipher%&: When a message is sent or received over an encrypted
39519 connection, the cipher suite used is added to the log line, preceded by X=.
39520 .next
39521 .cindex "log" "TLS peer DN"
39522 .cindex "TLS" "logging peer DN"
39523 &%tls_peerdn%&: When a message is sent or received over an encrypted
39524 connection, and a certificate is supplied by the remote host, the peer DN is
39525 added to the log line, preceded by DN=.
39526 .next
39527 .cindex "log" "TLS resumption"
39528 .cindex "TLS" "logging session resumption"
39529 &%tls_resumption%&: When a message is sent or received over an encrypted
39530 connection and the TLS session resumed one used on a previous TCP connection,
39531 an asterisk is appended to the X= cipher field in the log line.
39532 .next
39533 .cindex "log" "TLS SNI"
39534 .cindex "TLS" "logging SNI"
39535 .cindex SNI logging
39536 &%tls_sni%&: When a message is received over an encrypted connection, and
39537 the remote host provided the Server Name Indication extension, the SNI is
39538 added to the log line, preceded by SNI=.
39539 .next
39540 .cindex "log" "DNS failure in list"
39541 &%unknown_in_list%&: This setting causes a log entry to be written when the
39542 result of a list match is failure because a DNS lookup failed.
39543 .endlist
39544
39545
39546 .section "Message log" "SECID260"
39547 .cindex "message" "log file for"
39548 .cindex "log" "message log; description of"
39549 .cindex "&_msglog_& directory"
39550 .oindex "&%preserve_message_logs%&"
39551 In addition to the general log files, Exim writes a log file for each message
39552 that it handles. The names of these per-message logs are the message ids, and
39553 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39554 message log contains copies of the log lines that apply to the message. This
39555 makes it easier to inspect the status of an individual message without having
39556 to search the main log. A message log is deleted when processing of the message
39557 is complete, unless &%preserve_message_logs%& is set, but this should be used
39558 only with great care because they can fill up your disk very quickly.
39559
39560 On a heavily loaded system, it may be desirable to disable the use of
39561 per-message logs, in order to reduce disk I/O. This can be done by setting the
39562 &%message_logs%& option false.
39563 .ecindex IIDloggen
39564
39565
39566
39567
39568 . ////////////////////////////////////////////////////////////////////////////
39569 . ////////////////////////////////////////////////////////////////////////////
39570
39571 .chapter "Exim utilities" "CHAPutils"
39572 .scindex IIDutils "utilities"
39573 A number of utility scripts and programs are supplied with Exim and are
39574 described in this chapter. There is also the Exim Monitor, which is covered in
39575 the next chapter. The utilities described here are:
39576
39577 .itable none 0 0 3  7* left  15* left  40* left
39578 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39579   "list what Exim processes are doing"
39580 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39581 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39582 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39583 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39584                                                 various criteria"
39585 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39586 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39587   "extract statistics from the log"
39588 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39589   "check address acceptance from given IP"
39590 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39591 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39592 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39593 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39594 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39595 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39596 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39597 .endtable
39598
39599 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39600 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39601 &url(https://duncanthrax.net/exilog/) for details.
39602
39603
39604
39605
39606 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39607 .cindex "&'exiwhat'&"
39608 .cindex "process, querying"
39609 .cindex "SIGUSR1"
39610 On operating systems that can restart a system call after receiving a signal
39611 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39612 a line describing what it is doing to the file &_exim-process.info_& in the
39613 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39614 processes it can find, having first emptied the file. It then waits for one
39615 second to allow the Exim processes to react before displaying the results. In
39616 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39617 send the signal to the Exim processes, so it is normally run as root.
39618
39619 &*Warning*&: This is not an efficient process. It is intended for occasional
39620 use by system administrators. It is not sensible, for example, to set up a
39621 script that sends SIGUSR1 signals to Exim processes at short intervals.
39622
39623
39624 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39625 varies in different operating systems. Not only are different options used,
39626 but the format of the output is different. For this reason, there are some
39627 system configuration options that configure exactly how &'exiwhat'& works. If
39628 it doesn't seem to be working for you, check the following compile-time
39629 options:
39630 .itable none 0 0 2 30* left 70* left
39631 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39632 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39633 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39634 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39635 .endtable
39636 An example of typical output from &'exiwhat'& is
39637 .code
39638 164 daemon: -q1h, listening on port 25
39639 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39640 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39641   [10.19.42.42] (editor@ref.example)
39642 10592 handling incoming call from [192.168.243.242]
39643 10628 accepting a local non-SMTP message
39644 .endd
39645 The first number in the output line is the process number. The third line has
39646 been split here, in order to fit it on the page.
39647
39648
39649
39650 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39651 .cindex "&'exiqgrep'&"
39652 .cindex "queue" "grepping"
39653 This utility is a Perl script contributed by Matt Hubbard. It runs
39654 .code
39655 exim -bpu
39656 .endd
39657 or (in case &*-a*& switch is specified)
39658 .code
39659 exim -bp
39660 .endd
39661 to obtain a queue listing, and then greps the output to select messages
39662 that match given criteria. The following selection options are available:
39663
39664 .vlist
39665 .vitem &*-f*&&~<&'regex'&>
39666 Match the sender address using a case-insensitive search. The field that is
39667 tested is enclosed in angle brackets, so you can test for bounce messages with
39668 .code
39669 exiqgrep -f '^<>$'
39670 .endd
39671 .vitem &*-r*&&~<&'regex'&>
39672 Match a recipient address using a case-insensitive search. The field that is
39673 tested is not enclosed in angle brackets.
39674
39675 .vitem &*-s*&&~<&'regex'&>
39676 Match against the size field.
39677
39678 .vitem &*-y*&&~<&'seconds'&>
39679 Match messages that are younger than the given time.
39680
39681 .vitem &*-o*&&~<&'seconds'&>
39682 Match messages that are older than the given time.
39683
39684 .vitem &*-z*&
39685 Match only frozen messages.
39686
39687 .vitem &*-x*&
39688 Match only non-frozen messages.
39689
39690 .vitem &*-G*&&~<&'queuename'&>
39691 Match only messages in the given queue.  Without this, the default queue is searched.
39692 .endlist
39693
39694 The following options control the format of the output:
39695
39696 .vlist
39697 .vitem &*-c*&
39698 Display only the count of matching messages.
39699
39700 .vitem &*-l*&
39701 Long format &-- display the full message information as output by Exim. This is
39702 the default.
39703
39704 .vitem &*-i*&
39705 Display message ids only.
39706
39707 .vitem &*-b*&
39708 Brief format &-- one line per message.
39709
39710 .vitem &*-R*&
39711 Display messages in reverse order.
39712
39713 .vitem &*-a*&
39714 Include delivered recipients in queue listing.
39715 .endlist
39716
39717 The following options give alternates for configuration:
39718
39719 .vlist
39720 .vitem &*-C*&&~<&'config&~file'&>
39721 is used to specify an alternate &_exim.conf_& which might
39722 contain alternate exim configuration the queue management might be using.
39723
39724 .vitem &*-E*&&~<&'path'&>
39725 can be used to specify a path for the exim binary,
39726 overriding the built-in one.
39727 .endlist
39728
39729 There is one more option, &%-h%&, which outputs a list of options.
39730 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39731
39732
39733
39734 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39735 .cindex "&'exiqsumm'&"
39736 .cindex "queue" "summary"
39737 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39738 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39739 running a command such as
39740 .code
39741 exim -bp | exiqsumm
39742 .endd
39743 The output consists of one line for each domain that has messages waiting for
39744 it, as in the following example:
39745 .code
39746 3   2322   74m   66m  msn.com.example
39747 .endd
39748 Each line lists the number of pending deliveries for a domain, their total
39749 volume, and the length of time that the oldest and the newest messages have
39750 been waiting. Note that the number of pending deliveries is greater than the
39751 number of messages when messages have more than one recipient.
39752
39753 A summary line is output at the end. By default the output is sorted on the
39754 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39755 the output to be sorted by oldest message and by count of messages,
39756 respectively. There are also three options that split the messages for each
39757 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39758 separates frozen messages, and &%-s%& separates messages according to their
39759 sender.
39760
39761 The output of &'exim -bp'& contains the original addresses in the message, so
39762 this also applies to the output from &'exiqsumm'&. No domains from addresses
39763 generated by aliasing or forwarding are included (unless the &%one_time%&
39764 option of the &(redirect)& router has been used to convert them into &"top
39765 level"& addresses).
39766
39767
39768
39769
39770 .section "Extracting specific information from the log (exigrep)" &&&
39771          "SECTextspeinf"
39772 .cindex "&'exigrep'&"
39773 .cindex "log" "extracts; grepping for"
39774 The &'exigrep'& utility is a Perl script that searches one or more main log
39775 files for entries that match a given pattern. When it finds a match, it
39776 extracts all the log entries for the relevant message, not just those that
39777 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39778 given message, or all mail for a given user, or for a given host, for example.
39779 The input files can be in Exim log format or syslog format.
39780 If a matching log line is not associated with a specific message, it is
39781 included in &'exigrep'&'s output without any additional lines. The usage is:
39782 .display
39783 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39784 .endd
39785 If no log filenames are given on the command line, the standard input is read.
39786
39787 The &%-t%& argument specifies a number of seconds. It adds an additional
39788 condition for message selection. Messages that are complete are shown only if
39789 they spent more than <&'n'&> seconds in the queue.
39790
39791 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39792 makes it case-sensitive. This may give a performance improvement when searching
39793 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39794 option; with &%-I%& they do not. In both cases it is possible to change the
39795 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39796
39797 The &%-l%& option means &"literal"&, that is, treat all characters in the
39798 pattern as standing for themselves. Otherwise the pattern must be a Perl
39799 regular expression.
39800
39801 The &%-v%& option inverts the matching condition. That is, a line is selected
39802 if it does &'not'& match the pattern.
39803
39804 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39805 that are generated as a result/response to a message that &'exigrep'& matched
39806 normally.
39807
39808 Example of &%-M%&:
39809 user_a sends a message to user_b, which generates a bounce back to user_b. If
39810 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39811 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39812 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39813 when searching for &"user_a"& will show both messages since the bounce is
39814 &"related"& to or a &"result"& of the first message that was found by the
39815 search term.
39816
39817 If the location of a &'zcat'& command is known from the definition of
39818 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39819 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39820 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39821 autodetection of some well known compression extensions.
39822
39823
39824 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39825 .cindex "&'exipick'&"
39826 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39827 lists messages from the queue according to a variety of criteria. For details
39828 of &'exipick'&'s facilities, run &'exipick'& with
39829 the &%--help%& option.
39830
39831
39832 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39833 .cindex "log" "cycling local files"
39834 .cindex "cycling logs"
39835 .cindex "&'exicyclog'&"
39836 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39837 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39838 you are using log files with datestamps in their names (see section
39839 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39840 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39841 There are two command line options for &'exicyclog'&:
39842 .ilist
39843 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39844 default that is set when Exim is built. The default default is 10.
39845 .next
39846 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39847 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39848 overriding the script's default, which is to find the setting from Exim's
39849 configuration.
39850 .endlist
39851
39852 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39853 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39854 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39855 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39856 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39857 logs are handled similarly.
39858
39859 If the limit is greater than 99, the script uses 3-digit numbers such as
39860 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39861 to one that is greater, or &'vice versa'&, you will have to fix the names of
39862 any existing log files.
39863
39864 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39865 the end are deleted. All files with numbers greater than 01 are compressed,
39866 using a compression command which is configured by the COMPRESS_COMMAND
39867 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39868 root &%crontab%& entry of the form
39869 .code
39870 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39871 .endd
39872 assuming you have used the name &"exim"& for the Exim user. You can run
39873 &'exicyclog'& as root if you wish, but there is no need.
39874
39875
39876
39877 .section "Mail statistics (eximstats)" "SECTmailstat"
39878 .cindex "statistics"
39879 .cindex "&'eximstats'&"
39880 A Perl script called &'eximstats'& is provided for extracting statistical
39881 information from log files. The output is either plain text, or HTML.
39882 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39883 . --- 404 error and everything else points to that.
39884
39885 The &'eximstats'& script has been hacked about quite a bit over time. The
39886 latest version is the result of some extensive revision by Steve Campbell. A
39887 lot of information is given by default, but there are options for suppressing
39888 various parts of it. Following any options, the arguments to the script are a
39889 list of files, which should be main log files. For example:
39890 .code
39891 eximstats -nr /var/spool/exim/log/mainlog.01
39892 .endd
39893 By default, &'eximstats'& extracts information about the number and volume of
39894 messages received from or delivered to various hosts. The information is sorted
39895 both by message count and by volume, and the top fifty hosts in each category
39896 are listed on the standard output. Similar information, based on email
39897 addresses or domains instead of hosts can be requested by means of various
39898 options. For messages delivered and received locally, similar statistics are
39899 also produced per user.
39900
39901 The output also includes total counts and statistics about delivery errors, and
39902 histograms showing the number of messages received and deliveries made in each
39903 hour of the day. A delivery with more than one address in its envelope (for
39904 example, an SMTP transaction with more than one RCPT command) is counted
39905 as a single delivery by &'eximstats'&.
39906
39907 Though normally more deliveries than receipts are reported (as messages may
39908 have multiple recipients), it is possible for &'eximstats'& to report more
39909 messages received than delivered, even though the queue is empty at the start
39910 and end of the period in question. If an incoming message contains no valid
39911 recipients, no deliveries are recorded for it. A bounce message is handled as
39912 an entirely separate message.
39913
39914 &'eximstats'& always outputs a grand total summary giving the volume and number
39915 of messages received and deliveries made, and the number of hosts involved in
39916 each case. It also outputs the number of messages that were delayed (that is,
39917 not completely delivered at the first attempt), and the number that had at
39918 least one address that failed.
39919
39920 The remainder of the output is in sections that can be independently disabled
39921 or modified by various options. It consists of a summary of deliveries by
39922 transport, histograms of messages received and delivered per time interval
39923 (default per hour), information about the time messages spent in the queue,
39924 a list of relayed messages, lists of the top fifty sending hosts, local
39925 senders, destination hosts, and destination local users by count and by volume,
39926 and a list of delivery errors that occurred.
39927
39928 The relay information lists messages that were actually relayed, that is, they
39929 came from a remote host and were directly delivered to some other remote host,
39930 without being processed (for example, for aliasing or forwarding) locally.
39931
39932 There are quite a few options for &'eximstats'& to control exactly what it
39933 outputs. These are documented in the Perl script itself, and can be extracted
39934 by running the command &(perldoc)& on the script. For example:
39935 .code
39936 perldoc /usr/exim/bin/eximstats
39937 .endd
39938
39939 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39940 .cindex "&'exim_checkaccess'&"
39941 .cindex "policy control" "checking access"
39942 .cindex "checking access"
39943 The &%-bh%& command line argument allows you to run a fake SMTP session with
39944 debugging output, in order to check what Exim is doing when it is applying
39945 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39946 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39947 sometimes you just want to answer the question &"Does this address have
39948 access?"& without bothering with any further details.
39949
39950 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39951 two arguments, an IP address and an email address:
39952 .code
39953 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39954 .endd
39955 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39956 given email address would be accepted in a RCPT command in a TCP/IP
39957 connection from the host with the given IP address. The output of the utility
39958 is either the word &"accepted"&, or the SMTP error response, for example:
39959 .code
39960 Rejected:
39961 550 Relay not permitted
39962 .endd
39963 When running this test, the utility uses &`<>`& as the envelope sender address
39964 for the MAIL command, but you can change this by providing additional
39965 options. These are passed directly to the Exim command. For example, to specify
39966 that the test is to be run with the sender address &'himself@there.example'&
39967 you can use:
39968 .code
39969 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39970                  -f himself@there.example
39971 .endd
39972 Note that these additional Exim command line items must be given after the two
39973 mandatory arguments.
39974
39975 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39976 while running its checks. You can run checks that include callouts by using
39977 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39978
39979
39980
39981 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39982 .cindex "DBM" "building dbm files"
39983 .cindex "building DBM files"
39984 .cindex "&'exim_dbmbuild'&"
39985 .cindex "lower casing"
39986 .cindex "binary zero" "in lookup key"
39987 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39988 the format used by the &(lsearch)& lookup (see section
39989 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39990 names as keys and the remainder of the information as data. The lower-casing
39991 can be prevented by calling the program with the &%-nolc%& option.
39992
39993 A terminating zero is included as part of the key string. This is expected by
39994 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39995 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39996 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39997 files.
39998
39999 The program requires two arguments: the name of the input file (which can be a
40000 single hyphen to indicate the standard input), and the name of the output file.
40001 It creates the output under a temporary name, and then renames it if all went
40002 well.
40003
40004 .cindex "USE_DB"
40005 If the native DB interface is in use (USE_DB is set in a compile-time
40006 configuration file &-- this is common in free versions of Unix) the two
40007 filenames must be different, because in this mode the Berkeley DB functions
40008 create a single output file using exactly the name given. For example,
40009 .code
40010 exim_dbmbuild /etc/aliases /etc/aliases.db
40011 .endd
40012 reads the system alias file and creates a DBM version of it in
40013 &_/etc/aliases.db_&.
40014
40015 In systems that use the &'ndbm'& routines (mostly proprietary versions of
40016 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
40017 environment, the suffixes are added to the second argument of
40018 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40019 when the Berkeley functions are used in compatibility mode (though this is not
40020 recommended), because in that case it adds a &_.db_& suffix to the filename.
40021
40022 If a duplicate key is encountered, the program outputs a warning, and when it
40023 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40024 option is used. By default, only the first of a set of duplicates is used &--
40025 this makes it compatible with &(lsearch)& lookups. There is an option
40026 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40027 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40028 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40029 return code is 2.
40030
40031
40032
40033
40034 .section "Finding individual retry times (exinext)" "SECTfinindret"
40035 .cindex "retry" "times"
40036 .cindex "&'exinext'&"
40037 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40038 fish specific information out of the retry database. Given a mail domain (or a
40039 complete address), it looks up the hosts for that domain, and outputs any retry
40040 information for the hosts or for the domain. At present, the retry information
40041 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40042 output. For example:
40043 .code
40044 $ exinext piglet@milne.fict.example
40045 kanga.milne.example:192.168.8.1 error 146: Connection refused
40046   first failed: 21-Feb-1996 14:57:34
40047   last tried:   21-Feb-1996 14:57:34
40048   next try at:  21-Feb-1996 15:02:34
40049 roo.milne.example:192.168.8.3 error 146: Connection refused
40050   first failed: 20-Jan-1996 13:12:08
40051   last tried:   21-Feb-1996 11:42:03
40052   next try at:  21-Feb-1996 19:42:03
40053   past final cutoff time
40054 .endd
40055 You can also give &'exinext'& a local part, without a domain, and it
40056 will give any retry information for that local part in your default domain.
40057 A message id can be used to obtain retry information pertaining to a specific
40058 message. This exists only when an attempt to deliver a message to a remote host
40059 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40060 &'exinext'& is not particularly efficient, but then it is not expected to be
40061 run very often.
40062
40063 The &'exinext'& utility calls Exim to find out information such as the location
40064 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40065 passed on to the &'exim'& commands. The first specifies an alternate Exim
40066 configuration file, and the second sets macros for use within the configuration
40067 file. These features are mainly to help in testing, but might also be useful in
40068 environments where more than one configuration file is in use.
40069
40070
40071
40072 .section "Hints database maintenance" "SECThindatmai"
40073 .cindex "hints database" "maintenance"
40074 .cindex "maintaining Exim's hints database"
40075 Three utility programs are provided for maintaining the DBM files that Exim
40076 uses to contain its delivery hint information. Each program requires two
40077 arguments. The first specifies the name of Exim's spool directory, and the
40078 second is the name of the database it is to operate on. These are as follows:
40079
40080 .ilist
40081 &'retry'&: the database of retry information
40082 .next
40083 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40084 for remote hosts
40085 .next
40086 &'callout'&: the callout cache
40087 .next
40088 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40089 .next
40090 &'tls'&: TLS session resumption data
40091 .next
40092 &'misc'&: other hints data
40093 .endlist
40094
40095 The &'misc'& database is used for
40096
40097 .ilist
40098 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40099 .next
40100 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40101 &(smtp)& transport)
40102 .next
40103 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40104 in a transport)
40105 .next
40106 Recording EHLO-time facilities advertised by hosts
40107 .endlist
40108
40109
40110
40111 .section "exim_dumpdb" "SECTdumpdb"
40112 .cindex "&'exim_dumpdb'&"
40113 The entire contents of a database are written to the standard output by the
40114 &'exim_dumpdb'& program,
40115 taking as arguments the spool and database names.
40116 An option &'-z'& may be given to request times in UTC;
40117 otherwise times are in the local timezone.
40118 An option &'-k'& may be given to dump only the record keys.
40119 For example, to dump the retry database:
40120 .code
40121 exim_dumpdb /var/spool/exim retry
40122 .endd
40123 For the retry database
40124 two lines of output are produced for each entry:
40125 .code
40126 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40127 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40128 .endd
40129 The first item on the first line is the key of the record. It starts with one
40130 of the letters R, or T, depending on whether it refers to a routing or
40131 transport retry. For a local delivery, the next part is the local address; for
40132 a remote delivery it is the name of the remote host, followed by its failing IP
40133 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40134 transport). If the remote port is not the standard one (port 25), it is added
40135 to the IP address. Then there follows an error code, an additional error code,
40136 and a textual description of the error.
40137
40138 The three times on the second line are the time of first failure, the time of
40139 the last delivery attempt, and the computed time for the next attempt. The line
40140 ends with an asterisk if the cutoff time for the last retry rule has been
40141 exceeded.
40142
40143 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40144 consists of a host name followed by a list of ids for messages that are or were
40145 waiting to be delivered to that host. If there are a very large number for any
40146 one host, continuation records, with a sequence number added to the host name,
40147 may be seen. The data in these records is often out of date, because a message
40148 may be routed to several alternative hosts, and Exim makes no effort to keep
40149 cross-references.
40150
40151
40152
40153 .section "exim_tidydb" "SECTtidydb"
40154 .cindex "&'exim_tidydb'&"
40155 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40156 database. If run with no options, it removes all records that are more than 30
40157 days old. The age is calculated from the date and time that the record was last
40158 updated. Note that, in the case of the retry database, it is &'not'& the time
40159 since the first delivery failure. Information about a host that has been down
40160 for more than 30 days will remain in the database, provided that the record is
40161 updated sufficiently often.
40162
40163 The cutoff date can be altered by means of the &%-t%& option, which must be
40164 followed by a time. For example, to remove all records older than a week from
40165 the retry database:
40166 .code
40167 exim_tidydb -t 7d /var/spool/exim retry
40168 .endd
40169 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40170 message ids. In the former these appear as data in records keyed by host &--
40171 they were messages that were waiting for that host &-- and in the latter they
40172 are the keys for retry information for messages that have suffered certain
40173 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40174 message ids in database records are those of messages that are still on the
40175 queue. Message ids for messages that no longer exist are removed from
40176 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40177 For the &'retry'& database, records whose keys are non-existent message ids are
40178 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40179 whenever it removes information from the database.
40180
40181 Certain records are automatically removed by Exim when they are no longer
40182 needed, but others are not. For example, if all the MX hosts for a domain are
40183 down, a retry record is created for each one. If the primary MX host comes back
40184 first, its record is removed when Exim successfully delivers to it, but the
40185 records for the others remain because Exim has not tried to use those hosts.
40186
40187 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40188 hints databases. You should do this at a quiet time of day, because it requires
40189 a database to be locked (and therefore inaccessible to Exim) while it does its
40190 work. Removing records from a DBM file does not normally make the file smaller,
40191 but all the common DBM libraries are able to re-use the space that is released.
40192 After an initial phase of increasing in size, the databases normally reach a
40193 point at which they no longer get any bigger, as long as they are regularly
40194 tidied.
40195
40196 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40197 databases is likely to keep on increasing.
40198
40199
40200
40201
40202 .section "exim_fixdb" "SECTfixdb"
40203 .cindex "&'exim_fixdb'&"
40204 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40205 Its main use is for testing Exim, but it might also be occasionally useful for
40206 getting round problems in a live system. Its interface
40207 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40208 key of a database record can then be entered, and the data for that record is
40209 displayed.
40210
40211 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40212 except the &'retry'& database, that is the only operation that can be carried
40213 out. For the &'retry'& database, each field is output preceded by a number, and
40214 data for individual fields can be changed by typing the field number followed
40215 by new data, for example:
40216 .code
40217 > 4 951102:1000
40218 .endd
40219 resets the time of the next delivery attempt. Time values are given as a
40220 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40221 used as optional separators.
40222
40223 Both displayed and input times are in the local timezone by default.
40224 If an option &'-z'& is used on the command line, displayed times
40225 are in UTC.
40226
40227
40228
40229
40230 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40231 .cindex "mailbox" "maintenance"
40232 .cindex "&'exim_lock'&"
40233 .cindex "locking mailboxes"
40234 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40235 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40236 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40237 a user agent while investigating a problem. The utility requires the name of
40238 the file as its first argument. If the locking is successful, the second
40239 argument is run as a command (using C's &[system()]& function); if there is no
40240 second argument, the value of the SHELL environment variable is used; if this
40241 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40242 is unlocked and the utility ends. The following options are available:
40243
40244 .vlist
40245 .vitem &%-fcntl%&
40246 Use &[fcntl()]& locking on the open mailbox.
40247
40248 .vitem &%-flock%&
40249 Use &[flock()]& locking on the open mailbox, provided the operating system
40250 supports it.
40251
40252 .vitem &%-interval%&
40253 This must be followed by a number, which is a number of seconds; it sets the
40254 interval to sleep between retries (default 3).
40255
40256 .vitem &%-lockfile%&
40257 Create a lock file before opening the mailbox.
40258
40259 .vitem &%-mbx%&
40260 Lock the mailbox using MBX rules.
40261
40262 .vitem &%-q%&
40263 Suppress verification output.
40264
40265 .vitem &%-retries%&
40266 This must be followed by a number; it sets the number of times to try to get
40267 the lock (default 10).
40268
40269 .vitem &%-restore_time%&
40270 This option causes &%exim_lock%& to restore the modified and read times to the
40271 locked file before exiting. This allows you to access a locked mailbox (for
40272 example, to take a backup copy) without disturbing the times that the user
40273 subsequently sees.
40274
40275 .vitem &%-timeout%&
40276 This must be followed by a number, which is a number of seconds; it sets a
40277 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40278 default), a non-blocking call is used.
40279
40280 .vitem &%-v%&
40281 Generate verbose output.
40282 .endlist
40283
40284 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40285 default is to create a lock file and also to use &[fcntl()]& locking on the
40286 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40287 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40288 requires that the directory containing the file be writeable. Locking by lock
40289 file does not last forever; Exim assumes that a lock file is expired if it is
40290 more than 30 minutes old.
40291
40292 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40293 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40294 to be taken out on the open mailbox, and an exclusive lock on the file
40295 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40296 number of the mailbox file. When the locking is released, if an exclusive lock
40297 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40298
40299 The default output contains verification of the locking that takes place. The
40300 &%-v%& option causes some additional information to be given. The &%-q%& option
40301 suppresses all output except error messages.
40302
40303 A command such as
40304 .code
40305 exim_lock /var/spool/mail/spqr
40306 .endd
40307 runs an interactive shell while the file is locked, whereas
40308 .display
40309 &`exim_lock -q /var/spool/mail/spqr <<End`&
40310 <&'some commands'&>
40311 &`End`&
40312 .endd
40313 runs a specific non-interactive sequence of commands while the file is locked,
40314 suppressing all verification output. A single command can be run by a command
40315 such as
40316 .code
40317 exim_lock -q /var/spool/mail/spqr \
40318   "cp /var/spool/mail/spqr /some/where"
40319 .endd
40320 Note that if a command is supplied, it must be entirely contained within the
40321 second argument &-- hence the quotes.
40322
40323
40324 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40325 .cindex "exim_msgdate"
40326 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40327 This Perl script converts an Exim Mesage ID back into a human readable form.
40328 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40329
40330 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40331 .ecindex IIDutils
40332 . ////////////////////////////////////////////////////////////////////////////
40333 . ////////////////////////////////////////////////////////////////////////////
40334
40335 .chapter "The Exim monitor" "CHAPeximon"
40336 .scindex IIDeximon "Exim monitor" "description"
40337 .cindex "X-windows"
40338 .cindex "&'eximon'&"
40339 .cindex "Local/eximon.conf"
40340 .cindex "&_exim_monitor/EDITME_&"
40341 The Exim monitor is an application which displays in an X window information
40342 about the state of Exim's queue and what Exim is doing. An admin user can
40343 perform certain operations on messages from this GUI interface; however all
40344 such facilities are also available from the command line, and indeed, the
40345 monitor itself makes use of the command line to perform any actions requested.
40346
40347
40348
40349 .section "Running the monitor" "SECID264"
40350 The monitor is started by running the script called &'eximon'&. This is a shell
40351 script that sets up a number of environment variables, and then runs the
40352 binary called &_eximon.bin_&. The default appearance of the monitor window can
40353 be changed by editing the &_Local/eximon.conf_& file created by editing
40354 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40355 parameters are for.
40356
40357 The parameters that get built into the &'eximon'& script can be overridden for
40358 a particular invocation by setting up environment variables of the same names,
40359 preceded by &`EXIMON_`&. For example, a shell command such as
40360 .code
40361 EXIMON_LOG_DEPTH=400 eximon
40362 .endd
40363 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40364 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40365 overrides the Exim log file configuration. This makes it possible to have
40366 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40367 syslog messages are routed to a file on the local host.
40368
40369 X resources can be used to change the appearance of the window in the normal
40370 way. For example, a resource setting of the form
40371 .code
40372 Eximon*background: gray94
40373 .endd
40374 changes the colour of the background to light grey rather than white. The
40375 stripcharts are drawn with both the data lines and the reference lines in
40376 black. This means that the reference lines are not visible when on top of the
40377 data. However, their colour can be changed by setting a resource called
40378 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40379 For example, if your X server is running Unix, you could set up lighter
40380 reference lines in the stripcharts by obeying
40381 .code
40382 xrdb -merge <<End
40383 Eximon*highlight: gray
40384 End
40385 .endd
40386 .cindex "admin user"
40387 In order to see the contents of messages in the queue, and to operate on them,
40388 &'eximon'& must either be run as root or by an admin user.
40389
40390 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40391 contain X11 resource parameters interpreted by the X11 library.  In addition,
40392 if the first parameter starts with the string "gdb" then it is removed and the
40393 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40394 versioned variants of gdb can be invoked).
40395
40396 The monitor's window is divided into three parts. The first contains one or
40397 more stripcharts and two action buttons, the second contains a &"tail"& of the
40398 main log file, and the third is a display of the queue of messages awaiting
40399 delivery, with two more action buttons. The following sections describe these
40400 different parts of the display.
40401
40402
40403
40404
40405 .section "The stripcharts" "SECID265"
40406 .cindex "stripchart"
40407 The first stripchart is always a count of messages in the queue. Its name can
40408 be configured by setting QUEUE_STRIPCHART_NAME in the
40409 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40410 configuration script by regular expression matches on log file entries, making
40411 it possible to display, for example, counts of messages delivered to certain
40412 hosts or using certain transports. The supplied defaults display counts of
40413 received and delivered messages, and of local and SMTP deliveries. The default
40414 period between stripchart updates is one minute; this can be adjusted by a
40415 parameter in the &_Local/eximon.conf_& file.
40416
40417 The stripchart displays rescale themselves automatically as the value they are
40418 displaying changes. There are always 10 horizontal lines in each chart; the
40419 title string indicates the value of each division when it is greater than one.
40420 For example, &"x2"& means that each division represents a value of 2.
40421
40422 It is also possible to have a stripchart which shows the percentage fullness of
40423 a particular disk partition, which is useful when local deliveries are confined
40424 to a single partition.
40425
40426 .cindex "&%statvfs%& function"
40427 This relies on the availability of the &[statvfs()]& function or equivalent in
40428 the operating system. Most, but not all versions of Unix that support Exim have
40429 this. For this particular stripchart, the top of the chart always represents
40430 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40431 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40432 &_Local/eximon.conf_& file.
40433
40434
40435
40436
40437 .section "Main action buttons" "SECID266"
40438 .cindex "size" "of monitor window"
40439 .cindex "Exim monitor" "window size"
40440 .cindex "window size"
40441 Below the stripcharts there is an action button for quitting the monitor. Next
40442 to this is another button marked &"Size"&. They are placed here so that
40443 shrinking the window to its default minimum size leaves just the queue count
40444 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40445 the window to expand to its maximum size, unless it is already at the maximum,
40446 in which case it is reduced to its minimum.
40447
40448 When expanding to the maximum, if the window cannot be fully seen where it
40449 currently is, it is moved back to where it was the last time it was at full
40450 size. When it is expanding from its minimum size, the old position is
40451 remembered, and next time it is reduced to the minimum it is moved back there.
40452
40453 The idea is that you can keep a reduced window just showing one or two
40454 stripcharts at a convenient place on your screen, easily expand it to show
40455 the full window when required, and just as easily put it back to what it was.
40456 The idea is copied from what the &'twm'& window manager does for its
40457 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40458 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40459
40460 Normally, the monitor starts up with the window at its full size, but it can be
40461 built so that it starts up with the window at its smallest size, by setting
40462 START_SMALL=yes in &_Local/eximon.conf_&.
40463
40464
40465
40466 .section "The log display" "SECID267"
40467 .cindex "log" "tail of; in monitor"
40468 The second section of the window is an area in which a display of the tail of
40469 the main log is maintained.
40470 To save space on the screen, the timestamp on each log line is shortened by
40471 removing the date and, if &%log_timezone%& is set, the timezone.
40472 The log tail is not available when the only destination for logging data is
40473 syslog, unless the syslog lines are routed to a local file whose name is passed
40474 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40475
40476 The log sub-window has a scroll bar at its lefthand side which can be used to
40477 move back to look at earlier text, and the up and down arrow keys also have a
40478 scrolling effect. The amount of log that is kept depends on the setting of
40479 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40480 to use. When this is full, the earlier 50% of data is discarded &-- this is
40481 much more efficient than throwing it away line by line. The sub-window also has
40482 a horizontal scroll bar for accessing the ends of long log lines. This is the
40483 only means of horizontal scrolling; the right and left arrow keys are not
40484 available. Text can be cut from this part of the window using the mouse in the
40485 normal way. The size of this subwindow is controlled by parameters in the
40486 configuration file &_Local/eximon.conf_&.
40487
40488 Searches of the text in the log window can be carried out by means of the ^R
40489 and ^S keystrokes, which default to a reverse and a forward search,
40490 respectively. The search covers only the text that is displayed in the window.
40491 It cannot go further back up the log.
40492
40493 The point from which the search starts is indicated by a caret marker. This is
40494 normally at the end of the text in the window, but can be positioned explicitly
40495 by pointing and clicking with the left mouse button, and is moved automatically
40496 by a successful search. If new text arrives in the window when it is scrolled
40497 back, the caret remains where it is, but if the window is not scrolled back,
40498 the caret is moved to the end of the new text.
40499
40500 Pressing ^R or ^S pops up a window into which the search text can be typed.
40501 There are buttons for selecting forward or reverse searching, for carrying out
40502 the search, and for cancelling. If the &"Search"& button is pressed, the search
40503 happens and the window remains so that further searches can be done. If the
40504 &"Return"& key is pressed, a single search is done and the window is closed. If
40505 ^C is typed the search is cancelled.
40506
40507 The searching facility is implemented using the facilities of the Athena text
40508 widget. By default this pops up a window containing both &"search"& and
40509 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40510 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40511 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40512 provided version of &%TextPop%& when the remaining parts of the text widget
40513 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40514 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40515 on these systems, at the expense of having unwanted items in the search popup
40516 window.
40517
40518
40519
40520 .section "The queue display" "SECID268"
40521 .cindex "queue" "display in monitor"
40522 The bottom section of the monitor window contains a list of all messages that
40523 are in the queue, which includes those currently being received or delivered,
40524 as well as those awaiting delivery. The size of this subwindow is controlled by
40525 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40526 at which it is updated is controlled by another parameter in the same file &--
40527 the default is 5 minutes, since queue scans can be quite expensive. However,
40528 there is an &"Update"& action button just above the display which can be used
40529 to force an update of the queue display at any time.
40530
40531 When a host is down for some time, a lot of pending mail can build up for it,
40532 and this can make it hard to deal with other messages in the queue. To help
40533 with this situation there is a button next to &"Update"& called &"Hide"&. If
40534 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40535 type anything in here and press &"Return"&, the text is added to a chain of
40536 such texts, and if every undelivered address in a message matches at least one
40537 of the texts, the message is not displayed.
40538
40539 If there is an address that does not match any of the texts, all the addresses
40540 are displayed as normal. The matching happens on the ends of addresses so, for
40541 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40542 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40543 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40544 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40545 a hide request is automatically cancelled after one hour.
40546
40547 While the dialogue box is displayed, you can't press any buttons or do anything
40548 else to the monitor window. For this reason, if you want to cut text from the
40549 queue display to use in the dialogue box, you have to do the cutting before
40550 pressing the &"Hide"& button.
40551
40552 The queue display contains, for each unhidden queued message, the length of
40553 time it has been in the queue, the size of the message, the message id, the
40554 message sender, and the first undelivered recipient, all on one line. If it is
40555 a bounce message, the sender is shown as &"<>"&. If there is more than one
40556 recipient to which the message has not yet been delivered, subsequent ones are
40557 listed on additional lines, up to a maximum configured number, following which
40558 an ellipsis is displayed. Recipients that have already received the message are
40559 not shown.
40560
40561 .cindex "frozen messages" "display"
40562 If a message is frozen, an asterisk is displayed at the left-hand side.
40563
40564 The queue display has a vertical scroll bar, and can also be scrolled by means
40565 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40566 The text searching facilities, as described above for the log window, are also
40567 available, but the caret is always moved to the end of the text when the queue
40568 display is updated.
40569
40570
40571
40572 .section "The queue menu" "SECID269"
40573 .cindex "queue" "menu in monitor"
40574 If the &%shift%& key is held down and the left button is clicked when the mouse
40575 pointer is over the text for any message, an action menu pops up, and the first
40576 line of the queue display for the message is highlighted. This does not affect
40577 any selected text.
40578
40579 If you want to use some other event for popping up the menu, you can set the
40580 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40581 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40582 value set in this parameter is a standard X event description. For example, to
40583 run eximon using &%ctrl%& rather than &%shift%& you could use
40584 .code
40585 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40586 .endd
40587 The title of the menu is the message id, and it contains entries which act as
40588 follows:
40589
40590 .ilist
40591 &'message log'&: The contents of the message log for the message are displayed
40592 in a new text window.
40593 .next
40594 &'headers'&: Information from the spool file that contains the envelope
40595 information and headers is displayed in a new text window. See chapter
40596 &<<CHAPspool>>& for a description of the format of spool files.
40597 .next
40598 &'body'&: The contents of the spool file containing the body of the message are
40599 displayed in a new text window. There is a default limit of 20,000 bytes to the
40600 amount of data displayed. This can be changed by setting the BODY_MAX
40601 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40602 .next
40603 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40604 delivery of the message. This causes an automatic thaw if the message is
40605 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40606 a new text window. The delivery is run in a separate process, to avoid holding
40607 up the monitor while the delivery proceeds.
40608 .next
40609 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40610 that the message be frozen.
40611 .next
40612 .cindex "thawing messages"
40613 .cindex "unfreezing messages"
40614 .cindex "frozen messages" "thawing"
40615 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40616 that the message be thawed.
40617 .next
40618 .cindex "delivery" "forcing failure"
40619 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40620 that Exim gives up trying to deliver the message. A bounce message is generated
40621 for any remaining undelivered addresses.
40622 .next
40623 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40624 that the message be deleted from the system without generating a bounce
40625 message.
40626 .next
40627 &'add recipient'&: A dialog box is displayed into which a recipient address can
40628 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40629 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40630 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40631 causes a call to Exim to be made using the &%-Mar%& option to request that an
40632 additional recipient be added to the message, unless the entry box is empty, in
40633 which case no action is taken.
40634 .next
40635 &'mark delivered'&: A dialog box is displayed into which a recipient address
40636 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40637 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40638 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40639 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40640 recipient address as already delivered, unless the entry box is empty, in which
40641 case no action is taken.
40642 .next
40643 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40644 mark all recipient addresses as already delivered.
40645 .next
40646 &'edit sender'&: A dialog box is displayed initialized with the current
40647 sender's address. Pressing RETURN causes a call to Exim to be made using the
40648 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40649 in which case no action is taken. If you want to set an empty sender (as in
40650 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40651 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40652 the address is qualified with that domain.
40653 .endlist
40654
40655 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40656 other cases when a call to Exim is made, if there is any output from Exim (in
40657 particular, if the command fails) a window containing the command and the
40658 output is displayed. Otherwise, the results of the action are normally apparent
40659 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40660 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40661 if no output is generated.
40662
40663 The queue display is automatically updated for actions such as freezing and
40664 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40665 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40666 force an update of the display after one of these actions.
40667
40668 In any text window that is displayed as result of a menu action, the normal
40669 cut-and-paste facility is available, and searching can be carried out using ^R
40670 and ^S, as described above for the log tail window.
40671 .ecindex IIDeximon
40672
40673
40674
40675
40676
40677 . ////////////////////////////////////////////////////////////////////////////
40678 . ////////////////////////////////////////////////////////////////////////////
40679
40680 .chapter "Security considerations" "CHAPsecurity"
40681 .scindex IIDsecurcon "security" "discussion of"
40682 This chapter discusses a number of issues concerned with security, some of
40683 which are also covered in other parts of this manual.
40684
40685 For reasons that this author does not understand, some people have promoted
40686 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40687 existence of this chapter in the documentation. However, the intent of the
40688 chapter is simply to describe the way Exim works in relation to certain
40689 security concerns, not to make any specific claims about the effectiveness of
40690 its security as compared with other MTAs.
40691
40692 What follows is a description of the way Exim is supposed to be. Best efforts
40693 have been made to try to ensure that the code agrees with the theory, but an
40694 absence of bugs can never be guaranteed. Any that are reported will get fixed
40695 as soon as possible.
40696
40697
40698 .section "Building a more &""hardened""& Exim" "SECID286"
40699 .cindex "security" "build-time features"
40700 There are a number of build-time options that can be set in &_Local/Makefile_&
40701 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40702 Exim administrator who does not have the root password, or by someone who has
40703 penetrated the Exim (but not the root) account. These options are as follows:
40704
40705 .ilist
40706 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40707 start of any filenames used with the &%-C%& option. When it is set, these
40708 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40709 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40710 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40711 default setting for &%ALT_CONFIG_PREFIX%&.
40712
40713 If the permitted configuration files are confined to a directory to
40714 which only root has access, this guards against someone who has broken
40715 into the Exim account from running a privileged Exim with an arbitrary
40716 configuration file, and using it to break into other accounts.
40717 .next
40718
40719 If a non-trusted configuration file (i.e. not the default configuration file
40720 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40721 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40722 the next item), then root privilege is retained only if the caller of Exim is
40723 root. This locks out the possibility of testing a configuration using &%-C%&
40724 right through message reception and delivery, even if the caller is root. The
40725 reception works, but by that time, Exim is running as the Exim user, so when
40726 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40727 privilege to be lost. However, root can test reception and delivery using two
40728 separate commands.
40729
40730 .next
40731 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40732 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40733 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40734 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40735 the restrictive side.  Requiring build-time selection of safe macros is onerous
40736 but this option is intended solely as a transition mechanism to permit
40737 previously-working configurations to continue to work after release 4.73.
40738 .next
40739 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40740 is disabled.
40741 .next
40742 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40743 never to be used for any deliveries. This is like the &%never_users%& runtime
40744 option, but it cannot be overridden; the runtime option adds additional users
40745 to the list. The default setting is &"root"&; this prevents a non-root user who
40746 is permitted to modify the runtime file from using Exim as a way to get root.
40747 .endlist
40748
40749
40750
40751 .section "Root privilege" "SECID270"
40752 .cindex "setuid"
40753 .cindex "root privilege"
40754 The Exim binary is normally setuid to root, which means that it gains root
40755 privilege (runs as root) when it starts execution. In some special cases (for
40756 example, when the daemon is not in use and there are no local deliveries), it
40757 may be possible to run Exim setuid to some user other than root. This is
40758 discussed in the next section. However, in most installations, root privilege
40759 is required for two things:
40760
40761 .ilist
40762 To set up a socket connected to the standard SMTP port (25) when initialising
40763 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40764 not required.
40765 .next
40766 To be able to change uid and gid in order to read users' &_.forward_& files and
40767 perform local deliveries as the receiving user or as specified in the
40768 configuration.
40769 .endlist
40770
40771 It is not necessary to be root to do any of the other things Exim does, such as
40772 receiving messages and delivering them externally over SMTP, and it is
40773 obviously more secure if Exim does not run as root except when necessary.
40774 For this reason, a user and group for Exim to use must be defined in
40775 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40776 group"&. Their values can be changed by the runtime configuration, though this
40777 is not recommended. Often a user called &'exim'& is used, but some sites use
40778 &'mail'& or another user name altogether.
40779
40780 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40781 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40782 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40783
40784 After a new Exim process has interpreted its command line options, it changes
40785 uid and gid in the following cases:
40786
40787 .ilist
40788 .oindex "&%-C%&"
40789 .oindex "&%-D%&"
40790 If the &%-C%& option is used to specify an alternate configuration file, or if
40791 the &%-D%& option is used to define macro values for the configuration, and the
40792 calling process is not running as root, the uid and gid are changed to those of
40793 the calling process.
40794 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40795 option may not be used at all.
40796 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40797 can be supplied if the calling process is running as root, the Exim run-time
40798 user or CONFIGURE_OWNER, if defined.
40799 .next
40800 .oindex "&%-be%&"
40801 .oindex "&%-bf%&"
40802 .oindex "&%-bF%&"
40803 If the expansion test option (&%-be%&) or one of the filter testing options
40804 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40805 calling process.
40806 .next
40807 If the process is not a daemon process or a queue runner process or a delivery
40808 process or a process for testing address routing (started with &%-bt%&), the
40809 uid and gid are changed to the Exim user and group. This means that Exim always
40810 runs under its own uid and gid when receiving messages. This also applies when
40811 testing address verification
40812 .oindex "&%-bv%&"
40813 .oindex "&%-bh%&"
40814 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40815 option).
40816 .next
40817 For a daemon, queue runner, delivery, or address testing process, the uid
40818 remains as root at this stage, but the gid is changed to the Exim group.
40819 .endlist
40820
40821 The processes that initially retain root privilege behave as follows:
40822
40823 .ilist
40824 A daemon process changes the gid to the Exim group and the uid to the Exim
40825 user after setting up one or more listening sockets. The &[initgroups()]&
40826 function is called, so that if the Exim user is in any additional groups, they
40827 will be used during message reception.
40828 .next
40829 A queue runner process retains root privilege throughout its execution. Its
40830 job is to fork a controlled sequence of delivery processes.
40831 .next
40832 A delivery process retains root privilege throughout most of its execution,
40833 but any actual deliveries (that is, the transports themselves) are run in
40834 subprocesses which always change to a non-root uid and gid. For local
40835 deliveries this is typically the uid and gid of the owner of the mailbox; for
40836 remote deliveries, the Exim uid and gid are used. Once all the delivery
40837 subprocesses have been run, a delivery process changes to the Exim uid and gid
40838 while doing post-delivery tidying up such as updating the retry database and
40839 generating bounce and warning messages.
40840
40841 While the recipient addresses in a message are being routed, the delivery
40842 process runs as root. However, if a user's filter file has to be processed,
40843 this is done in a subprocess that runs under the individual user's uid and
40844 gid. A system filter is run as root unless &%system_filter_user%& is set.
40845 .next
40846 A process that is testing addresses (the &%-bt%& option) runs as root so that
40847 the routing is done in the same environment as a message delivery.
40848 .endlist
40849
40850
40851
40852
40853 .section "Running Exim without privilege" "SECTrunexiwitpri"
40854 .cindex "privilege, running without"
40855 .cindex "unprivileged running"
40856 .cindex "root privilege" "running without"
40857 Some installations like to run Exim in an unprivileged state for more of its
40858 operation, for added security. Support for this mode of operation is provided
40859 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40860 gid are changed to the Exim user and group at the start of a delivery process
40861 (and also queue runner and address testing processes). This means that address
40862 routing is no longer run as root, and the deliveries themselves cannot change
40863 to any other uid.
40864
40865 .cindex SIGHUP
40866 .cindex "daemon" "restarting"
40867 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40868 that the daemon can still be started in the usual way, and it can respond
40869 correctly to SIGHUP because the re-invocation regains root privilege.
40870
40871 An alternative approach is to make Exim setuid to the Exim user and also setgid
40872 to the Exim group. If you do this, the daemon must be started from a root
40873 process. (Calling Exim from a root process makes it behave in the way it does
40874 when it is setuid root.) However, the daemon cannot restart itself after a
40875 SIGHUP signal because it cannot regain privilege.
40876
40877 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40878 stops Exim from trying to re-invoke itself to do a delivery after a message has
40879 been received. Such a re-invocation is a waste of resources because it has no
40880 effect.
40881
40882 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40883 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40884 to the Exim user seems a clean approach, but there is one complication:
40885
40886 In this style of operation, Exim is running with the real uid and gid set to
40887 those of the calling process, and the effective uid/gid set to Exim's values.
40888 Ideally, any association with the calling process' uid/gid should be dropped,
40889 that is, the real uid/gid should be reset to the effective values so as to
40890 discard any privileges that the caller may have. While some operating systems
40891 have a function that permits this action for a non-root effective uid, quite a
40892 number of them do not. Because of this lack of standardization, Exim does not
40893 address this problem at this time.
40894
40895 For this reason, the recommended approach for &"mostly unprivileged"& running
40896 is to keep the Exim binary setuid to root, and to set
40897 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40898 be used in the most straightforward way.
40899
40900 If you configure Exim not to run delivery processes as root, there are a
40901 number of restrictions on what you can do:
40902
40903 .ilist
40904 You can deliver only as the Exim user/group. You should  explicitly use the
40905 &%user%& and &%group%& options to override routers or local transports that
40906 normally deliver as the recipient. This makes sure that configurations that
40907 work in this mode function the same way in normal mode. Any implicit or
40908 explicit specification of another user causes an error.
40909 .next
40910 Use of &_.forward_& files is severely restricted, such that it is usually
40911 not worthwhile to include them in the configuration.
40912 .next
40913 Users who wish to use &_.forward_& would have to make their home directory and
40914 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40915 and their equivalents in Exim filters, cannot be used. While they could be
40916 enabled in the Exim user's name, that would be insecure and not very useful.
40917 .next
40918 Unless the local user mailboxes are all owned by the Exim user (possible in
40919 some POP3 or IMAP-only environments):
40920
40921 .olist
40922 They must be owned by the Exim group and be writeable by that group. This
40923 implies you must set &%mode%& in the appendfile configuration, as well as the
40924 mode of the mailbox files themselves.
40925 .next
40926 You must set &%no_check_owner%&, since most or all of the files will not be
40927 owned by the Exim user.
40928 .next
40929 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40930 on a newly created mailbox when unprivileged. This also implies that new
40931 mailboxes need to be created manually.
40932 .endlist olist
40933 .endlist ilist
40934
40935
40936 These restrictions severely restrict what can be done in local deliveries.
40937 However, there are no restrictions on remote deliveries. If you are running a
40938 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40939 gives more security at essentially no cost.
40940
40941 If you are using the &%mua_wrapper%& facility (see chapter
40942 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40943
40944
40945
40946
40947 .section "Delivering to local files" "SECID271"
40948 Full details of the checks applied by &(appendfile)& before it writes to a file
40949 are given in chapter &<<CHAPappendfile>>&.
40950
40951
40952
40953 .section "Running local commands" "SECTsecconslocalcmds"
40954 .cindex "security" "local commands"
40955 .cindex "security" "command injection attacks"
40956 There are a number of ways in which an administrator can configure Exim to run
40957 commands based upon received, untrustworthy, data. Further, in some
40958 configurations a user who can control a &_.forward_& file can also arrange to
40959 run commands. Configuration to check includes, but is not limited to:
40960
40961 .ilist
40962 Use of &%use_shell%& in the pipe transport: various forms of shell command
40963 injection may be possible with this option present. It is dangerous and should
40964 be used only with considerable caution. Consider constraints which whitelist
40965 allowed characters in a variable which is to be used in a pipe transport that
40966 has &%use_shell%& enabled.
40967 .next
40968 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40969 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40970 &_.forward_& files in a redirect router. If Exim is running on a central mail
40971 hub to which ordinary users do not have shell access, but home directories are
40972 NFS mounted (for instance) then administrators should review the list of these
40973 forbid options available, and should bear in mind that the options that may
40974 need forbidding can change as new features are added between releases.
40975 .next
40976 The &%${run...}%& expansion item does not use a shell by default, but
40977 administrators can configure use of &_/bin/sh_& as part of the command.
40978 Such invocations should be viewed with prejudicial suspicion.
40979 .next
40980 Administrators who use embedded Perl are advised to explore how Perl's
40981 taint checking might apply to their usage.
40982 .next
40983 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40984 administrators are well advised to view its use with suspicion, in case (for
40985 instance) it allows a local-part to contain embedded Exim directives.
40986 .next
40987 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40988 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40989 each can reference arbitrary lists and files, rather than just being a list
40990 of opaque strings.
40991 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40992 real-world security vulnerabilities caused by its use with untrustworthy data
40993 injected in, for SQL injection attacks.
40994 Consider the use of the &%inlisti%& expansion condition instead.
40995 .endlist
40996
40997
40998
40999
41000 .section "Trust in configuration data" "SECTsecconfdata"
41001 .cindex "security" "data sources"
41002 .cindex "security" "regular expressions"
41003 .cindex "regular expressions" "security"
41004 .cindex "PCRE2" "security"
41005 If configuration data for Exim can come from untrustworthy sources, there
41006 are some issues to be aware of:
41007
41008 .ilist
41009 Use of &%${expand...}%& may provide a path for shell injection attacks.
41010 .next
41011 Letting untrusted data provide a regular expression is unwise.
41012 .next
41013 Using &%${match...}%& to apply a fixed regular expression against untrusted
41014 data may result in pathological behaviour within PCRE2.  Be aware of what
41015 "backtracking" means and consider options for being more strict with a regular
41016 expression. Avenues to explore include limiting what can match (avoiding &`.`&
41017 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
41018 possessive quantifiers or just not using regular expressions against untrusted
41019 data.
41020 .next
41021 It can be important to correctly use &%${quote:...}%&,
41022 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41023 items to ensure that data is correctly constructed.
41024 .next
41025 Some lookups might return multiple results, even though normal usage is only
41026 expected to yield one result.
41027 .endlist
41028
41029
41030
41031
41032 .section "IPv4 source routing" "SECID272"
41033 .cindex "source routing" "in IP packets"
41034 .cindex "IP source routing"
41035 Many operating systems suppress IP source-routed packets in the kernel, but
41036 some cannot be made to do this, so Exim does its own check. It logs incoming
41037 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41038 IPv6. No special checking is currently done.
41039
41040
41041
41042 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41043 Support for these SMTP commands is disabled by default. If required, they can
41044 be enabled by defining suitable ACLs.
41045
41046
41047
41048
41049 .section "Privileged users" "SECID274"
41050 .cindex "trusted users"
41051 .cindex "admin user"
41052 .cindex "privileged user"
41053 .cindex "user" "trusted"
41054 .cindex "user" "admin"
41055 Exim recognizes two sets of users with special privileges. Trusted users are
41056 able to submit new messages to Exim locally, but supply their own sender
41057 addresses and information about a sending host. For other users submitting
41058 local messages, Exim sets up the sender address from the uid, and doesn't
41059 permit a remote host to be specified.
41060
41061 .oindex "&%-f%&"
41062 However, an untrusted user is permitted to use the &%-f%& command line option
41063 in the special form &%-f <>%& to indicate that a delivery failure for the
41064 message should not cause an error report. This affects the message's envelope,
41065 but it does not affect the &'Sender:'& header. Untrusted users may also be
41066 permitted to use specific forms of address with the &%-f%& option by setting
41067 the &%untrusted_set_sender%& option.
41068
41069 Trusted users are used to run processes that receive mail messages from some
41070 other mail domain and pass them on to Exim for delivery either locally, or over
41071 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41072 as any user listed in the &%trusted_users%& configuration option, or under any
41073 group listed in the &%trusted_groups%& option.
41074
41075 Admin users are permitted to do things to the messages on Exim's queue. They
41076 can freeze or thaw messages, cause them to be returned to their senders, remove
41077 them entirely, or modify them in various ways. In addition, admin users can run
41078 the Exim monitor and see all the information it is capable of providing, which
41079 includes the contents of files on the spool.
41080
41081 .oindex "&%-M%&"
41082 .oindex "&%-q%&"
41083 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41084 delivery of messages on its queue is restricted to admin users. This
41085 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41086 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41087 queue is also restricted to admin users. This restriction can be relaxed by
41088 setting &%no_queue_list_requires_admin%&.
41089
41090 Exim recognizes an admin user if the calling process is running as root or as
41091 the Exim user or if any of the groups associated with the calling process is
41092 the Exim group. It is not necessary actually to be running under the Exim
41093 group. However, if admin users who are not root or the Exim user are to access
41094 the contents of files on the spool via the Exim monitor (which runs
41095 unprivileged), Exim must be built to allow group read access to its spool
41096 files.
41097
41098 By default, regular users are trusted to perform basic testing and
41099 introspection commands, as themselves.  This setting can be tightened by
41100 setting the &%commandline_checks_require_admin%& option.
41101 This affects most of the checking options,
41102 such as &%-be%& and anything else &%-b*%&.
41103
41104
41105 .section "Spool files" "SECID275"
41106 .cindex "spool directory" "files"
41107 Exim's spool directory and everything it contains is owned by the Exim user and
41108 set to the Exim group. The mode for spool files is defined in the
41109 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41110 any user who is a member of the Exim group can access these files.
41111
41112
41113
41114 .section "Use of argv[0]" "SECID276"
41115 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41116 of specific strings, Exim assumes certain options. For example, calling Exim
41117 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41118 to calling it with the option &%-bS%&. There are no security implications in
41119 this.
41120
41121
41122
41123 .section "Use of %f formatting" "SECID277"
41124 The only use made of &"%f"& by Exim is in formatting load average values. These
41125 are actually stored in integer variables as 1000 times the load average.
41126 Consequently, their range is limited and so therefore is the length of the
41127 converted output.
41128
41129
41130
41131 .section "Embedded Exim path" "SECID278"
41132 Exim uses its own path name, which is embedded in the code, only when it needs
41133 to re-exec in order to regain root privilege. Therefore, it is not root when it
41134 does so. If some bug allowed the path to get overwritten, it would lead to an
41135 arbitrary program's being run as exim, not as root.
41136
41137
41138
41139 .section "Dynamic module directory" "SECTdynmoddir"
41140 Any dynamically loadable modules must be installed into the directory
41141 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41142 loading it.
41143
41144
41145 .section "Use of sprintf()" "SECID279"
41146 .cindex "&[sprintf()]&"
41147 A large number of occurrences of &"sprintf"& in the code are actually calls to
41148 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41149 The intermediate formatting is done into a large fixed buffer by a function
41150 that runs through the format string itself, and checks the length of each
41151 conversion before performing it, thus preventing buffer overruns.
41152
41153 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41154 the output buffer is known to be sufficiently long to contain the converted
41155 string.
41156
41157
41158
41159 .section "Use of debug_printf() and log_write()" "SECID280"
41160 Arbitrary strings are passed to both these functions, but they do their
41161 formatting by calling the function &'string_vformat()'&, which runs through
41162 the format string itself, and checks the length of each conversion.
41163
41164
41165
41166 .section "Use of strcat() and strcpy()" "SECID281"
41167 These are used only in cases where the output buffer is known to be large
41168 enough to hold the result.
41169 .ecindex IIDsecurcon
41170
41171
41172
41173
41174 . ////////////////////////////////////////////////////////////////////////////
41175 . ////////////////////////////////////////////////////////////////////////////
41176
41177 .chapter "Format of spool files" "CHAPspool"
41178 .scindex IIDforspo1 "format" "spool files"
41179 .scindex IIDforspo2 "spool directory" "format of files"
41180 .scindex IIDforspo3 "spool files" "format of"
41181 .cindex "spool files" "editing"
41182 A message on Exim's queue consists of two files, whose names are the message id
41183 followed by -D and -H, respectively. The data portion of the message is kept in
41184 the -D file on its own. The message's envelope, status, and headers are all
41185 kept in the -H file, whose format is described in this chapter. Each of these
41186 two files contains the final component of its own name as its first line. This
41187 is insurance against disk crashes where the directory is lost but the files
41188 themselves are recoverable.
41189
41190 The file formats may be changed, or new formats added, at any release.
41191 Spool files are not intended as an interface to other programs
41192 and should not be used as such.
41193
41194 Some people are tempted into editing -D files in order to modify messages. You
41195 need to be extremely careful if you do this; it is not recommended and you are
41196 on your own if you do it. Here are some of the pitfalls:
41197
41198 .ilist
41199 You must ensure that Exim does not try to deliver the message while you are
41200 fiddling with it. The safest way is to take out a write lock on the -D file,
41201 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41202 place, the lock will be retained. If you write a new file and rename it, the
41203 lock will be lost at the instant of rename.
41204 .next
41205 .vindex "&$body_linecount$&"
41206 If you change the number of lines in the file, the value of
41207 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41208 cause incomplete transmission of messages or undeliverable messages.
41209 .next
41210 If the message is in MIME format, you must take care not to break it.
41211 .next
41212 If the message is cryptographically signed, any change will invalidate the
41213 signature.
41214 .endlist
41215 All in all, modifying -D files is fraught with danger.
41216
41217 Files whose names end with -J may also be seen in the &_input_& directory (or
41218 its subdirectories when &%split_spool_directory%& is set). These are journal
41219 files, used to record addresses to which the message has been delivered during
41220 the course of a delivery attempt. If there are still undelivered recipients at
41221 the end, the -H file is updated, and the -J file is deleted. If, however, there
41222 is some kind of crash (for example, a power outage) before this happens, the -J
41223 file remains in existence. When Exim next processes the message, it notices the
41224 -J file and uses it to update the -H file before starting the next delivery
41225 attempt.
41226
41227 Files whose names end with -K or .eml may also be seen in the spool.
41228 These are temporaries used for DKIM or malware processing, when that is used.
41229 They should be tidied up by normal operations; any old ones are probably
41230 relics of crashes and can be removed.
41231
41232 .section "Format of the -H file" "SECID282"
41233 .cindex "uid (user id)" "in spool file"
41234 .cindex "gid (group id)" "in spool file"
41235 The second line of the -H file contains the login name for the uid of the
41236 process that called Exim to read the message, followed by the numerical uid and
41237 gid. For a locally generated message, this is normally the user who sent the
41238 message. For a message received over TCP/IP via the daemon, it is
41239 normally the Exim user.
41240
41241 The third line of the file contains the address of the message's sender as
41242 transmitted in the envelope, contained in angle brackets. The sender address is
41243 empty for bounce messages. For incoming SMTP mail, the sender address is given
41244 in the MAIL command. For locally generated mail, the sender address is
41245 created by Exim from the login name of the current user and the configured
41246 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41247 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41248 &"<>"& or an address that matches &%untrusted_set_senders%&.
41249
41250 The fourth line contains two numbers. The first is the time that the message
41251 was received, in the conventional Unix form &-- the number of seconds since the
41252 start of the epoch. The second number is a count of the number of messages
41253 warning of delayed delivery that have been sent to the sender.
41254
41255 There follow a number of lines starting with a hyphen.
41256 These contain variables, can appear in any
41257 order, and are omitted when not relevant.
41258
41259 If there is a second hyphen after the first,
41260 the corresponding data is tainted.
41261 If there is a value in parentheses, the data is quoted for a lookup.
41262
41263 The following word specifies a variable,
41264 and the remainder of the item depends on the variable.
41265
41266 .vlist
41267 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41268 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41269 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41270 recognized, to provide backward compatibility. In the old format, a line of
41271 this form is present for every ACL variable that is not empty. The number
41272 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41273 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41274 the data string for the variable. The string itself starts at the beginning of
41275 the next line, and is followed by a newline character. It may contain internal
41276 newlines.
41277
41278 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41279 A line of this form is present for every ACL connection variable that is
41280 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41281 The length is the length of the data string for the variable. The string itself
41282 starts at the beginning of the next line, and is followed by a newline
41283 character. It may contain internal newlines.
41284
41285 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41286 A line of this form is present for every ACL message variable that is defined.
41287 Note that there is a space between &%-aclm%& and the rest of the name. The
41288 length is the length of the data string for the variable. The string itself
41289 starts at the beginning of the next line, and is followed by a newline
41290 character. It may contain internal newlines.
41291
41292 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41293 This is present if, when the message was received over SMTP, the value of
41294 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41295
41296 .vitem &%-allow_unqualified_recipient%&
41297 This is present if unqualified recipient addresses are permitted in header
41298 lines (to stop such addresses from being qualified if rewriting occurs at
41299 transport time). Local messages that were input using &%-bnq%& and remote
41300 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41301
41302 .vitem &%-allow_unqualified_sender%&
41303 This is present if unqualified sender addresses are permitted in header lines
41304 (to stop such addresses from being qualified if rewriting occurs at transport
41305 time). Local messages that were input using &%-bnq%& and remote messages from
41306 hosts that match &%sender_unqualified_hosts%& set this flag.
41307
41308 .vitem "&%-auth_id%&&~<&'text'&>"
41309 The id information for a message received on an authenticated SMTP connection
41310 &-- the value of the &$authenticated_id$& variable.
41311
41312 .vitem "&%-auth_sender%&&~<&'address'&>"
41313 The address of an authenticated sender &-- the value of the
41314 &$authenticated_sender$& variable.
41315
41316 .vitem "&%-body_linecount%&&~<&'number'&>"
41317 This records the number of lines in the body of the message, and is
41318 present unless &%-spool_file_wireformat%& is.
41319
41320 .vitem "&%-body_zerocount%&&~<&'number'&>"
41321 This records the number of binary zero bytes in the body of the message, and is
41322 present if the number is greater than zero.
41323
41324 .vitem &%-deliver_firsttime%&
41325 This is written when a new message is first added to the spool. When the spool
41326 file is updated after a deferral, it is omitted.
41327
41328 .vitem "&%-frozen%&&~<&'time'&>"
41329 .cindex "frozen messages" "spool data"
41330 The message is frozen, and the freezing happened at <&'time'&>.
41331
41332 .vitem "&%-helo_name%&&~<&'text'&>"
41333 This records the host name as specified by a remote host in a HELO or EHLO
41334 command.
41335
41336 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41337 This records the IP address of the host from which the message was received and
41338 the remote port number that was used. It is omitted for locally generated
41339 messages.
41340
41341 .vitem "&%-host_auth%&&~<&'text'&>"
41342 If the message was received on an authenticated SMTP connection, this records
41343 the name of the authenticator &-- the value of the
41344 &$sender_host_authenticated$& variable.
41345
41346 .vitem &%-host_lookup_failed%&
41347 This is present if an attempt to look up the sending host's name from its IP
41348 address failed. It corresponds to the &$host_lookup_failed$& variable.
41349
41350 .vitem "&%-host_name%&&~<&'text'&>"
41351 .cindex "reverse DNS lookup"
41352 .cindex "DNS" "reverse lookup"
41353 This records the name of the remote host from which the message was received,
41354 if the host name was looked up from the IP address when the message was being
41355 received. It is not present if no reverse lookup was done.
41356
41357 .vitem "&%-ident%&&~<&'text'&>"
41358 For locally submitted messages, this records the login of the originating user,
41359 unless it was a trusted user and the &%-oMt%& option was used to specify an
41360 ident value. For messages received over TCP/IP, this records the ident string
41361 supplied by the remote host, if any.
41362
41363 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41364 This records the IP address of the local interface and the port number through
41365 which a message was received from a remote host. It is omitted for locally
41366 generated messages.
41367
41368 .vitem &%-local%&
41369 The message is from a local sender.
41370
41371 .vitem &%-localerror%&
41372 The message is a locally-generated bounce message.
41373
41374 .vitem "&%-local_scan%&&~<&'string'&>"
41375 This records the data string that was returned by the &[local_scan()]& function
41376 when the message was received &-- the value of the &$local_scan_data$&
41377 variable. It is omitted if no data was returned.
41378
41379 .vitem &%-manual_thaw%&
41380 The message was frozen but has been thawed manually, that is, by an explicit
41381 Exim command rather than via the auto-thaw process.
41382
41383 .vitem &%-N%&
41384 A testing delivery process was started using the &%-N%& option to suppress any
41385 actual deliveries, but delivery was deferred. At any further delivery attempts,
41386 &%-N%& is assumed.
41387
41388 .vitem &%-received_protocol%&
41389 This records the value of the &$received_protocol$& variable, which contains
41390 the name of the protocol by which the message was received.
41391
41392 .vitem &%-sender_set_untrusted%&
41393 The envelope sender of this message was set by an untrusted local caller (used
41394 to ensure that the caller is displayed in queue listings).
41395
41396 .vitem "&%-spam_score_int%&&~<&'number'&>"
41397 If a message was scanned by SpamAssassin, this is present. It records the value
41398 of &$spam_score_int$&.
41399
41400 .vitem &%-spool_file_wireformat%&
41401 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41402 rather than Unix-format.
41403 The line-ending is CRLF rather than newline.
41404 There is still, however, no leading-dot-stuffing.
41405
41406 .vitem &%-tls_certificate_verified%&
41407 A TLS certificate was received from the client that sent this message, and the
41408 certificate was verified by the server.
41409
41410 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41411 When the message was received over an encrypted connection, this records the
41412 name of the cipher suite that was used.
41413
41414 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41415 When the message was received over an encrypted connection, and a certificate
41416 was received from the client, this records the Distinguished Name from that
41417 certificate.
41418 .endlist
41419
41420 Following the options there is a list of those addresses to which the message
41421 is not to be delivered. This set of addresses is initialized from the command
41422 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41423 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41424 the address is added to this set. The addresses are kept internally as a
41425 balanced binary tree, and it is a representation of that tree which is written
41426 to the spool file. If an address is expanded via an alias or forward file, the
41427 original address is added to the tree when deliveries to all its child
41428 addresses are complete.
41429
41430 If the tree is empty, there is a single line in the spool file containing just
41431 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41432 Y or N, followed by an address. The address is the value for the node of the
41433 tree, and the letters indicate whether the node has a left branch and/or a
41434 right branch attached to it, respectively. If branches exist, they immediately
41435 follow. Here is an example of a three-node tree:
41436 .code
41437 YY darcy@austen.fict.example
41438 NN alice@wonderland.fict.example
41439 NN editor@thesaurus.ref.example
41440 .endd
41441 After the non-recipients tree, there is a list of the message's recipients.
41442 This is a simple list, preceded by a count. It includes all the original
41443 recipients of the message, including those to whom the message has already been
41444 delivered. In the simplest case, the list contains one address per line. For
41445 example:
41446 .code
41447 4
41448 editor@thesaurus.ref.example
41449 darcy@austen.fict.example
41450 rdo@foundation
41451 alice@wonderland.fict.example
41452 .endd
41453 However, when a child address has been added to the top-level addresses as a
41454 result of the use of the &%one_time%& option on a &(redirect)& router, each
41455 line is of the following form:
41456 .display
41457 <&'top-level address'&> <&'errors_to address'&> &&&
41458   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41459 .endd
41460 The 01 flag bit indicates the presence of the three other fields that follow
41461 the top-level address. Other bits may be used in future to support additional
41462 fields. The <&'parent number'&> is the offset in the recipients list of the
41463 original parent of the &"one time"& address. The first two fields are the
41464 envelope sender that is associated with this address and its length. If the
41465 length is zero, there is no special envelope sender (there are then two space
41466 characters in the line). A non-empty field can arise from a &(redirect)& router
41467 that has an &%errors_to%& setting.
41468
41469
41470 A blank line separates the envelope and status information from the headers
41471 which follow. A header may occupy several lines of the file, and to save effort
41472 when reading it in, each header is preceded by a number and an identifying
41473 character. The number is the number of characters in the header, including any
41474 embedded newlines and the terminating newline. The character is one of the
41475 following:
41476
41477 .table2 50pt
41478 .row <&'blank'&>         "header in which Exim has no special interest"
41479 .row &`B`&               "&'Bcc:'& header"
41480 .row &`C`&               "&'Cc:'& header"
41481 .row &`F`&               "&'From:'& header"
41482 .row &`I`&               "&'Message-id:'& header"
41483 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41484 .row &`R`&               "&'Reply-To:'& header"
41485 .row &`S`&               "&'Sender:'& header"
41486 .row &`T`&               "&'To:'& header"
41487 .row &`*`&               "replaced or deleted header"
41488 .endtable
41489
41490 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41491 purposes. They are not transmitted when the message is delivered. Here is a
41492 typical set of headers:
41493 .code
41494 111P Received: by hobbit.fict.example with local (Exim 4.00)
41495 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41496 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41497 038* X-rewrote-sender: bb@hobbit.fict.example
41498 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41499 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41500 099* To: alice@wonderland.fict.example, rdo@foundation,
41501 darcy@austen.fict.example, editor@thesaurus.ref.example
41502 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41503 darcy@austen.fict.example, editor@thesaurus.ref.example
41504 038  Date: Fri, 11 May 2001 10:28:59 +0100
41505 .endd
41506 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41507 &'To:'& header have been rewritten, the last one because routing expanded the
41508 unqualified domain &'foundation'&.
41509 .ecindex IIDforspo1
41510 .ecindex IIDforspo2
41511 .ecindex IIDforspo3
41512
41513 .section "Format of the -D file" "SECID282a"
41514 The data file is traditionally in Unix-standard format: lines are ended with
41515 an ASCII newline character.
41516 However, when the &%spool_wireformat%& main option is used some -D files
41517 can have an alternate format.
41518 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41519 The -D file lines (not including the first name-component line) are
41520 suitable for direct copying to the wire when transmitting using the
41521 ESMTP CHUNKING option, meaning lower processing overhead.
41522 Lines are terminated with an ASCII CRLF pair.
41523 There is no dot-stuffing (and no dot-termination).
41524
41525 . ////////////////////////////////////////////////////////////////////////////
41526 . ////////////////////////////////////////////////////////////////////////////
41527
41528 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41529          "DKIM, SPF, SRS and DMARC Support"
41530
41531 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41532 .cindex "DKIM"
41533
41534 DKIM is a mechanism by which messages sent by some entity can be provably
41535 linked to a domain which that entity controls.  It permits reputation to
41536 be tracked on a per-domain basis, rather than merely upon source IP address.
41537 DKIM is documented in RFC 6376.
41538
41539 As DKIM relies on the message being unchanged in transit, messages handled
41540 by a mailing-list (which traditionally adds to the message) will not match
41541 any original DKIM signature.
41542
41543 DKIM support is compiled into Exim by default if TLS support is present.
41544 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41545
41546 Exim's DKIM implementation allows for
41547 .olist
41548 Signing outgoing messages: This function is implemented in the SMTP transport.
41549 It can co-exist with all other Exim features
41550 (including transport filters)
41551 except cutthrough delivery.
41552 .next
41553 Verifying signatures in incoming messages: This is implemented by an additional
41554 ACL (acl_smtp_dkim), which can be called several times per message, with
41555 different signature contexts.
41556 .endlist
41557
41558 In typical Exim style, the verification implementation does not include any
41559 default "policy". Instead it enables you to build your own policy using
41560 Exim's standard controls.
41561
41562 Please note that verification of DKIM signatures in incoming mail is turned
41563 on by default for logging (in the <= line) purposes.
41564
41565 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41566 When set, for each signature in incoming email,
41567 exim will log a line displaying the most important signature details, and the
41568 signature status. Here is an example (with line-breaks added for clarity):
41569 .code
41570 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41571     d=facebookmail.com s=q1-2009b
41572     c=relaxed/relaxed a=rsa-sha1
41573     i=@facebookmail.com t=1252484542 [verification succeeded]
41574 .endd
41575
41576 You might want to turn off DKIM verification processing entirely for internal
41577 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41578 control modifier. This should typically be done in the RCPT ACL, at points
41579 where you accept mail from relay sources (internal hosts or authenticated
41580 senders).
41581
41582
41583 .subsection "Signing outgoing messages" SECDKIMSIGN
41584 .cindex DKIM signing
41585
41586 For signing to be usable you must have published a DKIM record in DNS.
41587 Note that RFC 8301 (which does not cover EC keys) says:
41588 .code
41589 rsa-sha1 MUST NOT be used for signing or verifying.
41590
41591 Signers MUST use RSA keys of at least 1024 bits for all keys.
41592 Signers SHOULD use RSA keys of at least 2048 bits.
41593 .endd
41594
41595 Note also that the key content (the 'p=' field)
41596 in the DNS record is different between RSA and EC keys;
41597 for the former it is the base64 of the ASN.1 for the RSA public key
41598 (equivalent to the private-key .pem with the header/trailer stripped)
41599 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41600
41601 Signing is enabled by setting private options on the SMTP transport.
41602 These options take (expandable) strings as arguments.
41603
41604 .option dkim_domain smtp "string list&!!" unset
41605 The domain(s) you want to sign with.
41606 After expansion, this can be a list.
41607 Each element in turn,
41608 lowercased,
41609 .vindex "&$dkim_domain$&"
41610 is put into the &%$dkim_domain%& expansion variable
41611 while expanding the remaining signing options.
41612 If it is empty after expansion, DKIM signing is not done,
41613 and no error will result even if &%dkim_strict%& is set.
41614
41615 .option dkim_selector smtp "string list&!!" unset
41616 This sets the key selector string.
41617 After expansion, which can use &$dkim_domain$&, this can be a list.
41618 Each element in turn is put in the expansion
41619 .vindex "&$dkim_selector$&"
41620 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41621 option along with &%$dkim_domain%&.
41622 If the option is empty after expansion, DKIM signing is not done for this domain,
41623 and no error will result even if &%dkim_strict%& is set.
41624
41625 To do, for example, dual-signing with RSA and EC keys
41626 this could be be used:
41627 .code
41628 dkim_selector = ec_sel : rsa_sel
41629 dkim_private_key = KEYS_DIR/$dkim_selector
41630 .endd
41631
41632 .option dkim_private_key smtp string&!! unset
41633 This sets the private key to use.
41634 You can use the &%$dkim_domain%& and
41635 &%$dkim_selector%& expansion variables to determine the private key to use.
41636 The result can either
41637 .ilist
41638 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41639 .next
41640 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41641 be a valid Ed25519 private key (same format as above)
41642 .next
41643 start with a slash, in which case it is treated as a file that contains
41644 the private key
41645 .next
41646 be "0", "false" or the empty string, in which case the message will not
41647 be signed. This case will not result in an error, even if &%dkim_strict%&
41648 is set.
41649 .endlist
41650
41651 To generate keys under OpenSSL:
41652 .code
41653 openssl genrsa -out dkim_rsa.private 2048
41654 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41655 .endd
41656 The result file from the first command should be retained, and
41657 this option set to use it.
41658 Take the base-64 lines from the output of the second command, concatenated,
41659 for the DNS TXT record.
41660 See section 3.6 of RFC6376 for the record specification.
41661
41662 Under GnuTLS:
41663 .code
41664 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41665 certtool --load-privkey=dkim_rsa.private --pubkey-info
41666 .endd
41667
41668 Note that RFC 8301 says:
41669 .code
41670 Signers MUST use RSA keys of at least 1024 bits for all keys.
41671 Signers SHOULD use RSA keys of at least 2048 bits.
41672 .endd
41673
41674 EC keys for DKIM are defined by RFC 8463.
41675 They are considerably smaller than RSA keys for equivalent protection.
41676 As they are a recent development, users should consider dual-signing
41677 (by setting a list of selectors, and an expansion for this option)
41678 for some transition period.
41679 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41680 for EC keys.
41681
41682 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41683 .code
41684 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41685 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41686 .endd
41687
41688 To produce the required public key value for a DNS record:
41689 .code
41690 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41691 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41692 .endd
41693
41694 Exim also supports an alternate format
41695 of Ed25519 keys in DNS which was a candidate during development
41696 of the standard, but not adopted.
41697 A future release will probably drop that support.
41698
41699 .option dkim_hash smtp string&!! sha256
41700 Can be set to any one of the supported hash methods, which are:
41701 .ilist
41702 &`sha1`& &-- should not be used, is old and insecure
41703 .next
41704 &`sha256`& &-- the default
41705 .next
41706 &`sha512`& &-- possibly more secure but less well supported
41707 .endlist
41708
41709 Note that RFC 8301 says:
41710 .code
41711 rsa-sha1 MUST NOT be used for signing or verifying.
41712 .endd
41713
41714 .option dkim_identity smtp string&!! unset
41715 If set after expansion, the value is used to set an "i=" tag in
41716 the signing header.  The DKIM standards restrict the permissible
41717 syntax of this optional tag to a mail address, with possibly-empty
41718 local part, an @, and a domain identical to or subdomain of the "d="
41719 tag value.  Note that Exim does not check the value.
41720
41721 .option dkim_canon smtp string&!! unset
41722 This option sets the canonicalization method used when signing a message.
41723 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41724 The option defaults to "relaxed" when unset. Note: the current implementation
41725 only supports signing with the same canonicalization method for both headers and body.
41726
41727 .option dkim_strict smtp string&!! unset
41728 This  option  defines  how  Exim  behaves  when  signing a message that
41729 should be signed fails for some reason.  When the expansion evaluates to
41730 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41731 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41732 variables here.
41733
41734 .option dkim_sign_headers smtp string&!! "see below"
41735 If set, this option must expand to a colon-separated
41736 list of header names.
41737 Headers with these names, or the absence or such a header, will be included
41738 in the message signature.
41739 When unspecified, the header names listed in RFC4871 will be used,
41740 whether or not each header is present in the message.
41741 The default list is available for the expansion in the macro
41742 &"_DKIM_SIGN_HEADERS"&
41743 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41744
41745 If a name is repeated, multiple headers by that name (or the absence thereof)
41746 will be signed.  The textually later headers in the headers part of the
41747 message are signed first, if there are multiples.
41748
41749 A name can be prefixed with either an &"="& or a &"+"& character.
41750 If an &"="& prefix is used, all headers that are present with this name
41751 will be signed.
41752 If a &"+"& prefix if used, all headers that are present with this name
41753 will be signed, and one signature added for a missing header with the
41754 name will be appended.
41755
41756 .option dkim_timestamps smtp integer&!! unset
41757 This option controls the inclusion of timestamp information in the signature.
41758 If not set, no such information will be included.
41759 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41760 for the expiry tag
41761 (eg. 1209600 for two weeks);
41762 both creation (t=) and expiry (x=) tags will be included.
41763
41764 RFC 6376 lists these tags as RECOMMENDED.
41765
41766
41767 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41768 .cindex DKIM verification
41769
41770 Verification of DKIM signatures in SMTP incoming email is done for all
41771 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41772 .cindex DKIM "selecting signature algorithms"
41773 Individual classes of signature algorithm can be ignored by changing
41774 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41775 The &%dkim_verify_minimal%& option can be set to cease verification
41776 processing for a message once the first passing signature is found.
41777
41778 .cindex authentication "expansion item"
41779 Performing verification sets up information used by the
41780 &%authresults%& expansion item.
41781
41782 For most purposes the default option settings suffice and the remainder
41783 of this section can be ignored.
41784
41785 The results of verification are made available to the
41786 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41787 A missing ACL definition defaults to accept.
41788 By default, the ACL is called once for each
41789 syntactically(!) correct signature in the incoming message.
41790 If any ACL call does not accept, the message is not accepted.
41791 If a cutthrough delivery was in progress for the message, that is
41792 summarily dropped (having wasted the transmission effort).
41793
41794 To evaluate the verification result in the ACL
41795 a large number of expansion variables
41796 containing the signature status and its details are set up during the
41797 runtime of the ACL.
41798
41799 Calling the ACL only for existing signatures is not sufficient to build
41800 more advanced policies. For that reason, the main option
41801 &%dkim_verify_signers%&, and an expansion variable
41802 &%$dkim_signers%& exist.
41803
41804 The main option &%dkim_verify_signers%& can be set to a colon-separated
41805 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41806 called. It is expanded when the message has been received. At this point,
41807 the expansion variable &%$dkim_signers%& already contains a colon-separated
41808 list of signer domains and identities for the message. When
41809 &%dkim_verify_signers%& is not specified in the main configuration,
41810 it defaults as:
41811 .code
41812 dkim_verify_signers = $dkim_signers
41813 .endd
41814 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41815 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41816 call the ACL for known domains or identities. This would be achieved as follows:
41817 .code
41818 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41819 .endd
41820 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41821 and "ebay.com", plus all domains and identities that have signatures in the message.
41822 You can also be more creative in constructing your policy. For example:
41823 .code
41824 dkim_verify_signers = $sender_address_domain:$dkim_signers
41825 .endd
41826
41827 If a domain or identity is listed several times in the (expanded) value of
41828 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41829
41830 Note that if the option is set using untrustworthy data
41831 (such as the From: header)
41832 care should be taken to force lowercase for domains
41833 and for the domain part if identities.
41834 The default setting can be regarded as trustworthy in this respect.
41835
41836 If multiple signatures match a domain (or identity), the ACL is called once
41837 for each matching signature.
41838
41839
41840 Inside the DKIM ACL, the following expansion variables are
41841 available (from most to least important):
41842
41843
41844 .vlist
41845 .vitem &%$dkim_cur_signer%&
41846 The signer that is being evaluated in this ACL run. This can be a domain or
41847 an identity. This is one of the list items from the expanded main option
41848 &%dkim_verify_signers%& (see above).
41849
41850 .vitem &%$dkim_verify_status%&
41851 Within the DKIM ACL,
41852 a string describing the general status of the signature. One of
41853 .ilist
41854 &%none%&: There is no signature in the message for the current domain or
41855 identity (as reflected by &%$dkim_cur_signer%&).
41856 .next
41857 &%invalid%&: The signature could not be verified due to a processing error.
41858 More detail is available in &%$dkim_verify_reason%&.
41859 .next
41860 &%fail%&: Verification of the signature failed.  More detail is
41861 available in &%$dkim_verify_reason%&.
41862 .next
41863 &%pass%&: The signature passed verification. It is valid.
41864 .endlist
41865
41866 This variable can be overwritten using an ACL 'set' modifier.
41867 This might, for instance, be done to enforce a policy restriction on
41868 hash-method or key-size:
41869 .code
41870   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41871        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41872        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41873                                   {< {$dkim_key_length}{1024}}}}
41874        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41875        set dkim_verify_status = fail
41876        set dkim_verify_reason = hash too weak or key too short
41877 .endd
41878
41879 So long as a DKIM ACL is defined (it need do no more than accept),
41880 after all the DKIM ACL runs have completed, the value becomes a
41881 colon-separated list of the values after each run.
41882 This is maintained for the mime, prdr and data ACLs.
41883
41884 .vitem &%$dkim_verify_reason%&
41885 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41886 "fail" or "invalid". One of
41887 .ilist
41888 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41889 key for the domain could not be retrieved. This may be a temporary problem.
41890 .next
41891 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41892 record for the domain is syntactically invalid.
41893 .next
41894 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41895 body hash does not match the one specified in the signature header. This
41896 means that the message body was modified in transit.
41897 .next
41898 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41899 could not be verified. This may mean that headers were modified,
41900 re-written or otherwise changed in a way which is incompatible with
41901 DKIM verification. It may of course also mean that the signature is forged.
41902 .endlist
41903
41904 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41905
41906 .vitem &%$dkim_domain%&
41907 The signing domain. IMPORTANT: This variable is only populated if there is
41908 an actual signature in the message for the current domain or identity (as
41909 reflected by &%$dkim_cur_signer%&).
41910
41911 .vitem &%$dkim_identity%&
41912 The signing identity, if present. IMPORTANT: This variable is only populated
41913 if there is an actual signature in the message for the current domain or
41914 identity (as reflected by &%$dkim_cur_signer%&).
41915
41916 .vitem &%$dkim_selector%&
41917 The key record selector string.
41918
41919 .vitem &%$dkim_algo%&
41920 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41921 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41922 may also be 'ed25519-sha256'.
41923 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41924 for EC keys.
41925
41926 Note that RFC 8301 says:
41927 .code
41928 rsa-sha1 MUST NOT be used for signing or verifying.
41929
41930 DKIM signatures identified as having been signed with historic
41931 algorithms (currently, rsa-sha1) have permanently failed evaluation
41932 .endd
41933
41934 To enforce this you must either have a DKIM ACL which checks this variable
41935 and overwrites the &$dkim_verify_status$& variable as discussed above,
41936 or have set the main option &%dkim_verify_hashes%& to exclude
41937 processing of such signatures.
41938
41939 .vitem &%$dkim_canon_body%&
41940 The body canonicalization method. One of 'relaxed' or 'simple'.
41941
41942 .vitem &%$dkim_canon_headers%&
41943 The header canonicalization method. One of 'relaxed' or 'simple'.
41944
41945 .vitem &%$dkim_copiedheaders%&
41946 A transcript of headers and their values which are included in the signature
41947 (copied from the 'z=' tag of the signature).
41948 Note that RFC6376 requires that verification fail if the From: header is
41949 not included in the signature.  Exim does not enforce this; sites wishing
41950 strict enforcement should code the check explicitly.
41951
41952 .vitem &%$dkim_bodylength%&
41953 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41954 limit was set by the signer, "9999999999999" is returned. This makes sure
41955 that this variable always expands to an integer value.
41956 &*Note:*& The presence of the signature tag specifying a signing body length
41957 is one possible route to spoofing of valid DKIM signatures.
41958 A paranoid implementation might wish to regard signature where this variable
41959 shows less than the "no limit" return as being invalid.
41960
41961 .vitem &%$dkim_created%&
41962 UNIX timestamp reflecting the date and time when the signature was created.
41963 When this was not specified by the signer, "0" is returned.
41964
41965 .vitem &%$dkim_expires%&
41966 UNIX timestamp reflecting the date and time when the signer wants the
41967 signature to be treated as "expired". When this was not specified by the
41968 signer, "9999999999999" is returned. This makes it possible to do useful
41969 integer size comparisons against this value.
41970 Note that Exim does not check this value.
41971
41972 .vitem &%$dkim_headernames%&
41973 A colon-separated list of names of headers included in the signature.
41974
41975 .vitem &%$dkim_key_testing%&
41976 "1" if the key record has the "testing" flag set, "0" if not.
41977
41978 .vitem &%$dkim_key_nosubdomains%&
41979 "1" if the key record forbids subdomaining, "0" otherwise.
41980
41981 .vitem &%$dkim_key_srvtype%&
41982 Service type (tag s=) from the key record. Defaults to "*" if not specified
41983 in the key record.
41984
41985 .vitem &%$dkim_key_granularity%&
41986 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41987 in the key record.
41988
41989 .vitem &%$dkim_key_notes%&
41990 Notes from the key record (tag n=).
41991
41992 .vitem &%$dkim_key_length%&
41993 Number of bits in the key.
41994 Valid only once the key is loaded, which is at the time the header signature
41995 is verified, which is after the body hash is.
41996
41997 Note that RFC 8301 says:
41998 .code
41999 Verifiers MUST NOT consider signatures using RSA keys of
42000 less than 1024 bits as valid signatures.
42001 .endd
42002
42003 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
42004 option.
42005
42006 .endlist
42007
42008 In addition, two ACL conditions are provided:
42009
42010 .vlist
42011 .vitem &%dkim_signers%&
42012 ACL condition that checks a colon-separated list of domains or identities
42013 for a match against the domain or identity that the ACL is currently verifying
42014 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
42015 verb to a group of domains or identities. For example:
42016
42017 .code
42018 # Warn when Mail purportedly from GMail has no gmail signature
42019 warn sender_domains = gmail.com
42020      dkim_signers = gmail.com
42021      dkim_status = none
42022      log_message = GMail sender without gmail.com DKIM signature
42023 .endd
42024
42025 Note that the above does not check for a total lack of DKIM signing;
42026 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42027
42028 .vitem &%dkim_status%&
42029 ACL condition that checks a colon-separated list of possible DKIM verification
42030 results against the actual result of verification. This is typically used
42031 to restrict an ACL verb to a list of verification outcomes, for example:
42032
42033 .code
42034 deny sender_domains = paypal.com:paypal.de
42035      dkim_signers = paypal.com:paypal.de
42036      dkim_status = none:invalid:fail
42037      message = Mail from Paypal with invalid/missing signature
42038 .endd
42039
42040 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42041 see the documentation of the &%$dkim_verify_status%& expansion variable above
42042 for more information of what they mean.
42043 .endlist
42044
42045
42046
42047
42048 .section "SPF (Sender Policy Framework)" SECSPF
42049 .cindex SPF verification
42050
42051 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42052 messages with its domain in the envelope from, documented by RFC 7208.
42053 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42054 the &url(http://openspf.org).
42055 . --- 2019-10-28: still not https, open-spf.org is told to be a
42056 . --- web-archive copy of the now dead openspf.org site
42057 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42058 . --- discussion.
42059
42060 Messages sent by a system not authorised will fail checking of such assertions.
42061 This includes retransmissions done by traditional forwarders.
42062
42063 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42064 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42065 &url(https://www.libspf2.org/).
42066 There is no Exim involvement in the transmission of messages;
42067 publishing certain DNS records is all that is required.
42068
42069 For verification, an ACL condition and an expansion lookup are provided.
42070 .cindex authentication "expansion item"
42071 Performing verification sets up information used by the
42072 &%authresults%& expansion item.
42073
42074
42075 .cindex SPF "ACL condition"
42076 .cindex ACL "spf condition"
42077 The ACL condition "spf" can be used at or after the MAIL ACL.
42078 It takes as an argument a list of strings giving the outcome of the SPF check,
42079 and will succeed for any matching outcome.
42080 Valid strings are:
42081 .vlist
42082 .vitem &%pass%&
42083 The SPF check passed, the sending host is positively verified by SPF.
42084
42085 .vitem &%fail%&
42086 The SPF check failed, the sending host is NOT allowed to send mail for the
42087 domain in the envelope-from address.
42088
42089 .vitem &%softfail%&
42090 The SPF check failed, but the queried domain can't absolutely confirm that this
42091 is a forgery.
42092
42093 .vitem &%none%&
42094 The queried domain does not publish SPF records.
42095
42096 .vitem &%neutral%&
42097 The SPF check returned a "neutral" state.  This means the queried domain has
42098 published a SPF record, but wants to allow outside servers to send mail under
42099 its domain as well.  This should be treated like "none".
42100
42101 .vitem &%permerror%&
42102 This indicates a syntax error in the SPF record of the queried domain.
42103 You may deny messages when this occurs.
42104
42105 .vitem &%temperror%&
42106 This indicates a temporary error during all processing, including Exim's
42107 SPF processing.  You may defer messages when this occurs.
42108
42109 .vitem &%invalid%&
42110 There was an error during processing of the SPF lookup
42111 .endlist
42112
42113 You can prefix each string with an exclamation mark to  invert
42114 its meaning,  for example  "!fail" will  match all  results but
42115 "fail".  The  string  list is  evaluated  left-to-right,  in a
42116 short-circuit fashion.
42117
42118 Example:
42119 .code
42120 deny spf = fail
42121      message = $sender_host_address is not allowed to send mail from \
42122                ${if def:sender_address_domain \
42123                     {$sender_address_domain}{$sender_helo_name}}.  \
42124                Please see http://www.open-spf.org/Why;\
42125                identity=${if def:sender_address_domain \
42126                              {$sender_address}{$sender_helo_name}};\
42127                ip=$sender_host_address
42128 .endd
42129
42130 Note: The above mentioned URL may not be as helpful as expected. You are
42131 encouraged to replace the link with a link to a site with more
42132 explanations.
42133
42134 When the spf condition has run, it sets up several expansion
42135 variables:
42136
42137 .cindex SPF "verification variables"
42138 .vlist
42139 .vitem &$spf_header_comment$&
42140 .vindex &$spf_header_comment$&
42141   This contains a human-readable string describing the outcome
42142   of the SPF check. You can add it to a custom header or use
42143   it for logging purposes.
42144
42145 .vitem &$spf_received$&
42146 .vindex &$spf_received$&
42147   This contains a complete Received-SPF: header (name and
42148   content) that can be added to the message. Please note that
42149   according to the SPF draft, this header must be added at the
42150   top of the header list, i.e. with
42151 .code
42152 add_header = :at_start:$spf_received
42153 .endd
42154   See section &<<SECTaddheadacl>>& for further details.
42155
42156   Note: in case of "Best-guess" (see below), the convention is
42157   to put this string in a header called X-SPF-Guess: instead.
42158
42159 .vitem &$spf_result$&
42160 .vindex &$spf_result$&
42161   This contains the outcome of the SPF check in string form,
42162   currently one of pass, fail, softfail, none, neutral, permerror,
42163   temperror, or &"(invalid)"&.
42164
42165 .vitem &$spf_result_guessed$&
42166 .vindex &$spf_result_guessed$&
42167   This boolean is true only if a best-guess operation was used
42168   and required in order to obtain a result.
42169
42170 .vitem &$spf_smtp_comment$&
42171 .vindex &$spf_smtp_comment$&
42172 .vindex &%spf_smtp_comment_template%&
42173   This contains a string that can be used in a SMTP response
42174   to the calling party. Useful for "fail".
42175   The string is generated by the SPF library from the template configured in the main config
42176   option &%spf_smtp_comment_template%&.
42177 .endlist
42178
42179
42180 .cindex SPF "ACL condition"
42181 .cindex ACL "spf_guess condition"
42182 .cindex SPF "best guess"
42183 In addition to SPF, you can also perform checks for so-called
42184 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42185 SPF, but it is supported by the same framework that enables SPF
42186 capability.
42187 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42188 for a description of what it means.
42189 . --- 2019-10-28: still not https:
42190
42191 To access this feature, simply use the spf_guess condition in place
42192 of the spf one.  For example:
42193
42194 .code
42195 deny spf_guess = fail
42196      message = $sender_host_address doesn't look trustworthy to me
42197 .endd
42198
42199 In case you decide to reject messages based on this check, you
42200 should note that although it uses the same framework, "Best-guess"
42201 is not SPF, and therefore you should not mention SPF at all in your
42202 reject message.
42203
42204 When the spf_guess condition has run, it sets up the same expansion
42205 variables as when spf condition is run, described above.
42206
42207 Additionally, since Best-guess is not standardized, you may redefine
42208 what "Best-guess" means to you by redefining the main configuration
42209 &%spf_guess%& option.
42210 For example, the following:
42211
42212 .code
42213 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42214 .endd
42215
42216 would relax host matching rules to a broader network range.
42217
42218
42219 .cindex SPF "lookup expansion"
42220 .cindex lookup spf
42221 A lookup expansion is also available. It takes an email
42222 address as the key and an IP address
42223 (v4 or v6)
42224 as the database:
42225
42226 .code
42227   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42228 .endd
42229
42230 The lookup will return the same result strings as can appear in
42231 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42232
42233
42234
42235
42236
42237 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42238 .cindex SRS "sender rewriting scheme"
42239
42240 SRS can be used to modify sender addresses when forwarding so that
42241 SPF verification does not object to them.
42242 It operates by encoding the original envelope sender in a new
42243 sender local part and using a domain run by the forwarding site
42244 as the new domain for the sender.  Any DSN message should be returned
42245 to this new sender at the forwarding site, which can extract the
42246 original sender from the coded local part and forward the DSN to
42247 the originator.
42248
42249 This is a way of avoiding the breakage that SPF does to forwarding.
42250 The constructed local-part will be longer than the original,
42251 leading to possible problems with very long addresses.
42252 The changing of the sender address also hinders the tracing of mail
42253 problems.
42254
42255 Exim can be built to include native SRS support.  To do this
42256 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42257 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42258 will be defined.
42259 The support is limited to SRS0-encoding; SRS1 is not supported.
42260
42261 .cindex SRS excoding
42262 To encode an address use this expansion item:
42263 .vlist
42264 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42265 .cindex "&%srs_encode%& expansion item"
42266 .cindex SRS "expansion item"
42267 The first argument should be a secret known and used by all systems
42268 handling the recipient domain for the original message.
42269 There is no need to periodically change this key; a timestamp is also
42270 encoded.
42271 The second argument should be given as the envelope sender address before this
42272 encoding operation.
42273 If this value is empty the the expansion result will be empty.
42274 The third argument should be the recipient domain of the message when
42275 it arrived at this system.
42276 .endlist
42277
42278 .cindex SRS decoding
42279 To decode an address use this expansion condition:
42280 .vlist
42281 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42282 The first argument should be the recipient local prt as is was received.
42283 The second argument is the site secret.
42284
42285 If the messages is not for an SRS-encoded recipient the condition will
42286 return false.  If it is, the condition will return true and the variable
42287 &$srs_recipient$& will be set to the decoded (original) value.
42288 .endlist
42289
42290 Example usage:
42291 .code
42292   #macro
42293   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42294
42295   #routers
42296
42297   outbound:
42298     driver =    dnslookup
42299     # if outbound, and forwarding has been done, use an alternate transport
42300     domains =   ! +my_domains
42301     transport = ${if eq {$local_part@$domain} \
42302                         {$original_local_part@$original_domain} \
42303                      {remote_smtp} {remote_forwarded_smtp}}
42304
42305   inbound_srs:
42306     driver =    redirect
42307     senders =   :
42308     domains =   +my_domains
42309     # detect inbound bounces which are SRS'd, and decode them
42310     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42311     data =      $srs_recipient
42312
42313   inbound_srs_failure:
42314     driver =    redirect
42315     senders =   :
42316     domains =   +my_domains
42317     # detect inbound bounces which look SRS'd but are invalid
42318     condition = ${if inbound_srs {$local_part} {}}
42319     allow_fail
42320     data =      :fail: Invalid SRS recipient address
42321
42322   #... further routers here
42323
42324
42325   # transport; should look like the non-forward outbound
42326   # one, plus the max_rcpt and return_path options
42327   remote_forwarded_smtp:
42328     driver =              smtp
42329     # single-recipient so that $original_domain is valid
42330     max_rcpt =            1
42331     # modify the envelope from, for mails that we forward
42332     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42333 .endd
42334
42335
42336
42337
42338
42339 .section DMARC SECDMARC
42340 .cindex DMARC verification
42341
42342 DMARC combines feedback from SPF, DKIM, and header From: in order
42343 to attempt to provide better indicators of the authenticity of an
42344 email.  This document does not explain the fundamentals; you
42345 should read and understand how it works by visiting the website at
42346 &url(http://www.dmarc.org/).
42347
42348 If Exim is built with DMARC support,
42349 the libopendmarc library is used.
42350
42351 For building Exim yourself, obtain the library from
42352 &url(http://sourceforge.net/projects/opendmarc/)
42353 to obtain a copy, or find it in your favorite package
42354 repository.  You will need to attend to the local/Makefile feature
42355 SUPPORT_DMARC and the associated LDFLAGS addition.
42356 This description assumes
42357 that headers will be in /usr/local/include, and that the libraries
42358 are in /usr/local/lib.
42359
42360 .subsection Configuration SSECDMARCCONFIG
42361 .cindex DMARC configuration
42362
42363 There are three main-configuration options:
42364 .cindex DMARC "configuration options"
42365
42366 The &%dmarc_tld_file%& option
42367 .oindex &%dmarc_tld_file%&
42368 defines the location of a text file of valid
42369 top level domains the opendmarc library uses
42370 during domain parsing. Maintained by Mozilla,
42371 the most current version can be downloaded
42372 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42373 See also the util/renew-opendmarc-tlds.sh script.
42374 The default for the option is unset.
42375 If not set, DMARC processing is disabled.
42376
42377
42378 The &%dmarc_history_file%& option, if set
42379 .oindex &%dmarc_history_file%&
42380 defines the location of a file to log results
42381 of dmarc verification on inbound emails. The
42382 contents are importable by the opendmarc tools
42383 which will manage the data, send out DMARC
42384 reports, and expire the data. Make sure the
42385 directory of this file is writable by the user
42386 exim runs as.
42387 The default is unset.
42388
42389 The &%dmarc_forensic_sender%& option
42390 .oindex &%dmarc_forensic_sender%&
42391 defines an alternate email address to use when sending a
42392 forensic report detailing alignment failures
42393 if a sender domain's dmarc record specifies it
42394 and you have configured Exim to send them.
42395 If set, this is expanded and used for the
42396 From: header line; the address is extracted
42397 from it and used for the envelope from.
42398 If not set (the default), the From: header is expanded from
42399 the dsn_from option, and <> is used for the
42400 envelope from.
42401
42402 .subsection Controls SSECDMARCCONTROLS
42403 .cindex DMARC controls
42404
42405 By default, the DMARC processing will run for any remote,
42406 non-authenticated user.  It makes sense to only verify DMARC
42407 status of messages coming from remote, untrusted sources.  You can
42408 use standard conditions such as hosts, senders, etc, to decide that
42409 DMARC verification should *not* be performed for them and disable
42410 DMARC with an ACL control modifier:
42411 .code
42412   control = dmarc_disable_verify
42413 .endd
42414 A DMARC record can also specify a "forensic address", which gives
42415 exim an email address to submit reports about failed alignment.
42416 Exim does not do this by default because in certain conditions it
42417 results in unintended information leakage (what lists a user might
42418 be subscribed to, etc).  You must configure exim to submit forensic
42419 reports to the owner of the domain.  If the DMARC record contains a
42420 forensic address and you specify the control statement below, then
42421 exim will send these forensic emails.  It is also advised that you
42422 configure a &%dmarc_forensic_sender%& because the default sender address
42423 construction might be inadequate.
42424 .code
42425   control = dmarc_enable_forensic
42426 .endd
42427 (AGAIN: You can choose not to send these forensic reports by simply
42428 not putting the dmarc_enable_forensic control line at any point in
42429 your exim config.  If you don't tell exim to send them, it will not
42430 send them.)
42431
42432 There are no options to either control.  Both must appear before
42433 the DATA acl.
42434
42435 .subsection ACL SSECDMARCACL
42436 .cindex DMARC "ACL condition"
42437
42438 DMARC checks can be run on incoming SMTP  messages by using the
42439 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42440 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42441 condition.  Putting this condition in the ACLs is required in order
42442 for a DMARC check to actually occur.  All of the variables are set
42443 up before the DATA ACL, but there is no actual DMARC check that
42444 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42445
42446 The &"dmarc_status"& condition takes a list of strings on its
42447 right-hand side.  These strings describe recommended action based
42448 on the DMARC check.  To understand what the policy recommendations
42449 mean, refer to the DMARC website above.  Valid strings are:
42450 .itable none 0 0 2 20* left 80* left
42451 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42452 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42453 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42454 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42455 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42456 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42457 .irow &'temperror'&     "Library error or dns error"
42458 .irow &'off'&           "The DMARC check was disabled for this email"
42459 .endtable
42460 You can prefix each string with an exclamation mark to invert its
42461 meaning, for example "!accept" will match all results but
42462 "accept".  The string list is evaluated left-to-right in a
42463 short-circuit fashion.  When a string matches the outcome of the
42464 DMARC check, the condition succeeds.  If none of the listed
42465 strings matches the outcome of the DMARC check, the condition
42466 fails.
42467
42468 Of course, you can also use any other lookup method that Exim
42469 supports, including LDAP, Postgres, MySQL, etc, as long as the
42470 result is a list of colon-separated strings.
42471
42472 Performing the check sets up information used by the
42473 &%authresults%& expansion item.
42474
42475 Several expansion variables are set before the DATA ACL is
42476 processed, and you can use them in this ACL.  The following
42477 expansion variables are available:
42478
42479 .vlist
42480 .vitem &$dmarc_status$&
42481 .vindex &$dmarc_status$&
42482 .cindex DMARC result
42483 A one word status indicating what the DMARC library
42484 thinks of the email.  It is a combination of the results of
42485 DMARC record lookup and the SPF/DKIM/DMARC processing results
42486 (if a DMARC record was found).  The actual policy declared
42487 in the DMARC record is in a separate expansion variable.
42488
42489 .vitem &$dmarc_status_text$&
42490 .vindex &$dmarc_status_text$&
42491 Slightly longer, human readable status.
42492
42493 .vitem &$dmarc_used_domain$&
42494 .vindex &$dmarc_used_domain$&
42495 The domain which DMARC used to look up the DMARC policy record.
42496
42497 .vitem &$dmarc_domain_policy$&
42498 .vindex &$dmarc_domain_policy$&
42499 The policy declared in the DMARC record.  Valid values
42500 are "none", "reject" and "quarantine".  It is blank when there
42501 is any error, including no DMARC record.
42502 .endlist
42503
42504 .subsection Logging SSECDMARCLOGGING
42505 .cindex DMARC logging
42506
42507 By default, Exim's DMARC configuration is intended to be
42508 non-intrusive and conservative.  To facilitate this, Exim will not
42509 create any type of logging files without explicit configuration by
42510 you, the admin.  Nor will Exim send out any emails/reports about
42511 DMARC issues without explicit configuration by you, the admin (other
42512 than typical bounce messages that may come about due to ACL
42513 processing or failure delivery issues).
42514
42515 In order to log statistics suitable to be imported by the opendmarc
42516 tools, you need to:
42517 .ilist
42518 Configure the global option &%dmarc_history_file%&
42519 .next
42520 Configure cron jobs to call the appropriate opendmarc history
42521 import scripts and truncating the dmarc_history_file
42522 .endlist
42523
42524 In order to send forensic reports, you need to:
42525 .ilist
42526 Configure the global option &%dmarc_forensic_sender%&
42527 .next
42528 Configure, somewhere before the DATA ACL, the control option to
42529 enable sending DMARC forensic reports
42530 .endlist
42531
42532 .subsection Example SSECDMARCEXAMPLE
42533 .cindex DMARC example
42534
42535 Example usage:
42536 .code
42537 (RCPT ACL)
42538   warn    domains        = +local_domains
42539           hosts          = +local_hosts
42540           control        = dmarc_disable_verify
42541
42542   warn    !domains       = +screwed_up_dmarc_records
42543           control        = dmarc_enable_forensic
42544
42545   warn    condition      = (lookup if destined to mailing list)
42546           set acl_m_mailing_list = 1
42547
42548 (DATA ACL)
42549   warn    dmarc_status   = accept : none : off
42550           !authenticated = *
42551           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42552
42553   warn    dmarc_status   = !accept
42554           !authenticated = *
42555           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42556
42557   warn    dmarc_status   = quarantine
42558           !authenticated = *
42559           set $acl_m_quarantine = 1
42560           # Do something in a transport with this flag variable
42561
42562   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42563           condition      = ${if eq{$acl_m_mailing_list}{1}}
42564           message        = Messages from $dmarc_used_domain break mailing lists
42565
42566   deny    dmarc_status   = reject
42567           !authenticated = *
42568           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42569
42570   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42571 .endd
42572
42573
42574
42575
42576
42577 . ////////////////////////////////////////////////////////////////////////////
42578 . ////////////////////////////////////////////////////////////////////////////
42579
42580 .chapter "Proxies" "CHAPproxies" &&&
42581          "Proxy support"
42582 .cindex "proxy support"
42583 .cindex "proxy" "access via"
42584
42585 A proxy is an intermediate system through which communication is passed.
42586 Proxies may provide a security, availability or load-distribution function.
42587
42588
42589 .section "Inbound proxies" SECTproxyInbound
42590 .cindex proxy inbound
42591 .cindex proxy "server side"
42592 .cindex proxy "Proxy protocol"
42593 .cindex "Proxy protocol" proxy
42594
42595 Exim has support for receiving inbound SMTP connections via a proxy
42596 that uses &"Proxy Protocol"& to speak to it.
42597 To include this support, include &"SUPPORT_PROXY=yes"&
42598 in Local/Makefile.
42599
42600 It was built on the HAProxy specification, found at
42601 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42602
42603 The purpose of this facility is so that an application load balancer,
42604 such as HAProxy, can sit in front of several Exim servers
42605 to distribute load.
42606 Exim uses the local protocol communication with the proxy to obtain
42607 the remote SMTP system IP address and port information.
42608 There is no logging if a host passes or
42609 fails Proxy Protocol negotiation, but it can easily be determined and
42610 recorded in an ACL (example is below).
42611
42612 Use of a proxy is enabled by setting the &%hosts_proxy%&
42613 main configuration option to a hostlist; connections from these
42614 hosts will use Proxy Protocol.
42615 Exim supports both version 1 and version 2 of the Proxy Protocol and
42616 automatically determines which version is in use.
42617
42618 The Proxy Protocol header is the first data received on a TCP connection
42619 and is inserted before any TLS-on-connect handshake from the client; Exim
42620 negotiates TLS between Exim-as-server and the remote client, not between
42621 Exim and the proxy server. The Proxy Protocol header must be received
42622 within &%proxy_protocol_timeout%&, which defaults to 3s.
42623
42624 The following expansion variables are usable
42625 (&"internal"& and &"external"& here refer to the interfaces
42626 of the proxy):
42627 .itable none 0 0 2 30* left 70* left
42628 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42629 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42630 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42631 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42632 .irow $proxy_session            "boolean: SMTP connection via proxy"
42633 .endtable
42634 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42635 there was a protocol error.
42636 The variables &$sender_host_address$& and &$sender_host_port$&
42637 will have values for the actual client system, not the proxy.
42638
42639 Since the real connections are all coming from the proxy, and the
42640 per host connection tracking is done before Proxy Protocol is
42641 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42642 handle all of the parallel volume you expect per inbound proxy.
42643 With the option set so high, you lose the ability
42644 to protect your server from many connections from one IP.
42645 In order to prevent your server from overload, you
42646 need to add a per connection ratelimit to your connect ACL.
42647 A possible solution is:
42648 .display
42649   # Set max number of connections per host
42650   LIMIT   = 5
42651   # Or do some kind of IP lookup in a flat file or database
42652   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42653
42654   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42655           message        = Too many connections from this IP right now
42656 .endd
42657
42658
42659
42660 .section "Outbound proxies" SECTproxySOCKS
42661 .cindex proxy outbound
42662 .cindex proxy "client side"
42663 .cindex proxy SOCKS
42664 .cindex SOCKS proxy
42665 Exim has support for sending outbound SMTP via a proxy
42666 using a protocol called SOCKS5 (defined by RFC1928).
42667 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42668 Local/Makefile.
42669
42670 Use of a proxy is enabled by setting the &%socks_proxy%& option
42671 on an smtp transport.
42672 The option value is expanded and should then be a list
42673 (colon-separated by default) of proxy specifiers.
42674 Each proxy specifier is a list
42675 (space-separated by default) where the initial element
42676 is an IP address and any subsequent elements are options.
42677
42678 Options are a string <name>=<value>.
42679 The list of options is in the following table:
42680 .itable none 0 0 2 10* left 90* left
42681 .irow &'auth'&  "authentication method"
42682 .irow &'name'&  "authentication username"
42683 .irow &'pass'&  "authentication password"
42684 .irow &'port'&  "tcp port"
42685 .irow &'tmo'&   "connection timeout"
42686 .irow &'pri'&   "priority"
42687 .irow &'weight'& "selection bias"
42688 .endtable
42689
42690 More details on each of these options follows:
42691
42692 .ilist
42693 .cindex authentication "to proxy"
42694 .cindex proxy authentication
42695 &%auth%&: Either &"none"& (default) or &"name"&.
42696 Using &"name"& selects username/password authentication per RFC 1929
42697 for access to the proxy.
42698 Default is &"none"&.
42699 .next
42700 &%name%&: sets the username for the &"name"& authentication method.
42701 Default is empty.
42702 .next
42703 &%pass%&: sets the password for the &"name"& authentication method.
42704 Default is empty.
42705 .next
42706 &%port%&: the TCP port number to use for the connection to the proxy.
42707 Default is 1080.
42708 .next
42709 &%tmo%&: sets a connection timeout in seconds for this proxy.
42710 Default is 5.
42711 .next
42712 &%pri%&: specifies a priority for the proxy within the list,
42713 higher values being tried first.
42714 The default priority is 1.
42715 .next
42716 &%weight%&: specifies a selection bias.
42717 Within a priority set servers are queried in a random fashion,
42718 weighted by this value.
42719 The default value for selection bias is 1.
42720 .endlist
42721
42722 Proxies from the list are tried according to their priority
42723 and weight settings until one responds.  The timeout for the
42724 overall connection applies to the set of proxied attempts.
42725
42726 .section Logging SECTproxyLog
42727 To log the (local) IP of a proxy in the incoming or delivery logline,
42728 add &"+proxy"& to the &%log_selector%& option.
42729 This will add a component tagged with &"PRX="& to the line.
42730
42731 . ////////////////////////////////////////////////////////////////////////////
42732 . ////////////////////////////////////////////////////////////////////////////
42733
42734 .chapter "Internationalisation" "CHAPi18n" &&&
42735          "Internationalisation""
42736 .cindex internationalisation "email address"
42737 .cindex EAI
42738 .cindex i18n
42739 .cindex utf8 "mail name handling"
42740
42741 Exim has support for Internationalised mail names.
42742 To include this it must be built with SUPPORT_I18N and the libidn library.
42743 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42744
42745 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42746 instead of it) then IDNA2008 is supported; this adds an extra library
42747 requirement, upon libidn2.
42748
42749 .section "MTA operations" SECTi18nMTA
42750 .cindex SMTPUTF8 "ESMTP option"
42751 .cindex "ESMTP extensions" SMTPUTF8
42752 The main configuration option &%smtputf8_advertise_hosts%& specifies
42753 a host list.  If this matches the sending host and
42754 accept_8bitmime is true (the default) then the ESMTP option
42755 SMTPUTF8 will be advertised.
42756
42757 If the sender specifies the SMTPUTF8 option on a MAIL command
42758 international handling for the message is enabled and
42759 the expansion variable &$message_smtputf8$& will have value TRUE.
42760
42761 The option &%allow_utf8_domains%& is set to true for this
42762 message. All DNS lookups are converted to a-label form
42763 whatever the setting of &%allow_utf8_domains%&
42764 when Exim is built with SUPPORT_I18N.
42765
42766 Both localparts and domain are maintained as the original
42767 UTF-8 form internally; any comparison or regular-expression use will
42768 require appropriate care.  Filenames created, eg. by
42769 the appendfile transport, will have UTF-8 names.
42770
42771 HELO names sent by the smtp transport will have any UTF-8
42772 components expanded to a-label form,
42773 and any certificate name checks will be done using the a-label
42774 form of the name.
42775
42776 .cindex log protocol
42777 .cindex SMTPUTF8 logging
42778 .cindex i18n logging
42779 Log lines and Received-by: header lines will acquire a "utf8"
42780 prefix on the protocol element, eg. utf8esmtp.
42781
42782 The following expansion operators can be used:
42783 .code
42784 ${utf8_domain_to_alabel:str}
42785 ${utf8_domain_from_alabel:str}
42786 ${utf8_localpart_to_alabel:str}
42787 ${utf8_localpart_from_alabel:str}
42788 .endd
42789
42790 .cindex utf8 "address downconversion"
42791 .cindex i18n "utf8 address downconversion"
42792 The RCPT ACL
42793 may use the following modifier:
42794 .display
42795 control = utf8_downconvert
42796 control = utf8_downconvert/<value>
42797 .endd
42798 This sets a flag requiring that envelope addresses are converted to
42799 a-label form before smtp delivery.
42800 This is usually for use in a Message Submission Agent context,
42801 but could be used for any message.
42802
42803 If a value is appended it may be:
42804 .itable none 0 0 2 5* right 95* left
42805 .irow &`1`&     "mandatory downconversion"
42806 .irow &`0`&     "no downconversion"
42807 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42808 .endtable
42809 If no value is given, 1 is used.
42810
42811 If mua_wrapper is set, the utf8_downconvert control
42812 is initially set to -1.
42813
42814 The smtp transport has an option &%utf8_downconvert%&.
42815 If set it must expand to one of the three values described above,
42816 or an empty string.
42817 If non-empty it overrides value previously set
42818 (due to mua_wrapper or by an ACL control).
42819
42820
42821 There is no explicit support for VRFY and EXPN.
42822 Configurations supporting these should inspect
42823 &$smtp_command_argument$& for an SMTPUTF8 argument.
42824
42825 There is no support for LMTP on Unix sockets.
42826 Using the "lmtp" protocol option on an smtp transport,
42827 for LMTP over TCP, should work as expected.
42828
42829 There is no support for DSN unitext handling,
42830 and no provision for converting logging from or to UTF-8.
42831
42832
42833
42834 .section "MDA operations" SECTi18nMDA
42835 To aid in constructing names suitable for IMAP folders
42836 the following expansion operator can be used:
42837 .code
42838 ${imapfolder {<string>} {<sep>} {<specials>}}
42839 .endd
42840
42841 The string is converted from the charset specified by
42842 the "headers charset" command (in a filter file)
42843 or &%headers_charset%& main configuration option (otherwise),
42844 to the
42845 modified UTF-7 encoding specified by RFC 2060,
42846 with the following exception: All occurrences of <sep>
42847 (which has to be a single character)
42848 are replaced with periods ("."), and all periods and slashes that are not
42849 <sep> and are not in the <specials> string are BASE64 encoded.
42850
42851 The third argument can be omitted, defaulting to an empty string.
42852 The second argument can be omitted, defaulting to "/".
42853
42854 This is the encoding used by Courier for Maildir names on disk, and followed
42855 by many other IMAP servers.
42856
42857 Examples:
42858 .display
42859 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42860 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42861 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42862 .endd
42863
42864 Note that the source charset setting is vital, and also that characters
42865 must be representable in UTF-16.
42866
42867
42868 . ////////////////////////////////////////////////////////////////////////////
42869 . ////////////////////////////////////////////////////////////////////////////
42870
42871 .chapter "Events" "CHAPevents" &&&
42872          "Events"
42873 .cindex events
42874
42875 The events mechanism in Exim can be used to intercept processing at a number
42876 of points.  It was originally invented to give a way to do customised logging
42877 actions (for example, to a database) but can also be used to modify some
42878 processing actions.
42879
42880 Most installations will never need to use Events.
42881 The support can be left out of a build by defining DISABLE_EVENT=yes
42882 in &_Local/Makefile_&.
42883
42884 There are two major classes of events: main and transport.
42885 The main configuration option &%event_action%& controls reception events;
42886 a transport option &%event_action%& controls delivery events.
42887
42888 Both options are a string which is expanded when the event fires.
42889 An example might look like:
42890 .cindex logging custom
42891 .code
42892 event_action = ${if eq {msg:delivery}{$event_name} \
42893 {${lookup pgsql {SELECT * FROM record_Delivery( \
42894     '${quote_pgsql:$sender_address_domain}',\
42895     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42896     '${quote_pgsql:$domain}', \
42897     '${quote_pgsql:${lc:$local_part}}', \
42898     '${quote_pgsql:$host_address}', \
42899     '${quote_pgsql:${lc:$host}}', \
42900     '${quote_pgsql:$message_exim_id}')}} \
42901 } {}}
42902 .endd
42903
42904 Events have names which correspond to the point in process at which they fire.
42905 The name is placed in the variable &$event_name$& and the event action
42906 expansion must check this, as it will be called for every possible event type.
42907
42908 The current list of events is:
42909 .itable all 0 0 4 25* left 10* center 15* center 50* left
42910 .row auth:fail              after    both       "per driver per authentication attempt"
42911 .row dane:fail              after    transport  "per connection"
42912 .row msg:complete           after    main       "per message"
42913 .row msg:defer              after    transport  "per message per delivery try"
42914 .row msg:delivery           after    transport  "per recipient"
42915 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42916 .row msg:rcpt:defer         after    transport  "per recipient"
42917 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42918 .row msg:fail:delivery      after    transport  "per recipient"
42919 .row msg:fail:internal      after    main       "per recipient"
42920 .row tcp:connect            before   transport  "per connection"
42921 .row tcp:close              after    transport  "per connection"
42922 .row tls:cert               before   both       "per certificate in verification chain"
42923 .row tls:fail:connect       after    main       "per connection"
42924 .row smtp:connect           after    transport  "per connection"
42925 .row smtp:ehlo              after    transport  "per connection"
42926 .endtable
42927 New event types may be added in future.
42928
42929 The event name is a colon-separated list, defining the type of
42930 event in a tree of possibilities.  It may be used as a list
42931 or just matched on as a whole.  There will be no spaces in the name.
42932
42933 The second column in the table above describes whether the event fires
42934 before or after the action is associates with.  Those which fire before
42935 can be used to affect that action (more on this below).
42936
42937 The third column in the table above says what section of the configuration
42938 should define the event action.
42939
42940 An additional variable, &$event_data$&, is filled with information varying
42941 with the event type:
42942 .itable all 0 0 2 20* left 80* left
42943 .row auth:fail            "smtp response"
42944 .row dane:fail            "failure reason"
42945 .row msg:defer            "error string"
42946 .row msg:delivery         "smtp confirmation message"
42947 .row msg:fail:internal    "failure reason"
42948 .row msg:fail:delivery    "smtp error message"
42949 .row msg:host:defer       "error string"
42950 .row msg:rcpt:host:defer  "error string"
42951 .row msg:rcpt:defer       "error string"
42952 .row tls:cert             "verification chain depth"
42953 .row tls:fail:connect     "error string"
42954 .row smtp:connect         "smtp banner"
42955 .row smtp:ehlo            "smtp ehlo response"
42956 .endtable
42957
42958 The :defer events populate one extra variable: &$event_defer_errno$&.
42959
42960 For complex operations an ACL expansion can be used in &%event_action%&,
42961 however due to the multiple contexts that Exim operates in during
42962 the course of its processing:
42963 .ilist
42964 variables set in transport events will not be visible outside that
42965 transport call
42966 .next
42967 acl_m variables in a server context are lost on a new connection,
42968 and after smtp helo/ehlo/mail/starttls/rset commands
42969 .endlist
42970 Using an ACL expansion with the logwrite modifier can be
42971 a useful way of writing to the main log.
42972
42973 The expansion of the event_action option should normally
42974 return an empty string.  Should it return anything else the
42975 following will be forced:
42976 .itable all 0 0 2 20* left 80* left
42977 .row auth:fail        "log information to write"
42978 .row tcp:connect      "do not connect"
42979 .row tls:cert         "refuse verification"
42980 .row smtp:connect     "close connection"
42981 .endtable
42982 All other message types ignore the result string, and
42983 no other use is made of it.
42984
42985 For a tcp:connect event, if the connection is being made to a proxy
42986 then the address and port variables will be that of the proxy and not
42987 the target system.
42988
42989 For tls:cert events, if GnuTLS is in use this will trigger only per
42990 chain element received on the connection.
42991 For OpenSSL it will trigger for every chain element including those
42992 loaded locally.
42993
42994 . ////////////////////////////////////////////////////////////////////////////
42995 . ////////////////////////////////////////////////////////////////////////////
42996
42997 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42998          "Adding drivers or lookups"
42999 .cindex "adding drivers"
43000 .cindex "new drivers, adding"
43001 .cindex "drivers" "adding new"
43002 The following actions have to be taken in order to add a new router, transport,
43003 authenticator, or lookup type to Exim:
43004
43005 .olist
43006 Choose a name for the driver or lookup type that does not conflict with any
43007 existing name; I will use &"newdriver"& in what follows.
43008 .next
43009 Add to &_src/EDITME_& the line:
43010 .display
43011 <&'type'&>&`_NEWDRIVER=yes`&
43012 .endd
43013 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
43014 code is not to be included in the binary by default, comment this line out. You
43015 should also add any relevant comments about the driver or lookup type.
43016 .next
43017 Add to &_src/config.h.defaults_& the line:
43018 .code
43019 #define <type>_NEWDRIVER
43020 .endd
43021 .next
43022 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43023 and create a table entry as is done for all the other drivers and lookup types.
43024 .next
43025 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43026 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43027 Add your &`NEWDRIVER`& to that list.
43028 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43029 simple form that most lookups have.
43030 .next
43031 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43032 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43033 driver or lookup type and add it to the definition of OBJ.
43034 .next
43035 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43036 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43037 .next
43038 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43039 &_src_&.
43040 .next
43041 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43042 as for other drivers and lookups.
43043 .endlist
43044
43045 Then all you need to do is write the code! A good way to start is to make a
43046 proforma by copying an existing module of the same type, globally changing all
43047 occurrences of the name, and cutting out most of the code. Note that any
43048 options you create must be listed in alphabetical order, because the tables are
43049 searched using a binary chop procedure.
43050
43051 There is a &_README_& file in each of the sub-directories of &_src_& describing
43052 the interface that is expected.
43053
43054
43055
43056
43057 . ////////////////////////////////////////////////////////////////////////////
43058 . ////////////////////////////////////////////////////////////////////////////
43059
43060 . /////////////////////////////////////////////////////////////////////////////
43061 . These lines are processing instructions for the Simple DocBook Processor that
43062 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43063 . PDFs than using xmlto and fop. They will be ignored by all other XML
43064 . processors.
43065 . /////////////////////////////////////////////////////////////////////////////
43066
43067 .literal xml
43068 <?sdop
43069   format="newpage"
43070   foot_right_recto="&chaptertitle;"
43071   foot_right_verso="&chaptertitle;"
43072 ?>
43073 .literal off
43074
43075 .makeindex "Options index"   "option"
43076 .makeindex "Variables index" "variable"
43077 .makeindex "Concept index"   "concept"
43078
43079
43080 . /////////////////////////////////////////////////////////////////////////////
43081 . /////////////////////////////////////////////////////////////////////////////