Tidying: massage to project coding style
[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 23
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.
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 When the lookup is done from a string-expansion,
7353 the variables &$1$& and &$2$& contain the wild and non-wild parts of the key
7354 during the expansion of the replacement text.
7355 They return to their previous values at the end of the lookup item.
7356
7357
7358
7359
7360 .section "Lookup caching" "SECID64"
7361 .cindex "lookup" "caching"
7362 .cindex "caching" "lookup data"
7363 Exim caches all lookup results in order to avoid needless repetition of
7364 lookups. However, because (apart from the daemon) Exim operates as a collection
7365 of independent, short-lived processes, this caching applies only within a
7366 single Exim process. There is no inter-process lookup caching facility.
7367
7368 If an option &"cache=no_rd"& is used on the lookup then
7369 the cache is only written to, cached data is not used for the operation
7370 and a real lookup is done.
7371
7372 For single-key lookups, Exim keeps the relevant files open in case there is
7373 another lookup that needs them. In some types of configuration this can lead to
7374 many files being kept open for messages with many recipients. To avoid hitting
7375 the operating system limit on the number of simultaneously open files, Exim
7376 closes the least recently used file when it needs to open more files than its
7377 own internal limit, which can be changed via the &%lookup_open_max%& option.
7378
7379 The single-key lookup files are closed and the lookup caches are flushed at
7380 strategic points during delivery &-- for example, after all routing is
7381 complete.
7382
7383
7384
7385
7386 .section "Quoting lookup data" "SECID65"
7387 .cindex "lookup" "quoting"
7388 .cindex "quoting" "in lookups"
7389 When data from an incoming message is included in a query-style lookup, there
7390 is the possibility of special characters in the data messing up the syntax of
7391 the query. For example, a NIS+ query that contains
7392 .code
7393 [name=$local_part]
7394 .endd
7395 will be broken if the local part happens to contain a closing square bracket.
7396 For NIS+, data can be enclosed in double quotes like this:
7397 .code
7398 [name="$local_part"]
7399 .endd
7400 but this still leaves the problem of a double quote in the data. The rule for
7401 NIS+ is that double quotes must be doubled. Other lookup types have different
7402 rules, and to cope with the differing requirements, an expansion operator
7403 of the following form is provided:
7404 .code
7405 ${quote_<lookup-type>:<string>}
7406 .endd
7407 For example, the way to write the NIS+ query is
7408 .code
7409 [name="${quote_nisplus:$local_part}"]
7410 .endd
7411 .cindex "tainted data" "in lookups"
7412 .new
7413 &*All*& tainted data used in a query-style lookup must be quoted
7414 using a mechanism appropriate for the lookup type.
7415 .wen
7416 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7417 operator can be used for all lookup types, but has no effect for single-key
7418 lookups, since no quoting is ever needed in their key strings.
7419
7420
7421
7422
7423 .section "More about dnsdb" "SECTdnsdb"
7424 .cindex "dnsdb lookup"
7425 .cindex "lookup" "dnsdb"
7426 .cindex "DNS" "as a lookup type"
7427 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7428 of a record type and a domain name, separated by an equals sign. For example,
7429 an expansion string could contain:
7430 .code
7431 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7432 .endd
7433 If the lookup succeeds, the result is placed in &$value$&, which in this case
7434 is used on its own as the result. If the lookup does not succeed, the
7435 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7436 &<<SECTforexpfai>>& for an explanation of what this means.
7437
7438 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7439 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7440 If no type is given, TXT is assumed.
7441
7442 For any record type, if multiple records are found, the data is returned as a
7443 concatenation, with newline as the default separator. The order, of course,
7444 depends on the DNS resolver. You can specify a different separator character
7445 between multiple records by putting a right angle-bracket followed immediately
7446 by the new separator at the start of the query. For example:
7447 .code
7448 ${lookup dnsdb{>: a=host1.example}}
7449 .endd
7450 It is permitted to specify a space as the separator character. Further
7451 white space is ignored.
7452 For lookup types that return multiple fields per record,
7453 an alternate field separator can be specified using a comma after the main
7454 separator character, followed immediately by the field separator.
7455
7456 .cindex "PTR record" "in &(dnsdb)& lookup"
7457 When the type is PTR,
7458 the data can be an IP address, written as normal; inversion and the addition of
7459 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7460 .code
7461 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7462 .endd
7463 If the data for a PTR record is not a syntactically valid IP address, it is not
7464 altered and nothing is added.
7465
7466 .cindex "MX record" "in &(dnsdb)& lookup"
7467 .cindex "SRV record" "in &(dnsdb)& lookup"
7468 For an MX lookup, both the preference value and the host name are returned for
7469 each record, separated by a space. For an SRV lookup, the priority, weight,
7470 port, and host name are returned for each record, separated by spaces.
7471 The field separator can be modified as above.
7472
7473 .cindex "TXT record" "in &(dnsdb)& lookup"
7474 .cindex "SPF record" "in &(dnsdb)& lookup"
7475 For TXT records with multiple items of data, only the first item is returned,
7476 unless a field separator is specified.
7477 To concatenate items without a separator, use a semicolon instead.
7478 For SPF records the
7479 default behaviour is to concatenate multiple items without using a separator.
7480 .code
7481 ${lookup dnsdb{>\n,: txt=a.b.example}}
7482 ${lookup dnsdb{>\n; txt=a.b.example}}
7483 ${lookup dnsdb{spf=example.org}}
7484 .endd
7485 It is permitted to specify a space as the separator character. Further
7486 white space is ignored.
7487
7488 .cindex "SOA record" "in &(dnsdb)& lookup"
7489 For an SOA lookup, while no result is obtained the lookup is redone with
7490 successively more leading components dropped from the given domain.
7491 Only the primary-nameserver field is returned unless a field separator is
7492 specified.
7493 .code
7494 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7495 .endd
7496
7497 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7498 .cindex "dnsdb modifiers"
7499 .cindex "modifiers" "dnsdb"
7500 .cindex "options" "dnsdb"
7501 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7502 each followed by a comma,
7503 that may appear before the record type.
7504
7505 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7506 temporary DNS error for any of them, the behaviour is controlled by
7507 a defer-option modifier.
7508 The possible keywords are
7509 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7510 With &"strict"& behaviour, any temporary DNS error causes the
7511 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7512 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7513 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7514 error causes the whole lookup to defer only if none of the other lookups
7515 succeed. The default is &"lax"&, so the following lookups are equivalent:
7516 .code
7517 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7518 ${lookup dnsdb{a=one.host.com:two.host.com}}
7519 .endd
7520 Thus, in the default case, as long as at least one of the DNS lookups
7521 yields some data, the lookup succeeds.
7522
7523 .cindex "DNSSEC" "dns lookup"
7524 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7525 The possible keywords are
7526 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7527 With &"strict"& or &"lax"& DNSSEC information is requested
7528 with the lookup.
7529 With &"strict"& a response from the DNS resolver that
7530 is not labelled as authenticated data
7531 is treated as equivalent to a temporary DNS error.
7532 The default is &"lax"&.
7533
7534 See also the &$lookup_dnssec_authenticated$& variable.
7535
7536 .cindex timeout "dns lookup"
7537 .cindex "DNS" timeout
7538 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7539 The form is &"retrans_VAL"& where VAL is an Exim time specification
7540 (e.g. &"5s"&).
7541 The default value is set by the main configuration option &%dns_retrans%&.
7542
7543 Retries for the dnsdb lookup can be controlled by a retry modifier.
7544 The form if &"retry_VAL"& where VAL is an integer.
7545 The default count is set by the main configuration option &%dns_retry%&.
7546
7547 .cindex caching "of dns lookup"
7548 .cindex TTL "of dns lookup"
7549 .cindex DNS TTL
7550 Dnsdb lookup results are cached within a single process (and its children).
7551 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7552 value of the set of returned DNS records.
7553
7554
7555 .subsection "Pseudo dnsdb record types" SECID66
7556 .cindex "MX record" "in &(dnsdb)& lookup"
7557 By default, both the preference value and the host name are returned for
7558 each MX record, separated by a space. If you want only host names, you can use
7559 the pseudo-type MXH:
7560 .code
7561 ${lookup dnsdb{mxh=a.b.example}}
7562 .endd
7563 In this case, the preference values are omitted, and just the host names are
7564 returned.
7565
7566 .cindex "name server for enclosing domain"
7567 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7568 records on the given domain, but if none are found, it removes the first
7569 component of the domain name, and tries again. This process continues until NS
7570 records are found or there are no more components left (or there is a DNS
7571 error). In other words, it may return the name servers for a top-level domain,
7572 but it never returns the root name servers. If there are no NS records for the
7573 top-level domain, the lookup fails. Consider these examples:
7574 .code
7575 ${lookup dnsdb{zns=xxx.quercite.com}}
7576 ${lookup dnsdb{zns=xxx.edu}}
7577 .endd
7578 Assuming that in each case there are no NS records for the full domain name,
7579 the first returns the name servers for &%quercite.com%&, and the second returns
7580 the name servers for &%edu%&.
7581
7582 You should be careful about how you use this lookup because, unless the
7583 top-level domain does not exist, the lookup always returns some host names. The
7584 sort of use to which this might be put is for seeing if the name servers for a
7585 given domain are on a blacklist. You can probably assume that the name servers
7586 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7587 such a list.
7588
7589 .cindex "CSA" "in &(dnsdb)& lookup"
7590 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7591 records according to the CSA rules, which are described in section
7592 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7593 not sufficient because of the extra parent domain search behaviour of CSA. The
7594 result of a successful lookup such as:
7595 .code
7596 ${lookup dnsdb {csa=$sender_helo_name}}
7597 .endd
7598 has two space-separated fields: an authorization code and a target host name.
7599 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7600 authorization required but absent, or &"?"& for unknown.
7601
7602 .cindex "A+" "in &(dnsdb)& lookup"
7603 The pseudo-type A+ performs an AAAA
7604 and then an A lookup.  All results are returned; defer processing
7605 (see below) is handled separately for each lookup.  Example:
7606 .code
7607 ${lookup dnsdb {>; a+=$sender_helo_name}}
7608 .endd
7609
7610
7611 .subsection "Multiple dnsdb lookups" SECID67
7612 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7613 However, you can specify a list of domains or IP addresses in a single
7614 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7615 the default separator, but with the ability to change this. For example:
7616 .code
7617 ${lookup dnsdb{one.domain.com:two.domain.com}}
7618 ${lookup dnsdb{a=one.host.com:two.host.com}}
7619 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7620 .endd
7621 In order to retain backwards compatibility, there is one special case: if
7622 the lookup type is PTR and no change of separator is specified, Exim looks
7623 to see if the rest of the string is precisely one IPv6 address. In this
7624 case, it does not treat it as a list.
7625
7626 The data from each lookup is concatenated, with newline separators by default,
7627 in the same way that multiple DNS records for a single item are handled. A
7628 different separator can be specified, as described above.
7629
7630
7631
7632
7633 .section "More about LDAP" "SECTldap"
7634 .cindex "LDAP" "lookup, more about"
7635 .cindex "lookup" "LDAP"
7636 .cindex "Solaris" "LDAP"
7637 The original LDAP implementation came from the University of Michigan; this has
7638 become &"Open LDAP"&, and there are now two different releases. Another
7639 implementation comes from Netscape, and Solaris 7 and subsequent releases
7640 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7641 the lookup function level, their error handling is different. For this reason
7642 it is necessary to set a compile-time variable when building Exim with LDAP, to
7643 indicate which LDAP library is in use. One of the following should appear in
7644 your &_Local/Makefile_&:
7645 .code
7646 LDAP_LIB_TYPE=UMICHIGAN
7647 LDAP_LIB_TYPE=OPENLDAP1
7648 LDAP_LIB_TYPE=OPENLDAP2
7649 LDAP_LIB_TYPE=NETSCAPE
7650 LDAP_LIB_TYPE=SOLARIS
7651 .endd
7652 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7653 same interface as the University of Michigan version.
7654
7655 There are three LDAP lookup types in Exim. These behave slightly differently in
7656 the way they handle the results of a query:
7657
7658 .ilist
7659 &(ldap)& requires the result to contain just one entry; if there are more, it
7660 gives an error.
7661 .next
7662 &(ldapdn)& also requires the result to contain just one entry, but it is the
7663 Distinguished Name that is returned rather than any attribute values.
7664 .next
7665 &(ldapm)& permits the result to contain more than one entry; the attributes
7666 from all of them are returned.
7667 .endlist
7668
7669
7670 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7671 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7672 the data returned by a successful lookup is described in the next section.
7673 First we explain how LDAP queries are coded.
7674
7675
7676 .subsection "Format of LDAP queries" SECTforldaque
7677 .cindex "LDAP" "query format"
7678 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7679 the configuration of a &(redirect)& router one might have this setting:
7680 .code
7681 data = ${lookup ldap \
7682   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7683   c=UK?mailbox?base?}}
7684 .endd
7685 .cindex "LDAP" "with TLS"
7686 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7687 secure (encrypted) LDAP connections. The second of these ensures that an
7688 encrypted TLS connection is used.
7689
7690 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7691 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7692 See the &%ldap_start_tls%& option.
7693
7694 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7695 controlled. Every part of the TLS configuration can be configured by settings in
7696 &_exim.conf_&. Depending on the version of the client libraries installed on
7697 your system, some of the initialization may have required setting options in
7698 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7699 certificates. This revealed a nuance where the current UID that exim was
7700 running as could affect which config files it read. With Exim 4.83, these
7701 methods become optional, only taking effect if not specifically set in
7702 &_exim.conf_&.
7703
7704
7705 .subsection "LDAP quoting" SECID68
7706 .cindex "LDAP" "quoting"
7707 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7708 and the second because the LDAP query is represented as a URL. Furthermore,
7709 within an LDAP query, two different kinds of quoting are required. For this
7710 reason, there are two different LDAP-specific quoting operators.
7711
7712 The &%quote_ldap%& operator is designed for use on strings that are part of
7713 filter specifications. Conceptually, it first does the following conversions on
7714 the string:
7715 .code
7716 *   =>   \2A
7717 (   =>   \28
7718 )   =>   \29
7719 \   =>   \5C
7720 .endd
7721 in accordance with RFC 2254. The resulting string is then quoted according
7722 to the rules for URLs, that is, all non-alphanumeric characters except
7723 .code
7724 ! $ ' - . _ ( ) * +
7725 .endd
7726 are converted to their hex values, preceded by a percent sign. For example:
7727 .code
7728 ${quote_ldap: a(bc)*, a<yz>; }
7729 .endd
7730 yields
7731 .code
7732 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7733 .endd
7734 Removing the URL quoting, this is (with a leading and a trailing space):
7735 .code
7736 a\28bc\29\2A, a<yz>;
7737 .endd
7738 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7739 base DN specifications in queries. Conceptually, it first converts the string
7740 by inserting a backslash in front of any of the following characters:
7741 .code
7742 , + " \ < > ;
7743 .endd
7744 It also inserts a backslash before any leading spaces or # characters, and
7745 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7746 is then quoted according to the rules for URLs. For example:
7747 .code
7748 ${quote_ldap_dn: a(bc)*, a<yz>; }
7749 .endd
7750 yields
7751 .code
7752 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7753 .endd
7754 Removing the URL quoting, this is (with a trailing space):
7755 .code
7756 \ a(bc)*\, a\<yz\>\;\
7757 .endd
7758 There are some further comments about quoting in the section on LDAP
7759 authentication below.
7760
7761
7762 .subsection "LDAP connections" SECID69
7763 .cindex "LDAP" "connections"
7764 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7765 is in use, via a Unix domain socket. The example given above does not specify
7766 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7767 by starting it with
7768 .code
7769 ldap://<hostname>:<port>/...
7770 .endd
7771 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7772 used. When no server is specified in a query, a list of default servers is
7773 taken from the &%ldap_default_servers%& configuration option. This supplies a
7774 colon-separated list of servers which are tried in turn until one successfully
7775 handles a query, or there is a serious error. Successful handling either
7776 returns the requested data, or indicates that it does not exist. Serious errors
7777 are syntactical, or multiple values when only a single value is expected.
7778 Errors which cause the next server to be tried are connection failures, bind
7779 failures, and timeouts.
7780
7781 For each server name in the list, a port number can be given. The standard way
7782 of specifying a host and port is to use a colon separator (RFC 1738). Because
7783 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7784 doubled. For example
7785 .code
7786 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7787 .endd
7788 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7789 to the LDAP library with no server name, and the library's default (normally
7790 the local host) is used.
7791
7792 If you are using the OpenLDAP library, you can connect to an LDAP server using
7793 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7794 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7795 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7796 not available.
7797
7798 For this type of connection, instead of a host name for the server, a pathname
7799 for the socket is required, and the port number is not relevant. The pathname
7800 can be specified either as an item in &%ldap_default_servers%&, or inline in
7801 the query. In the former case, you can have settings such as
7802 .code
7803 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7804 .endd
7805 When the pathname is given in the query, you have to escape the slashes as
7806 &`%2F`& to fit in with the LDAP URL syntax. For example:
7807 .code
7808 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7809 .endd
7810 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7811 a pathname, it uses the Unix domain socket code, even if the query actually
7812 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7813 socket connection. This behaviour means that you can use a setting of
7814 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7815 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7816 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7817 backup host.
7818
7819 If an explicit &`ldapi`& type is given in a query when a host name is
7820 specified, an error is diagnosed. However, if there are more items in
7821 &%ldap_default_servers%&, they are tried. In other words:
7822
7823 .ilist
7824 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7825 interface.
7826 .next
7827 Using &`ldapi`& with a host name causes an error.
7828 .endlist
7829
7830
7831 Using &`ldapi`& with no host or path in the query, and no setting of
7832 &%ldap_default_servers%&, does whatever the library does by default.
7833
7834
7835
7836 .subsection "LDAP authentication and control information" SECID70
7837 .cindex "LDAP" "authentication"
7838 The LDAP URL syntax provides no way of passing authentication and other control
7839 information to the server. To make this possible, the URL in an LDAP query may
7840 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7841 spaces. If a value contains spaces it must be enclosed in double quotes, and
7842 when double quotes are used, backslash is interpreted in the usual way inside
7843 them. The following names are recognized:
7844 .itable none 0 0 2 20* left 80* left
7845 .irow DEREFERENCE "set the dereferencing parameter"
7846 .irow NETTIME     "set a timeout for a network operation"
7847 .irow USER        "set the DN, for authenticating the LDAP bind"
7848 .irow PASS        "set the password, likewise"
7849 .irow REFERRALS   "set the referrals parameter"
7850 .irow SERVERS     "set alternate server list for this query only"
7851 .irow SIZE        "set the limit for the number of entries returned"
7852 .irow TIME        "set the maximum waiting time for a query"
7853 .endtable
7854 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7855 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7856 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7857 library from trying to follow referrals issued by the LDAP server.
7858
7859 .cindex LDAP timeout
7860 .cindex timeout "LDAP lookup"
7861 The name CONNECT is an obsolete name for NETTIME, retained for
7862 backwards compatibility. This timeout (specified as a number of seconds) is
7863 enforced from the client end for operations that can be carried out over a
7864 network. Specifically, it applies to network connections and calls to the
7865 &'ldap_result()'& function. If the value is greater than zero, it is used if
7866 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7867 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7868 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7869 Netscape SDK; for OpenLDAP no action is taken.
7870
7871 The TIME parameter (also a number of seconds) is passed to the server to
7872 set a server-side limit on the time taken to complete a search.
7873
7874 The SERVERS parameter allows you to specify an alternate list of ldap servers
7875 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7876 default list of ldap servers, and a single lookup can specify a single ldap
7877 server to use.  But when you need to do a lookup with a list of servers that is
7878 different than the default list (maybe different order, maybe a completely
7879 different set of servers), the SERVERS parameter allows you to specify this
7880 alternate list (colon-separated).
7881
7882 Here is an example of an LDAP query in an Exim lookup that uses some of these
7883 values. This is a single line, folded to fit on the page:
7884 .code
7885 ${lookup ldap
7886   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7887   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7888   {$value}fail}
7889 .endd
7890 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7891 any of the auxiliary data. Exim configuration settings that include lookups
7892 which contain password information should be preceded by &"hide"& to prevent
7893 non-admin users from using the &%-bP%& option to see their values.
7894
7895 The auxiliary data items may be given in any order. The default is no
7896 connection timeout (the system timeout is used), no user or password, no limit
7897 on the number of entries returned, and no time limit on queries.
7898
7899 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7900 removes any URL quoting that it may contain before passing it to the LDAP library.
7901 Apparently
7902 some libraries do this for themselves, but some do not. Removing the URL
7903 quoting has two advantages:
7904
7905 .ilist
7906 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7907 DNs as with DNs inside actual queries.
7908 .next
7909 It permits spaces inside USER= DNs.
7910 .endlist
7911
7912 For example, a setting such as
7913 .code
7914 USER=cn=${quote_ldap_dn:$1}
7915 .endd
7916 should work even if &$1$& contains spaces.
7917
7918 Expanded data for the PASS= value should be quoted using the &%quote%&
7919 expansion operator, rather than the LDAP quote operators. The only reason this
7920 field needs quoting is to ensure that it conforms to the Exim syntax, which
7921 does not allow unquoted spaces. For example:
7922 .code
7923 PASS=${quote:$3}
7924 .endd
7925 The LDAP authentication mechanism can be used to check passwords as part of
7926 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7927 &<<CHAPexpand>>&.
7928
7929
7930
7931 .subsection "Format of data returned by LDAP" SECID71
7932 .cindex "LDAP" "returned data formats"
7933 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7934 as a sequence of values, for example
7935 .code
7936 cn=manager,o=University of Cambridge,c=UK
7937 .endd
7938 The &(ldap)& lookup type generates an error if more than one entry matches the
7939 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7940 the result between the data from different entries. It is possible for multiple
7941 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7942 you know that whatever values are returned all came from a single entry in the
7943 directory.
7944
7945 In the common case where you specify a single attribute in your LDAP query, the
7946 result is not quoted, and does not contain the attribute name. If the attribute
7947 has multiple values, they are separated by commas. Any comma that is
7948 part of an attribute's value is doubled.
7949
7950 If you specify multiple attributes, the result contains space-separated, quoted
7951 strings, each preceded by the attribute name and an equals sign. Within the
7952 quotes, the quote character, backslash, and newline are escaped with
7953 backslashes, and commas are used to separate multiple values for the attribute.
7954 Any commas in attribute values are doubled
7955 (permitting treatment of the values as a comma-separated list).
7956 Apart from the escaping, the string within quotes takes the same form as the
7957 output when a single attribute is requested. Specifying no attributes is the
7958 same as specifying all of an entry's attributes.
7959
7960 Here are some examples of the output format. The first line of each pair is an
7961 LDAP query, and the second is the data that is returned. The attribute called
7962 &%attr1%& has two values, one of them with an embedded comma, whereas
7963 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7964 (they have SUP &%attr%& in their schema definitions).
7965
7966 .code
7967 ldap:///o=base?attr1?sub?(uid=fred)
7968 value1.1,value1,,2
7969
7970 ldap:///o=base?attr2?sub?(uid=fred)
7971 value two
7972
7973 ldap:///o=base?attr?sub?(uid=fred)
7974 value1.1,value1,,2,value two
7975
7976 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7977 attr1="value1.1,value1,,2" attr2="value two"
7978
7979 ldap:///o=base??sub?(uid=fred)
7980 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7981 .endd
7982 You can
7983 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7984 results of LDAP lookups.
7985 The &%extract%& operator in string expansions can be used to pick out
7986 individual fields from data that consists of &'key'&=&'value'& pairs.
7987 The &%listextract%& operator should be used to pick out individual values
7988 of attributes, even when only a single value is expected.
7989 The doubling of embedded commas allows you to use the returned data as a
7990 comma separated list (using the "<," syntax for changing the input list separator).
7991
7992
7993
7994
7995 .section "More about NIS+" "SECTnisplus"
7996 .cindex "NIS+ lookup type"
7997 .cindex "lookup" "NIS+"
7998 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7999 and field name. If this is given, the result of a successful query is the
8000 contents of the named field; otherwise the result consists of a concatenation
8001 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8002 values containing spaces are quoted. For example, the query
8003 .code
8004 [name=mg1456],passwd.org_dir
8005 .endd
8006 might return the string
8007 .code
8008 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8009 home=/home/mg1456 shell=/bin/bash shadow=""
8010 .endd
8011 (split over two lines here to fit on the page), whereas
8012 .code
8013 [name=mg1456],passwd.org_dir:gcos
8014 .endd
8015 would just return
8016 .code
8017 Martin Guerre
8018 .endd
8019 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8020 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8021 operator is to double any quote characters within the text.
8022
8023
8024
8025 .section "SQL lookups" "SECTsql"
8026 .cindex "SQL lookup types"
8027 .cindex "MySQL" "lookup type"
8028 .cindex "PostgreSQL lookup type"
8029 .cindex "lookup" "MySQL"
8030 .cindex "lookup" "PostgreSQL"
8031 .cindex "Oracle" "lookup type"
8032 .cindex "lookup" "Oracle"
8033 .cindex "InterBase lookup type"
8034 .cindex "lookup" "InterBase"
8035 .cindex "Redis lookup type"
8036 .cindex lookup Redis
8037 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8038 and SQLite
8039 databases. Queries for these databases contain SQL statements, so an example
8040 might be
8041 .code
8042 ${lookup mysql{select mailbox from users where id='userx'}\
8043   {$value}fail}
8044 .endd
8045 If the result of the query contains more than one field, the data for each
8046 field in the row is returned, preceded by its name, so the result of
8047 .code
8048 ${lookup pgsql{select home,name from users where id='userx'}\
8049   {$value}}
8050 .endd
8051 might be
8052 .code
8053 home=/home/userx name="Mister X"
8054 .endd
8055 Empty values and values containing spaces are double quoted, with embedded
8056 quotes escaped by a backslash. If the result of the query contains just one
8057 field, the value is passed back verbatim, without a field name, for example:
8058 .code
8059 Mister X
8060 .endd
8061 If the result of the query yields more than one row, it is all concatenated,
8062 with a newline between the data for each row.
8063
8064
8065 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8066 .cindex "MySQL" "lookup type"
8067 .cindex "PostgreSQL lookup type"
8068 .cindex "lookup" "MySQL"
8069 .cindex "lookup" "PostgreSQL"
8070 .cindex "Oracle" "lookup type"
8071 .cindex "lookup" "Oracle"
8072 .cindex "InterBase lookup type"
8073 .cindex "lookup" "InterBase"
8074 .cindex "Redis lookup type"
8075 .cindex lookup Redis
8076 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8077 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8078 or &%redis_servers%&
8079 option (as appropriate) must be set to a colon-separated list of server
8080 information.
8081 .oindex &%mysql_servers%&
8082 .oindex &%pgsql_servers%&
8083 .oindex &%oracle_servers%&
8084 .oindex &%ibase_servers%&
8085 .oindex &%redis_servers%&
8086 (For MySQL and PostgreSQL, the global option need not be set if all
8087 queries contain their own server information &-- see section
8088 &<<SECTspeserque>>&.)
8089 For all but Redis
8090 each item in the list is a slash-separated list of four
8091 items: host name, database name, user name, and password. In the case of
8092 Oracle, the host name field is used for the &"service name"&, and the database
8093 name field is not used and should be empty. For example:
8094 .code
8095 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8096 .endd
8097 Because password data is sensitive, you should always precede the setting with
8098 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8099 option. Here is an example where two MySQL servers are listed:
8100 .code
8101 hide mysql_servers = localhost/users/root/secret:\
8102                      otherhost/users/root/othersecret
8103 .endd
8104 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8105 because this is a colon-separated list, the colon has to be doubled. For each
8106 query, these parameter groups are tried in order until a connection is made and
8107 a query is successfully processed. The result of a query may be that no data is
8108 found, but that is still a successful query. In other words, the list of
8109 servers provides a backup facility, not a list of different places to look.
8110
8111 For Redis the global option need not be specified if all queries contain their
8112 own server information &-- see section &<<SECTspeserque>>&.
8113 If specified, the option must be set to a colon-separated list of server
8114 information.
8115 Each item in the list is a slash-separated list of three items:
8116 host, database number, and password.
8117 .olist
8118 The host is required and may be either an IPv4 address and optional
8119 port number (separated by a colon, which needs doubling due to the
8120 higher-level list), or a Unix socket pathname enclosed in parentheses
8121 .next
8122 The database number is optional; if present that number is selected in the backend
8123 .next
8124 The password is optional; if present it is used to authenticate to the backend
8125 .endlist
8126
8127 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8128 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8129 respectively, and the characters single-quote, double-quote, and backslash
8130 itself are escaped with backslashes.
8131
8132 The &%quote_redis%& expansion operator
8133 escapes whitespace and backslash characters with a backslash.
8134
8135 .subsection "Specifying the server in the query" SECTspeserque
8136 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8137 it is possible to specify a list of servers with an individual query. This is
8138 done by appending a comma-separated option to the query type:
8139 .display
8140 &`,servers=`&&'server1:server2:server3:...'&
8141 .endd
8142 Each item in the list may take one of two forms:
8143 .olist
8144 If it contains no slashes it is assumed to be just a host name. The appropriate
8145 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8146 of the same name, and the remaining parameters (database, user, password) are
8147 taken from there.
8148 .next
8149 If it contains any slashes, it is taken as a complete parameter set.
8150 .endlist
8151 The list of servers is used in exactly the same way as the global list.
8152 Once a connection to a server has happened and a query has been
8153 successfully executed, processing of the lookup ceases.
8154
8155 This feature is intended for use in master/slave situations where updates
8156 are occurring and you want to update the master rather than a slave. If the
8157 master is in the list as a backup for reading, you might have a global setting
8158 like this:
8159 .code
8160 mysql_servers = slave1/db/name/pw:\
8161                 slave2/db/name/pw:\
8162                 master/db/name/pw
8163 .endd
8164 In an updating lookup, you could then write:
8165 .code
8166 ${lookup mysql,servers=master {UPDATE ...} }
8167 .endd
8168 That query would then be sent only to the master server. If, on the other hand,
8169 the master is not to be used for reading, and so is not present in the global
8170 option, you can still update it by a query of this form:
8171 .code
8172 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8173 .endd
8174
8175 An older syntax places the servers specification before the query,
8176 semicolon separated:
8177 .code
8178 ${lookup mysql{servers=master; UPDATE ...} }
8179 .endd
8180 The new version avoids potential issues with tainted
8181 arguments in the query, for explicit expansion.
8182 &*Note*&: server specifications in list-style lookups are still problematic.
8183
8184
8185 .subsection "Special MySQL features" SECID73
8186 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8187 causes a connection to the server on the local host by means of a Unix domain
8188 socket. An alternate socket can be specified in parentheses.
8189 An option group name for MySQL option files can be specified in square brackets;
8190 the default value is &"exim"&.
8191 The full syntax of each item in &%mysql_servers%& is:
8192 .display
8193 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8194   <&'database'&>/<&'user'&>/<&'password'&>
8195 .endd
8196 Any of the four sub-parts of the first field can be omitted. For normal use on
8197 the local host it can be left blank or set to just &"localhost"&.
8198
8199 No database need be supplied &-- but if it is absent here, it must be given in
8200 the queries.
8201
8202 If a MySQL query is issued that does not request any data (an insert, update,
8203 or delete command), the result of the lookup is the number of rows affected.
8204
8205 &*Warning*&: This can be misleading. If an update does not actually change
8206 anything (for example, setting a field to the value it already has), the result
8207 is zero because no rows are affected.
8208
8209
8210 .subsection "Special PostgreSQL features" SECID74
8211 PostgreSQL lookups can also use Unix domain socket connections to the database.
8212 This is usually faster and costs less CPU time than a TCP/IP connection.
8213 However it can be used only if the mail server runs on the same machine as the
8214 database server. A configuration line for PostgreSQL via Unix domain sockets
8215 looks like this:
8216 .code
8217 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8218 .endd
8219 In other words, instead of supplying a host name, a path to the socket is
8220 given. The path name is enclosed in parentheses so that its slashes aren't
8221 visually confused with the delimiters for the other server parameters.
8222
8223 If a PostgreSQL query is issued that does not request any data (an insert,
8224 update, or delete command), the result of the lookup is the number of rows
8225 affected.
8226
8227 .subsection "More about SQLite" SECTsqlite
8228 .cindex "lookup" "SQLite"
8229 .cindex "sqlite lookup type"
8230 SQLite is different to the other SQL lookups because a filename is required in
8231 addition to the SQL query. An SQLite database is a single file, and there is no
8232 daemon as in the other SQL databases.
8233
8234 .oindex &%sqlite_dbfile%&
8235 There are two ways of
8236 specifying the file.
8237 The first is by using the &%sqlite_dbfile%& main option.
8238 The second, which allows separate files for each query,
8239 is to use an option appended, comma-separated, to the &"sqlite"&
8240 lookup type word.  The option is the word &"file"&, then an equals,
8241 then the filename.
8242 The filename in this case cannot contain whitespace or open-brace charachters.
8243
8244 A deprecated method is available, prefixing the query with the filename
8245 separated by white space.
8246 This means that
8247 .cindex "tainted data" "sqlite file"
8248 the query cannot use any tainted values, as that taints
8249 the entire query including the filename - resulting in a refusal to open
8250 the file.
8251
8252 In all the above cases the filename must be an absolute path.
8253
8254 Here is a lookup expansion example:
8255 .code
8256 sqlite_dbfile = /some/thing/sqlitedb
8257 ...
8258 ${lookup sqlite {select name from aliases where id='userx';}}
8259 .endd
8260 In a list, the syntax is similar. For example:
8261 .code
8262 domainlist relay_to_domains = sqlite;\
8263    select * from relays where ip='$sender_host_address';
8264 .endd
8265 The only character affected by the &%quote_sqlite%& operator is a single
8266 quote, which it doubles.
8267
8268 .cindex timeout SQLite
8269 .cindex sqlite "lookup timeout"
8270 The SQLite library handles multiple simultaneous accesses to the database
8271 internally. Multiple readers are permitted, but only one process can
8272 update at once. Attempts to access the database while it is being updated
8273 are rejected after a timeout period, during which the SQLite library
8274 waits for the lock to be released. In Exim, the default timeout is set
8275 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8276 option.
8277
8278 .subsection "More about Redis" SECTredis
8279 .cindex "lookup" "Redis"
8280 .cindex "redis lookup type"
8281 Redis is a non-SQL database. Commands are simple get and set.
8282 Examples:
8283 .code
8284 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8285 ${lookup redis{get keyname}}
8286 .endd
8287
8288 As of release 4.91, "lightweight" support for Redis Cluster is available.
8289 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8290 of which must be reachable from the running exim instance. If the cluster has
8291 master/slave replication, the list must contain all the master and slave
8292 servers.
8293
8294 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8295 immediately follow the redirection but treats the response as a DEFER, moving on
8296 to the next server in the &%redis_servers%& list until the correct server is
8297 reached.
8298
8299 .ecindex IIDfidalo1
8300 .ecindex IIDfidalo2
8301
8302
8303 . ////////////////////////////////////////////////////////////////////////////
8304 . ////////////////////////////////////////////////////////////////////////////
8305
8306 .chapter "Domain, host, address, and local part lists" &&&
8307          "CHAPdomhosaddlists" &&&
8308          "Domain, host, and address lists"
8309 .scindex IIDdohoadli "lists of domains; hosts; etc."
8310 A number of Exim configuration options contain lists of domains, hosts,
8311 email addresses, or local parts. For example, the &%hold_domains%& option
8312 contains a list of domains whose delivery is currently suspended. These lists
8313 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8314 arguments to expansion conditions such as &%match_domain%&.
8315
8316 Each item in one of these lists is a pattern to be matched against a domain,
8317 host, email address, or local part, respectively. In the sections below, the
8318 different types of pattern for each case are described, but first we cover some
8319 general facilities that apply to all four kinds of list.
8320
8321 Note that other parts of Exim use a &'string list'& which does not
8322 support all the complexity available in
8323 domain, host, address and local part lists.
8324
8325
8326
8327 .section "Results of list checking" SECTlistresults
8328 The primary result of doing a list check is a truth value.
8329 In some contexts additional information is stored
8330 about the list element that matched:
8331 .vlist
8332 .vitem hosts
8333 A &%hosts%& ACL condition
8334 will store a result in the &$host_data$& variable.
8335 .vitem local_parts
8336 A &%local_parts%& router option or &%local_parts%& ACL condition
8337 will store a result in the &$local_part_data$& variable.
8338 .vitem domains
8339 A &%domains%& router option or &%domains%& ACL condition
8340 will store a result in the &$domain_data$& variable.
8341 .vitem senders
8342 A &%senders%& router option or &%senders%& ACL condition
8343 will store a result in the &$sender_data$& variable.
8344 .vitem recipients
8345 A &%recipients%& ACL condition
8346 will store a result in the &$recipient_data$& variable.
8347 .endlist
8348
8349 The detail of the additional information depends on the
8350 type of match and is given below as the &*value*& information.
8351
8352
8353
8354
8355 .section "Expansion of lists" "SECTlistexpand"
8356 .cindex "expansion" "of lists"
8357 Each list is expanded as a single string before it is used.
8358
8359 &'Exception: the router headers_remove option, where list-item
8360 splitting is done before string-expansion.'&
8361
8362 The result of
8363 expansion must be a list, possibly containing empty items, which is split up
8364 into separate items for matching. By default, colon is the separator character,
8365 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8366 &<<SECTempitelis>>& for details of the list syntax; the second of these
8367 discusses the way to specify empty list items.
8368
8369
8370 If the string expansion is forced to fail, Exim behaves as if the item it is
8371 testing (domain, host, address, or local part) is not in the list. Other
8372 expansion failures cause temporary errors.
8373
8374 If an item in a list is a regular expression, backslashes, dollars and possibly
8375 other special characters in the expression must be protected against
8376 misinterpretation by the string expander. The easiest way to do this is to use
8377 the &`\N`& expansion feature to indicate that the contents of the regular
8378 expression should not be expanded. For example, in an ACL you might have:
8379 .code
8380 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8381                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8382 .endd
8383 The first item is a regular expression that is protected from expansion by
8384 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8385 senders based on the receiving domain.
8386
8387
8388
8389
8390 .subsection "Negated items in lists" SECID76
8391 .cindex "list" "negation"
8392 .cindex "negation" "in lists"
8393 Items in a list may be positive or negative. Negative items are indicated by a
8394 leading exclamation mark, which may be followed by optional white space. A list
8395 defines a set of items (domains, etc). When Exim processes one of these lists,
8396 it is trying to find out whether a domain, host, address, or local part
8397 (respectively) is in the set that is defined by the list. It works like this:
8398
8399 The list is scanned from left to right. If a positive item is matched, the
8400 subject that is being checked is in the set; if a negative item is matched, the
8401 subject is not in the set. If the end of the list is reached without the
8402 subject having matched any of the patterns, it is in the set if the last item
8403 was a negative one, but not if it was a positive one. For example, the list in
8404 .code
8405 domainlist relay_to_domains = !a.b.c : *.b.c
8406 .endd
8407 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8408 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8409 list is positive. However, if the setting were
8410 .code
8411 domainlist relay_to_domains = !a.b.c
8412 .endd
8413 then all domains other than &'a.b.c'& would match because the last item in the
8414 list is negative. In other words, a list that ends with a negative item behaves
8415 as if it had an extra item &`:*`& on the end.
8416
8417 Another way of thinking about positive and negative items in lists is to read
8418 the connector as &"or"& after a positive item and as &"and"& after a negative
8419 item.
8420
8421
8422
8423 .subsection "File names in lists" SECTfilnamlis
8424 .cindex "list" "filename in"
8425 If an item in a domain, host, address, or local part list is an absolute
8426 filename (beginning with a slash character), each line of the file is read and
8427 processed as if it were an independent item in the list, except that further
8428 filenames are not allowed,
8429 and no expansion of the data from the file takes place.
8430 Empty lines in the file are ignored, and the file may also contain comment
8431 lines:
8432
8433 .ilist
8434 For domain and host lists, if a # character appears anywhere in a line of the
8435 file, it and all following characters are ignored.
8436 .next
8437 Because local parts may legitimately contain # characters, a comment in an
8438 address list or local part list file is recognized only if # is preceded by
8439 white space or the start of the line. For example:
8440 .code
8441 not#comment@x.y.z   # but this is a comment
8442 .endd
8443 .endlist
8444
8445 Putting a filename in a list has the same effect as inserting each line of the
8446 file as an item in the list (blank lines and comments excepted). However, there
8447 is one important difference: the file is read each time the list is processed,
8448 so if its contents vary over time, Exim's behaviour changes.
8449
8450 If a filename is preceded by an exclamation mark, the sense of any match
8451 within the file is inverted. For example, if
8452 .code
8453 hold_domains = !/etc/nohold-domains
8454 .endd
8455 and the file contains the lines
8456 .code
8457 !a.b.c
8458 *.b.c
8459 .endd
8460 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8461 any domain matching &`*.b.c`& is not.
8462
8463
8464
8465 .subsection "An lsearch file is not an out-of-line list" SECID77
8466 As will be described in the sections that follow, lookups can be used in lists
8467 to provide indexed methods of checking list membership. There has been some
8468 confusion about the way &(lsearch)& lookups work in lists. Because
8469 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8470 sometimes thought that it is allowed to contain wild cards and other kinds of
8471 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8472 always fixed strings, just as for any other single-key lookup type.
8473
8474 If you want to use a file to contain wild-card patterns that form part of a
8475 list, just give the filename on its own, without a search type, as described
8476 in the previous section. You could also use the &(wildlsearch)& or
8477 &(nwildlsearch)&, but there is no advantage in doing this.
8478
8479
8480
8481
8482 .subsection "Named lists" SECTnamedlists
8483 .cindex "named lists"
8484 .cindex "list" "named"
8485 A list of domains, hosts, email addresses, or local parts can be given a name
8486 which is then used to refer to the list elsewhere in the configuration. This is
8487 particularly convenient if the same list is required in several different
8488 places. It also allows lists to be given meaningful names, which can improve
8489 the readability of the configuration. For example, it is conventional to define
8490 a domain list called &'local_domains'& for all the domains that are handled
8491 locally on a host, using a configuration line such as
8492 .code
8493 domainlist local_domains = localhost:my.dom.example
8494 .endd
8495 Named lists are referenced by giving their name preceded by a plus sign, so,
8496 for example, a router that is intended to handle local domains would be
8497 configured with the line
8498 .code
8499 domains = +local_domains
8500 .endd
8501 The first router in a configuration is often one that handles all domains
8502 except the local ones, using a configuration with a negated item like this:
8503 .code
8504 dnslookup:
8505   driver = dnslookup
8506   domains = ! +local_domains
8507   transport = remote_smtp
8508   no_more
8509 .endd
8510 The four kinds of named list are created by configuration lines starting with
8511 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8512 respectively. Then there follows the name that you are defining, followed by an
8513 equals sign and the list itself. For example:
8514 .code
8515 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8516 addresslist bad_senders = cdb;/etc/badsenders
8517 .endd
8518 A named list may refer to other named lists:
8519 .code
8520 domainlist  dom1 = first.example : second.example
8521 domainlist  dom2 = +dom1 : third.example
8522 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8523 .endd
8524 &*Warning*&: If the last item in a referenced list is a negative one, the
8525 effect may not be what you intended, because the negation does not propagate
8526 out to the higher level. For example, consider:
8527 .code
8528 domainlist  dom1 = !a.b
8529 domainlist  dom2 = +dom1 : *.b
8530 .endd
8531 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8532 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8533 means it matches the second list as well. The effect is not the same as
8534 .code
8535 domainlist  dom2 = !a.b : *.b
8536 .endd
8537 where &'x.y'& does not match. It's best to avoid negation altogether in
8538 referenced lists if you can.
8539
8540 .cindex "hiding named list values"
8541 .cindex "named lists" "hiding value of"
8542 Some named list definitions may contain sensitive data, for example, passwords for
8543 accessing databases. To stop non-admin users from using the &%-bP%& command
8544 line option to read these values, you can precede the definition with the
8545 word &"hide"&. For example:
8546 .code
8547 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8548 .endd
8549
8550
8551 Named lists may have a performance advantage. When Exim is routing an
8552 address or checking an incoming message, it caches the result of tests on named
8553 lists. So, if you have a setting such as
8554 .code
8555 domains = +local_domains
8556 .endd
8557 on several of your routers
8558 or in several ACL statements,
8559 the actual test is done only for the first one. However, the caching works only
8560 if there are no expansions within the list itself or any sublists that it
8561 references. In other words, caching happens only for lists that are known to be
8562 the same each time they are referenced.
8563
8564 By default, there may be up to 16 named lists of each type. This limit can be
8565 extended by changing a compile-time variable. The use of domain and host lists
8566 is recommended for concepts such as local domains, relay domains, and relay
8567 hosts. The default configuration is set up like this.
8568
8569
8570
8571 .subsection "Named lists compared with macros" SECID78
8572 .cindex "list" "named compared with macro"
8573 .cindex "macro" "compared with named list"
8574 At first sight, named lists might seem to be no different from macros in the
8575 configuration file. However, macros are just textual substitutions. If you
8576 write
8577 .code
8578 ALIST = host1 : host2
8579 auth_advertise_hosts = !ALIST
8580 .endd
8581 it probably won't do what you want, because that is exactly the same as
8582 .code
8583 auth_advertise_hosts = !host1 : host2
8584 .endd
8585 Notice that the second host name is not negated. However, if you use a host
8586 list, and write
8587 .code
8588 hostlist alist = host1 : host2
8589 auth_advertise_hosts = ! +alist
8590 .endd
8591 the negation applies to the whole list, and so that is equivalent to
8592 .code
8593 auth_advertise_hosts = !host1 : !host2
8594 .endd
8595
8596
8597 .subsection "Named list caching" SECID79
8598 .cindex "list" "caching of named"
8599 .cindex "caching" "named lists"
8600 While processing a message, Exim caches the result of checking a named list if
8601 it is sure that the list is the same each time. In practice, this means that
8602 the cache operates only if the list contains no $ characters, which guarantees
8603 that it will not change when it is expanded. Sometimes, however, you may have
8604 an expanded list that you know will be the same each time within a given
8605 message. For example:
8606 .code
8607 domainlist special_domains = \
8608            ${lookup{$sender_host_address}cdb{/some/file}}
8609 .endd
8610 This provides a list of domains that depends only on the sending host's IP
8611 address. If this domain list is referenced a number of times (for example,
8612 in several ACL lines, or in several routers) the result of the check is not
8613 cached by default, because Exim does not know that it is going to be the
8614 same list each time.
8615
8616 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8617 cache the result anyway. For example:
8618 .code
8619 domainlist_cache special_domains = ${lookup{...
8620 .endd
8621 If you do this, you should be absolutely sure that caching is going to do
8622 the right thing in all cases. When in doubt, leave it out.
8623
8624
8625
8626 .section "Domain lists" "SECTdomainlist"
8627 .cindex "domain list" "patterns for"
8628 .cindex "list" "domain list"
8629 Domain lists contain patterns that are to be matched against a mail domain.
8630 The following types of item may appear in domain lists:
8631
8632 .ilist
8633 .cindex "primary host name"
8634 .cindex "host name" "matched in domain list"
8635 .oindex "&%primary_hostname%&"
8636 .cindex "domain list" "matching primary host name"
8637 .cindex "@ in a domain list"
8638 If a pattern consists of a single @ character, it matches the local host name,
8639 as set by the &%primary_hostname%& option (or defaulted). This makes it
8640 possible to use the same configuration file on several different hosts that
8641 differ only in their names.
8642
8643 The value for a match will be the primary host name.
8644
8645
8646 .next
8647 .cindex "@[] in a domain list"
8648 .cindex "domain list" "matching local IP interfaces"
8649 .cindex "domain literal"
8650 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8651 in square brackets (as in an email address that contains a domain literal), but
8652 only if that IP address is recognized as local for email routing purposes. The
8653 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8654 control which of a host's several IP addresses are treated as local.
8655 In today's Internet, the use of domain literals is controversial;
8656 see the &%allow_domain_literals%& main option.
8657
8658 The value for a match will be the string &`@[]`&.
8659
8660
8661 .next
8662 .cindex "@mx_any"
8663 .cindex "@mx_primary"
8664 .cindex "@mx_secondary"
8665 .cindex "domain list" "matching MX pointers to local host"
8666 If a pattern consists of the string &`@mx_any`& it matches any domain that
8667 has an MX record pointing to the local host or to any host that is listed in
8668 .oindex "&%hosts_treat_as_local%&"
8669 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8670 are similar, except that the first matches only when a primary MX target is the
8671 local host, and the second only when no primary MX target is the local host,
8672 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8673 preference value &-- there may of course be more than one of them.
8674
8675 The MX lookup that takes place when matching a pattern of this type is
8676 performed with the resolver options for widening names turned off. Thus, for
8677 example, a single-component domain will &'not'& be expanded by adding the
8678 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8679 options of the &(dnslookup)& router for a discussion of domain widening.
8680
8681 Sometimes you may want to ignore certain IP addresses when using one of these
8682 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8683 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8684 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8685 on a router). For example:
8686 .code
8687 domains = @mx_any/ignore=127.0.0.1
8688 .endd
8689 This example matches any domain that has an MX record pointing to one of
8690 the local host's IP addresses other than 127.0.0.1.
8691
8692 The list of IP addresses is in fact processed by the same code that processes
8693 host lists, so it may contain CIDR-coded network specifications and it may also
8694 contain negative items.
8695
8696 Because the list of IP addresses is a sublist within a domain list, you have to
8697 be careful about delimiters if there is more than one address. Like any other
8698 list, the default delimiter can be changed. Thus, you might have:
8699 .code
8700 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8701           an.other.domain : ...
8702 .endd
8703 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8704 involved, it is easiest to change the delimiter for the main list as well:
8705 .code
8706 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8707           an.other.domain ? ...
8708 .endd
8709 The value for a match will be the list element string (starting &`@mx_`&).
8710
8711
8712 .next
8713 .cindex "asterisk" "in domain list"
8714 .cindex "domain list" "asterisk in"
8715 .cindex "domain list" "matching &""ends with""&"
8716 If a pattern starts with an asterisk, the remaining characters of the pattern
8717 are compared with the terminating characters of the domain. The use of &"*"& in
8718 domain lists differs from its use in partial matching lookups. In a domain
8719 list, the character following the asterisk need not be a dot, whereas partial
8720 matching works only in terms of dot-separated components. For example, a domain
8721 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8722 &'cipher.key.ex'&.
8723
8724 The value for a match will be the list element string (starting with the asterisk).
8725 Additionally, &$0$& will be set to the matched string
8726 and &$1$& to the variable portion which the asterisk matched.
8727
8728 .next
8729 .cindex "regular expressions" "in domain list"
8730 .cindex "domain list" "matching regular expression"
8731 If a pattern starts with a circumflex character, it is treated as a regular
8732 expression, and matched against the domain using a regular expression matching
8733 function. The circumflex is treated as part of the regular expression.
8734 Email domains are case-independent, so this regular expression match is by
8735 default case-independent, but you can make it case-dependent by starting it
8736 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8737 are given in chapter &<<CHAPregexp>>&.
8738
8739 &*Warning*&: Because domain lists are expanded before being processed, you
8740 must escape any backslash and dollar characters in the regular expression, or
8741 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8742 it is not to be expanded (unless you really do want to build a regular
8743 expression by expansion, of course).
8744
8745 The value for a match will be the list element string (starting with the circumflex).
8746 Additionally, &$0$& will be set to the string matching the regular expression,
8747 and &$1$& (onwards) to any submatches identified by parentheses.
8748
8749
8750
8751 .next
8752 .cindex "lookup" "in domain list"
8753 .cindex "domain list" "matching by lookup"
8754 If a pattern starts with the name of a single-key lookup type followed by a
8755 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8756 must be a filename in a suitable format for the lookup type. For example, for
8757 &"cdb;"& it must be an absolute path:
8758 .code
8759 domains = cdb;/etc/mail/local_domains.cdb
8760 .endd
8761 The appropriate type of lookup is done on the file using the domain name as the
8762 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8763 only in whether or not the key is present in the file. However, when a lookup
8764 is used for the &%domains%& option on a router
8765 or a &%domains%& condition in an ACL statement, the value is preserved in the
8766 &$domain_data$& variable and can be referred to in other router options or
8767 other statements in the same ACL.
8768 .cindex "tainted data" "de-tainting"
8769 .cindex "de-tainting" "using ACL domains condition"
8770 The value will be untainted.
8771
8772 &*Note*&: If the data result of the lookup (as opposed to the key)
8773 is empty, then this empty value is stored in &$domain_data$&.
8774 The option to return the key for the lookup, as the value,
8775 may be what is wanted.
8776
8777
8778 .next
8779 Any of the single-key lookup type names may be preceded by
8780 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8781 .code
8782 domains = partial-dbm;/partial/domains
8783 .endd
8784 This causes partial matching logic to be invoked; a description of how this
8785 works is given in section &<<SECTpartiallookup>>&.
8786
8787 .next
8788 .cindex "asterisk" "in lookup type"
8789 Any of the single-key lookup types may be followed by an asterisk. This causes
8790 a default lookup for a key consisting of a single asterisk to be done if the
8791 original lookup fails. This is not a useful feature when using a domain list to
8792 select particular domains (because any domain would match), but it might have
8793 value if the result of the lookup is being used via the &$domain_data$&
8794 expansion variable.
8795
8796 .next
8797 If the pattern starts with the name of a query-style lookup type followed by a
8798 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8799 pattern must be an appropriate query for the lookup type, as described in
8800 chapter &<<CHAPfdlookup>>&. For example:
8801 .code
8802 hold_domains = mysql;select domain from holdlist \
8803   where domain = '${quote_mysql:$domain}';
8804 .endd
8805 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8806 example, it doesn't matter what field you select). Exim is interested only in
8807 whether or not the query succeeds. However, when a lookup is used for the
8808 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8809 variable and can be referred to in other options.
8810 .cindex "tainted data" "de-tainting"
8811 .cindex "de-tainting" "using router domains option"
8812 The value will be untainted.
8813
8814 .next
8815 If the pattern starts with the name of a lookup type
8816 of either kind (single-key or query-style) it may be
8817 followed by a comma and options,
8818 The options are lookup-type specific and consist of a comma-separated list.
8819 Each item starts with a tag and and equals "=" sign.
8820
8821 .next
8822 .cindex "domain list" "matching literal domain name"
8823 If none of the above cases apply, a caseless textual comparison is made
8824 between the pattern and the domain.
8825
8826 The value for a match will be the list element string.
8827 .cindex "tainted data" "de-tainting"
8828 Note that this is commonly untainted
8829 (depending on the way the list was created).
8830 Specifically, explicit text in the configuration file in not tainted.
8831 This is a useful way of obtaining an untainted equivalent to
8832 the domain, for later operations.
8833
8834 However if the list (including one-element lists)
8835 is created by expanding a variable containing tainted data,
8836 it is tainted and so will the match value be.
8837 .endlist
8838
8839
8840 Here is an example that uses several different kinds of pattern:
8841 .code
8842 domainlist funny_domains = \
8843   @ : \
8844   lib.unseen.edu : \
8845   *.foundation.fict.example : \
8846   \N^[1-2]\d{3}\.fict\.example$\N : \
8847   partial-dbm;/opt/data/penguin/book : \
8848   nis;domains.byname : \
8849   nisplus;[name=$domain,status=local],domains.org_dir
8850 .endd
8851 There are obvious processing trade-offs among the various matching modes. Using
8852 an asterisk is faster than a regular expression, and listing a few names
8853 explicitly probably is too. The use of a file or database lookup is expensive,
8854 but may be the only option if hundreds of names are required. Because the
8855 patterns are tested in order, it makes sense to put the most commonly matched
8856 patterns earlier.
8857
8858
8859
8860 .section "Host lists" "SECThostlist"
8861 .cindex "host list" "patterns in"
8862 .cindex "list" "host list"
8863 Host lists are used to control what remote hosts are allowed to do. For
8864 example, some hosts may be allowed to use the local host as a relay, and some
8865 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8866 two different ways, by name or by IP address. In a host list, some types of
8867 pattern are matched to a host name, and some are matched to an IP address.
8868 You need to be particularly careful with this when single-key lookups are
8869 involved, to ensure that the right value is being used as the key.
8870
8871
8872 .subsection "Special host list patterns" SECID80
8873 .cindex "empty item in hosts list"
8874 .cindex "host list" "empty string in"
8875 If a host list item is the empty string, it matches only when no remote host is
8876 involved. This is the case when a message is being received from a local
8877 process using SMTP on the standard input, that is, when a TCP/IP connection is
8878 not used.
8879
8880 .cindex "asterisk" "in host list"
8881 The special pattern &"*"& in a host list matches any host or no host. Neither
8882 the IP address nor the name is actually inspected.
8883
8884
8885
8886 .subsection "Host list patterns that match by IP address" SECThoslispatip
8887 .cindex "host list" "matching IP addresses"
8888 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8889 the incoming address actually appears in the IPv6 host as
8890 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8891 list, it is converted into a traditional IPv4 address first. (Not all operating
8892 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8893 concerns.)
8894
8895 The following types of pattern in a host list check the remote host by
8896 inspecting its IP address:
8897
8898 .ilist
8899 If the pattern is a plain domain name (not a regular expression, not starting
8900 with *, not a lookup of any kind), Exim calls the operating system function
8901 to find the associated IP address(es). Exim uses the newer
8902 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8903 This typically causes a forward DNS lookup of the name. The result is compared
8904 with the IP address of the subject host.
8905
8906 If there is a temporary problem (such as a DNS timeout) with the host name
8907 lookup, a temporary error occurs. For example, if the list is being used in an
8908 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8909 temporary SMTP error code. If no IP address can be found for the host name,
8910 what happens is described in section &<<SECTbehipnot>>& below.
8911
8912 .next
8913 .cindex "@ in a host list"
8914 If the pattern is &"@"&, the primary host name is substituted and used as a
8915 domain name, as just described.
8916
8917 .next
8918 If the pattern is an IP address, it is matched against the IP address of the
8919 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8920 IPv6 addresses can be given in colon-separated format, but the colons have to
8921 be doubled so as not to be taken as item separators when the default list
8922 separator is used. IPv6 addresses are recognized even when Exim is compiled
8923 without IPv6 support. This means that if they appear in a host list on an
8924 IPv4-only host, Exim will not treat them as host names. They are just addresses
8925 that can never match a client host.
8926
8927 .next
8928 .cindex "@[] in a host list"
8929 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8930 the local host. For example, if the local host is an IPv4 host with one
8931 interface address 10.45.23.56, these two ACL statements have the same effect:
8932 .code
8933 accept hosts = 127.0.0.1 : 10.45.23.56
8934 accept hosts = @[]
8935 .endd
8936 .next
8937 .cindex "CIDR notation"
8938 If the pattern is an IP address followed by a slash and a mask length, for
8939 example
8940 .code
8941 10.11.42.0/24
8942 .endd
8943 , it is matched against the IP address of the subject
8944 host under the given mask. This allows an entire network of hosts to be
8945 included (or excluded) by a single item. The mask uses CIDR notation; it
8946 specifies the number of address bits that must match, starting from the most
8947 significant end of the address.
8948
8949 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8950 of a range of addresses. It is the number of bits in the network portion of the
8951 address. The above example specifies a 24-bit netmask, so it matches all 256
8952 addresses in the 10.11.42.0 network. An item such as
8953 .code
8954 192.168.23.236/31
8955 .endd
8956 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8957 32 for an IPv4 address is the same as no mask at all; just a single address
8958 matches.
8959
8960 Here is another example which shows an IPv4 and an IPv6 network:
8961 .code
8962 recipient_unqualified_hosts = 192.168.0.0/16: \
8963                               3ffe::ffff::836f::::/48
8964 .endd
8965 The doubling of list separator characters applies only when these items
8966 appear inline in a host list. It is not required when indirecting via a file.
8967 For example:
8968 .code
8969 recipient_unqualified_hosts = /opt/exim/unqualnets
8970 .endd
8971 could make use of a file containing
8972 .code
8973 172.16.0.0/12
8974 3ffe:ffff:836f::/48
8975 .endd
8976 to have exactly the same effect as the previous example. When listing IPv6
8977 addresses inline, it is usually more convenient to use the facility for
8978 changing separator characters. This list contains the same two networks:
8979 .code
8980 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8981                                  3ffe:ffff:836f::/48
8982 .endd
8983 The separator is changed to semicolon by the leading &"<;"& at the start of the
8984 list.
8985 .endlist
8986
8987
8988
8989 .subsection "Host list patterns for single-key lookups by host address" &&&
8990          SECThoslispatsikey
8991 .cindex "host list" "lookup of IP address"
8992 When a host is to be identified by a single-key lookup of its complete IP
8993 address, the pattern takes this form:
8994 .display
8995 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8996 .endd
8997 For example:
8998 .code
8999 hosts_lookup = net-cdb;/hosts-by-ip.db
9000 .endd
9001 The text form of the IP address of the subject host is used as the lookup key.
9002 IPv6 addresses are converted to an unabbreviated form, using lower case
9003 letters, with dots as separators because colon is the key terminator in
9004 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9005 quoting the keys, but this is a facility that was added later.] The data
9006 returned by the lookup is not used.
9007
9008 .cindex "IP address" "masking"
9009 .cindex "host list" "masked IP address"
9010 Single-key lookups can also be performed using masked IP addresses, using
9011 patterns of this form:
9012 .display
9013 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9014 .endd
9015 For example:
9016 .code
9017 net24-dbm;/networks.db
9018 .endd
9019 The IP address of the subject host is masked using <&'number'&> as the mask
9020 length. A textual string is constructed from the masked value, followed by the
9021 mask, and this is used as the lookup key. For example, if the host's IP address
9022 is 192.168.34.6, the key that is looked up for the above example is
9023 &"192.168.34.0/24"&.
9024
9025 When an IPv6 address is converted to a string, dots are normally used instead
9026 of colons, so that keys in &(lsearch)& files need not contain colons (which
9027 terminate &(lsearch)& keys). This was implemented some time before the ability
9028 to quote keys was made available in &(lsearch)& files. However, the more
9029 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9030 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9031 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9032 converted using colons and not dots.
9033 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9034 addresses are always used.
9035 The latter are converted to IPv4 addresses, in dotted-quad form.
9036
9037 Ideally, it would be nice to tidy up this anomalous situation by changing to
9038 colons in all cases, given that quoting is now available for &(lsearch)&.
9039 However, this would be an incompatible change that might break some existing
9040 configurations.
9041
9042 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9043 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9044 the former case the key strings include the mask value, whereas in the latter
9045 case the IP address is used on its own.
9046
9047
9048
9049 .subsection "Host list patterns that match by host name" SECThoslispatnam
9050 .cindex "host" "lookup failures"
9051 .cindex "unknown host name"
9052 .cindex "host list" "matching host name"
9053 There are several types of pattern that require Exim to know the name of the
9054 remote host. These are either wildcard patterns or lookups by name. (If a
9055 complete hostname is given without any wildcarding, it is used to find an IP
9056 address to match against, as described in section &<<SECThoslispatip>>&
9057 above.)
9058
9059 If the remote host name is not already known when Exim encounters one of these
9060 patterns, it has to be found from the IP address.
9061 Although many sites on the Internet are conscientious about maintaining reverse
9062 DNS data for their hosts, there are also many that do not do this.
9063 Consequently, a name cannot always be found, and this may lead to unwanted
9064 effects. Take care when configuring host lists with wildcarded name patterns.
9065 Consider what will happen if a name cannot be found.
9066
9067 Because of the problems of determining host names from IP addresses, matching
9068 against host names is not as common as matching against IP addresses.
9069
9070 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9071 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9072 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9073 are done can be changed by setting the &%host_lookup_order%& option. For
9074 security, once Exim has found one or more names, it looks up the IP addresses
9075 for these names and compares them with the IP address that it started with.
9076 Only those names whose IP addresses match are accepted. Any other names are
9077 discarded. If no names are left, Exim behaves as if the host name cannot be
9078 found. In the most common case there is only one name and one IP address.
9079
9080 There are some options that control what happens if a host name cannot be
9081 found. These are described in section &<<SECTbehipnot>>& below.
9082
9083 .cindex "host" "alias for"
9084 .cindex "alias for host"
9085 As a result of aliasing, hosts may have more than one name. When processing any
9086 of the following types of pattern, all the host's names are checked:
9087
9088 .ilist
9089 .cindex "asterisk" "in host list"
9090 If a pattern starts with &"*"& the remainder of the item must match the end of
9091 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9092 &'.b.c'&. This special simple form is provided because this is a very common
9093 requirement. Other kinds of wildcarding require the use of a regular
9094 expression.
9095 .next
9096 .cindex "regular expressions" "in host list"
9097 .cindex "host list" "regular expression in"
9098 If the item starts with &"^"& it is taken to be a regular expression which is
9099 matched against the host name. Host names are case-independent, so this regular
9100 expression match is by default case-independent, but you can make it
9101 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9102 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9103 example,
9104 .code
9105 ^(a|b)\.c\.d$
9106 .endd
9107 is a regular expression that matches either of the two hosts &'a.c.d'& or
9108 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9109 that backslash and dollar characters are not misinterpreted as part of the
9110 string expansion. The simplest way to do this is to use &`\N`& to mark that
9111 part of the string as non-expandable. For example:
9112 .code
9113 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9114 .endd
9115 &*Warning*&: If you want to match a complete host name, you must include the
9116 &`$`& terminating metacharacter in the regular expression, as in the above
9117 example. Without it, a match at the start of the host name is all that is
9118 required.
9119 .endlist
9120
9121
9122
9123
9124 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9125 .cindex "host" "lookup failures, permanent"
9126 While processing a host list, Exim may need to look up an IP address from a
9127 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9128 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9129 behaviour when it fails to find the information it is seeking is the same.
9130
9131 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9132 apply to temporary DNS errors, whose handling is described in the next section.
9133
9134 .cindex "&`+include_unknown`&"
9135 .cindex "&`+ignore_unknown`&"
9136 Exim parses a host list from left to right. If it encounters a permanent
9137 lookup failure in any item in the host list before it has found a match,
9138 Exim treats it as a failure and the default behavior is as if the host
9139 does not match the list. This may not always be what you want to happen.
9140 To change Exim's behaviour, the special items &`+include_unknown`& or
9141 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9142 not recognized in an indirected file).
9143
9144 .ilist
9145 If any item that follows &`+include_unknown`& requires information that
9146 cannot found, Exim behaves as if the host does match the list. For example,
9147 .code
9148 host_reject_connection = +include_unknown:*.enemy.ex
9149 .endd
9150 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9151 any hosts whose name it cannot find.
9152
9153 .next
9154 If any item that follows &`+ignore_unknown`& requires information that cannot
9155 be found, Exim ignores that item and proceeds to the rest of the list. For
9156 example:
9157 .code
9158 accept hosts = +ignore_unknown : friend.example : \
9159                192.168.4.5
9160 .endd
9161 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9162 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9163 name can be found for 192.168.4.5, it is rejected.
9164 .endlist
9165
9166 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9167 list. The effect of each one lasts until the next, or until the end of the
9168 list.
9169
9170 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9171          SECTmixwilhos
9172 .cindex "host list" "mixing names and addresses in"
9173
9174 This section explains the host/ip processing logic with the same concepts
9175 as the previous section, but specifically addresses what happens when a
9176 wildcarded hostname is one of the items in the hostlist.
9177
9178 .ilist
9179 If you have name lookups or wildcarded host names and
9180 IP addresses in the same host list, you should normally put the IP
9181 addresses first. For example, in an ACL you could have:
9182 .code
9183 accept hosts = 10.9.8.7 : *.friend.example
9184 .endd
9185 The reason you normally would order it this way lies in the
9186 left-to-right way that Exim processes lists.  It can test IP addresses
9187 without doing any DNS lookups, but when it reaches an item that requires
9188 a host name, it fails if it cannot find a host name to compare with the
9189 pattern. If the above list is given in the opposite order, the
9190 &%accept%& statement fails for a host whose name cannot be found, even
9191 if its IP address is 10.9.8.7.
9192
9193 .next
9194 If you really do want to do the name check first, and still recognize the IP
9195 address, you can rewrite the ACL like this:
9196 .code
9197 accept hosts = *.friend.example
9198 accept hosts = 10.9.8.7
9199 .endd
9200 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9201 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9202 &`+ignore_unknown`&, which was discussed in depth in the first example in
9203 this section.
9204 .endlist
9205
9206
9207 .subsection "Temporary DNS errors when looking up host information" &&&
9208          SECTtemdnserr
9209 .cindex "host" "lookup failures, temporary"
9210 .cindex "&`+include_defer`&"
9211 .cindex "&`+ignore_defer`&"
9212 A temporary DNS lookup failure normally causes a defer action (except when
9213 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9214 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9215 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9216 section. These options should be used with care, probably only in non-critical
9217 host lists such as whitelists.
9218
9219
9220
9221 .subsection "Host list patterns for single-key lookups by host name" &&&
9222          SECThoslispatnamsk
9223 .cindex "unknown host name"
9224 .cindex "host list" "matching host name"
9225 If a pattern is of the form
9226 .display
9227 <&'single-key-search-type'&>;<&'search-data'&>
9228 .endd
9229 for example
9230 .code
9231 dbm;/host/accept/list
9232 .endd
9233 a single-key lookup is performed, using the host name as its key. If the
9234 lookup succeeds, the host matches the item. The actual data that is looked up
9235 is not used.
9236
9237 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9238 keys in the file, not IP addresses. If you want to do lookups based on IP
9239 addresses, you must precede the search type with &"net-"& (see section
9240 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9241 two items in the same list, one doing an address lookup and one doing a name
9242 lookup, both using the same file.
9243
9244
9245
9246 .subsection "Host list patterns for query-style lookups" SECID81
9247 If a pattern is of the form
9248 .display
9249 <&'query-style-search-type'&>;<&'query'&>
9250 .endd
9251 the query is obeyed, and if it succeeds, the host matches the item. The actual
9252 data that is looked up is not used. The variables &$sender_host_address$& and
9253 &$sender_host_name$& can be used in the query. For example:
9254 .code
9255 hosts_lookup = pgsql;\
9256   select ip from hostlist where ip='$sender_host_address'
9257 .endd
9258 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9259 can use the &%sg%& expansion item to change this if you need to. If you want to
9260 use masked IP addresses in database queries, you can use the &%mask%& expansion
9261 operator.
9262
9263 If the query contains a reference to &$sender_host_name$&, Exim automatically
9264 looks up the host name if it has not already done so. (See section
9265 &<<SECThoslispatnam>>& for comments on finding host names.)
9266
9267 Historical note: prior to release 4.30, Exim would always attempt to find a
9268 host name before running the query, unless the search type was preceded by
9269 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9270 still recognized for query-style lookups, but its presence or absence has no
9271 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9272 See section &<<SECThoslispatsikey>>&.)
9273
9274
9275
9276
9277
9278 .section "Address lists" "SECTaddresslist"
9279 .cindex "list" "address list"
9280 .cindex "address list" "empty item"
9281 .cindex "address list" "patterns"
9282 Address lists contain patterns that are matched against mail addresses. There
9283 is one special case to be considered: the sender address of a bounce message is
9284 always empty. You can test for this by providing an empty item in an address
9285 list. For example, you can set up a router to process bounce messages by
9286 using this option setting:
9287 .code
9288 senders = :
9289 .endd
9290 The presence of the colon creates an empty item. If you do not provide any
9291 data, the list is empty and matches nothing. The empty sender can also be
9292 detected by a regular expression that matches an empty string,
9293 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9294
9295 Non-empty items in an address list can be straightforward email addresses. For
9296 example:
9297 .code
9298 senders = jbc@askone.example : hs@anacreon.example
9299 .endd
9300 A certain amount of wildcarding is permitted. If a pattern contains an @
9301 character, but is not a regular expression and does not begin with a
9302 semicolon-terminated lookup type (described below), the local part of the
9303 subject address is compared with the local part of the pattern, which may start
9304 with an asterisk. If the local parts match, the domain is checked in exactly
9305 the same way as for a pattern in a domain list. For example, the domain can be
9306 wildcarded, refer to a named list, or be a lookup:
9307 .code
9308 deny senders = *@*.spamming.site:\
9309                *@+hostile_domains:\
9310                bozo@partial-lsearch;/list/of/dodgy/sites:\
9311                *@dbm;/bad/domains.db
9312 .endd
9313 .cindex "local part" "starting with !"
9314 .cindex "address list" "local part starting with !"
9315 If a local part that begins with an exclamation mark is required, it has to be
9316 specified using a regular expression, because otherwise the exclamation mark is
9317 treated as a sign of negation, as is standard in lists.
9318
9319 If a non-empty pattern that is not a regular expression or a lookup does not
9320 contain an @ character, it is matched against the domain part of the subject
9321 address. The only two formats that are recognized this way are a literal
9322 domain, or a domain pattern that starts with *. In both these cases, the effect
9323 is the same as if &`*@`& preceded the pattern. For example:
9324 .code
9325 deny senders = enemy.domain : *.enemy.domain
9326 .endd
9327
9328 The following kinds of more complicated address list pattern can match any
9329 address, including the empty address that is characteristic of bounce message
9330 senders:
9331
9332 .ilist
9333 .cindex "regular expressions" "in address list"
9334 .cindex "address list" "regular expression in"
9335 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9336 done against the complete address, with the pattern as the regular expression.
9337 You must take care that backslash and dollar characters are not misinterpreted
9338 as part of the string expansion. The simplest way to do this is to use &`\N`&
9339 to mark that part of the string as non-expandable. For example:
9340 .code
9341 deny senders = \N^.*this.*@example\.com$\N : \
9342                \N^\d{8}.+@spamhaus.example$\N : ...
9343 .endd
9344 The &`\N`& sequences are removed by the expansion, so these items do indeed
9345 start with &"^"& by the time they are being interpreted as address patterns.
9346
9347 .next
9348 .cindex "address list" "lookup for complete address"
9349 Complete addresses can be looked up by using a pattern that starts with a
9350 lookup type terminated by a semicolon, followed by the data for the lookup. For
9351 example:
9352 .code
9353 deny senders = cdb;/etc/blocked.senders : \
9354   mysql;select address from blocked where \
9355   address='${quote_mysql:$sender_address}'
9356 .endd
9357 Both query-style and single-key lookup types can be used. For a single-key
9358 lookup type, Exim uses the complete address as the key. However, empty keys are
9359 not supported for single-key lookups, so a match against the empty address
9360 always fails. This restriction does not apply to query-style lookups.
9361
9362 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9363 cannot be used, and is ignored if specified, with an entry being written to the
9364 panic log.
9365 .cindex "*@ with single-key lookup"
9366 However, you can configure lookup defaults, as described in section
9367 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9368 default. For example, with this lookup:
9369 .code
9370 accept senders = lsearch*@;/some/file
9371 .endd
9372 the file could contains lines like this:
9373 .code
9374 user1@domain1.example
9375 *@domain2.example
9376 .endd
9377 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9378 that are tried is:
9379 .code
9380 nimrod@jaeger.example
9381 *@jaeger.example
9382 *
9383 .endd
9384 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9385 would mean that every address matches, thus rendering the test useless.
9386
9387 &*Warning 2*&: Do not confuse these two kinds of item:
9388 .code
9389 deny recipients = dbm*@;/some/file
9390 deny recipients = *@dbm;/some/file
9391 .endd
9392 The first does a whole address lookup, with defaulting, as just described,
9393 because it starts with a lookup type. The second matches the local part and
9394 domain independently, as described in a bullet point below.
9395 .endlist
9396
9397
9398 The following kinds of address list pattern can match only non-empty addresses.
9399 If the subject address is empty, a match against any of these pattern types
9400 always fails.
9401
9402
9403 .ilist
9404 .cindex "@@ with single-key lookup"
9405 .cindex "address list" "@@ lookup type"
9406 .cindex "address list" "split local part and domain"
9407 If a pattern starts with &"@@"& followed by a single-key lookup item
9408 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9409 split into a local part and a domain. The domain is looked up in the file. If
9410 it is not found, there is no match. If it is found, the data that is looked up
9411 from the file is treated as a colon-separated list of local part patterns, each
9412 of which is matched against the subject local part in turn.
9413
9414 .cindex "asterisk" "in address list"
9415 The lookup may be a partial one, and/or one involving a search for a default
9416 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9417 patterns that are looked up can be regular expressions or begin with &"*"&, or
9418 even be further lookups. They may also be independently negated. For example,
9419 with
9420 .code
9421 deny senders = @@dbm;/etc/reject-by-domain
9422 .endd
9423 the data from which the DBM file is built could contain lines like
9424 .code
9425 baddomain.com:  !postmaster : *
9426 .endd
9427 to reject all senders except &%postmaster%& from that domain.
9428
9429 .cindex "local part" "starting with !"
9430 If a local part that actually begins with an exclamation mark is required, it
9431 has to be specified using a regular expression. In &(lsearch)& files, an entry
9432 may be split over several lines by indenting the second and subsequent lines,
9433 but the separating colon must still be included at line breaks. White space
9434 surrounding the colons is ignored. For example:
9435 .code
9436 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9437   spammer3 : spammer4
9438 .endd
9439 As in all colon-separated lists in Exim, a colon can be included in an item by
9440 doubling.
9441
9442 If the last item in the list starts with a right angle-bracket, the remainder
9443 of the item is taken as a new key to look up in order to obtain a continuation
9444 list of local parts. The new key can be any sequence of characters. Thus one
9445 might have entries like
9446 .code
9447 aol.com: spammer1 : spammer 2 : >*
9448 xyz.com: spammer3 : >*
9449 *:       ^\d{8}$
9450 .endd
9451 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9452 local parts for all domains, in addition to the specific local parts listed for
9453 each domain. Of course, using this feature costs another lookup each time a
9454 chain is followed, but the effort needed to maintain the data is reduced.
9455
9456 .cindex "loop" "in lookups"
9457 It is possible to construct loops using this facility, and in order to catch
9458 them, the chains may be no more than fifty items long.
9459
9460 .next
9461 The @@<&'lookup'&> style of item can also be used with a query-style
9462 lookup, but in this case, the chaining facility is not available. The lookup
9463 can only return a single list of local parts.
9464 .endlist
9465
9466 &*Warning*&: There is an important difference between the address list items
9467 in these two examples:
9468 .code
9469 senders = +my_list
9470 senders = *@+my_list
9471 .endd
9472 In the first one, &`my_list`& is a named address list, whereas in the second
9473 example it is a named domain list.
9474
9475
9476
9477
9478 .subsection "Case of letters in address lists" SECTcasletadd
9479 .cindex "case of local parts"
9480 .cindex "address list" "case forcing"
9481 .cindex "case forcing in address lists"
9482 Domains in email addresses are always handled caselessly, but for local parts
9483 case may be significant on some systems (see &%caseful_local_part%& for how
9484 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9485 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9486 blocking lists should be done in a case-independent manner. Since most address
9487 lists in Exim are used for this kind of control, Exim attempts to do this by
9488 default.
9489
9490 The domain portion of an address is always lowercased before matching it to an
9491 address list. The local part is lowercased by default, and any string
9492 comparisons that take place are done caselessly. This means that the data in
9493 the address list itself, in files included as plain filenames, and in any file
9494 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9495 keys in files that are looked up by a search type other than &(lsearch)& (which
9496 works caselessly) must be in lower case, because these lookups are not
9497 case-independent.
9498
9499 .cindex "&`+caseful`&"
9500 To allow for the possibility of caseful address list matching, if an item in
9501 an address list is the string &"+caseful"&, the original case of the local
9502 part is restored for any comparisons that follow, and string comparisons are no
9503 longer case-independent. This does not affect the domain, which remains in
9504 lower case. However, although independent matches on the domain alone are still
9505 performed caselessly, regular expressions that match against an entire address
9506 become case-sensitive after &"+caseful"& has been seen.
9507
9508
9509
9510 .section "Local part lists" "SECTlocparlis"
9511 .cindex "list" "local part list"
9512 .cindex "local part" "list"
9513 These behave in the same way as domain and host lists, with the following
9514 changes:
9515
9516 Case-sensitivity in local part lists is handled in the same way as for address
9517 lists, as just described. The &"+caseful"& item can be used if required. In a
9518 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9519 set false, the subject is lowercased and the matching is initially
9520 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9521 matching in the local part list, but not elsewhere in the router. If
9522 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9523 option is case-sensitive from the start.
9524
9525 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9526 comments are handled in the same way as address lists &-- they are recognized
9527 only if the # is preceded by white space or the start of the line.
9528 Otherwise, local part lists are matched in the same way as domain lists, except
9529 that the special items that refer to the local host (&`@`&, &`@[]`&,
9530 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9531 Refer to section &<<SECTdomainlist>>& for details of the other available item
9532 types.
9533 .ecindex IIDdohoadli
9534
9535
9536
9537
9538 . ////////////////////////////////////////////////////////////////////////////
9539 . ////////////////////////////////////////////////////////////////////////////
9540
9541 .chapter "String expansions" "CHAPexpand"
9542 .scindex IIDstrexp "expansion" "of strings"
9543 Many strings in Exim's runtime configuration are expanded before use. Some of
9544 them are expanded every time they are used; others are expanded only once.
9545
9546 When a string is being expanded it is copied verbatim from left to right except
9547 .cindex expansion "string concatenation"
9548 when a dollar or backslash character is encountered. A dollar specifies the
9549 start of a portion of the string that is interpreted and replaced as described
9550 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9551 escape character, as described in the following section.
9552
9553 Whether a string is expanded depends upon the context.  Usually this is solely
9554 dependent upon the option for which a value is sought; in this documentation,
9555 options for which string expansion is performed are marked with &dagger; after
9556 the data type.  ACL rules always expand strings.  A couple of expansion
9557 conditions do not expand some of the brace-delimited branches, for security
9558 reasons,
9559 .cindex "tainted data" expansion
9560 .cindex "tainted data" definition
9561 .cindex expansion "tainted data"
9562 and expansion of data deriving from the sender (&"tainted data"&)
9563 is not permitted (including acessing a file using a tainted name).
9564
9565 Common ways of obtaining untainted equivalents of variables with
9566 tainted values
9567 .cindex "tainted data" "de-tainting"
9568 come down to using the tainted value as a lookup key in a trusted database.
9569 This database could be the filesystem structure,
9570 or the password file,
9571 or accessed via a DBMS.
9572 Specific methods are indexed under &"de-tainting"&.
9573
9574
9575
9576 .section "Literal text in expanded strings" "SECTlittext"
9577 .cindex "expansion" "including literal text"
9578 An uninterpreted dollar can be included in an expanded string by putting a
9579 backslash in front of it. A backslash can be used to prevent any special
9580 character being treated specially in an expansion, including backslash itself.
9581 If the string appears in quotes in the configuration file, two backslashes are
9582 required because the quotes themselves cause interpretation of backslashes when
9583 the string is read in (see section &<<SECTstrings>>&).
9584
9585 .cindex "expansion" "non-expandable substrings"
9586 A portion of the string can specified as non-expandable by placing it between
9587 two occurrences of &`\N`&. This is particularly useful for protecting regular
9588 expressions, which often contain backslashes and dollar signs. For example:
9589 .code
9590 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9591 .endd
9592 On encountering the first &`\N`&, the expander copies subsequent characters
9593 without interpretation until it reaches the next &`\N`& or the end of the
9594 string.
9595
9596
9597
9598 .section "Character escape sequences in expanded strings" "SECID82"
9599 .cindex "expansion" "escape sequences"
9600 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9601 expanded string is recognized as an escape sequence for the character newline,
9602 carriage return, or tab, respectively. A backslash followed by up to three
9603 octal digits is recognized as an octal encoding for a single character, and a
9604 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9605 encoding.
9606
9607 These escape sequences are also recognized in quoted strings when they are read
9608 in. Their interpretation in expansions as well is useful for unquoted strings,
9609 and for other cases such as looked-up strings that are then expanded.
9610
9611
9612 .section "Testing string expansions" "SECID83"
9613 .cindex "expansion" "testing"
9614 .cindex "testing" "string expansion"
9615 .oindex "&%-be%&"
9616 Many expansions can be tested by calling Exim with the &%-be%& option. This
9617 takes the command arguments, or lines from the standard input if there are no
9618 arguments, runs them through the string expansion code, and writes the results
9619 to the standard output. Variables based on configuration values are set up, but
9620 since no message is being processed, variables such as &$local_part$& have no
9621 value. Nevertheless the &%-be%& option can be useful for checking out file and
9622 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9623 and &%nhash%&.
9624
9625 .new
9626 When reading lines from the standard input,
9627 macros can be defined and ACL variables can be set.
9628 For example:
9629 .code
9630 MY_MACRO = foo
9631 set acl_m_myvar = bar
9632 .endd
9633 Such macros and variables can then be used in later input lines.
9634 .wen
9635
9636 Exim gives up its root privilege when it is called with the &%-be%& option, and
9637 instead runs under the uid and gid it was called with, to prevent users from
9638 using &%-be%& for reading files to which they do not have access.
9639
9640 .oindex "&%-bem%&"
9641 If you want to test expansions that include variables whose values are taken
9642 from a message, there are two other options that can be used. The &%-bem%&
9643 option is like &%-be%& except that it is followed by a filename. The file is
9644 read as a message before doing the test expansions. For example:
9645 .code
9646 exim -bem /tmp/test.message '$h_subject:'
9647 .endd
9648 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9649 Exim message identifier. For example:
9650 .code
9651 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9652 .endd
9653 This loads the message from Exim's spool before doing the test expansions, and
9654 is therefore restricted to admin users.
9655
9656
9657 .section "Forced expansion failure" "SECTforexpfai"
9658 .cindex "expansion" "forced failure"
9659 A number of expansions that are described in the following section have
9660 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9661 (which are sometimes called &"curly brackets"&). Which of the two strings is
9662 used depends on some condition that is evaluated as part of the expansion. If,
9663 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9664 the entire string expansion fails in a way that can be detected by the code
9665 that requested the expansion. This is called &"forced expansion failure"&, and
9666 its consequences depend on the circumstances. In some cases it is no different
9667 from any other expansion failure, but in others a different action may be
9668 taken. Such variations are mentioned in the documentation of the option that is
9669 being expanded.
9670
9671
9672
9673
9674 .section "Expansion items" "SECTexpansionitems"
9675 The following items are recognized in expanded strings. White space may be used
9676 between sub-items that are keywords or substrings enclosed in braces inside an
9677 outer set of braces, to improve readability. &*Warning*&: Within braces,
9678 white space is significant.
9679
9680 .vlist
9681 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9682 .cindex "expansion" "variables"
9683 Substitute the contents of the named variable, for example:
9684 .code
9685 $local_part
9686 ${domain}
9687 .endd
9688 The second form can be used to separate the name from subsequent alphanumeric
9689 characters. This form (using braces) is available only for variables; it does
9690 &'not'& apply to message headers. The names of the variables are given in
9691 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9692 given, the expansion fails.
9693
9694 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9695 .cindex "expansion" "operators"
9696 The string is first itself expanded, and then the operation specified by
9697 <&'op'&> is applied to it. For example:
9698 .code
9699 ${lc:$local_part}
9700 .endd
9701 The string starts with the first character after the colon, which may be
9702 leading white space. A list of operators is given in section &<<SECTexpop>>&
9703 below. The operator notation is used for simple expansion items that have just
9704 one argument, because it reduces the number of braces and therefore makes the
9705 string easier to understand.
9706
9707 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9708 This item inserts &"basic"& header lines. It is described with the &%header%&
9709 expansion item below.
9710
9711
9712 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9713 .cindex "expansion" "calling an acl"
9714 .cindex "&%acl%&" "call from expansion"
9715 The name and zero to nine argument strings are first expanded separately.  The expanded
9716 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9717 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9718 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9719 and may use the variables; if another acl expansion is used the values
9720 are restored after it returns.  If the ACL sets
9721 a value using a "message =" modifier and returns accept or deny, the value becomes
9722 the result of the expansion.
9723 If no message is set and the ACL returns accept or deny
9724 the expansion result is an empty string.
9725 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9726
9727
9728 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9729 .cindex authentication "results header"
9730 .chindex Authentication-Results:
9731 .cindex authentication "expansion item"
9732 This item returns a string suitable for insertion as an
9733 &'Authentication-Results:'&
9734 header line.
9735 The given <&'authserv-id'&> is included in the result; typically this
9736 will be a domain name identifying the system performing the authentications.
9737 Methods that might be present in the result include:
9738 .code
9739 none
9740 iprev
9741 auth
9742 spf
9743 dkim
9744 .endd
9745
9746 Example use (as an ACL modifier):
9747 .code
9748       add_header = :at_start:${authresults {$primary_hostname}}
9749 .endd
9750 This is safe even if no authentication results are available
9751 .new
9752 and would generally be placed in the DATA ACL.
9753 .wen
9754
9755
9756 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9757        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9758 .cindex "expansion" "extracting certificate fields"
9759 .cindex "&%certextract%&" "certificate fields"
9760 .cindex "certificate" "extracting fields"
9761 The <&'certificate'&> must be a variable of type certificate.
9762 The field name is expanded and used to retrieve the relevant field from
9763 the certificate.  Supported fields are:
9764 .display
9765 &`version        `&
9766 &`serial_number  `&
9767 &`subject        `& RFC4514 DN
9768 &`issuer         `& RFC4514 DN
9769 &`notbefore      `& time
9770 &`notafter       `& time
9771 &`sig_algorithm  `&
9772 &`signature      `&
9773 &`subj_altname   `& tagged list
9774 &`ocsp_uri       `& list
9775 &`crl_uri        `& list
9776 .endd
9777 If the field is found,
9778 <&'string2'&> is expanded, and replaces the whole item;
9779 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9780 variable &$value$& contains the value that has been extracted. Afterwards, it
9781 is restored to any previous value it might have had.
9782
9783 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9784 key is not found. If {<&'string2'&>} is also omitted, the value that was
9785 extracted is used.
9786
9787 Some field names take optional modifiers, appended and separated by commas.
9788
9789 The field selectors marked as "RFC4514" above
9790 output a Distinguished Name string which is
9791 not quite
9792 parseable by Exim as a comma-separated tagged list
9793 (the exceptions being elements containing commas).
9794 RDN elements of a single type may be selected by
9795 a modifier of the type label; if so the expansion
9796 result is a list (newline-separated by default).
9797 The separator may be changed by another modifier of
9798 a right angle-bracket followed immediately by the new separator.
9799 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9800
9801 The field selectors marked as "time" above
9802 take an optional modifier of "int"
9803 for which the result is the number of seconds since epoch.
9804 Otherwise the result is a human-readable string
9805 in the timezone selected by the main "timezone" option.
9806
9807 The field selectors marked as "list" above return a list,
9808 newline-separated by default,
9809 (embedded separator characters in elements are doubled).
9810 The separator may be changed by a modifier of
9811 a right angle-bracket followed immediately by the new separator.
9812
9813 The field selectors marked as "tagged" above
9814 prefix each list element with a type string and an equals sign.
9815 Elements of only one type may be selected by a modifier
9816 which is one of "dns", "uri" or "mail";
9817 if so the element tags are omitted.
9818
9819 If not otherwise noted field values are presented in human-readable form.
9820
9821 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9822        {*&<&'arg'&>&*}...}*&"
9823 .cindex &%dlfunc%&
9824 This expansion dynamically loads and then calls a locally-written C function.
9825 This functionality is available only if Exim is compiled with
9826 .code
9827 EXPAND_DLFUNC=yes
9828 .endd
9829 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9830 object so that it doesn't reload the same object file in the same Exim process
9831 (but of course Exim does start new processes frequently).
9832
9833 There may be from zero to eight arguments to the function.
9834
9835 When compiling
9836 a local function that is to be called in this way,
9837 first &_DLFUNC_IMPL_& should be defined,
9838 and second &_local_scan.h_& should be included.
9839 The Exim variables and functions that are defined by that API
9840 are also available for dynamically loaded functions. The function itself
9841 must have the following type:
9842 .code
9843 int dlfunction(uschar **yield, int argc, uschar *argv[])
9844 .endd
9845 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9846 function should return one of the following values:
9847
9848 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9849 into the expanded string that is being built.
9850
9851 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9852 from &'yield'&, if it is set.
9853
9854 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9855 taken from &'yield'& if it is set.
9856
9857 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9858
9859 When compiling a function that is to be used in this way with gcc,
9860 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9861 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9862
9863
9864 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9865 .cindex "expansion" "extracting value from environment"
9866 .cindex "environment" "values from"
9867 The key is first expanded separately, and leading and trailing white space
9868 removed.
9869 This is then searched for as a name in the environment.
9870 If a variable is found then its value is placed in &$value$&
9871 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9872
9873 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9874 appear, for example:
9875 .code
9876 ${env{USER}{$value} fail }
9877 .endd
9878 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9879 {<&'string1'&>} must be present for &"fail"& to be recognized.
9880
9881 If {<&'string2'&>} is omitted an empty string is substituted on
9882 search failure.
9883 If {<&'string1'&>} is omitted the search result is substituted on
9884 search success.
9885
9886 The environment is adjusted by the &%keep_environment%& and
9887 &%add_environment%& main section options.
9888
9889
9890 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9891        {*&<&'string3'&>&*}}*&"
9892 .cindex "expansion" "extracting substrings by key"
9893 .cindex "&%extract%&" "substrings by key"
9894 The key and <&'string1'&> are first expanded separately. Leading and trailing
9895 white space is removed from the key (but not from any of the strings). The key
9896 must not be empty and must not consist entirely of digits.
9897 The expanded <&'string1'&> must be of the form:
9898 .display
9899 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9900 .endd
9901 .vindex "&$value$&"
9902 where the equals signs and spaces (but not both) are optional. If any of the
9903 values contain white space, they must be enclosed in double quotes, and any
9904 values that are enclosed in double quotes are subject to escape processing as
9905 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9906 for the value that corresponds to the key. The search is case-insensitive. If
9907 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9908 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9909 variable &$value$& contains the value that has been extracted. Afterwards, it
9910 is restored to any previous value it might have had.
9911
9912 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9913 key is not found. If {<&'string2'&>} is also omitted, the value that was
9914 extracted is used. Thus, for example, these two expansions are identical, and
9915 yield &"2001"&:
9916 .code
9917 ${extract{gid}{uid=1984 gid=2001}}
9918 ${extract{gid}{uid=1984 gid=2001}{$value}}
9919 .endd
9920 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9921 appear, for example:
9922 .code
9923 ${extract{Z}{A=... B=...}{$value} fail }
9924 .endd
9925 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9926 {<&'string2'&>} must be present for &"fail"& to be recognized.
9927
9928 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9929        {*&<&'string3'&>&*}}*&" &&&
9930        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9931        {*&<&'string3'&>&*}}*&"
9932 .cindex "expansion" "extracting from JSON object"
9933 .cindex JSON expansions
9934 The key and <&'string1'&> are first expanded separately. Leading and trailing
9935 white space is removed from the key (but not from any of the strings). The key
9936 must not be empty and must not consist entirely of digits.
9937 The expanded <&'string1'&> must be of the form:
9938 .display
9939 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9940 .endd
9941 .vindex "&$value$&"
9942 The braces, commas and colons, and the quoting of the member name are required;
9943 the spaces are optional.
9944 Matching of the key against the member names is done case-sensitively.
9945 For the &"json"& variant,
9946 if a returned value is a JSON string, it retains its leading and
9947 trailing quotes.
9948 For the &"jsons"& variant, which is intended for use with JSON strings, the
9949 leading and trailing quotes are removed from the returned value.
9950 . XXX should be a UTF-8 compare
9951
9952 The results of matching are handled as above.
9953
9954
9955 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9956         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9957 .cindex "expansion" "extracting substrings by number"
9958 .cindex "&%extract%&" "substrings by number"
9959 The <&'number'&> argument must consist entirely of decimal digits,
9960 apart from leading and trailing white space, which is ignored.
9961 This is what distinguishes this form of &%extract%& from the previous kind. It
9962 behaves in the same way, except that, instead of extracting a named field, it
9963 extracts from <&'string1'&> the field whose number is given as the first
9964 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9965 <&'string3'&> as before.
9966
9967 The fields in the string are separated by any one of the characters in the
9968 separator string. These may include space or tab characters.
9969 The first field is numbered one. If the number is negative, the fields are
9970 counted from the end of the string, with the rightmost one numbered -1. If the
9971 number given is zero, the entire string is returned. If the modulus of the
9972 number is greater than the number of fields in the string, the result is the
9973 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9974 provided. For example:
9975 .code
9976 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9977 .endd
9978 yields &"42"&, and
9979 .code
9980 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9981 .endd
9982 yields &"99"&. Two successive separators mean that the field between them is
9983 empty (for example, the fifth field above).
9984
9985
9986 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9987         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9988        "&*${extract jsons{*&<&'number'&>&*}}&&&
9989         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9990 .cindex "expansion" "extracting from JSON array"
9991 .cindex JSON expansions
9992 The <&'number'&> argument must consist entirely of decimal digits,
9993 apart from leading and trailing white space, which is ignored.
9994
9995 Field selection and result handling is as above;
9996 there is no choice of field separator.
9997 For the &"json"& variant,
9998 if a returned value is a JSON string, it retains its leading and
9999 trailing quotes.
10000 For the &"jsons"& variant, which is intended for use with JSON strings, the
10001 leading and trailing quotes are removed from the returned value.
10002
10003
10004 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10005 .cindex "list" "selecting by condition"
10006 .cindex "expansion" "selecting from list by condition"
10007 .vindex "&$item$&"
10008 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10009 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10010 For each item
10011 in this list, its value is placed in &$item$&, and then the condition is
10012 evaluated.
10013 .new
10014 Any modification of &$value$& by this evaluation is discarded.
10015 .wen
10016 If the condition is true, &$item$& is added to the output as an
10017 item in a new list; if the condition is false, the item is discarded. The
10018 separator used for the output list is the same as the one used for the
10019 input, but a separator setting is not included in the output. For example:
10020 .code
10021 ${filter{a:b:c}{!eq{$item}{b}}}
10022 .endd
10023 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10024 to what it was before.
10025 See also the &%map%& and &%reduce%& expansion items.
10026
10027
10028 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10029 .cindex "hash function" "textual"
10030 .cindex "expansion" "textual hash"
10031 This is a textual hashing function, and was the first to be implemented in
10032 early versions of Exim. In current releases, there are other hashing functions
10033 (numeric, MD5, and SHA-1), which are described below.
10034
10035 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10036 <&'n'&>. If you are using fixed values for these numbers, that is, if
10037 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10038 use the simpler operator notation that avoids some of the braces:
10039 .code
10040 ${hash_<n>_<m>:<string>}
10041 .endd
10042 The second number is optional (in both notations). If <&'n'&> is greater than
10043 or equal to the length of the string, the expansion item returns the string.
10044 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10045 function to the string. The new string consists of characters taken from the
10046 first <&'m'&> characters of the string
10047 .code
10048 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10049 .endd
10050 If <&'m'&> is not present the value 26 is used, so that only lower case
10051 letters appear. For example:
10052 .display
10053 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10054 &`$hash{5}{monty}}           `&   yields  &`monty`&
10055 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10056 .endd
10057
10058 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10059         &*$h_*&<&'header&~name'&>&*:*&" &&&
10060        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10061         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10062        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10063         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10064        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10065         &*$rh_*&<&'header&~name'&>&*:*&"
10066 .cindex "expansion" "header insertion"
10067 .vindex "&$header_$&"
10068 .vindex "&$bheader_$&"
10069 .vindex "&$lheader_$&"
10070 .vindex "&$rheader_$&"
10071 .cindex "header lines" "in expansion strings"
10072 .cindex "header lines" "character sets"
10073 .cindex "header lines" "decoding"
10074 Substitute the contents of the named message header line, for example
10075 .code
10076 $header_reply-to:
10077 .endd
10078 The newline that terminates a header line is not included in the expansion, but
10079 internal newlines (caused by splitting the header line over several physical
10080 lines) may be present.
10081
10082 The difference between the four pairs of expansions is in the way
10083 the data in the header line is interpreted.
10084
10085 .ilist
10086 .cindex "white space" "in header lines"
10087 &%rheader%& gives the original &"raw"& content of the header line, with no
10088 processing at all, and without the removal of leading and trailing white space.
10089
10090 .next
10091 .cindex "list" "of header lines"
10092 &%lheader%& gives a colon-separated list, one element per header when there
10093 are multiple headers with a given name.
10094 Any embedded colon characters within an element are doubled, so normal Exim
10095 list-processing facilities can be used.
10096 The terminating newline of each element is removed; in other respects
10097 the content is &"raw"&.
10098
10099 .next
10100 .cindex "base64 encoding" "in header lines"
10101 &%bheader%& removes leading and trailing white space, and then decodes base64
10102 or quoted-printable MIME &"words"& within the header text, but does no
10103 character set translation. If decoding of what looks superficially like a MIME
10104 &"word"& fails, the raw string is returned. If decoding
10105 .cindex "binary zero" "in header line"
10106 produces a binary zero character, it is replaced by a question mark &-- this is
10107 what Exim does for binary zeros that are actually received in header lines.
10108
10109 .next
10110 &%header%& tries to translate the string as decoded by &%bheader%& to a
10111 standard character set. This is an attempt to produce the same string as would
10112 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10113 returned. Translation is attempted only on operating systems that support the
10114 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10115 a system Makefile or in &_Local/Makefile_&.
10116 .endlist ilist
10117
10118 In a filter file, the target character set for &%header%& can be specified by a
10119 command of the following form:
10120 .code
10121 headers charset "UTF-8"
10122 .endd
10123 This command affects all references to &$h_$& (or &$header_$&) expansions in
10124 subsequently obeyed filter commands. In the absence of this command, the target
10125 character set in a filter is taken from the setting of the &%headers_charset%&
10126 option in the runtime configuration. The value of this option defaults to the
10127 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10128 ISO-8859-1.
10129
10130 Header names follow the syntax of RFC 2822, which states that they may contain
10131 any printing characters except space and colon. Consequently, curly brackets
10132 &'do not'& terminate header names, and should not be used to enclose them as
10133 if they were variables. Attempting to do so causes a syntax error.
10134
10135 Only header lines that are common to all copies of a message are visible to
10136 this mechanism. These are the original header lines that are received with the
10137 message, and any that are added by an ACL statement or by a system
10138 filter. Header lines that are added to a particular copy of a message by a
10139 router or transport are not accessible.
10140
10141 For incoming SMTP messages, no header lines are visible in
10142 ACLs that are obeyed before the data phase completes,
10143 because the header structure is not set up until the message is received.
10144 They are visible in DKIM, PRDR and DATA ACLs.
10145 Header lines that are added in a RCPT ACL (for example)
10146 are saved until the message's incoming header lines are available, at which
10147 point they are added.
10148 When any of the above ACLs are
10149 running, however, header lines added by earlier ACLs are visible.
10150
10151 Upper case and lower case letters are synonymous in header names. If the
10152 following character is white space, the terminating colon may be omitted, but
10153 this is not recommended, because you may then forget it when it is needed. When
10154 white space terminates the header name, this white space is included in the
10155 expanded string.  If the message does not contain the given header, the
10156 expansion item is replaced by an empty string. (See the &%def%& condition in
10157 section &<<SECTexpcond>>& for a means of testing for the existence of a
10158 header.)
10159
10160 If there is more than one header with the same name, they are all concatenated
10161 to form the substitution string, up to a maximum length of 64K. Unless
10162 &%rheader%& is being used, leading and trailing white space is removed from
10163 each header before concatenation, and a completely empty header is ignored. A
10164 newline character is then inserted between non-empty headers, but there is no
10165 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10166 those headers that contain lists of addresses, a comma is also inserted at the
10167 junctions between headers. This does not happen for the &%rheader%& expansion.
10168
10169 .cindex "tainted data" "message headers"
10170 When the headers are from an incoming message,
10171 the result of expanding any of these variables is tainted.
10172
10173
10174 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10175 .cindex "expansion" "hmac hashing"
10176 .cindex &%hmac%&
10177 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10178 shared secret and some text into a message authentication code, as specified in
10179 RFC 2104. This differs from &`${md5:secret_text...}`& or
10180 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10181 cryptographic hash, allowing for authentication that is not possible with MD5
10182 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10183 present. For example:
10184 .code
10185 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10186 .endd
10187 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10188 produces:
10189 .code
10190 dd97e3ba5d1a61b5006108f8c8252953
10191 .endd
10192 As an example of how this might be used, you might put in the main part of
10193 an Exim configuration:
10194 .code
10195 SPAMSCAN_SECRET=cohgheeLei2thahw
10196 .endd
10197 In a router or a transport you could then have:
10198 .code
10199 headers_add = \
10200   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10201   ${hmac{md5}{SPAMSCAN_SECRET}\
10202   {${primary_hostname},${message_exim_id},$h_message-id:}}
10203 .endd
10204 Then given a message, you can check where it was scanned by looking at the
10205 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10206 this header line is authentic by recomputing the authentication code from the
10207 host name, message ID and the &'Message-id:'& header line. This can be done
10208 using Exim's &%-be%& option, or by other means, for example, by using the
10209 &'hmac_md5_hex()'& function in Perl.
10210
10211
10212 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10213 .cindex "expansion" "conditional"
10214 .cindex "&%if%&, expansion item"
10215 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10216 item; otherwise <&'string2'&> is used. The available conditions are described
10217 in section &<<SECTexpcond>>& below. For example:
10218 .code
10219 ${if eq {$local_part}{postmaster} {yes}{no} }
10220 .endd
10221 The second string need not be present; if it is not and the condition is not
10222 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10223 be present instead of the second string (without any curly brackets). In this
10224 case, the expansion is forced to fail if the condition is not true (see section
10225 &<<SECTforexpfai>>&).
10226
10227 If both strings are omitted, the result is the string &`true`& if the condition
10228 is true, and the empty string if the condition is false. This makes it less
10229 cumbersome to write custom ACL and router conditions. For example, instead of
10230 .code
10231 condition = ${if >{$acl_m4}{3}{true}{false}}
10232 .endd
10233 you can use
10234 .code
10235 condition = ${if >{$acl_m4}{3}}
10236 .endd
10237
10238
10239
10240 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10241 .cindex expansion "imap folder"
10242 .cindex "&%imapfolder%& expansion item"
10243 This item converts a (possibly multilevel, or with non-ASCII characters)
10244 folder specification to a Maildir name for filesystem use.
10245 For information on internationalisation support see &<<SECTi18nMDA>>&.
10246
10247
10248
10249 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10250 .cindex "expansion" "string truncation"
10251 .cindex "&%length%& expansion item"
10252 The &%length%& item is used to extract the initial portion of a string. Both
10253 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10254 you are using a fixed value for the number, that is, if <&'string1'&> does not
10255 change when expanded, you can use the simpler operator notation that avoids
10256 some of the braces:
10257 .code
10258 ${length_<n>:<string>}
10259 .endd
10260 The result of this item is either the first <&'n'&> bytes or the whole
10261 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10262 &%strlen%&, which gives the length of a string.
10263 All measurement is done in bytes and is not UTF-8 aware.
10264
10265
10266 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10267         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10268 .cindex "expansion" "extracting list elements by number"
10269 .cindex "&%listextract%&" "extract list elements by number"
10270 .cindex "list" "extracting elements by number"
10271 The <&'number'&> argument must consist entirely of decimal digits,
10272 apart from an optional leading minus,
10273 and leading and trailing white space (which is ignored).
10274
10275 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10276 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10277
10278 The first field of the list is numbered one.
10279 If the number is negative, the fields are
10280 counted from the end of the list, with the rightmost one numbered -1.
10281 The numbered element of the list is extracted and placed in &$value$&,
10282 then <&'string2'&> is expanded as the result.
10283
10284 If the modulus of the
10285 number is zero or greater than the number of fields in the string,
10286 the result is the expansion of <&'string3'&>.
10287
10288 For example:
10289 .code
10290 ${listextract{2}{x:42:99}}
10291 .endd
10292 yields &"42"&, and
10293 .code
10294 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10295 .endd
10296 yields &"result: 42"&.
10297
10298 If {<&'string3'&>} is omitted, an empty string is used for string3.
10299 If {<&'string2'&>} is also omitted, the value that was
10300 extracted is used.
10301 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10302
10303
10304 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10305 .cindex quoting "for list"
10306 .cindex list quoting
10307 This item doubles any occurrence of the separator character
10308 in the given string.
10309 An empty string is replaced with a single space.
10310 This converts the string into a safe form for use as a list element,
10311 in a list using the given separator.
10312
10313
10314 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10315         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10316        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10317         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10318 .cindex "expansion" "lookup in"
10319 .cindex "file" "lookups"
10320 .cindex "lookup" "in expanded string"
10321 The two forms of lookup item specify data lookups in files and databases, as
10322 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10323 lookups, and the second is used for query-style lookups. The <&'key'&>,
10324 <&'file'&>, and <&'query'&> strings are expanded before use.
10325
10326 If there is any white space in a lookup item which is part of a filter command,
10327 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10328 other place where white space is significant, the lookup item must be enclosed
10329 in double quotes. The use of data lookups in users' filter files may be locked
10330 out by the system administrator.
10331
10332 .vindex "&$value$&"
10333 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10334 During its expansion, the variable &$value$& contains the data returned by the
10335 lookup. Afterwards it reverts to the value it had previously (at the outer
10336 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10337 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10338 string on failure. If <&'string2'&> is provided, it can itself be a nested
10339 lookup, thus providing a mechanism for looking up a default value when the
10340 original lookup fails.
10341
10342 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10343 data for the outer lookup while the parameters of the second lookup are
10344 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10345 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10346 appear, and in this case, if the lookup fails, the entire expansion is forced
10347 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10348 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10349 successful lookup, and nothing in the case of failure.
10350
10351 For single-key lookups, the string &"partial"& is permitted to precede the
10352 search type in order to do partial matching, and * or *@ may follow a search
10353 type to request default lookups if the key does not match (see sections
10354 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10355
10356 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10357 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10358 and non-wild parts of the key during the expansion of the replacement text.
10359 They return to their previous values at the end of the lookup item.
10360
10361 This example looks up the postmaster alias in the conventional alias file:
10362 .code
10363 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10364 .endd
10365 This example uses NIS+ to look up the full name of the user corresponding to
10366 the local part of an address, forcing the expansion to fail if it is not found:
10367 .code
10368 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10369   {$value}fail}
10370 .endd
10371
10372
10373 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10374 .cindex "expansion" "list creation"
10375 .vindex "&$item$&"
10376 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10377 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10378 For each item
10379 in this list, its value is place in &$item$&, and then <&'string2'&> is
10380 expanded and added to the output as an item in a new list. The separator used
10381 for the output list is the same as the one used for the input, but a separator
10382 setting is not included in the output. For example:
10383 .code
10384 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10385 .endd
10386 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10387 value of &$item$& is restored to what it was before. See also the &%filter%&
10388 and &%reduce%& expansion items.
10389
10390 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10391 .cindex "expansion" "numeric hash"
10392 .cindex "hash function" "numeric"
10393 The three strings are expanded; the first two must yield numbers. Call them
10394 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10395 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10396 can use the simpler operator notation that avoids some of the braces:
10397 .code
10398 ${nhash_<n>_<m>:<string>}
10399 .endd
10400 The second number is optional (in both notations). If there is only one number,
10401 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10402 processed by a div/mod hash function that returns two numbers, separated by a
10403 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10404 example,
10405 .code
10406 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10407 .endd
10408 returns the string &"6/33"&.
10409
10410
10411
10412 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10413 .cindex "Perl" "use in expanded string"
10414 .cindex "expansion" "calling Perl from"
10415 This item is available only if Exim has been built to include an embedded Perl
10416 interpreter. The subroutine name and the arguments are first separately
10417 expanded, and then the Perl subroutine is called with those arguments. No
10418 additional arguments need be given; the maximum number permitted, including the
10419 name of the subroutine, is nine.
10420
10421 The return value of the subroutine is inserted into the expanded string, unless
10422 the return value is &%undef%&. In that case, the entire expansion is
10423 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10424 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10425 in a scalar context, thus the return value is a scalar.  For example, if you
10426 return a Perl vector, the return value is the size of the vector,
10427 not its contents.
10428
10429 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10430 with the error message that was passed to &%die%&. More details of the embedded
10431 Perl facility are given in chapter &<<CHAPperl>>&.
10432
10433 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10434 out the use of this expansion item in filter files.
10435
10436
10437 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10438 .cindex "&%prvs%& expansion item"
10439 The first argument is a complete email address and the second is secret
10440 keystring. The third argument, specifying a key number, is optional. If absent,
10441 it defaults to 0. The result of the expansion is a prvs-signed email address,
10442 to be typically used with the &%return_path%& option on an &(smtp)& transport
10443 as part of a bounce address tag validation (BATV) scheme. For more discussion
10444 and an example, see section &<<SECTverifyPRVS>>&.
10445
10446 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10447         {*&<&'string'&>&*}}*&"
10448 .cindex "&%prvscheck%& expansion item"
10449 This expansion item is the complement of the &%prvs%& item. It is used for
10450 checking prvs-signed addresses. If the expansion of the first argument does not
10451 yield a syntactically valid prvs-signed address, the whole item expands to the
10452 empty string. When the first argument does expand to a syntactically valid
10453 prvs-signed address, the second argument is expanded, with the prvs-decoded
10454 version of the address and the key number extracted from the address in the
10455 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10456
10457 These two variables can be used in the expansion of the second argument to
10458 retrieve the secret. The validity of the prvs-signed address is then checked
10459 against the secret. The result is stored in the variable &$prvscheck_result$&,
10460 which is empty for failure or &"1"& for success.
10461
10462 The third argument is optional; if it is missing, it defaults to an empty
10463 string. This argument is now expanded. If the result is an empty string, the
10464 result of the expansion is the decoded version of the address. This is the case
10465 whether or not the signature was valid. Otherwise, the result of the expansion
10466 is the expansion of the third argument.
10467
10468 All three variables can be used in the expansion of the third argument.
10469 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10470 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10471
10472 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10473 .cindex "expansion" "inserting an entire file"
10474 .cindex "file" "inserting into expansion"
10475 .cindex "&%readfile%& expansion item"
10476 The filename and end-of-line (eol) string are first expanded separately. The file is
10477 then read, and its contents replace the entire item. All newline characters in
10478 the file are replaced by the end-of-line string if it is present. Otherwise,
10479 newlines are left in the string.
10480 String expansion is not applied to the contents of the file. If you want this,
10481 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10482 the string expansion fails.
10483
10484 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10485 locks out the use of this expansion item in filter files.
10486
10487
10488
10489 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10490         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10491 .cindex "expansion" "inserting from a socket"
10492 .cindex "socket, use of in expansion"
10493 .cindex "&%readsocket%& expansion item"
10494 This item inserts data from a Unix domain or TCP socket into the expanded
10495 string. The minimal way of using it uses just two arguments, as in these
10496 examples:
10497 .code
10498 ${readsocket{/socket/name}{request string}}
10499 ${readsocket{inet:some.host:1234}{request string}}
10500 .endd
10501 For a Unix domain socket, the first substring must be the path to the socket.
10502 For an Internet socket, the first substring must contain &`inet:`& followed by
10503 a host name or IP address, followed by a colon and a port, which can be a
10504 number or the name of a TCP port in &_/etc/services_&. An IP address may
10505 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10506 example:
10507 .code
10508 ${readsocket{inet:[::1]:1234}{request string}}
10509 .endd
10510 Only a single host name may be given, but if looking it up yields more than
10511 one IP address, they are each tried in turn until a connection is made. For
10512 both kinds of socket, Exim makes a connection, writes the request string
10513 (unless it is an empty string; no terminating NUL is ever sent)
10514 and reads from the socket until an end-of-file
10515 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10516 extend what can be done. Firstly, you can vary the timeout. For example:
10517 .code
10518 ${readsocket{/socket/name}{request string}{3s}}
10519 .endd
10520
10521 The third argument is a list of options, of which the first element is the timeout
10522 and must be present if any options are given.
10523 Further elements are options of form &'name=value'&.
10524 Example:
10525 .code
10526 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10527 .endd
10528
10529 The following option names are recognised:
10530 .ilist
10531 &*cache*&
10532 Defines if the result data can be cached for use by a later identical
10533 request in the same process.
10534 Values are &"yes"& or &"no"& (the default).
10535 If not, all cached results for this connection specification
10536 will be invalidated.
10537
10538 .next
10539 &*shutdown*&
10540 Defines whether or not a write-shutdown is done on the connection after
10541 sending the request. Values are &"yes"& (the default) or &"no"&
10542 (preferred, eg. by some webservers).
10543
10544 .next
10545 &*sni*&
10546 Controls the use of Server Name Identification on the connection.
10547 Any nonempty value will be the SNI sent; TLS will be forced.
10548
10549 .next
10550 &*tls*&
10551 Controls the use of TLS on the connection.
10552 Values are &"yes"& or &"no"& (the default).
10553 If it is enabled, a shutdown as described above is never done.
10554 .endlist
10555
10556
10557 A fourth argument allows you to change any newlines that are in the data
10558 that is read, in the same way as for &%readfile%& (see above). This example
10559 turns them into spaces:
10560 .code
10561 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10562 .endd
10563 As with all expansions, the substrings are expanded before the processing
10564 happens. Errors in these sub-expansions cause the expansion to fail. In
10565 addition, the following errors can occur:
10566
10567 .ilist
10568 Failure to create a socket file descriptor;
10569 .next
10570 Failure to connect the socket;
10571 .next
10572 Failure to write the request string;
10573 .next
10574 Timeout on reading from the socket.
10575 .endlist
10576
10577 By default, any of these errors causes the expansion to fail. However, if
10578 you supply a fifth substring, it is expanded and used when any of the above
10579 errors occurs. For example:
10580 .code
10581 ${readsocket{/socket/name}{request string}{3s}{\n}\
10582   {socket failure}}
10583 .endd
10584 You can test for the existence of a Unix domain socket by wrapping this
10585 expansion in &`${if exists`&, but there is a race condition between that test
10586 and the actual opening of the socket, so it is safer to use the fifth argument
10587 if you want to be absolutely sure of avoiding an expansion error for a
10588 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10589
10590 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10591 locks out the use of this expansion item in filter files.
10592
10593
10594 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10595 .cindex "expansion" "reducing a list to a scalar"
10596 .cindex "list" "reducing to a scalar"
10597 .vindex "&$value$&"
10598 .vindex "&$item$&"
10599 This operation reduces a list to a single, scalar string. After expansion,
10600 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10601 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10602 Then <&'string2'&> is expanded and
10603 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10604 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10605 them. The result of that expansion is assigned to &$value$& before the next
10606 iteration. When the end of the list is reached, the final value of &$value$& is
10607 added to the expansion output. The &%reduce%& expansion item can be used in a
10608 number of ways. For example, to add up a list of numbers:
10609 .code
10610 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10611 .endd
10612 The result of that expansion would be &`6`&. The maximum of a list of numbers
10613 can be found:
10614 .code
10615 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10616 .endd
10617 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10618 restored to what they were before. See also the &%filter%& and &%map%&
10619 expansion items.
10620
10621 . A bit of a special-case logic error in writing an expansion;
10622 . probably not worth including in the mainline of documentation.
10623 . If only we had footnotes (the html output variant is the problem).
10624 .
10625 . .new
10626 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10627 . and that condition modifies &$value$&,
10628 . then the string expansions dependent on the condition cannot use
10629 . the &$value$& of the reduce iteration.
10630 . .wen
10631
10632 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10633 This item inserts &"raw"& header lines. It is described with the &%header%&
10634 expansion item in section &<<SECTexpansionitems>>& above.
10635
10636 .vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10637         {*&<&'string2'&>&*}}*&"
10638 .cindex "expansion" "running a command"
10639 .cindex "&%run%& expansion item"
10640 This item runs an external command, as a subprocess.
10641 One option is supported after the word &'run'&, comma-separated
10642 and without whitespace.
10643
10644 If the option &'preexpand'& is not used,
10645 the command string is split into individual arguments by spaces
10646 and then each argument is expanded.
10647 Then the command is run
10648 in a separate process, but under the same uid and gid.  As in other command
10649 executions from Exim, a shell is not used by default. If the command requires
10650 a shell, you must explicitly code it.
10651 The command name may not be tainted, but the remaining arguments can be.
10652
10653 &*Note*&: if tainted arguments are used, they are supplied by a
10654 potential attacker;
10655 a careful assessment for security vulnerabilities should be done.
10656
10657 If the option &'preexpand'& is used,
10658 the command and its arguments are first expanded as one string. The result is
10659 split apart into individual arguments by spaces, and then the command is run
10660 as above.
10661 Since the arguments are split by spaces, when there is a variable expansion
10662 which has an empty result, it will cause the situation that the argument will
10663 simply be omitted when the program is actually executed by Exim. If the
10664 script/program requires a specific number of arguments and the expanded
10665 variable could possibly result in this empty expansion, the variable must be
10666 quoted. This is more difficult if the expanded variable itself could result
10667 in a string containing quotes, because it would interfere with the quotes
10668 around the command arguments. A possible guard against this is to wrap the
10669 variable in the &%sg%& operator to change any quote marks to some other
10670 character.
10671 Neither the command nor any argument may be tainted.
10672
10673 The standard input for the command exists, but is empty. The standard output
10674 and standard error are set to the same file descriptor.
10675 .cindex "return code" "from &%run%& expansion"
10676 .vindex "&$value$&"
10677 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10678 and replaces the entire item; during this expansion, the standard output/error
10679 from the command is in the variable &$value$&. If the command fails,
10680 <&'string2'&>, if present, is expanded and used. Once again, during the
10681 expansion, the standard output/error from the command is in the variable
10682 &$value$&.
10683
10684 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10685 can be the word &"fail"& (not in braces) to force expansion failure if the
10686 command does not succeed. If both strings are omitted, the result is contents
10687 of the standard output/error on success, and nothing on failure.
10688
10689 .vindex "&$run_in_acl$&"
10690 The standard output/error of the command is put in the variable &$value$&.
10691 In this ACL example, the output of a command is logged for the admin to
10692 troubleshoot:
10693 .code
10694 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10695       log_message  = Output of id: $value
10696 .endd
10697 If the command requires shell idioms, such as the > redirect operator, the
10698 shell must be invoked directly, such as with:
10699 .code
10700 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10701 .endd
10702 Note that &$value$& will not persist beyond the reception of a single message.
10703
10704 .vindex "&$runrc$&"
10705 The return code from the command is put in the variable &$runrc$&, and this
10706 remains set afterwards, so in a filter file you can do things like this:
10707 .code
10708 if "${run{x y z}{}}$runrc" is 1 then ...
10709   elif $runrc is 2 then ...
10710   ...
10711 endif
10712 .endd
10713 If execution of the command fails (for example, the command does not exist),
10714 the return code is 127 &-- the same code that shells use for non-existent
10715 commands.
10716
10717 &*Warning*&: In a router or transport, you cannot assume the order in which
10718 option values are expanded, except for those preconditions whose order of
10719 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10720 by the expansion of one option, and use it in another.
10721
10722 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10723 out the use of this expansion item in filter files.
10724
10725
10726 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10727 .cindex "expansion" "string substitution"
10728 .cindex "&%sg%& expansion item"
10729 This item works like Perl's substitution operator (s) with the global (/g)
10730 option; hence its name. However, unlike the Perl equivalent, Exim does not
10731 modify the subject string; instead it returns the modified string for insertion
10732 into the overall expansion. The item takes three arguments: the subject string,
10733 a regular expression, and a substitution string. For example:
10734 .code
10735 ${sg{abcdefabcdef}{abc}{xyz}}
10736 .endd
10737 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10738 if any $, } or \ characters are required in the regular expression or in the
10739 substitution string, they have to be escaped. For example:
10740 .code
10741 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10742 .endd
10743 yields &"defabc"&, and
10744 .code
10745 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10746 .endd
10747 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10748 the regular expression from string expansion.
10749
10750 The regular expression is compiled in 8-bit mode, working against bytes
10751 rather than any Unicode-aware character handling.
10752
10753
10754 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10755 .cindex sorting "a list"
10756 .cindex list sorting
10757 .cindex expansion "list sorting"
10758 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10759 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10760 The <&'comparator'&> argument is interpreted as the operator
10761 of a two-argument expansion condition.
10762 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10763 The comparison should return true when applied to two values
10764 if the first value should sort before the second value.
10765 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10766 the element being placed in &$item$&,
10767 to give values for comparison.
10768
10769 The item result is a sorted list,
10770 with the original list separator,
10771 of the list elements (in full) of the original.
10772
10773 Examples:
10774 .code
10775 ${sort{3:2:1:4}{<}{$item}}
10776 .endd
10777 sorts a list of numbers, and
10778 .code
10779 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10780 .endd
10781 will sort an MX lookup into priority order.
10782
10783
10784
10785 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10786 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10787
10788
10789
10790 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10791 .cindex "&%substr%& expansion item"
10792 .cindex "substring extraction"
10793 .cindex "expansion" "substring extraction"
10794 The three strings are expanded; the first two must yield numbers. Call them
10795 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10796 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10797 can use the simpler operator notation that avoids some of the braces:
10798 .code
10799 ${substr_<n>_<m>:<subject>}
10800 .endd
10801 The second number is optional (in both notations).
10802 If it is absent in the simpler format, the preceding underscore must also be
10803 omitted.
10804
10805 The &%substr%& item can be used to extract more general substrings than
10806 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10807 length required. For example
10808 .code
10809 ${substr{3}{2}{$local_part}}
10810 .endd
10811 If the starting offset is greater than the string length the result is the
10812 null string; if the length plus starting offset is greater than the string
10813 length, the result is the right-hand part of the string, starting from the
10814 given offset. The first byte (character) in the string has offset zero.
10815
10816 The &%substr%& expansion item can take negative offset values to count
10817 from the right-hand end of its operand. The last byte (character) is offset -1,
10818 the second-last is offset -2, and so on. Thus, for example,
10819 .code
10820 ${substr{-5}{2}{1234567}}
10821 .endd
10822 yields &"34"&. If the absolute value of a negative offset is greater than the
10823 length of the string, the substring starts at the beginning of the string, and
10824 the length is reduced by the amount of overshoot. Thus, for example,
10825 .code
10826 ${substr{-5}{2}{12}}
10827 .endd
10828 yields an empty string, but
10829 .code
10830 ${substr{-3}{2}{12}}
10831 .endd
10832 yields &"1"&.
10833
10834 When the second number is omitted from &%substr%&, the remainder of the string
10835 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10836 string preceding the offset point are taken. For example, an offset of -1 and
10837 no length, as in these semantically identical examples:
10838 .code
10839 ${substr_-1:abcde}
10840 ${substr{-1}{abcde}}
10841 .endd
10842 yields all but the last character of the string, that is, &"abcd"&.
10843
10844 All measurement is done in bytes and is not UTF-8 aware.
10845
10846
10847
10848 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10849         {*&<&'replacements'&>&*}}*&"
10850 .cindex "expansion" "character translation"
10851 .cindex "&%tr%& expansion item"
10852 This item does single-character (in bytes) translation on its subject string. The second
10853 argument is a list of characters to be translated in the subject string. Each
10854 matching character is replaced by the corresponding character from the
10855 replacement list. For example
10856 .code
10857 ${tr{abcdea}{ac}{13}}
10858 .endd
10859 yields &`1b3de1`&. If there are duplicates in the second character string, the
10860 last occurrence is used. If the third string is shorter than the second, its
10861 last character is replicated. However, if it is empty, no translation takes
10862 place.
10863
10864 All character handling is done in bytes and is not UTF-8 aware.
10865
10866 .endlist
10867
10868
10869
10870 .section "Expansion operators" "SECTexpop"
10871 .cindex "expansion" "operators"
10872 For expansion items that perform transformations on a single argument string,
10873 the &"operator"& notation is used because it is simpler and uses fewer braces.
10874 The substring is first expanded before the operation is applied to it. The
10875 following operations can be performed:
10876
10877 .vlist
10878 .vitem &*${address:*&<&'string'&>&*}*&
10879 .cindex "expansion" "RFC 2822 address handling"
10880 .cindex "&%address%& expansion item"
10881 The string is interpreted as an RFC 2822 address, as it might appear in a
10882 header line, and the effective address is extracted from it. If the string does
10883 not parse successfully, the result is empty.
10884
10885 The parsing correctly handles SMTPUTF8 Unicode in the string.
10886
10887
10888 .vitem &*${addresses:*&<&'string'&>&*}*&
10889 .cindex "expansion" "RFC 2822 address handling"
10890 .cindex "&%addresses%& expansion item"
10891 The string (after expansion) is interpreted as a list of addresses in RFC
10892 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10893 operative address (&'local-part@domain'&) is extracted from each item, and the
10894 result of the expansion is a colon-separated list, with appropriate
10895 doubling of colons should any happen to be present in the email addresses.
10896 Syntactically invalid RFC2822 address items are omitted from the output.
10897
10898 It is possible to specify a character other than colon for the output
10899 separator by starting the string with > followed by the new separator
10900 character. For example:
10901 .code
10902 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10903 .endd
10904 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10905 first, so if the expanded string starts with >, it may change the output
10906 separator unintentionally. This can be avoided by setting the output
10907 separator explicitly:
10908 .code
10909 ${addresses:>:$h_from:}
10910 .endd
10911
10912 Compare the &%address%& (singular)
10913 expansion item, which extracts the working address from a single RFC2822
10914 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10915 processing lists.
10916
10917 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10918 a strict interpretation of header line formatting.  Exim parses the bare,
10919 unquoted portion of an email address and if it finds a comma, treats it as an
10920 email address separator. For the example header line:
10921 .code
10922 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10923 .endd
10924 The first example below demonstrates that Q-encoded email addresses are parsed
10925 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10926 It does not see the comma because it's still encoded as "=2C".  The second
10927 example below is passed the contents of &`$header_from:`&, meaning it gets
10928 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10929 The third example shows that the presence of a comma is skipped when it is
10930 quoted.  The fourth example shows SMTPUTF8 handling.
10931 .code
10932 # exim -be '${addresses:From: \
10933 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10934 user@example.com
10935 # exim -be '${addresses:From: Last, First <user@example.com>}'
10936 Last:user@example.com
10937 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10938 user@example.com
10939 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10940 フィリップ@example.jp
10941 .endd
10942
10943 .vitem &*${base32:*&<&'digits'&>&*}*&
10944 .cindex "&%base32%& expansion item"
10945 .cindex "expansion" "conversion to base 32"
10946 The string must consist entirely of decimal digits. The number is converted to
10947 base 32 and output as a (empty, for zero) string of characters.
10948 Only lowercase letters are used.
10949
10950 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10951 .cindex "&%base32d%& expansion item"
10952 .cindex "expansion" "conversion to base 32"
10953 The string must consist entirely of base-32 digits.
10954 The number is converted to decimal and output as a string.
10955
10956 .vitem &*${base62:*&<&'digits'&>&*}*&
10957 .cindex "&%base62%& expansion item"
10958 .cindex "expansion" "conversion to base 62"
10959 The string must consist entirely of decimal digits. The number is converted to
10960 base 62 and output as a string of six characters, including leading zeros. In
10961 the few operating environments where Exim uses base 36 instead of base 62 for
10962 its message identifiers (because those systems do not have case-sensitive
10963 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10964 to be absolutely clear: this is &'not'& base64 encoding.
10965
10966 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10967 .cindex "&%base62d%& expansion item"
10968 .cindex "expansion" "conversion to base 62"
10969 The string must consist entirely of base-62 digits, or, in operating
10970 environments where Exim uses base 36 instead of base 62 for its message
10971 identifiers, base-36 digits. The number is converted to decimal and output as a
10972 string.
10973
10974 .vitem &*${base64:*&<&'string'&>&*}*&
10975 .cindex "expansion" "base64 encoding"
10976 .cindex "base64 encoding" "in string expansion"
10977 .cindex "&%base64%& expansion item"
10978 .cindex certificate "base64 of DER"
10979 This operator converts a string into one that is base64 encoded.
10980
10981 If the string is a single variable of type certificate,
10982 returns the base64 encoding of the DER form of the certificate.
10983
10984
10985 .vitem &*${base64d:*&<&'string'&>&*}*&
10986 .cindex "expansion" "base64 decoding"
10987 .cindex "base64 decoding" "in string expansion"
10988 .cindex "&%base64d%& expansion item"
10989 This operator converts a base64-encoded string into the un-coded form.
10990
10991
10992 .vitem &*${domain:*&<&'string'&>&*}*&
10993 .cindex "domain" "extraction"
10994 .cindex "expansion" "domain extraction"
10995 The string is interpreted as an RFC 2822 address and the domain is extracted
10996 from it. If the string does not parse successfully, the result is empty.
10997
10998
10999 .vitem &*${escape:*&<&'string'&>&*}*&
11000 .cindex "expansion" "escaping non-printing characters"
11001 .cindex "&%escape%& expansion item"
11002 If the string contains any non-printing characters, they are converted to
11003 escape sequences starting with a backslash. Whether characters with the most
11004 significant bit set (so-called &"8-bit characters"&) count as printing or not
11005 is controlled by the &%print_topbitchars%& option.
11006
11007 .vitem &*${escape8bit:*&<&'string'&>&*}*&
11008 .cindex "expansion" "escaping 8-bit characters"
11009 .cindex "&%escape8bit%& expansion item"
11010 If the string contains any characters with the most significant bit set,
11011 they are converted to escape sequences starting with a backslash.
11012 Backslashes and DEL characters are also converted.
11013
11014
11015 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
11016 .cindex "expansion" "expression evaluation"
11017 .cindex "expansion" "arithmetic expression"
11018 .cindex "&%eval%& expansion item"
11019 These items supports simple arithmetic and bitwise logical operations in
11020 expansion strings. The string (after expansion) must be a conventional
11021 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11022 logical operators, and parentheses. All operations are carried out using
11023 integer arithmetic. The operator priorities are as follows (the same as in the
11024 C programming language):
11025 .table2 70pt 300pt
11026 .irow &'highest:'& "not (~), negate (-)"
11027 .irow ""   "multiply (*), divide (/), remainder (%)"
11028 .irow ""   "plus (+), minus (-)"
11029 .irow ""   "shift-left (<<), shift-right (>>)"
11030 .irow ""   "and (&&)"
11031 .irow ""   "xor (^)"
11032 .irow &'lowest:'&  "or (|)"
11033 .endtable
11034 Binary operators with the same priority are evaluated from left to right. White
11035 space is permitted before or after operators.
11036
11037 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11038 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11039 decimal, even if they start with a leading zero; hexadecimal numbers are not
11040 permitted. This can be useful when processing numbers extracted from dates or
11041 times, which often do have leading zeros.
11042
11043 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11044 or 1024*1024*1024,
11045 respectively. Negative numbers are supported. The result of the computation is
11046 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11047
11048 .display
11049 &`${eval:1+1}            `&  yields 2
11050 &`${eval:1+2*3}          `&  yields 7
11051 &`${eval:(1+2)*3}        `&  yields 9
11052 &`${eval:2+42%5}         `&  yields 4
11053 &`${eval:0xc&amp;5}          `&  yields 4
11054 &`${eval:0xc|5}          `&  yields 13
11055 &`${eval:0xc^5}          `&  yields 9
11056 &`${eval:0xc>>1}         `&  yields 6
11057 &`${eval:0xc<<1}         `&  yields 24
11058 &`${eval:~255&amp;0x1234}    `&  yields 4608
11059 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11060 .endd
11061
11062 As a more realistic example, in an ACL you might have
11063 .code
11064 deny   condition =                    \
11065          ${if and {                   \
11066            {>{$rcpt_count}{10}}       \
11067            {                          \
11068            <                          \
11069              {$recipients_count}      \
11070              {${eval:$rcpt_count/2}}  \
11071            }                          \
11072          }{yes}{no}}
11073        message = Too many bad recipients
11074 .endd
11075 The condition is true if there have been more than 10 RCPT commands and
11076 fewer than half of them have resulted in a valid recipient.
11077
11078
11079 .vitem &*${expand:*&<&'string'&>&*}*&
11080 .cindex "expansion" "re-expansion of substring"
11081 The &%expand%& operator causes a string to be expanded for a second time. For
11082 example,
11083 .code
11084 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11085 .endd
11086 first looks up a string in a file while expanding the operand for &%expand%&,
11087 and then re-expands what it has found.
11088
11089
11090 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11091 .cindex "Unicode"
11092 .cindex "UTF-8" "conversion from"
11093 .cindex "expansion" "UTF-8 conversion"
11094 .cindex "&%from_utf8%& expansion item"
11095 The world is slowly moving towards Unicode, although there are no standards for
11096 email yet. However, other applications (including some databases) are starting
11097 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11098 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11099 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11100 the result is an undefined sequence of bytes.
11101
11102 Unicode code points with values less than 256 are compatible with ASCII and
11103 ISO-8859-1 (also known as Latin-1).
11104 For example, character 169 is the copyright symbol in both cases, though the
11105 way it is encoded is different. In UTF-8, more than one byte is needed for
11106 characters with code values greater than 127, whereas ISO-8859-1 is a
11107 single-byte encoding (but thereby limited to 256 characters). This makes
11108 translation from UTF-8 to ISO-8859-1 straightforward.
11109
11110
11111 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11112 .cindex "hash function" "textual"
11113 .cindex "expansion" "textual hash"
11114 The &%hash%& operator is a simpler interface to the hashing function that can
11115 be used when the two parameters are fixed numbers (as opposed to strings that
11116 change when expanded). The effect is the same as
11117 .code
11118 ${hash{<n>}{<m>}{<string>}}
11119 .endd
11120 See the description of the general &%hash%& item above for details. The
11121 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11122
11123
11124
11125 .new
11126 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11127 .cindex header "wrapping operator"
11128 .cindex expansion "header wrapping"
11129 This operator line-wraps its argument in a way useful for headers.
11130 The &'cols'& value gives the column number to wrap after,
11131 the &'limit'& gives a limit number of result characters to truncate at.
11132 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11133 the defaults are 80 and 998.
11134 Wrapping will be inserted at a space if possible before the
11135 column number is reached.
11136 Whitespace at a chosen wrap point is removed.
11137 A line-wrap consists of a newline followed by a tab,
11138 and the tab is counted as 8 columns.
11139 .wen
11140
11141
11142
11143 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11144 .cindex "base64 encoding" "conversion from hex"
11145 .cindex "expansion" "hex to base64"
11146 .cindex "&%hex2b64%& expansion item"
11147 This operator converts a hex string into one that is base64 encoded. This can
11148 be useful for processing the output of the various hashing functions.
11149
11150
11151
11152 .vitem &*${hexquote:*&<&'string'&>&*}*&
11153 .cindex "quoting" "hex-encoded unprintable characters"
11154 .cindex "&%hexquote%& expansion item"
11155 This operator converts non-printable characters in a string into a hex
11156 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11157 as is, and other byte values are converted to &`\xNN`&, for example, a
11158 byte value 127 is converted to &`\x7f`&.
11159
11160
11161 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11162 .cindex "&%ipv6denorm%& expansion item"
11163 .cindex "IP address" normalisation
11164 This expands an IPv6 address to a full eight-element colon-separated set
11165 of hex digits including leading zeroes.
11166 A trailing ipv4-style dotted-decimal set is converted to hex.
11167 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11168
11169 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11170 .cindex "&%ipv6norm%& expansion item"
11171 .cindex "IP address" normalisation
11172 .cindex "IP address" "canonical form"
11173 This converts an IPv6 address to canonical form.
11174 Leading zeroes of groups are omitted, and the longest
11175 set of zero-valued groups is replaced with a double colon.
11176 A trailing ipv4-style dotted-decimal set is converted to hex.
11177 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11178
11179
11180 .vitem &*${lc:*&<&'string'&>&*}*&
11181 .cindex "case forcing in strings"
11182 .cindex "string" "case forcing"
11183 .cindex "lower casing"
11184 .cindex "expansion" "case forcing"
11185 .cindex "&%lc%& expansion item"
11186 This forces the letters in the string into lower-case, for example:
11187 .code
11188 ${lc:$local_part}
11189 .endd
11190 Case is defined per the system C locale.
11191
11192 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11193 .cindex "expansion" "string truncation"
11194 .cindex "&%length%& expansion item"
11195 The &%length%& operator is a simpler interface to the &%length%& function that
11196 can be used when the parameter is a fixed number (as opposed to a string that
11197 changes when expanded). The effect is the same as
11198 .code
11199 ${length{<number>}{<string>}}
11200 .endd
11201 See the description of the general &%length%& item above for details. Note that
11202 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11203 when &%length%& is used as an operator.
11204 All measurement is done in bytes and is not UTF-8 aware.
11205
11206
11207 .vitem &*${listcount:*&<&'string'&>&*}*&
11208 .cindex "expansion" "list item count"
11209 .cindex "list" "item count"
11210 .cindex "list" "count of items"
11211 .cindex "&%listcount%& expansion item"
11212 The string is interpreted as a list and the number of items is returned.
11213
11214
11215 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11216 .cindex "expansion" "named list"
11217 .cindex "&%listnamed%& expansion item"
11218 The name is interpreted as a named list and the content of the list is returned,
11219 expanding any referenced lists, re-quoting as needed for colon-separation.
11220 If the optional type is given it must be one of "a", "d", "h" or "l"
11221 and selects address-, domain-, host- or localpart- lists to search among respectively.
11222 Otherwise all types are searched in an undefined order and the first
11223 matching list is returned.
11224 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11225 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11226
11227
11228 .vitem &*${local_part:*&<&'string'&>&*}*&
11229 .cindex "expansion" "local part extraction"
11230 .cindex "&%local_part%& expansion item"
11231 The string is interpreted as an RFC 2822 address and the local part is
11232 extracted from it. If the string does not parse successfully, the result is
11233 empty.
11234 The parsing correctly handles SMTPUTF8 Unicode in the string.
11235
11236
11237 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11238        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11239 .cindex "masked IP address"
11240 .cindex "IP address" "masking"
11241 .cindex "CIDR notation"
11242 .cindex "expansion" "IP address masking"
11243 .cindex "&%mask%& expansion item"
11244 If the form of the string to be operated on is not an IP address followed by a
11245 slash and an integer (that is, a network address in CIDR notation), the
11246 expansion fails. Otherwise, this operator converts the IP address to binary,
11247 masks off the least significant bits according to the bit count, and converts
11248 the result back to text, with mask appended. For example,
11249 .code
11250 ${mask:10.111.131.206/28}
11251 .endd
11252 returns the string &"10.111.131.192/28"&.
11253
11254 Since this operation is expected to
11255 be mostly used for looking up masked addresses in files, the
11256 normal
11257 result for an IPv6
11258 address uses dots to separate components instead of colons, because colon
11259 terminates a key string in lsearch files. So, for example,
11260 .code
11261 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11262 .endd
11263 returns the string
11264 .code
11265 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11266 .endd
11267 If the optional form &*mask_n*& is used, IPv6 address result are instead
11268 returned in normailsed form, using colons and with zero-compression.
11269 Letters in IPv6 addresses are always output in lower case.
11270
11271
11272 .vitem &*${md5:*&<&'string'&>&*}*&
11273 .cindex "MD5 hash"
11274 .cindex "expansion" "MD5 hash"
11275 .cindex certificate fingerprint
11276 .cindex "&%md5%& expansion item"
11277 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11278 as a 32-digit hexadecimal number, in which any letters are in lower case.
11279
11280 If the string is a single variable of type certificate,
11281 returns the MD5 hash fingerprint of the certificate.
11282
11283
11284 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11285 .cindex "expansion" "numeric hash"
11286 .cindex "hash function" "numeric"
11287 The &%nhash%& operator is a simpler interface to the numeric hashing function
11288 that can be used when the two parameters are fixed numbers (as opposed to
11289 strings that change when expanded). The effect is the same as
11290 .code
11291 ${nhash{<n>}{<m>}{<string>}}
11292 .endd
11293 See the description of the general &%nhash%& item above for details.
11294
11295
11296 .vitem &*${quote:*&<&'string'&>&*}*&
11297 .cindex "quoting" "in string expansions"
11298 .cindex "expansion" "quoting"
11299 .cindex "&%quote%& expansion item"
11300 The &%quote%& operator puts its argument into double quotes if it
11301 is an empty string or
11302 contains anything other than letters, digits, underscores, dots, and hyphens.
11303 Any occurrences of double quotes and backslashes are escaped with a backslash.
11304 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11305 respectively For example,
11306 .code
11307 ${quote:ab"*"cd}
11308 .endd
11309 becomes
11310 .code
11311 "ab\"*\"cd"
11312 .endd
11313 The place where this is useful is when the argument is a substitution from a
11314 variable or a message header.
11315
11316 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11317 .cindex "&%quote_local_part%& expansion item"
11318 This operator is like &%quote%&, except that it quotes the string only if
11319 required to do so by the rules of RFC 2822 for quoting local parts. For
11320 example, a plus sign would not cause quoting (but it would for &%quote%&).
11321 If you are creating a new email address from the contents of &$local_part$&
11322 (or any other unknown data), you should always use this operator.
11323
11324 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11325 will likely use the quoting form.
11326 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11327
11328
11329 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11330 .cindex "quoting" "lookup-specific"
11331 This operator applies lookup-specific quoting rules to the string. Each
11332 query-style lookup type has its own quoting rules which are described with
11333 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11334 .code
11335 ${quote_ldap:two * two}
11336 .endd
11337 returns
11338 .code
11339 two%20%5C2A%20two
11340 .endd
11341 For single-key lookup types, no quoting is ever necessary and this operator
11342 yields an unchanged string.
11343
11344
11345 .vitem &*${randint:*&<&'n'&>&*}*&
11346 .cindex "random number"
11347 This operator returns a somewhat random number which is less than the
11348 supplied number and is at least 0.  The quality of this randomness depends
11349 on how Exim was built; the values are not suitable for keying material.
11350 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11351 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11352 for versions of GnuTLS with that function.
11353 Otherwise, the implementation may be arc4random(), random() seeded by
11354 srandomdev() or srandom(), or a custom implementation even weaker than
11355 random().
11356
11357
11358 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11359 .cindex "expansion" "IP address"
11360 This operator reverses an IP address; for IPv4 addresses, the result is in
11361 dotted-quad decimal form, while for IPv6 addresses the result is in
11362 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11363 for DNS.  For example,
11364 .code
11365 ${reverse_ip:192.0.2.4}
11366 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11367 .endd
11368 returns
11369 .code
11370 4.2.0.192
11371 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
11372 .endd
11373
11374
11375 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11376 .cindex "expansion" "RFC 2047"
11377 .cindex "RFC 2047" "expansion operator"
11378 .cindex "&%rfc2047%& expansion item"
11379 This operator encodes text according to the rules of RFC 2047. This is an
11380 encoding that is used in header lines to encode non-ASCII characters. It is
11381 assumed that the input string is in the encoding specified by the
11382 &%headers_charset%& option, which gets its default at build time. If the string
11383 contains only characters in the range 33&--126, and no instances of the
11384 characters
11385 .code
11386 ? = ( ) < > @ , ; : \ " . [ ] _
11387 .endd
11388 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11389 string, using as many &"encoded words"& as necessary to encode all the
11390 characters.
11391
11392
11393 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11394 .cindex "expansion" "RFC 2047"
11395 .cindex "RFC 2047" "decoding"
11396 .cindex "&%rfc2047d%& expansion item"
11397 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11398 bytes are replaced by question marks. Characters are converted into the
11399 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11400 not recognized unless &%check_rfc2047_length%& is set false.
11401
11402 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11403 access a header line, RFC 2047 decoding is done automatically. You do not need
11404 to use this operator as well.
11405
11406
11407
11408 .vitem &*${rxquote:*&<&'string'&>&*}*&
11409 .cindex "quoting" "in regular expressions"
11410 .cindex "regular expressions" "quoting"
11411 .cindex "&%rxquote%& expansion item"
11412 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11413 characters in its argument. This is useful when substituting the values of
11414 variables or headers inside regular expressions.
11415
11416
11417 .vitem &*${sha1:*&<&'string'&>&*}*&
11418 .cindex "SHA-1 hash"
11419 .cindex "expansion" "SHA-1 hashing"
11420 .cindex certificate fingerprint
11421 .cindex "&%sha1%& expansion item"
11422 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11423 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11424
11425 If the string is a single variable of type certificate,
11426 returns the SHA-1 hash fingerprint of the certificate.
11427
11428
11429 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11430        &*${sha2:*&<&'string'&>&*}*& &&&
11431        &*${sha2_<n>:*&<&'string'&>&*}*&
11432 .cindex "SHA-256 hash"
11433 .cindex "SHA-2 hash"
11434 .cindex certificate fingerprint
11435 .cindex "expansion" "SHA-256 hashing"
11436 .cindex "&%sha256%& expansion item"
11437 .cindex "&%sha2%& expansion item"
11438 The &%sha256%& operator computes the SHA-256 hash value of the string
11439 and returns
11440 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11441
11442 If the string is a single variable of type certificate,
11443 returns the SHA-256 hash fingerprint of the certificate.
11444
11445 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11446 (except for certificates, which are not supported).
11447 Finally, if an underbar
11448 and a number is appended it specifies the output length, selecting a
11449 member of the SHA-2 family of hash functions.
11450 Values of 256, 384 and 512 are accepted, with 256 being the default.
11451
11452
11453 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11454        &*${sha3_<n>:*&<&'string'&>&*}*&
11455 .cindex "SHA3 hash"
11456 .cindex "expansion" "SHA3 hashing"
11457 .cindex "&%sha3%& expansion item"
11458 The &%sha3%& operator computes the SHA3-256 hash value of the string
11459 and returns
11460 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11461
11462 If a number is appended, separated by an underbar, it specifies
11463 the output length.  Values of 224, 256, 384 and 512 are accepted;
11464 with 256 being the default.
11465
11466 The &%sha3%& expansion item is only supported if Exim has been
11467 compiled with GnuTLS 3.5.0 or later,
11468 or OpenSSL 1.1.1 or later.
11469 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11470
11471
11472 .vitem &*${stat:*&<&'string'&>&*}*&
11473 .cindex "expansion" "statting a file"
11474 .cindex "file" "extracting characteristics"
11475 .cindex "&%stat%& expansion item"
11476 The string, after expansion, must be a file path. A call to the &[stat()]&
11477 function is made for this path. If &[stat()]& fails, an error occurs and the
11478 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11479 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11480 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11481 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11482 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11483 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11484 can extract individual fields using the &%extract%& expansion item.
11485
11486 The use of the &%stat%& expansion in users' filter files can be locked out by
11487 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11488 systems for files larger than 2GB.
11489
11490 .vitem &*${str2b64:*&<&'string'&>&*}*&
11491 .cindex "&%str2b64%& expansion item"
11492 Now deprecated, a synonym for the &%base64%& expansion operator.
11493
11494
11495
11496 .vitem &*${strlen:*&<&'string'&>&*}*&
11497 .cindex "expansion" "string length"
11498 .cindex "string" "length in expansion"
11499 .cindex "&%strlen%& expansion item"
11500 The item is replaced by the length of the expanded string, expressed as a
11501 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11502 All measurement is done in bytes and is not UTF-8 aware.
11503
11504
11505 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11506 .cindex "&%substr%& expansion item"
11507 .cindex "substring extraction"
11508 .cindex "expansion" "substring expansion"
11509 The &%substr%& operator is a simpler interface to the &%substr%& function that
11510 can be used when the two parameters are fixed numbers (as opposed to strings
11511 that change when expanded). The effect is the same as
11512 .code
11513 ${substr{<start>}{<length>}{<string>}}
11514 .endd
11515 See the description of the general &%substr%& item above for details. The
11516 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11517 All measurement is done in bytes and is not UTF-8 aware.
11518
11519 .vitem &*${time_eval:*&<&'string'&>&*}*&
11520 .cindex "&%time_eval%& expansion item"
11521 .cindex "time interval" "decoding"
11522 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11523 seconds.
11524
11525 .vitem &*${time_interval:*&<&'string'&>&*}*&
11526 .cindex "&%time_interval%& expansion item"
11527 .cindex "time interval" "formatting"
11528 The argument (after sub-expansion) must be a sequence of decimal digits that
11529 represents an interval of time as a number of seconds. It is converted into a
11530 number of larger units and output in Exim's normal time format, for example,
11531 &`1w3d4h2m6s`&.
11532
11533 .vitem &*${uc:*&<&'string'&>&*}*&
11534 .cindex "case forcing in strings"
11535 .cindex "string" "case forcing"
11536 .cindex "upper casing"
11537 .cindex "expansion" "case forcing"
11538 .cindex "&%uc%& expansion item"
11539 This forces the letters in the string into upper-case.
11540 Case is defined per the system C locale.
11541
11542 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11543 .cindex "correction of invalid utf-8 sequences in strings"
11544 .cindex "utf-8" "utf-8 sequences"
11545 .cindex "incorrect utf-8"
11546 .cindex "expansion" "utf-8 forcing"
11547 .cindex "&%utf8clean%& expansion item"
11548 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11549 In versions of Exim before 4.92, this did not correctly do so for a truncated
11550 final codepoint's encoding, and the character would be silently dropped.
11551 If you must handle detection of this scenario across both sets of Exim behavior,
11552 the complexity will depend upon the task.
11553 For instance, to detect if the first character is multibyte and a 1-byte
11554 extraction can be successfully used as a path component (as is common for
11555 dividing up delivery folders), you might use:
11556 .code
11557 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11558 .endd
11559 (which will false-positive if the first character of the local part is a
11560 literal question mark).
11561
11562 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11563        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11564        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11565        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11566 .cindex expansion UTF-8
11567 .cindex UTF-8 expansion
11568 .cindex EAI
11569 .cindex internationalisation
11570 .cindex "&%utf8_domain_to_alabel%& expansion item"
11571 .cindex "&%utf8_domain_from_alabel%& expansion item"
11572 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11573 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11574 These convert EAI mail name components between UTF-8 and a-label forms.
11575 For information on internationalisation support see &<<SECTi18nMTA>>&.
11576 .endlist
11577
11578
11579
11580
11581
11582
11583 .section "Expansion conditions" "SECTexpcond"
11584 .scindex IIDexpcond "expansion" "conditions"
11585 The following conditions are available for testing by the &%${if%& construct
11586 while expanding strings:
11587
11588 .vlist
11589 .vitem &*!*&<&'condition'&>
11590 .cindex "expansion" "negating a condition"
11591 .cindex "negation" "in expansion condition"
11592 Preceding any condition with an exclamation mark negates the result of the
11593 condition.
11594
11595 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11596 .cindex "numeric comparison"
11597 .cindex "expansion" "numeric comparison"
11598 There are a number of symbolic operators for doing numeric comparisons. They
11599 are:
11600 .itable none 0 0 2 10* left 90* left
11601 .irow "=   " "equal"
11602 .irow "==  " "equal"
11603 .irow ">   " "greater"
11604 .irow ">=  " "greater or equal"
11605 .irow "<   " "less"
11606 .irow "<=  " "less or equal"
11607 .endtable
11608 For example:
11609 .code
11610 ${if >{$message_size}{10M} ...
11611 .endd
11612 Note that the general negation operator provides for inequality testing. The
11613 two strings must take the form of optionally signed decimal integers,
11614 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11615 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11616 As a special case, the numerical value of an empty string is taken as
11617 zero.
11618
11619 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11620 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11621 10M, not if 10M is larger than &$message_size$&.
11622
11623
11624 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11625         {*&<&'arg2'&>&*}...}*&
11626 .cindex "expansion" "calling an acl"
11627 .cindex "&%acl%&" "expansion condition"
11628 The name and zero to nine argument strings are first expanded separately.  The expanded
11629 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11630 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11631 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11632 and may use the variables; if another acl expansion is used the values
11633 are restored after it returns.  If the ACL sets
11634 a value using a "message =" modifier the variable $value becomes
11635 the result of the expansion, otherwise it is empty.
11636 If the ACL returns accept the condition is true; if deny, false.
11637 If the ACL returns defer the result is a forced-fail.
11638
11639 .vitem &*bool&~{*&<&'string'&>&*}*&
11640 .cindex "expansion" "boolean parsing"
11641 .cindex "&%bool%& expansion condition"
11642 This condition turns a string holding a true or false representation into
11643 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11644 (case-insensitively); also integer numbers map to true if non-zero,
11645 false if zero.
11646 An empty string is treated as false.
11647 Leading and trailing whitespace is ignored;
11648 thus a string consisting only of whitespace is false.
11649 All other string values will result in expansion failure.
11650
11651 When combined with ACL variables, this expansion condition will let you
11652 make decisions in one place and act on those decisions in another place.
11653 For example:
11654 .code
11655 ${if bool{$acl_m_privileged_sender} ...
11656 .endd
11657
11658
11659 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11660 .cindex "expansion" "boolean parsing"
11661 .cindex "&%bool_lax%& expansion condition"
11662 Like &%bool%&, this condition turns a string into a boolean state.  But
11663 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11664 loose definition that the Router &%condition%& option uses.  The empty string
11665 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11666 true.  Leading and trailing whitespace is ignored.
11667
11668 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11669
11670 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11671 .cindex "expansion" "encrypted comparison"
11672 .cindex "encrypted strings, comparing"
11673 .cindex "&%crypteq%& expansion condition"
11674 This condition is included in the Exim binary if it is built to support any
11675 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11676 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11677 included in the binary.
11678
11679 The &%crypteq%& condition has two arguments. The first is encrypted and
11680 compared against the second, which is already encrypted. The second string may
11681 be in the LDAP form for storing encrypted strings, which starts with the
11682 encryption type in curly brackets, followed by the data. If the second string
11683 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11684 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11685 Typically this will be a field from a password file. An example of an encrypted
11686 string in LDAP form is:
11687 .code
11688 {md5}CY9rzUYh03PK3k6DJie09g==
11689 .endd
11690 If such a string appears directly in an expansion, the curly brackets have to
11691 be quoted, because they are part of the expansion syntax. For example:
11692 .code
11693 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11694 .endd
11695 The following encryption types (whose names are matched case-independently) are
11696 supported:
11697
11698 .ilist
11699 .cindex "MD5 hash"
11700 .cindex "base64 encoding" "in encrypted password"
11701 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11702 printable characters to compare with the remainder of the second string. If the
11703 length of the comparison string is 24, Exim assumes that it is base64 encoded
11704 (as in the above example). If the length is 32, Exim assumes that it is a
11705 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11706 comparison fails.
11707
11708 .next
11709 .cindex "SHA-1 hash"
11710 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11711 printable characters to compare with the remainder of the second string. If the
11712 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11713 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11714 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11715
11716 .next
11717 .cindex "&[crypt()]&"
11718 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11719 only the first eight characters of the password. However, in modern operating
11720 systems this is no longer true, and in many cases the entire password is used,
11721 whatever its length.
11722
11723 .next
11724 .cindex "&[crypt16()]&"
11725 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11726 use up to 16 characters of the password in some operating systems. Again, in
11727 modern operating systems, more characters may be used.
11728 .endlist
11729 Exim has its own version of &[crypt16()]&, which is just a double call to
11730 &[crypt()]&. For operating systems that have their own version, setting
11731 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11732 operating system version instead of its own. This option is set by default in
11733 the OS-dependent &_Makefile_& for those operating systems that are known to
11734 support &[crypt16()]&.
11735
11736 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11737 it was not using the same algorithm as some operating systems' versions. It
11738 turns out that as well as &[crypt16()]& there is a function called
11739 &[bigcrypt()]& in some operating systems. This may or may not use the same
11740 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11741
11742 However, since there is now a move away from the traditional &[crypt()]&
11743 functions towards using SHA1 and other algorithms, tidying up this area of
11744 Exim is seen as very low priority.
11745
11746 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11747 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11748 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11749 default is &`{crypt}`&. Whatever the default, you can always use either
11750 function by specifying it explicitly in curly brackets.
11751
11752 .vitem &*def:*&<&'variable&~name'&>
11753 .cindex "expansion" "checking for empty variable"
11754 .cindex "&%def%& expansion condition"
11755 The &%def%& condition must be followed by the name of one of the expansion
11756 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11757 variable does not contain the empty string. For example:
11758 .code
11759 ${if def:sender_ident {from $sender_ident}}
11760 .endd
11761 Note that the variable name is given without a leading &%$%& character. If the
11762 variable does not exist, the expansion fails.
11763
11764 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11765         &~&*def:h_*&<&'header&~name'&>&*:*&"
11766 .cindex "expansion" "checking header line existence"
11767 This condition is true if a message is being processed and the named header
11768 exists in the message. For example,
11769 .code
11770 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11771 .endd
11772 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11773 the header name must be terminated by a colon if white space does not follow.
11774
11775 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11776        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11777 .cindex "string" "comparison"
11778 .cindex "expansion" "string comparison"
11779 .cindex "&%eq%& expansion condition"
11780 .cindex "&%eqi%& expansion condition"
11781 The two substrings are first expanded. The condition is true if the two
11782 resulting strings are identical. For &%eq%& the comparison includes the case of
11783 letters, whereas for &%eqi%& the comparison is case-independent, where
11784 case is defined per the system C locale.
11785
11786 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11787 .cindex "expansion" "file existence test"
11788 .cindex "file" "existence test"
11789 .cindex "&%exists%&, expansion condition"
11790 The substring is first expanded and then interpreted as an absolute path. The
11791 condition is true if the named file (or directory) exists. The existence test
11792 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11793 users' filter files may be locked out by the system administrator.
11794
11795 &*Note:*& Testing a path using this condition is not a sufficient way of
11796 de-tainting it.
11797 Consider using a dsearch lookup.
11798
11799 .vitem &*first_delivery*&
11800 .cindex "delivery" "first"
11801 .cindex "first delivery"
11802 .cindex "expansion" "first delivery test"
11803 .cindex "&%first_delivery%& expansion condition"
11804 .cindex retry condition
11805 This condition, which has no data, is true during a message's first delivery
11806 attempt. It is false during any subsequent delivery attempts.
11807
11808
11809 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11810        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11811 .cindex "list" "iterative conditions"
11812 .cindex "expansion" "&*forall*& condition"
11813 .cindex "expansion" "&*forany*& condition"
11814 .vindex "&$item$&"
11815 These conditions iterate over a list. The first argument is expanded to form
11816 the list. By default, the list separator is a colon, but it can be changed by
11817 the normal method (&<<SECTlistsepchange>>&).
11818 The second argument is interpreted as a condition that is to
11819 be applied to each item in the list in turn. During the interpretation of the
11820 condition, the current list item is placed in a variable called &$item$&.
11821 .ilist
11822 For &*forany*&, interpretation stops if the condition is true for any item, and
11823 the result of the whole condition is true. If the condition is false for all
11824 items in the list, the overall condition is false.
11825 .next
11826 For &*forall*&, interpretation stops if the condition is false for any item,
11827 and the result of the whole condition is false. If the condition is true for
11828 all items in the list, the overall condition is true.
11829 .endlist
11830 Note that negation of &*forany*& means that the condition must be false for all
11831 items for the overall condition to succeed, and negation of &*forall*& means
11832 that the condition must be false for at least one item.
11833
11834 Example:
11835 .code
11836 ${if forany{$recipients_list}{match{$item}{^user3@}}{yes}{no}}
11837 .endd
11838 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11839 being processed, to enable these expansion items to be nested.
11840
11841 To scan a named list, expand it with the &*listnamed*& operator.
11842
11843 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11844        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11845        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11846        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11847 .cindex JSON "iterative conditions"
11848 .cindex JSON expansions
11849 .cindex expansion "&*forall_json*& condition"
11850 .cindex expansion "&*forany_json*& condition"
11851 .cindex expansion "&*forall_jsons*& condition"
11852 .cindex expansion "&*forany_jsons*& condition"
11853 As for the above, except that the first argument must, after expansion,
11854 be a JSON array.
11855 The array separator is not changeable.
11856 For the &"jsons"& variants the elements are expected to be JSON strings
11857 and have their quotes removed before the evaluation of the condition.
11858
11859
11860
11861 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11862        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11863 .cindex "string" "comparison"
11864 .cindex "expansion" "string comparison"
11865 .cindex "&%ge%& expansion condition"
11866 .cindex "&%gei%& expansion condition"
11867 The two substrings are first expanded. The condition is true if the first
11868 string is lexically greater than or equal to the second string. For &%ge%& the
11869 comparison includes the case of letters, whereas for &%gei%& the comparison is
11870 case-independent.
11871 Case and collation order are defined per the system C locale.
11872
11873 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11874        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11875 .cindex "string" "comparison"
11876 .cindex "expansion" "string comparison"
11877 .cindex "&%gt%& expansion condition"
11878 .cindex "&%gti%& expansion condition"
11879 The two substrings are first expanded. The condition is true if the first
11880 string is lexically greater than the second string. For &%gt%& the comparison
11881 includes the case of letters, whereas for &%gti%& the comparison is
11882 case-independent.
11883 Case and collation order are defined per the system C locale.
11884
11885
11886 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11887 SRS decode.  See SECT &<<SECTSRS>>& for details.
11888
11889
11890 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11891        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11892 .cindex "string" "comparison"
11893 .cindex "list" "iterative conditions"
11894 Both strings are expanded; the second string is treated as a list of simple
11895 strings; if the first string is a member of the second, then the condition
11896 is true.
11897 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11898
11899 These are simpler to use versions of the more powerful &*forany*& condition.
11900 Examples, and the &*forany*& equivalents:
11901 .code
11902 ${if inlist{needle}{foo:needle:bar}}
11903   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11904 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11905   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11906 .endd
11907
11908 The variable &$value$& will be set for a successful match and can be
11909 used in the success clause of an &%if%& expansion item using the condition.
11910 .cindex "tainted data" "de-tainting"
11911 .cindex "de-tainting" "using an inlist expansion condition"
11912 It will have the same taint status as the list; expansions such as
11913 .code
11914 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11915 .endd
11916 can be used for de-tainting.
11917 Any previous &$value$& is restored after the if.
11918
11919
11920 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11921        &*isip4&~{*&<&'string'&>&*}*& &&&
11922        &*isip6&~{*&<&'string'&>&*}*&
11923 .cindex "IP address" "testing string format"
11924 .cindex "string" "testing for IP address"
11925 .cindex "&%isip%& expansion condition"
11926 .cindex "&%isip4%& expansion condition"
11927 .cindex "&%isip6%& expansion condition"
11928 The substring is first expanded, and then tested to see if it has the form of
11929 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11930 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11931
11932 For an IPv4 address, the test is for four dot-separated components, each of
11933 which consists of from one to three digits. For an IPv6 address, up to eight
11934 colon-separated components are permitted, each containing from one to four
11935 hexadecimal digits. There may be fewer than eight components if an empty
11936 component (adjacent colons) is present. Only one empty component is permitted.
11937
11938 &*Note*&: The checks used to be just on the form of the address; actual numerical
11939 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11940 check.
11941 This is no longer the case.
11942
11943 The main use of these tests is to distinguish between IP addresses and
11944 host names, or between IPv4 and IPv6 addresses. For example, you could use
11945 .code
11946 ${if isip4{$sender_host_address}...
11947 .endd
11948 to test which IP version an incoming SMTP connection is using.
11949
11950 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11951 .cindex "LDAP" "use for authentication"
11952 .cindex "expansion" "LDAP authentication test"
11953 .cindex "&%ldapauth%& expansion condition"
11954 This condition supports user authentication using LDAP. See section
11955 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11956 queries. For this use, the query must contain a user name and password. The
11957 query itself is not used, and can be empty. The condition is true if the
11958 password is not empty, and the user name and password are accepted by the LDAP
11959 server. An empty password is rejected without calling LDAP because LDAP binds
11960 with an empty password are considered anonymous regardless of the username, and
11961 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11962 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11963 this can be used.
11964
11965
11966 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11967        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11968 .cindex "string" "comparison"
11969 .cindex "expansion" "string comparison"
11970 .cindex "&%le%& expansion condition"
11971 .cindex "&%lei%& expansion condition"
11972 The two substrings are first expanded. The condition is true if the first
11973 string is lexically less than or equal to the second string. For &%le%& the
11974 comparison includes the case of letters, whereas for &%lei%& the comparison is
11975 case-independent.
11976 Case and collation order are defined per the system C locale.
11977
11978 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11979        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11980 .cindex "string" "comparison"
11981 .cindex "expansion" "string comparison"
11982 .cindex "&%lt%& expansion condition"
11983 .cindex "&%lti%& expansion condition"
11984 The two substrings are first expanded. The condition is true if the first
11985 string is lexically less than the second string. For &%lt%& the comparison
11986 includes the case of letters, whereas for &%lti%& the comparison is
11987 case-independent.
11988 Case and collation order are defined per the system C locale.
11989
11990
11991 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11992 .cindex "expansion" "regular expression comparison"
11993 .cindex "regular expressions" "match in expanded string"
11994 .cindex "&%match%& expansion condition"
11995 The two substrings are first expanded. The second is then treated as a regular
11996 expression and applied to the first. Because of the pre-expansion, if the
11997 regular expression contains dollar, or backslash characters, they must be
11998 escaped. Care must also be taken if the regular expression contains braces
11999 (curly brackets). A closing brace must be escaped so that it is not taken as a
12000 premature termination of <&'string2'&>. The easiest approach is to use the
12001 &`\N`& feature to disable expansion of the regular expression.
12002 For example,
12003 .code
12004 ${if match {$local_part}{\N^\d{3}\N} ...
12005 .endd
12006 If the whole expansion string is in double quotes, further escaping of
12007 backslashes is also required.
12008
12009 The condition is true if the regular expression match succeeds.
12010 The regular expression is not required to begin with a circumflex
12011 metacharacter, but if there is no circumflex, the expression is not anchored,
12012 and it may match anywhere in the subject, not just at the start. If you want
12013 the pattern to match at the end of the subject, you must include the &`$`&
12014 metacharacter at an appropriate point.
12015 All character handling is done in bytes and is not UTF-8 aware,
12016 but we might change this in a future Exim release.
12017
12018 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
12019 At the start of an &%if%& expansion the values of the numeric variable
12020 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
12021 succeeds causes them to be reset to the substrings of that condition and they
12022 will have these values during the expansion of the success string. At the end
12023 of the &%if%& expansion, the previous values are restored. After testing a
12024 combination of conditions using &%or%&, the subsequent values of the numeric
12025 variables are those of the condition that succeeded.
12026
12027 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12028 .cindex "&%match_address%& expansion condition"
12029 See &*match_local_part*&.
12030
12031 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12032 .cindex "&%match_domain%& expansion condition"
12033 See &*match_local_part*&.
12034
12035 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12036 .cindex "&%match_ip%& expansion condition"
12037 This condition matches an IP address to a list of IP address patterns. It must
12038 be followed by two argument strings. The first (after expansion) must be an IP
12039 address or an empty string. The second (not expanded) is a restricted host
12040 list that can match only an IP address, not a host name. For example:
12041 .code
12042 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12043 .endd
12044 The specific types of host list item that are permitted in the list are:
12045
12046 .ilist
12047 An IP address, optionally with a CIDR mask.
12048 .next
12049 A single asterisk, which matches any IP address.
12050 .next
12051 An empty item, which matches only if the IP address is empty. This could be
12052 useful for testing for a locally submitted message or one from specific hosts
12053 in a single test such as
12054 . ==== As this is a nested list, any displays it contains must be indented
12055 . ==== as otherwise they are too far to the left. This comment applies to
12056 . ==== the use of xmlto plus fop. There's no problem when formatting with
12057 . ==== sdop, with or without the extra indent.
12058 .code
12059   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12060 .endd
12061 where the first item in the list is the empty string.
12062 .next
12063 The item @[] matches any of the local host's interface addresses.
12064 .next
12065 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12066 even if &`net-`& is not specified. There is never any attempt to turn the IP
12067 address into a host name. The most common type of linear search for
12068 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12069 masks. For example:
12070 .code
12071   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12072 .endd
12073 It is of course possible to use other kinds of lookup, and in such a case, you
12074 do need to specify the &`net-`& prefix if you want to specify a specific
12075 address mask, for example:
12076 .code
12077   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12078 .endd
12079 However, unless you are combining a &%match_ip%& condition with others, it is
12080 just as easy to use the fact that a lookup is itself a condition, and write:
12081 .code
12082   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12083 .endd
12084 .endlist ilist
12085
12086 Note that <&'string2'&> is not itself subject to string expansion, unless
12087 Exim was built with the EXPAND_LISTMATCH_RHS option.
12088
12089 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12090
12091 The variable &$value$& will be set for a successful match and can be
12092 used in the success clause of an &%if%& expansion item using the condition.
12093 Any previous &$value$& is restored after the if.
12094
12095 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12096 .cindex "domain list" "in expansion condition"
12097 .cindex "address list" "in expansion condition"
12098 .cindex "local part" "list, in expansion condition"
12099 .cindex "&%match_local_part%& expansion condition"
12100 This condition, together with &%match_address%& and &%match_domain%&, make it
12101 possible to test domain, address, and local part lists within expansions. Each
12102 condition requires two arguments: an item and a list to match. A trivial
12103 example is:
12104 .code
12105 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12106 .endd
12107 In each case, the second argument may contain any of the allowable items for a
12108 list of the appropriate type. Also, because the second argument
12109 is a standard form of list, it is possible to refer to a named list.
12110 Thus, you can use conditions like this:
12111 .code
12112 ${if match_domain{$domain}{+local_domains}{...
12113 .endd
12114 .cindex "&`+caseful`&"
12115 For address lists, the matching starts off caselessly, but the &`+caseful`&
12116 item can be used, as in all address lists, to cause subsequent items to
12117 have their local parts matched casefully. Domains are always matched
12118 caselessly.
12119
12120 The variable &$value$& will be set for a successful match and can be
12121 used in the success clause of an &%if%& expansion item using the condition.
12122 .cindex "tainted data" "de-tainting"
12123 .cindex "de-tainting" "using a match_local_part expansion condition"
12124 It will have the same taint status as the list; expansions such as
12125 .code
12126 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12127 .endd
12128 can be used for de-tainting.
12129 Any previous &$value$& is restored after the if.
12130
12131 Note that <&'string2'&> is not itself subject to string expansion, unless
12132 Exim was built with the EXPAND_LISTMATCH_RHS option.
12133
12134 &*Note*&: Host lists are &'not'& supported in this way. This is because
12135 hosts have two identities: a name and an IP address, and it is not clear
12136 how to specify cleanly how such a test would work. However, IP addresses can be
12137 matched using &%match_ip%&.
12138
12139 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12140 .cindex "PAM authentication"
12141 .cindex "AUTH" "with PAM"
12142 .cindex "Solaris" "PAM support"
12143 .cindex "expansion" "PAM authentication test"
12144 .cindex "&%pam%& expansion condition"
12145 &'Pluggable Authentication Modules'&
12146 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12147 available in Solaris
12148 and in some GNU/Linux distributions.
12149 The Exim support, which is intended for use in conjunction with
12150 the SMTP AUTH command, is available only if Exim is compiled with
12151 .code
12152 SUPPORT_PAM=yes
12153 .endd
12154 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12155 in some releases of GNU/Linux &%-ldl%& is also needed.
12156
12157 The argument string is first expanded, and the result must be a
12158 colon-separated list of strings. Leading and trailing white space is ignored.
12159 The PAM module is initialized with the service name &"exim"& and the user name
12160 taken from the first item in the colon-separated data string (<&'string1'&>).
12161 The remaining items in the data string are passed over in response to requests
12162 from the authentication function. In the simple case there will only be one
12163 request, for a password, so the data consists of just two strings.
12164
12165 There can be problems if any of the strings are permitted to contain colon
12166 characters. In the usual way, these have to be doubled to avoid being taken as
12167 separators.
12168 The &%listquote%& expansion item can be used for this.
12169 For example, the configuration
12170 of a LOGIN authenticator might contain this setting:
12171 .code
12172 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12173 .endd
12174 In some operating systems, PAM authentication can be done only from a process
12175 running as root. Since Exim is running as the Exim user when receiving
12176 messages, this means that PAM cannot be used directly in those systems.
12177 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12178
12179
12180 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12181 .cindex "&'pwcheck'& daemon"
12182 .cindex "Cyrus"
12183 .cindex "expansion" "&'pwcheck'& authentication test"
12184 .cindex "&%pwcheck%& expansion condition"
12185 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12186 This is one way of making it possible for passwords to be checked by a process
12187 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12188 deprecated. Its replacement is &'saslauthd'& (see below).
12189
12190 The pwcheck support is not included in Exim by default. You need to specify
12191 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12192 building Exim. For example:
12193 .code
12194 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12195 .endd
12196 You do not need to install the full Cyrus software suite in order to use
12197 the pwcheck daemon. You can compile and install just the daemon alone
12198 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12199 access to the &_/var/pwcheck_& directory.
12200
12201 The &%pwcheck%& condition takes one argument, which must be the user name and
12202 password, separated by a colon. For example, in a LOGIN authenticator
12203 configuration, you might have this:
12204 .code
12205 server_condition = ${if pwcheck{$auth1:$auth2}}
12206 .endd
12207 Again, for a PLAIN authenticator configuration, this would be:
12208 .code
12209 server_condition = ${if pwcheck{$auth2:$auth3}}
12210 .endd
12211 .vitem &*queue_running*&
12212 .cindex "queue runner" "detecting when delivering from"
12213 .cindex "expansion" "queue runner test"
12214 .cindex "&%queue_running%& expansion condition"
12215 This condition, which has no data, is true during delivery attempts that are
12216 initiated by queue runner processes, and false otherwise.
12217
12218
12219 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12220 .cindex "Radius"
12221 .cindex "expansion" "Radius authentication"
12222 .cindex "&%radius%& expansion condition"
12223 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12224 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12225 the Radius client configuration file in order to build Exim with Radius
12226 support.
12227
12228 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12229 library, using the original API. If you are using release 0.4.0 or later of
12230 this library, you need to set
12231 .code
12232 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12233 .endd
12234 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12235 &%libradius%& library that comes with FreeBSD. To do this, set
12236 .code
12237 RADIUS_LIB_TYPE=RADLIB
12238 .endd
12239 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12240 You may also have to supply a suitable setting in EXTRALIBS so that the
12241 Radius library can be found when Exim is linked.
12242
12243 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12244 Radius client library, which calls the Radius server. The condition is true if
12245 the authentication is successful. For example:
12246 .code
12247 server_condition = ${if radius{<arguments>}}
12248 .endd
12249
12250
12251 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12252         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12253 .cindex "&'saslauthd'& daemon"
12254 .cindex "Cyrus"
12255 .cindex "expansion" "&'saslauthd'& authentication test"
12256 .cindex "&%saslauthd%& expansion condition"
12257 This condition supports user authentication using the Cyrus &'saslauthd'&
12258 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12259 Using this daemon is one way of making it possible for passwords to be checked
12260 by a process that is not running as root.
12261
12262 The saslauthd support is not included in Exim by default. You need to specify
12263 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12264 building Exim. For example:
12265 .code
12266 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12267 .endd
12268 You do not need to install the full Cyrus software suite in order to use
12269 the saslauthd daemon. You can compile and install just the daemon alone
12270 from the Cyrus SASL library.
12271
12272 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12273 two are mandatory. For example:
12274 .code
12275 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12276 .endd
12277 The service and the realm are optional (which is why the arguments are enclosed
12278 in their own set of braces). For details of the meaning of the service and
12279 realm, and how to run the daemon, consult the Cyrus documentation.
12280 .endlist vlist
12281
12282
12283
12284 .section "Combining expansion conditions" "SECID84"
12285 .cindex "expansion" "combining conditions"
12286 Several conditions can be tested at once by combining them using the &%and%&
12287 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12288 conditions on their own, and precede their lists of sub-conditions. Each
12289 sub-condition must be enclosed in braces within the overall braces that contain
12290 the list. No repetition of &%if%& is used.
12291
12292
12293 .vlist
12294 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12295 .cindex "&""or""& expansion condition"
12296 .cindex "expansion" "&""or""& of conditions"
12297 The sub-conditions are evaluated from left to right. The condition is true if
12298 any one of the sub-conditions is true.
12299 For example,
12300 .code
12301 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12302 .endd
12303 When a true sub-condition is found, the following ones are parsed but not
12304 evaluated. If there are several &"match"& sub-conditions the values of the
12305 numeric variables afterwards are taken from the first one that succeeds.
12306
12307 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12308 .cindex "&""and""& expansion condition"
12309 .cindex "expansion" "&""and""& of conditions"
12310 The sub-conditions are evaluated from left to right. The condition is true if
12311 all of the sub-conditions are true. If there are several &"match"&
12312 sub-conditions, the values of the numeric variables afterwards are taken from
12313 the last one. When a false sub-condition is found, the following ones are
12314 parsed but not evaluated.
12315 .endlist
12316 .ecindex IIDexpcond
12317
12318
12319
12320
12321 .section "Expansion variables" "SECTexpvar"
12322 .cindex "expansion" "variables, list of"
12323 This section contains an alphabetical list of all the expansion variables. Some
12324 of them are available only when Exim is compiled with specific options such as
12325 support for TLS or the content scanning extension.
12326 .cindex "tainted data"
12327 Variables marked as &'tainted'& are likely to carry data supplied by
12328 a potential attacker.
12329 Variables without such marking may also, depending on how their
12330 values are created.
12331 Such variables should not be further expanded,
12332 used as filenames
12333 or used as command-line arguments for external commands.
12334
12335 .vlist
12336 .vitem "&$0$&, &$1$&, etc"
12337 .cindex "numerical variables (&$1$& &$2$& etc)"
12338 When a &%match%& expansion condition succeeds, these variables contain the
12339 captured substrings identified by the regular expression during subsequent
12340 processing of the success string of the containing &%if%& expansion item.
12341 In the expansion condition case
12342 they do not retain their values afterwards; in fact, their previous
12343 values are restored at the end of processing an &%if%& item. The numerical
12344 variables may also be set externally by some other matching process which
12345 precedes the expansion of the string. For example, the commands available in
12346 Exim filter files include an &%if%& command with its own regular expression
12347 matching condition.
12348 If the subject string was tainted then any captured substring will also be.
12349
12350 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12351 Within an acl condition, expansion condition or expansion item
12352 any arguments are copied to these variables,
12353 any unused variables being made empty.
12354
12355 .vitem "&$acl_c...$&"
12356 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12357 can be given any name that starts with &$acl_c$& and is at least six characters
12358 long, but the sixth character must be either a digit or an underscore. For
12359 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12360 variables persist throughout the lifetime of an SMTP connection. They can be
12361 used to pass information between ACLs and between different invocations of the
12362 same ACL. When a message is received, the values of these variables are saved
12363 with the message, and can be accessed by filters, routers, and transports
12364 during subsequent delivery.
12365
12366 .vitem "&$acl_m...$&"
12367 These variables are like the &$acl_c...$& variables, except that their values
12368 are reset after a message has been received. Thus, if several messages are
12369 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12370 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12371 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12372 message is received, the values of these variables are saved with the message,
12373 and can be accessed by filters, routers, and transports during subsequent
12374 delivery.
12375
12376 .vitem &$acl_narg$&
12377 Within an acl condition, expansion condition or expansion item
12378 this variable has the number of arguments.
12379
12380 .vitem &$acl_verify_message$&
12381 .vindex "&$acl_verify_message$&"
12382 After an address verification has failed, this variable contains the failure
12383 message. It retains its value for use in subsequent modifiers of the verb.
12384 The message can be preserved by coding like this:
12385 .code
12386 warn !verify = sender
12387      set acl_m0 = $acl_verify_message
12388 .endd
12389 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12390 &%log_message%& modifiers, to include information about the verification
12391 failure.
12392 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12393
12394 .vitem &$address_data$&
12395 .vindex "&$address_data$&"
12396 This variable is set by means of the &%address_data%& option in routers. The
12397 value then remains with the address while it is processed by subsequent routers
12398 and eventually a transport. If the transport is handling multiple addresses,
12399 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12400 for more details. &*Note*&: The contents of &$address_data$& are visible in
12401 user filter files.
12402
12403 If &$address_data$& is set when the routers are called from an ACL to verify
12404 a recipient address, the final value is still in the variable for subsequent
12405 conditions and modifiers of the ACL statement. If routing the address caused it
12406 to be redirected to just one address, the child address is also routed as part
12407 of the verification, and in this case the final value of &$address_data$& is
12408 from the child's routing.
12409
12410 If &$address_data$& is set when the routers are called from an ACL to verify a
12411 sender address, the final value is also preserved, but this time in
12412 &$sender_address_data$&, to distinguish it from data from a recipient
12413 address.
12414
12415 In both cases (recipient and sender verification), the value does not persist
12416 after the end of the current ACL statement. If you want to preserve
12417 these values for longer, you can save them in ACL variables.
12418
12419 .vitem &$address_file$&
12420 .vindex "&$address_file$&"
12421 When, as a result of aliasing, forwarding, or filtering, a message is directed
12422 to a specific file, this variable holds the name of the file when the transport
12423 is running. At other times, the variable is empty. For example, using the
12424 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12425 .code
12426 /home/r2d2/savemail
12427 .endd
12428 then when the &(address_file)& transport is running, &$address_file$&
12429 contains the text string &`/home/r2d2/savemail`&.
12430 .cindex "Sieve filter" "value of &$address_file$&"
12431 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12432 then up to the transport configuration to generate an appropriate absolute path
12433 to the relevant file.
12434
12435 .vitem &$address_pipe$&
12436 .vindex "&$address_pipe$&"
12437 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12438 this variable holds the pipe command when the transport is running.
12439
12440 .vitem "&$auth1$& &-- &$auth4$&"
12441 .vindex "&$auth1$&, &$auth2$&, etc"
12442 These variables are used in SMTP authenticators (see chapters
12443 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12444
12445 .vitem &$authenticated_id$&
12446 .cindex "authentication" "id"
12447 .vindex "&$authenticated_id$&"
12448 When a server successfully authenticates a client it may be configured to
12449 preserve some of the authentication information in the variable
12450 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12451 user/password authenticator configuration might preserve the user name for use
12452 in the routers. Note that this is not the same information that is saved in
12453 &$sender_host_authenticated$&.
12454
12455 When a message is submitted locally (that is, not over a TCP connection)
12456 the value of &$authenticated_id$& is normally the login name of the calling
12457 process. However, a trusted user can override this by means of the &%-oMai%&
12458 command line option.
12459 This second case also sets up information used by the
12460 &$authresults$& expansion item.
12461
12462 .vitem &$authenticated_fail_id$&
12463 .cindex "authentication" "fail" "id"
12464 .vindex "&$authenticated_fail_id$&"
12465 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12466 will contain the failed authentication id. If more than one authentication
12467 id is attempted, it will contain only the last one. The variable is
12468 available for processing in the ACL's, generally the quit or notquit ACL.
12469 A message to a local recipient could still be accepted without requiring
12470 authentication, which means this variable could also be visible in all of
12471 the ACL's as well.
12472
12473
12474 .tvar &$authenticated_sender$&
12475 .cindex "sender" "authenticated"
12476 .cindex "authentication" "sender"
12477 .cindex "AUTH" "on MAIL command"
12478 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12479 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12480 described in section &<<SECTauthparamail>>&. Unless the data is the string
12481 &"<>"&, it is set as the authenticated sender of the message, and the value is
12482 available during delivery in the &$authenticated_sender$& variable. If the
12483 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12484
12485 .vindex "&$qualify_domain$&"
12486 When a message is submitted locally (that is, not over a TCP connection), the
12487 value of &$authenticated_sender$& is an address constructed from the login
12488 name of the calling process and &$qualify_domain$&, except that a trusted user
12489 can override this by means of the &%-oMas%& command line option.
12490
12491
12492 .vitem &$authentication_failed$&
12493 .cindex "authentication" "failure"
12494 .vindex "&$authentication_failed$&"
12495 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12496 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12497 possible to distinguish between &"did not try to authenticate"&
12498 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12499 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12500 is empty and &$authentication_failed$& is set to &"1"&).
12501 Failure includes cancellation of a authentication attempt,
12502 and any negative response to an AUTH command,
12503 (including, for example, an attempt to use an undefined mechanism).
12504
12505 .vitem &$av_failed$&
12506 .cindex "content scanning" "AV scanner failure"
12507 This variable is available when Exim is compiled with the content-scanning
12508 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12509 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12510 the ACL malware condition.
12511
12512 .vitem &$body_linecount$&
12513 .cindex "message body" "line count"
12514 .cindex "body of message" "line count"
12515 .vindex "&$body_linecount$&"
12516 When a message is being received or delivered, this variable contains the
12517 number of lines in the message's body. See also &$message_linecount$&.
12518
12519 .vitem &$body_zerocount$&
12520 .cindex "message body" "binary zero count"
12521 .cindex "body of message" "binary zero count"
12522 .cindex "binary zero" "in message body"
12523 .vindex "&$body_zerocount$&"
12524 When a message is being received or delivered, this variable contains the
12525 number of binary zero bytes (ASCII NULs) in the message's body.
12526
12527 .vitem &$bounce_recipient$&
12528 .vindex "&$bounce_recipient$&"
12529 This is set to the recipient address of a bounce message while Exim is creating
12530 it. It is useful if a customized bounce message text file is in use (see
12531 chapter &<<CHAPemsgcust>>&).
12532
12533 .vitem &$bounce_return_size_limit$&
12534 .vindex "&$bounce_return_size_limit$&"
12535 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12536 up to a multiple of 1000. It is useful when a customized error message text
12537 file is in use (see chapter &<<CHAPemsgcust>>&).
12538
12539 .vitem &$caller_gid$&
12540 .cindex "gid (group id)" "caller"
12541 .vindex "&$caller_gid$&"
12542 The real group id under which the process that called Exim was running. This is
12543 not the same as the group id of the originator of a message (see
12544 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12545 incarnation normally contains the Exim gid.
12546
12547 .vitem &$caller_uid$&
12548 .cindex "uid (user id)" "caller"
12549 .vindex "&$caller_uid$&"
12550 The real user id under which the process that called Exim was running. This is
12551 not the same as the user id of the originator of a message (see
12552 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12553 incarnation normally contains the Exim uid.
12554
12555 .vitem &$callout_address$&
12556 .vindex "&$callout_address$&"
12557 After a callout for verification, spamd or malware daemon service, the
12558 address that was connected to.
12559
12560 .vitem &$compile_number$&
12561 .vindex "&$compile_number$&"
12562 The building process for Exim keeps a count of the number
12563 of times it has been compiled. This serves to distinguish different
12564 compilations of the same version of Exim.
12565
12566 .vitem &$config_dir$&
12567 .vindex "&$config_dir$&"
12568 The directory name of the main configuration file. That is, the content of
12569 &$config_file$& with the last component stripped. The value does not
12570 contain the trailing slash. If &$config_file$& does not contain a slash,
12571 &$config_dir$& is ".".
12572
12573 .vitem &$config_file$&
12574 .vindex "&$config_file$&"
12575 The name of the main configuration file Exim is using.
12576
12577 .vitem &$dkim_verify_status$&
12578 Results of DKIM verification.
12579 For details see section &<<SECDKIMVFY>>&.
12580
12581 .vitem &$dkim_cur_signer$& &&&
12582        &$dkim_verify_reason$& &&&
12583        &$dkim_domain$& &&&
12584        &$dkim_identity$& &&&
12585        &$dkim_selector$& &&&
12586        &$dkim_algo$& &&&
12587        &$dkim_canon_body$& &&&
12588        &$dkim_canon_headers$& &&&
12589        &$dkim_copiedheaders$& &&&
12590        &$dkim_bodylength$& &&&
12591        &$dkim_created$& &&&
12592        &$dkim_expires$& &&&
12593        &$dkim_headernames$& &&&
12594        &$dkim_key_testing$& &&&
12595        &$dkim_key_nosubdomains$& &&&
12596        &$dkim_key_srvtype$& &&&
12597        &$dkim_key_granularity$& &&&
12598        &$dkim_key_notes$& &&&
12599        &$dkim_key_length$&
12600 These variables are only available within the DKIM ACL.
12601 For details see section &<<SECDKIMVFY>>&.
12602
12603 .vitem &$dkim_signers$&
12604 .vindex &$dkim_signers$&
12605 When a message has been received this variable contains
12606 a colon-separated list of signer domains and identities for the message.
12607 For details see section &<<SECDKIMVFY>>&.
12608
12609 .vitem &$dmarc_domain_policy$& &&&
12610        &$dmarc_status$& &&&
12611        &$dmarc_status_text$& &&&
12612        &$dmarc_used_domains$&
12613 Results of DMARC verification.
12614 For details see section &<<SECDMARC>>&.
12615
12616 .vitem &$dnslist_domain$& &&&
12617        &$dnslist_matched$& &&&
12618        &$dnslist_text$& &&&
12619        &$dnslist_value$&
12620 .vindex "&$dnslist_domain$&"
12621 .vindex "&$dnslist_matched$&"
12622 .vindex "&$dnslist_text$&"
12623 .vindex "&$dnslist_value$&"
12624 .cindex "black list (DNS)"
12625 When a DNS (black) list lookup succeeds, these variables are set to contain
12626 the following data from the lookup: the list's domain name, the key that was
12627 looked up, the contents of any associated TXT record, and the value from the
12628 main A record. See section &<<SECID204>>& for more details.
12629
12630 .tvar &$domain$&
12631 When an address is being routed, or delivered on its own, this variable
12632 contains the domain. Uppercase letters in the domain are converted into lower
12633 case for &$domain$&.
12634
12635 Global address rewriting happens when a message is received, so the value of
12636 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12637 is set during user filtering, but not during system filtering, because a
12638 message may have many recipients and the system filter is called just once.
12639
12640 When more than one address is being delivered at once (for example, several
12641 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12642 have the same domain. Transports can be restricted to handling only one domain
12643 at a time if the value of &$domain$& is required at transport time &-- this is
12644 the default for local transports. For further details of the environment in
12645 which local transports are run, see chapter &<<CHAPenvironment>>&.
12646
12647 .oindex "&%delay_warning_condition%&"
12648 At the end of a delivery, if all deferred addresses have the same domain, it is
12649 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12650
12651 The &$domain$& variable is also used in some other circumstances:
12652
12653 .ilist
12654 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12655 the recipient address. The domain of the &'sender'& address is in
12656 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12657 normally set during the running of the MAIL ACL. However, if the sender address
12658 is verified with a callout during the MAIL ACL, the sender domain is placed in
12659 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12660 the &(smtp)& transport.
12661
12662 .next
12663 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12664 &$domain$& contains the domain portion of the address that is being rewritten;
12665 it can be used in the expansion of the replacement address, for example, to
12666 rewrite domains by file lookup.
12667
12668 .next
12669 With one important exception, whenever a domain list is being scanned,
12670 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12671 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12672 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12673 that, in a RCPT ACL, the sender domain list can be dependent on the
12674 recipient domain (which is what is in &$domain$& at this time).
12675
12676 .next
12677 .cindex "ETRN" "value of &$domain$&"
12678 .oindex "&%smtp_etrn_command%&"
12679 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12680 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12681 .endlist
12682
12683 .cindex "tainted data"
12684 If the origin of the data is an incoming message,
12685 the result of expanding this variable is tainted and may not
12686 be further expanded or used as a filename.
12687 When an untainted version is needed, one should be obtained from
12688 looking up the value in a local (therefore trusted) database.
12689 Often &$domain_data$& is usable in this role.
12690
12691
12692 .vitem &$domain_data$&
12693 .vindex "&$domain_data$&"
12694 When the &%domains%& condition on a router
12695 or an ACL
12696 matches a domain
12697 against a list, the match value is copied to &$domain_data$&.
12698 This is an enhancement over previous versions of Exim, when it only
12699 applied to the data read by a lookup.
12700 For details on match values see section &<<SECTlistresults>>& et. al.
12701
12702 If the router routes the
12703 address to a transport, the value is available in that transport. If the
12704 transport is handling multiple addresses, the value from the first address is
12705 used.
12706
12707 &$domain_data$& set in an ACL is available during
12708 the rest of the ACL statement.
12709
12710 .vitem &$exim_gid$&
12711 .vindex "&$exim_gid$&"
12712 This variable contains the numerical value of the Exim group id.
12713
12714 .vitem &$exim_path$&
12715 .vindex "&$exim_path$&"
12716 This variable contains the path to the Exim binary.
12717
12718 .vitem &$exim_uid$&
12719 .vindex "&$exim_uid$&"
12720 This variable contains the numerical value of the Exim user id.
12721
12722 .vitem &$exim_version$&
12723 .vindex "&$exim_version$&"
12724 This variable contains the version string of the Exim build.
12725 The first character is a major version number, currently 4.
12726 Then after a dot, the next group of digits is a minor version number.
12727 There may be other characters following the minor version.
12728 This value may be overridden by the &%exim_version%& main config option.
12729
12730 .vitem &$header_$&<&'name'&>
12731 .tmark
12732 This is not strictly an expansion variable. It is expansion syntax for
12733 inserting the message header line with the given name. Note that the name must
12734 be terminated by colon or white space, because it may contain a wide variety of
12735 characters. Note also that braces must &'not'& be used.
12736 See the full description in section &<<SECTexpansionitems>>& above.
12737
12738 .vitem &$headers_added$&
12739 .vindex "&$headers_added$&"
12740 Within an ACL this variable contains the headers added so far by
12741 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12742 The headers are a newline-separated list.
12743
12744 .vitem &$home$&
12745 .vindex "&$home$&"
12746 When the &%check_local_user%& option is set for a router, the user's home
12747 directory is placed in &$home$& when the check succeeds. In particular, this
12748 means it is set during the running of users' filter files. A router may also
12749 explicitly set a home directory for use by a transport; this can be overridden
12750 by a setting on the transport itself.
12751
12752 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12753 of the environment variable HOME, which is subject to the
12754 &%keep_environment%& and &%add_environment%& main config options.
12755
12756 .vitem &$host$&
12757 .vindex "&$host$&"
12758 If a router assigns an address to a transport (any transport), and passes a
12759 list of hosts with the address, the value of &$host$& when the transport starts
12760 to run is the name of the first host on the list. Note that this applies both
12761 to local and remote transports.
12762
12763 .cindex "transport" "filter"
12764 .cindex "filter" "transport filter"
12765 For the &(smtp)& transport, if there is more than one host, the value of
12766 &$host$& changes as the transport works its way through the list. In
12767 particular, when the &(smtp)& transport is expanding its options for encryption
12768 using TLS, or for specifying a transport filter (see chapter
12769 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12770 is connected.
12771
12772 When used in the client part of an authenticator configuration (see chapter
12773 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12774 client is connected.
12775
12776
12777 .vitem &$host_address$&
12778 .vindex "&$host_address$&"
12779 This variable is set to the remote host's IP address whenever &$host$& is set
12780 for a remote connection. It is also set to the IP address that is being checked
12781 when the &%ignore_target_hosts%& option is being processed.
12782
12783 .vitem &$host_data$&
12784 .vindex "&$host_data$&"
12785 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12786 result of the lookup is made available in the &$host_data$& variable. This
12787 allows you, for example, to do things like this:
12788 .code
12789 deny  hosts = net-lsearch;/some/file
12790       message = $host_data
12791 .endd
12792
12793 .vitem &$host_lookup_deferred$&
12794 .cindex "host name" "lookup, failure of"
12795 .vindex "&$host_lookup_deferred$&"
12796 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12797 message comes from a remote host and there is an attempt to look up the host's
12798 name from its IP address, and the attempt is not successful, one of these
12799 variables is set to &"1"&.
12800
12801 .ilist
12802 If the lookup receives a definite negative response (for example, a DNS lookup
12803 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12804
12805 .next
12806 If there is any kind of problem during the lookup, such that Exim cannot
12807 tell whether or not the host name is defined (for example, a timeout for a DNS
12808 lookup), &$host_lookup_deferred$& is set to &"1"&.
12809 .endlist ilist
12810
12811 Looking up a host's name from its IP address consists of more than just a
12812 single reverse lookup. Exim checks that a forward lookup of at least one of the
12813 names it receives from a reverse lookup yields the original IP address. If this
12814 is not the case, Exim does not accept the looked up name(s), and
12815 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12816 IP address (for example, the existence of a PTR record in the DNS) is not
12817 sufficient on its own for the success of a host name lookup. If the reverse
12818 lookup succeeds, but there is a lookup problem such as a timeout when checking
12819 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12820 &"1"&. See also &$sender_host_name$&.
12821
12822 .cindex authentication "expansion item"
12823 Performing these checks sets up information used by the
12824 &%authresults%& expansion item.
12825
12826
12827 .vitem &$host_lookup_failed$&
12828 .vindex "&$host_lookup_failed$&"
12829 See &$host_lookup_deferred$&.
12830
12831 .vitem &$host_port$&
12832 .vindex "&$host_port$&"
12833 This variable is set to the remote host's TCP port whenever &$host$& is set
12834 for an outbound connection.
12835
12836 .vitem &$initial_cwd$&
12837 .vindex "&$initial_cwd$&
12838 This variable contains the full path name of the initial working
12839 directory of the current Exim process. This may differ from the current
12840 working directory, as Exim changes this to "/" during early startup, and
12841 to &$spool_directory$& later.
12842
12843 .vitem &$inode$&
12844 .vindex "&$inode$&"
12845 The only time this variable is set is while expanding the &%directory_file%&
12846 option in the &(appendfile)& transport. The variable contains the inode number
12847 of the temporary file which is about to be renamed. It can be used to construct
12848 a unique name for the file.
12849
12850 .vitem &$interface_address$& &&&
12851        &$interface_port$&
12852 .vindex "&$interface_address$&"
12853 .vindex "&$interface_port$&"
12854 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12855
12856 .vitem &$item$&
12857 .vindex "&$item$&"
12858 This variable is used during the expansion of &*forall*& and &*forany*&
12859 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12860 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12861 empty.
12862
12863 .vitem &$ldap_dn$&
12864 .vindex "&$ldap_dn$&"
12865 This variable, which is available only when Exim is compiled with LDAP support,
12866 contains the DN from the last entry in the most recently successful LDAP
12867 lookup.
12868
12869 .vitem &$load_average$&
12870 .vindex "&$load_average$&"
12871 This variable contains the system load average, multiplied by 1000 so that it
12872 is an integer. For example, if the load average is 0.21, the value of the
12873 variable is 210. The value is recomputed every time the variable is referenced.
12874
12875 .tvar &$local_part$&
12876 When an address is being routed, or delivered on its own, this
12877 variable contains the local part. When a number of addresses are being
12878 delivered together (for example, multiple RCPT commands in an SMTP
12879 session), &$local_part$& is not set.
12880
12881 Global address rewriting happens when a message is received, so the value of
12882 &$local_part$& during routing and delivery is the value after rewriting.
12883 &$local_part$& is set during user filtering, but not during system filtering,
12884 because a message may have many recipients and the system filter is called just
12885 once.
12886
12887 .cindex "tainted data"
12888 If the origin of the data is an incoming message,
12889 the result of expanding this variable is tainted and
12890 may not be further expanded or used as a filename.
12891
12892 &*Warning*&: the content of this variable is usually provided by a potential
12893 attacker.
12894 Consider carefully the implications of using it unvalidated as a name
12895 for file access.
12896 This presents issues for users' &_.forward_& and filter files.
12897 For traditional full user accounts, use &%check_local_users%& and the
12898 &$local_part_data$& variable rather than this one.
12899 For virtual users, store a suitable pathname component in the database
12900 which is used for account name validation, and use that retrieved value
12901 rather than this variable.
12902 Often &$local_part_data$& is usable in this role.
12903 If needed, use a router &%address_data%& or &%set%& option for
12904 the retrieved data.
12905
12906 When a message is being delivered to a file, pipe, or autoreply transport as a
12907 result of aliasing or forwarding, &$local_part$& is set to the local part of
12908 the parent address, not to the filename or command (see &$address_file$& and
12909 &$address_pipe$&).
12910
12911 When an ACL is running for a RCPT command, &$local_part$& contains the
12912 local part of the recipient address.
12913
12914 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12915 &$local_part$& contains the local part of the address that is being rewritten;
12916 it can be used in the expansion of the replacement address, for example.
12917
12918 In all cases, all quoting is removed from the local part. For example, for both
12919 the addresses
12920 .code
12921 "abc:xyz"@test.example
12922 abc\:xyz@test.example
12923 .endd
12924 the value of &$local_part$& is
12925 .code
12926 abc:xyz
12927 .endd
12928 If you use &$local_part$& to create another address, you should always wrap it
12929 inside a quoting operator. For example, in a &(redirect)& router you could
12930 have:
12931 .code
12932 data = ${quote_local_part:$local_part}@new.domain.example
12933 .endd
12934 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12935 to process local parts in a case-dependent manner in a router, you can set the
12936 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12937
12938 .vitem &$local_part_data$&
12939 .vindex "&$local_part_data$&"
12940 When the &%local_parts%& condition on a router or ACL
12941 matches a local part list
12942 the match value is copied to &$local_part_data$&.
12943 This is an enhancement over previous versions of Exim, when it only
12944 applied to the data read by a lookup.
12945 For details on match values see section &<<SECTlistresults>>& et. al.
12946
12947 The &%check_local_user%& router option also sets this variable.
12948
12949 .vindex &$local_part_prefix$& &&&
12950         &$local_part_prefix_v$& &&&
12951         &$local_part_suffix$& &&&
12952         &$local_part_suffix_v$&
12953 .cindex affix variables
12954 If a local part prefix or suffix has been recognized, it is not included in the
12955 value of &$local_part$& during routing and subsequent delivery. The values of
12956 any prefix or suffix are in &$local_part_prefix$& and
12957 &$local_part_suffix$&, respectively.
12958 .cindex "tainted data"
12959 If the specification did not include a wildcard then
12960 the affix variable value is not tainted.
12961
12962 If the affix specification included a wildcard then the portion of
12963 the affix matched by the wildcard is in
12964 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12965 and both the whole and varying values are tainted.
12966
12967 .vitem &$local_scan_data$&
12968 .vindex "&$local_scan_data$&"
12969 This variable contains the text returned by the &[local_scan()]& function when
12970 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12971
12972 .vitem &$local_user_gid$&
12973 .vindex "&$local_user_gid$&"
12974 See &$local_user_uid$&.
12975
12976 .vitem &$local_user_uid$&
12977 .vindex "&$local_user_uid$&"
12978 This variable and &$local_user_gid$& are set to the uid and gid after the
12979 &%check_local_user%& router precondition succeeds. This means that their values
12980 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12981 and &%condition%&), for the &%address_data%& expansion, and for any
12982 router-specific expansions. At all other times, the values in these variables
12983 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12984
12985 .vitem &$localhost_number$&
12986 .vindex "&$localhost_number$&"
12987 This contains the expanded value of the
12988 &%localhost_number%& option. The expansion happens after the main options have
12989 been read.
12990
12991 .vitem &$log_inodes$&
12992 .vindex "&$log_inodes$&"
12993 The number of free inodes in the disk partition where Exim's
12994 log files are being written. The value is recalculated whenever the variable is
12995 referenced. If the relevant file system does not have the concept of inodes,
12996 the value of is -1. See also the &%check_log_inodes%& option.
12997
12998 .vitem &$log_space$&
12999 .vindex "&$log_space$&"
13000 The amount of free space (as a number of kilobytes) in the disk
13001 partition where Exim's log files are being written. The value is recalculated
13002 whenever the variable is referenced. If the operating system does not have the
13003 ability to find the amount of free space (only true for experimental systems),
13004 the space value is -1. See also the &%check_log_space%& option.
13005
13006
13007 .vitem &$lookup_dnssec_authenticated$&
13008 .vindex "&$lookup_dnssec_authenticated$&"
13009 This variable is set after a DNS lookup done by
13010 a dnsdb lookup expansion, dnslookup router or smtp transport.
13011 .cindex "DNS" "DNSSEC"
13012 It will be empty if &(DNSSEC)& was not requested,
13013 &"no"& if the result was not labelled as authenticated data
13014 and &"yes"& if it was.
13015 Results that are labelled as authoritative answer that match
13016 the &%dns_trust_aa%& configuration variable count also
13017 as authenticated data.
13018
13019 .vitem &$mailstore_basename$&
13020 .vindex "&$mailstore_basename$&"
13021 This variable is set only when doing deliveries in &"mailstore"& format in the
13022 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
13023 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
13024 contains the basename of the files that are being written, that is, the name
13025 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
13026 variable is empty.
13027
13028 .vitem &$malware_name$&
13029 .vindex "&$malware_name$&"
13030 This variable is available when Exim is compiled with the
13031 content-scanning extension. It is set to the name of the virus that was found
13032 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13033
13034 .vitem &$max_received_linelength$&
13035 .vindex "&$max_received_linelength$&"
13036 .cindex "maximum" "line length"
13037 .cindex "line length" "maximum"
13038 This variable contains the number of bytes in the longest line that was
13039 received as part of the message, not counting the line termination
13040 character(s).
13041 It is not valid if the &%spool_wireformat%& option is used.
13042
13043 .vitem &$message_age$&
13044 .cindex "message" "age of"
13045 .vindex "&$message_age$&"
13046 This variable is set at the start of a delivery attempt to contain the number
13047 of seconds since the message was received. It does not change during a single
13048 delivery attempt.
13049
13050 .tvar &$message_body$&
13051 .cindex "body of message" "expansion variable"
13052 .cindex "message body" "in expansion"
13053 .cindex "binary zero" "in message body"
13054 .oindex "&%message_body_visible%&"
13055 This variable contains the initial portion of a message's body while it is
13056 being delivered, and is intended mainly for use in filter files. The maximum
13057 number of characters of the body that are put into the variable is set by the
13058 &%message_body_visible%& configuration option; the default is 500.
13059
13060 .oindex "&%message_body_newlines%&"
13061 By default, newlines are converted into spaces in &$message_body$&, to make it
13062 easier to search for phrases that might be split over a line break. However,
13063 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13064 zeros are always converted into spaces.
13065
13066 .tvar &$message_body_end$&
13067 .cindex "body of message" "expansion variable"
13068 .cindex "message body" "in expansion"
13069 This variable contains the final portion of a message's
13070 body while it is being delivered. The format and maximum size are as for
13071 &$message_body$&.
13072
13073 .vitem &$message_body_size$&
13074 .cindex "body of message" "size"
13075 .cindex "message body" "size"
13076 .vindex "&$message_body_size$&"
13077 When a message is being delivered, this variable contains the size of the body
13078 in bytes. The count starts from the character after the blank line that
13079 separates the body from the header. Newlines are included in the count. See
13080 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13081
13082 If the spool file is wireformat
13083 (see the &%spool_wireformat%& main option)
13084 the CRLF line-terminators are included in the count.
13085
13086 .vitem &$message_exim_id$&
13087 .vindex "&$message_exim_id$&"
13088 When a message is being received or delivered, this variable contains the
13089 unique message id that is generated and used by Exim to identify the message.
13090 An id is not created for a message until after its header has been successfully
13091 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13092 line; it is the local id that Exim assigns to the message, for example:
13093 &`1BXTIK-0001yO-VA`&.
13094
13095 .tvar &$message_headers$&
13096 This variable contains a concatenation of all the header lines when a message
13097 is being processed, except for lines added by routers or transports. The header
13098 lines are separated by newline characters. Their contents are decoded in the
13099 same way as a header line that is inserted by &%bheader%&.
13100
13101 .tvar &$message_headers_raw$&
13102 This variable is like &$message_headers$& except that no processing of the
13103 contents of header lines is done.
13104
13105 .vitem &$message_id$&
13106 This is an old name for &$message_exim_id$&. It is now deprecated.
13107
13108 .vitem &$message_linecount$&
13109 .vindex "&$message_linecount$&"
13110 This variable contains the total number of lines in the header and body of the
13111 message. Compare &$body_linecount$&, which is the count for the body only.
13112 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13113 number of lines received. Before delivery happens (that is, before filters,
13114 routers, and transports run) the count is increased to include the
13115 &'Received:'& header line that Exim standardly adds, and also any other header
13116 lines that are added by ACLs. The blank line that separates the message header
13117 from the body is not counted.
13118
13119 As with the special case of &$message_size$&, during the expansion of the
13120 appendfile transport's maildir_tag option in maildir format, the value of
13121 &$message_linecount$& is the precise size of the number of newlines in the
13122 file that has been written (minus one for the blank line between the
13123 header and the body).
13124
13125 Here is an example of the use of this variable in a DATA ACL:
13126 .code
13127 deny condition = \
13128       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13129      message   = Too many lines in message header
13130 .endd
13131 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13132 message has not yet been received.
13133
13134 This variable is not valid if the &%spool_wireformat%& option is used.
13135
13136 .vitem &$message_size$&
13137 .cindex "size" "of message"
13138 .cindex "message" "size"
13139 .vindex "&$message_size$&"
13140 When a message is being processed, this variable contains its size in bytes. In
13141 most cases, the size includes those headers that were received with the
13142 message, but not those (such as &'Envelope-to:'&) that are added to individual
13143 deliveries as they are written. However, there is one special case: during the
13144 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13145 doing a delivery in maildir format, the value of &$message_size$& is the
13146 precise size of the file that has been written. See also
13147 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13148
13149 .cindex "RCPT" "value of &$message_size$&"
13150 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13151 contains the size supplied on the MAIL command, or -1 if no size was given. The
13152 value may not, of course, be truthful.
13153
13154 .vitem &$mime_anomaly_level$& &&&
13155        &$mime_anomaly_text$& &&&
13156        &$mime_boundary$& &&&
13157        &$mime_charset$& &&&
13158        &$mime_content_description$& &&&
13159        &$mime_content_disposition$& &&&
13160        &$mime_content_id$& &&&
13161        &$mime_content_size$& &&&
13162        &$mime_content_transfer_encoding$& &&&
13163        &$mime_content_type$& &&&
13164        &$mime_decoded_filename$& &&&
13165        &$mime_filename$& &&&
13166        &$mime_is_coverletter$& &&&
13167        &$mime_is_multipart$& &&&
13168        &$mime_is_rfc822$& &&&
13169        &$mime_part_count$&
13170 A number of variables whose names start with &$mime$& are
13171 available when Exim is compiled with the content-scanning extension. For
13172 details, see section &<<SECTscanmimepart>>&.
13173
13174 .vitem "&$n0$& &-- &$n9$&"
13175 These variables are counters that can be incremented by means
13176 of the &%add%& command in filter files.
13177
13178 .tvar &$original_domain$&
13179 .vindex "&$domain$&"
13180 When a top-level address is being processed for delivery, this contains the
13181 same value as &$domain$&. However, if a &"child"& address (for example,
13182 generated by an alias, forward, or filter file) is being processed, this
13183 variable contains the domain of the original address (lower cased). This
13184 differs from &$parent_domain$& only when there is more than one level of
13185 aliasing or forwarding. When more than one address is being delivered in a
13186 single transport run, &$original_domain$& is not set.
13187
13188 If a new address is created by means of a &%deliver%& command in a system
13189 filter, it is set up with an artificial &"parent"& address. This has the local
13190 part &'system-filter'& and the default qualify domain.
13191
13192 .tvar &$original_local_part$&
13193 .vindex "&$local_part$&"
13194 When a top-level address is being processed for delivery, this contains the
13195 same value as &$local_part$&, unless a prefix or suffix was removed from the
13196 local part, because &$original_local_part$& always contains the full local
13197 part. When a &"child"& address (for example, generated by an alias, forward, or
13198 filter file) is being processed, this variable contains the full local part of
13199 the original address.
13200
13201 If the router that did the redirection processed the local part
13202 case-insensitively, the value in &$original_local_part$& is in lower case.
13203 This variable differs from &$parent_local_part$& only when there is more than
13204 one level of aliasing or forwarding. When more than one address is being
13205 delivered in a single transport run, &$original_local_part$& is not set.
13206
13207 If a new address is created by means of a &%deliver%& command in a system
13208 filter, it is set up with an artificial &"parent"& address. This has the local
13209 part &'system-filter'& and the default qualify domain.
13210
13211 .vitem &$originator_gid$&
13212 .cindex "gid (group id)" "of originating user"
13213 .cindex "sender" "gid"
13214 .vindex "&$caller_gid$&"
13215 .vindex "&$originator_gid$&"
13216 This variable contains the value of &$caller_gid$& that was set when the
13217 message was received. For messages received via the command line, this is the
13218 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13219 normally the gid of the Exim user.
13220
13221 .vitem &$originator_uid$&
13222 .cindex "uid (user id)" "of originating user"
13223 .cindex "sender" "uid"
13224 .vindex "&$caller_uid$&"
13225 .vindex "&$originator_uid$&"
13226 The value of &$caller_uid$& that was set when the message was received. For
13227 messages received via the command line, this is the uid of the sending user.
13228 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13229 user.
13230
13231 .tvar &$parent_domain$&
13232 This variable is similar to &$original_domain$& (see
13233 above), except that it refers to the immediately preceding parent address.
13234
13235 .tvar &$parent_local_part$&
13236 This variable is similar to &$original_local_part$&
13237 (see above), except that it refers to the immediately preceding parent address.
13238
13239 .vitem &$pid$&
13240 .cindex "pid (process id)" "of current process"
13241 .vindex "&$pid$&"
13242 This variable contains the current process id.
13243
13244 .vitem &$pipe_addresses$&
13245 .cindex "filter" "transport filter"
13246 .cindex "transport" "filter"
13247 .vindex "&$pipe_addresses$&"
13248 This is not an expansion variable, but is mentioned here because the string
13249 &`$pipe_addresses`& is handled specially in the command specification for the
13250 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13251 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13252 It cannot be used in general expansion strings, and provokes an &"unknown
13253 variable"& error if encountered.
13254 &*Note*&: This value permits data supplied by a potential attacker to
13255 be used in the command for a &(pipe)& transport.
13256 Such configurations should be carefully assessed for security vulnerbilities.
13257
13258 .vitem &$primary_hostname$&
13259 .vindex "&$primary_hostname$&"
13260 This variable contains the value set by &%primary_hostname%& in the
13261 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13262 a single-component name, Exim calls &[gethostbyname()]& (or
13263 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13264 qualified host name. See also &$smtp_active_hostname$&.
13265
13266
13267 .vitem &$proxy_external_address$& &&&
13268        &$proxy_external_port$& &&&
13269        &$proxy_local_address$& &&&
13270        &$proxy_local_port$& &&&
13271        &$proxy_session$&
13272 These variables are only available when built with Proxy Protocol
13273 or SOCKS5 support.
13274 For details see chapter &<<SECTproxyInbound>>&.
13275
13276 .vitem &$prdr_requested$&
13277 .cindex "PRDR" "variable for"
13278 This variable is set to &"yes"& if PRDR was requested by the client for the
13279 current message, otherwise &"no"&.
13280
13281 .vitem &$prvscheck_address$& &&&
13282        &$prvscheck_keynum$& &&&
13283        &$prvscheck_result$&
13284 These variables are used in conjunction with the &%prvscheck%& expansion item,
13285 which is described in sections &<<SECTexpansionitems>>& and
13286 &<<SECTverifyPRVS>>&.
13287
13288 .vitem &$qualify_domain$&
13289 .vindex "&$qualify_domain$&"
13290 The value set for the &%qualify_domain%& option in the configuration file.
13291
13292 .vitem &$qualify_recipient$&
13293 .vindex "&$qualify_recipient$&"
13294 The value set for the &%qualify_recipient%& option in the configuration file,
13295 or if not set, the value of &$qualify_domain$&.
13296
13297 .vitem &$queue_name$&
13298 .vindex &$queue_name$&
13299 .cindex "named queues" variable
13300 .cindex queues named
13301 The name of the spool queue in use; empty for the default queue.
13302
13303 .vitem &$queue_size$&
13304 .vindex "&$queue_size$&"
13305 .cindex "queue" "size of"
13306 .cindex "spool" "number of messages"
13307 This variable contains the number of messages queued.
13308 It is evaluated on demand, but no more often than once every minute.
13309 If there is no daemon notifier socket open, the value will be
13310 an empty string.
13311
13312 .vitem &$r_...$&
13313 .vindex &$r_...$&
13314 .cindex router variables
13315 Values can be placed in these variables by the &%set%& option of a router.
13316 They can be given any name that starts with &$r_$&.
13317 The values persist for the address being handled through subsequent routers
13318 and the eventual transport.
13319
13320 .vitem &$rcpt_count$&
13321 .vindex "&$rcpt_count$&"
13322 When a message is being received by SMTP, this variable contains the number of
13323 RCPT commands received for the current message. If this variable is used in a
13324 RCPT ACL, its value includes the current command.
13325
13326 .vitem &$rcpt_defer_count$&
13327 .vindex "&$rcpt_defer_count$&"
13328 .cindex "4&'xx'& responses" "count of"
13329 When a message is being received by SMTP, this variable contains the number of
13330 RCPT commands in the current message that have previously been rejected with a
13331 temporary (4&'xx'&) response.
13332
13333 .vitem &$rcpt_fail_count$&
13334 .vindex "&$rcpt_fail_count$&"
13335 When a message is being received by SMTP, this variable contains the number of
13336 RCPT commands in the current message that have previously been rejected with a
13337 permanent (5&'xx'&) response.
13338
13339 .vitem &$received_count$&
13340 .vindex "&$received_count$&"
13341 This variable contains the number of &'Received:'& header lines in the message,
13342 including the one added by Exim (so its value is always greater than zero). It
13343 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13344 delivering.
13345
13346 .tvar &$received_for$&
13347 If there is only a single recipient address in an incoming message, this
13348 variable contains that address when the &'Received:'& header line is being
13349 built. The value is copied after recipient rewriting has happened, but before
13350 the &[local_scan()]& function is run.
13351
13352 .vitem &$received_ip_address$& &&&
13353        &$received_port$&
13354 .vindex "&$received_ip_address$&"
13355 .vindex "&$received_port$&"
13356 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13357 variables are set to the address and port on the local IP interface.
13358 (The remote IP address and port are in
13359 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13360 the port value is -1 unless it has been set using the &%-oMi%& command line
13361 option.
13362
13363 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13364 could be used, for example, to make the filename for a TLS certificate depend
13365 on which interface and/or port is being used for the incoming connection. The
13366 values of &$received_ip_address$& and &$received_port$& are saved with any
13367 messages that are received, thus making these variables available at delivery
13368 time.
13369 For outbound connections see &$sending_ip_address$&.
13370
13371 .vitem &$received_protocol$&
13372 .vindex "&$received_protocol$&"
13373 When a message is being processed, this variable contains the name of the
13374 protocol by which it was received. Most of the names used by Exim are defined
13375 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13376 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13377 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13378 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13379 connection and the client was successfully authenticated.
13380
13381 Exim uses the protocol name &"smtps"& for the case when encryption is
13382 automatically set up on connection without the use of STARTTLS (see
13383 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13384 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13385 where the client initially uses EHLO, sets up an encrypted connection using
13386 STARTTLS, and then uses HELO afterwards.
13387
13388 The &%-oMr%& option provides a way of specifying a custom protocol name for
13389 messages that are injected locally by trusted callers. This is commonly used to
13390 identify messages that are being re-injected after some kind of scanning.
13391
13392 .vitem &$received_time$&
13393 .vindex "&$received_time$&"
13394 This variable contains the date and time when the current message was received,
13395 as a number of seconds since the start of the Unix epoch.
13396
13397 .vitem &$recipient_data$&
13398 .vindex "&$recipient_data$&"
13399 This variable is set after an indexing lookup success in an ACL &%recipients%&
13400 condition. It contains the data from the lookup, and the value remains set
13401 until the next &%recipients%& test. Thus, you can do things like this:
13402 .display
13403 &`require recipients  = cdb*@;/some/file`&
13404 &`deny    `&&'some further test involving'& &`$recipient_data`&
13405 .endd
13406 &*Warning*&: This variable is set only when a lookup is used as an indexing
13407 method in the address list, using the semicolon syntax as in the example above.
13408 The variable is not set for a lookup that is used as part of the string
13409 expansion that all such lists undergo before being interpreted.
13410
13411 .vitem &$recipient_verify_failure$&
13412 .vindex "&$recipient_verify_failure$&"
13413 In an ACL, when a recipient verification fails, this variable contains
13414 information about the failure. It is set to one of the following words:
13415
13416 .ilist
13417 &"qualify"&: The address was unqualified (no domain), and the message
13418 was neither local nor came from an exempted host.
13419
13420 .next
13421 &"route"&: Routing failed.
13422
13423 .next
13424 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13425 or before the MAIL command (that is, on initial connection, HELO, or
13426 MAIL).
13427
13428 .next
13429 &"recipient"&: The RCPT command in a callout was rejected.
13430 .next
13431
13432 &"postmaster"&: The postmaster check in a callout was rejected.
13433 .endlist
13434
13435 The main use of this variable is expected to be to distinguish between
13436 rejections of MAIL and rejections of RCPT.
13437
13438 .tvar &$recipients$&
13439 .new
13440 .tvar &$recipients_list$&
13441 These variables both contain the envelope recipients for a message.
13442
13443 The first uses a comma and a space separate the addresses in the replacement text.
13444 &*Note*&: an address can legitimately contain a comma;
13445 this variable is not intended for further processing.
13446
13447 The second is a proper Exim list; colon-separated.
13448 .wen
13449
13450 However, the variables
13451 are not generally available, to prevent exposure of Bcc recipients in
13452 unprivileged users' filter files. You can use either of them  only in these
13453 cases:
13454
13455 .olist
13456 In a system filter file.
13457 .next
13458 In the ACLs associated with the DATA command and with non-SMTP messages, that
13459 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13460 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13461 &%acl_not_smtp_mime%&.
13462 .next
13463 From within a &[local_scan()]& function.
13464 .endlist
13465
13466
13467 .vitem &$recipients_count$&
13468 .vindex "&$recipients_count$&"
13469 When a message is being processed, this variable contains the number of
13470 envelope recipients that came with the message. Duplicates are not excluded
13471 from the count. While a message is being received over SMTP, the number
13472 increases for each accepted recipient. It can be referenced in an ACL.
13473
13474
13475 .vitem &$regex_match_string$&
13476 .vindex "&$regex_match_string$&"
13477 This variable is set to contain the matching regular expression after a
13478 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13479
13480 .vitem "&$regex1$&, &$regex2$&, etc"
13481 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13482 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13483 these variables contain the
13484 captured substrings identified by the regular expression.
13485 If the subject string was tainted then so will any captured substring.
13486
13487
13488 .tvar &$reply_address$&
13489 When a message is being processed, this variable contains the contents of the
13490 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13491 contents of the &'From:'& header line. Apart from the removal of leading
13492 white space, the value is not processed in any way. In particular, no RFC 2047
13493 decoding or character code translation takes place.
13494
13495 .vitem &$return_path$&
13496 .vindex "&$return_path$&"
13497 When a message is being delivered, this variable contains the return path &--
13498 the sender field that will be sent as part of the envelope. It is not enclosed
13499 in <> characters. At the start of routing an address, &$return_path$& has the
13500 same value as &$sender_address$&, but if, for example, an incoming message to a
13501 mailing list has been expanded by a router which specifies a different address
13502 for bounce messages, &$return_path$& subsequently contains the new bounce
13503 address, whereas &$sender_address$& always contains the original sender address
13504 that was received with the message. In other words, &$sender_address$& contains
13505 the incoming envelope sender, and &$return_path$& contains the outgoing
13506 envelope sender.
13507
13508 .vitem &$return_size_limit$&
13509 .vindex "&$return_size_limit$&"
13510 This is an obsolete name for &$bounce_return_size_limit$&.
13511
13512 .vitem &$router_name$&
13513 .cindex "router" "name"
13514 .cindex "name" "of router"
13515 .vindex "&$router_name$&"
13516 During the running of a router, or a transport called,
13517 this variable contains the router name.
13518
13519 .vitem &$runrc$&
13520 .cindex "return code" "from &%run%& expansion"
13521 .vindex "&$runrc$&"
13522 This variable contains the return code from a command that is run by the
13523 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13524 assume the order in which option values are expanded, except for those
13525 preconditions whose order of testing is documented. Therefore, you cannot
13526 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13527 another.
13528
13529 .vitem &$self_hostname$&
13530 .oindex "&%self%&" "value of host name"
13531 .vindex "&$self_hostname$&"
13532 When an address is routed to a supposedly remote host that turns out to be the
13533 local host, what happens is controlled by the &%self%& generic router option.
13534 One of its values causes the address to be passed to another router. When this
13535 happens, &$self_hostname$& is set to the name of the local host that the
13536 original router encountered. In other circumstances its contents are null.
13537
13538 .tvar &$sender_address$&
13539 When a message is being processed, this variable contains the sender's address
13540 that was received in the message's envelope. The case of letters in the address
13541 is retained, in both the local part and the domain. For bounce messages, the
13542 value of this variable is the empty string. See also &$return_path$&.
13543
13544 .vitem &$sender_address_data$&
13545 .vindex "&$address_data$&"
13546 .vindex "&$sender_address_data$&"
13547 If &$address_data$& is set when the routers are called from an ACL to verify a
13548 sender address, the final value is preserved in &$sender_address_data$&, to
13549 distinguish it from data from a recipient address. The value does not persist
13550 after the end of the current ACL statement. If you want to preserve it for
13551 longer, you can save it in an ACL variable.
13552
13553 .tvar &$sender_address_domain$&
13554 The domain portion of &$sender_address$&.
13555
13556 .tvar &$sender_address_local_part$&
13557 The local part portion of &$sender_address$&.
13558
13559 .vitem &$sender_data$&
13560 .vindex "&$sender_data$&"
13561 This variable is set after a lookup success in an ACL &%senders%& condition or
13562 in a router &%senders%& option. It contains the data from the lookup, and the
13563 value remains set until the next &%senders%& test. Thus, you can do things like
13564 this:
13565 .display
13566 &`require senders      = cdb*@;/some/file`&
13567 &`deny    `&&'some further test involving'& &`$sender_data`&
13568 .endd
13569 &*Warning*&: This variable is set only when a lookup is used as an indexing
13570 method in the address list, using the semicolon syntax as in the example above.
13571 The variable is not set for a lookup that is used as part of the string
13572 expansion that all such lists undergo before being interpreted.
13573
13574 .vitem &$sender_fullhost$&
13575 .vindex "&$sender_fullhost$&"
13576 When a message is received from a remote host, this variable contains the host
13577 name and IP address in a single string. It ends with the IP address in square
13578 brackets, followed by a colon and a port number if the logging of ports is
13579 enabled. The format of the rest of the string depends on whether the host
13580 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13581 looking up its IP address. (Looking up the IP address can be forced by the
13582 &%host_lookup%& option, independent of verification.) A plain host name at the
13583 start of the string is a verified host name; if this is not present,
13584 verification either failed or was not requested. A host name in parentheses is
13585 the argument of a HELO or EHLO command. This is omitted if it is identical to
13586 the verified host name or to the host's IP address in square brackets.
13587
13588 .vitem &$sender_helo_dnssec$&
13589 .vindex "&$sender_helo_dnssec$&"
13590 This boolean variable is true if a successful HELO verification was
13591 .cindex "DNS" "DNSSEC"
13592 done using DNS information the resolver library stated was authenticated data.
13593
13594 .tvar &$sender_helo_name$&
13595 When a message is received from a remote host that has issued a HELO or EHLO
13596 command, the argument of that command is placed in this variable. It is also
13597 set if HELO or EHLO is used when a message is received using SMTP locally via
13598 the &%-bs%& or &%-bS%& options.
13599
13600 .vitem &$sender_host_address$&
13601 .vindex "&$sender_host_address$&"
13602 When a message is received from a remote host using SMTP,
13603 this variable contains that
13604 host's IP address. For locally non-SMTP submitted messages, it is empty.
13605
13606 .vitem &$sender_host_authenticated$&
13607 .vindex "&$sender_host_authenticated$&"
13608 This variable contains the name (not the public name) of the authenticator
13609 driver that successfully authenticated the client from which the message was
13610 received. It is empty if there was no successful authentication. See also
13611 &$authenticated_id$&.
13612
13613 .vitem &$sender_host_dnssec$&
13614 .vindex "&$sender_host_dnssec$&"
13615 If an attempt to populate &$sender_host_name$& has been made
13616 (by reference, &%hosts_lookup%& or
13617 otherwise) then this boolean will have been set true if, and only if, the
13618 resolver library states that both
13619 the reverse and forward DNS were authenticated data.  At all
13620 other times, this variable is false.
13621
13622 .cindex "DNS" "DNSSEC"
13623 It is likely that you will need to coerce DNSSEC support on in the resolver
13624 library, by setting:
13625 .code
13626 dns_dnssec_ok = 1
13627 .endd
13628
13629 In addition, on Linux with glibc 2.31 or newer the resolver library will
13630 default to stripping out a successful validation status.
13631 This will break a previously working Exim installation.
13632 Provided that you do trust the resolver (ie, is on localhost) you can tell
13633 glibc to pass through any successful validation with a new option in
13634 &_/etc/resolv.conf_&:
13635 .code
13636 options trust-ad
13637 .endd
13638
13639 Exim does not perform DNSSEC validation itself, instead leaving that to a
13640 validating resolver (e.g. unbound, or bind with suitable configuration).
13641
13642 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13643 mechanism in the list, then this variable will be false.
13644
13645 This requires that your system resolver library support EDNS0 (and that
13646 DNSSEC flags exist in the system headers).  If the resolver silently drops
13647 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13648 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13649
13650
13651 .tvar &$sender_host_name$&
13652 When a message is received from a remote host, this variable contains the
13653 host's name as obtained by looking up its IP address. For messages received by
13654 other means, this variable is empty.
13655
13656 .vindex "&$host_lookup_failed$&"
13657 If the host name has not previously been looked up, a reference to
13658 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13659 A looked up name is accepted only if it leads back to the original IP address
13660 via a forward lookup. If either the reverse or the forward lookup fails to find
13661 any data, or if the forward lookup does not yield the original IP address,
13662 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13663
13664 .vindex "&$host_lookup_deferred$&"
13665 However, if either of the lookups cannot be completed (for example, there is a
13666 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13667 &$host_lookup_failed$& remains set to &"0"&.
13668
13669 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13670 host name again if there is a subsequent reference to &$sender_host_name$&
13671 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13672 is set to &"1"&.
13673
13674 Exim does not automatically look up every calling host's name. If you want
13675 maximum efficiency, you should arrange your configuration so that it avoids
13676 these lookups altogether. The lookup happens only if one or more of the
13677 following are true:
13678
13679 .ilist
13680 A string containing &$sender_host_name$& is expanded.
13681 .next
13682 The calling host matches the list in &%host_lookup%&. In the default
13683 configuration, this option is set to *, so it must be changed if lookups are
13684 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13685 .next
13686 Exim needs the host name in order to test an item in a host list. The items
13687 that require this are described in sections &<<SECThoslispatnam>>& and
13688 &<<SECThoslispatnamsk>>&.
13689 .next
13690 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13691 In this case, the host name is required to compare with the name quoted in any
13692 EHLO or HELO commands that the client issues.
13693 .next
13694 The remote host issues a EHLO or HELO command that quotes one of the
13695 domains in &%helo_lookup_domains%&. The default value of this option is
13696 . ==== As this is a nested list, any displays it contains must be indented
13697 . ==== as otherwise they are too far to the left.
13698 .code
13699   helo_lookup_domains = @ : @[]
13700 .endd
13701 which causes a lookup if a remote host (incorrectly) gives the server's name or
13702 IP address in an EHLO or HELO command.
13703 .endlist
13704
13705
13706 .vitem &$sender_host_port$&
13707 .vindex "&$sender_host_port$&"
13708 When a message is received from a remote host, this variable contains the port
13709 number that was used on the remote host.
13710
13711 .vitem &$sender_ident$&
13712 .vindex "&$sender_ident$&"
13713 When a message is received from a remote host, this variable contains the
13714 identification received in response to an RFC 1413 request. When a message has
13715 been received locally, this variable contains the login name of the user that
13716 called Exim.
13717
13718 .vitem &$sender_rate_$&&'xxx'&
13719 A number of variables whose names begin &$sender_rate_$& are set as part of the
13720 &%ratelimit%& ACL condition. Details are given in section
13721 &<<SECTratelimiting>>&.
13722
13723 .vitem &$sender_rcvhost$&
13724 .cindex "DNS" "reverse lookup"
13725 .cindex "reverse DNS lookup"
13726 .vindex "&$sender_rcvhost$&"
13727 This is provided specifically for use in &'Received:'& headers. It starts with
13728 either the verified host name (as obtained from a reverse DNS lookup) or, if
13729 there is no verified host name, the IP address in square brackets. After that
13730 there may be text in parentheses. When the first item is a verified host name,
13731 the first thing in the parentheses is the IP address in square brackets,
13732 followed by a colon and a port number if port logging is enabled. When the
13733 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13734 the parentheses.
13735
13736 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13737 was used and its argument was not identical to the real host name or IP
13738 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13739 all three items are present in the parentheses, a newline and tab are inserted
13740 into the string, to improve the formatting of the &'Received:'& header.
13741
13742 .vitem &$sender_verify_failure$&
13743 .vindex "&$sender_verify_failure$&"
13744 In an ACL, when a sender verification fails, this variable contains information
13745 about the failure. The details are the same as for
13746 &$recipient_verify_failure$&.
13747
13748 .vitem &$sending_ip_address$&
13749 .vindex "&$sending_ip_address$&"
13750 This variable is set whenever an outgoing SMTP connection to another host has
13751 been set up. It contains the IP address of the local interface that is being
13752 used. This is useful if a host that has more than one IP address wants to take
13753 on different personalities depending on which one is being used. For incoming
13754 connections, see &$received_ip_address$&.
13755
13756 .vitem &$sending_port$&
13757 .vindex "&$sending_port$&"
13758 This variable is set whenever an outgoing SMTP connection to another host has
13759 been set up. It contains the local port that is being used. For incoming
13760 connections, see &$received_port$&.
13761
13762 .vitem &$smtp_active_hostname$&
13763 .vindex "&$smtp_active_hostname$&"
13764 During an incoming SMTP session, this variable contains the value of the active
13765 host name, as specified by the &%smtp_active_hostname%& option. The value of
13766 &$smtp_active_hostname$& is saved with any message that is received, so its
13767 value can be consulted during routing and delivery.
13768
13769 .tvar &$smtp_command$&
13770 During the processing of an incoming SMTP command, this variable contains the
13771 entire command. This makes it possible to distinguish between HELO and EHLO in
13772 the HELO ACL, and also to distinguish between commands such as these:
13773 .code
13774 MAIL FROM:<>
13775 MAIL FROM: <>
13776 .endd
13777 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13778 command, the address in &$smtp_command$& is the original address before any
13779 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13780 the address after SMTP-time rewriting.
13781
13782 .tvar &$smtp_command_argument$&
13783 .cindex "SMTP" "command, argument for"
13784 While an ACL is running to check an SMTP command, this variable contains the
13785 argument, that is, the text that follows the command name, with leading white
13786 space removed. Following the introduction of &$smtp_command$&, this variable is
13787 somewhat redundant, but is retained for backwards compatibility.
13788
13789 .vitem &$smtp_command_history$&
13790 .cindex SMTP "command history"
13791 .vindex "&$smtp_command_history$&"
13792 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13793 received, in time-order left to right.  Only a limited number of commands
13794 are remembered.
13795
13796 .vitem &$smtp_count_at_connection_start$&
13797 .vindex "&$smtp_count_at_connection_start$&"
13798 This variable is set greater than zero only in processes spawned by the Exim
13799 daemon for handling incoming SMTP connections. The name is deliberately long,
13800 in order to emphasize what the contents are. When the daemon accepts a new
13801 connection, it increments this variable. A copy of the variable is passed to
13802 the child process that handles the connection, but its value is fixed, and
13803 never changes. It is only an approximation of how many incoming connections
13804 there actually are, because many other connections may come and go while a
13805 single connection is being processed. When a child process terminates, the
13806 daemon decrements its copy of the variable.
13807
13808 .vitem &$smtp_notquit_reason$&
13809 .vindex "&$smtp_notquit_reason$&"
13810 When the not-QUIT ACL is running, this variable is set to a string
13811 that indicates the reason for the termination of the SMTP connection.
13812
13813 .vitem "&$sn0$& &-- &$sn9$&"
13814 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13815 that were current at the end of the system filter file. This allows a system
13816 filter file to set values that can be tested in users' filter files. For
13817 example, a system filter could set a value indicating how likely it is that a
13818 message is junk mail.
13819
13820 .vitem &$spam_score$& &&&
13821        &$spam_score_int$& &&&
13822        &$spam_bar$& &&&
13823        &$spam_report$& &&&
13824        &$spam_action$&
13825 A number of variables whose names start with &$spam$& are available when Exim
13826 is compiled with the content-scanning extension. For details, see section
13827 &<<SECTscanspamass>>&.
13828
13829 .vitem &$spf_header_comment$& &&&
13830        &$spf_received$& &&&
13831        &$spf_result$& &&&
13832        &$spf_result_guessed$& &&&
13833        &$spf_smtp_comment$&
13834 These variables are only available if Exim is built with SPF support.
13835 For details see section &<<SECSPF>>&.
13836
13837 .vitem &$spool_directory$&
13838 .vindex "&$spool_directory$&"
13839 The name of Exim's spool directory.
13840
13841 .vitem &$spool_inodes$&
13842 .vindex "&$spool_inodes$&"
13843 The number of free inodes in the disk partition where Exim's spool files are
13844 being written. The value is recalculated whenever the variable is referenced.
13845 If the relevant file system does not have the concept of inodes, the value of
13846 is -1. See also the &%check_spool_inodes%& option.
13847
13848 .vitem &$spool_space$&
13849 .vindex "&$spool_space$&"
13850 The amount of free space (as a number of kilobytes) in the disk partition where
13851 Exim's spool files are being written. The value is recalculated whenever the
13852 variable is referenced. If the operating system does not have the ability to
13853 find the amount of free space (only true for experimental systems), the space
13854 value is -1. For example, to check in an ACL that there is at least 50
13855 megabytes free on the spool, you could write:
13856 .code
13857 condition = ${if > {$spool_space}{50000}}
13858 .endd
13859 See also the &%check_spool_space%& option.
13860
13861
13862 .vitem &$thisaddress$&
13863 .vindex "&$thisaddress$&"
13864 This variable is set only during the processing of the &%foranyaddress%&
13865 command in a filter file. Its use is explained in the description of that
13866 command, which can be found in the separate document entitled &'Exim's
13867 interfaces to mail filtering'&.
13868
13869 .vitem &$tls_in_bits$&
13870 .vindex "&$tls_in_bits$&"
13871 Contains an approximation of the TLS cipher's bit-strength
13872 on the inbound connection; the meaning of
13873 this depends upon the TLS implementation used.
13874 If TLS has not been negotiated, the value will be 0.
13875 The value of this is automatically fed into the Cyrus SASL authenticator
13876 when acting as a server, to specify the "external SSF" (a SASL term).
13877
13878 The deprecated &$tls_bits$& variable refers to the inbound side
13879 except when used in the context of an outbound SMTP delivery, when it refers to
13880 the outbound.
13881
13882 .vitem &$tls_out_bits$&
13883 .vindex "&$tls_out_bits$&"
13884 Contains an approximation of the TLS cipher's bit-strength
13885 on an outbound SMTP connection; the meaning of
13886 this depends upon the TLS implementation used.
13887 If TLS has not been negotiated, the value will be 0.
13888
13889 .vitem &$tls_in_ourcert$&
13890 .vindex "&$tls_in_ourcert$&"
13891 .cindex certificate variables
13892 This variable refers to the certificate presented to the peer of an
13893 inbound connection when the message was received.
13894 It is only useful as the argument of a
13895 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13896 or a &%def%& condition.
13897
13898 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13899 when a list of more than one
13900 file is used for &%tls_certificate%&, this variable is not reliable.
13901 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13902
13903 .vitem &$tls_in_peercert$&
13904 .vindex "&$tls_in_peercert$&"
13905 This variable refers to the certificate presented by the peer of an
13906 inbound connection when the message was received.
13907 It is only useful as the argument of a
13908 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13909 or a &%def%& condition.
13910 If certificate verification fails it may refer to a failing chain element
13911 which is not the leaf.
13912
13913 .vitem &$tls_out_ourcert$&
13914 .vindex "&$tls_out_ourcert$&"
13915 This variable refers to the certificate presented to the peer of an
13916 outbound connection.  It is only useful as the argument of a
13917 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13918 or a &%def%& condition.
13919
13920 .vitem &$tls_out_peercert$&
13921 .vindex "&$tls_out_peercert$&"
13922 This variable refers to the certificate presented by the peer of an
13923 outbound connection.  It is only useful as the argument of a
13924 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13925 or a &%def%& condition.
13926 If certificate verification fails it may refer to a failing chain element
13927 which is not the leaf.
13928
13929 .vitem &$tls_in_certificate_verified$&
13930 .vindex "&$tls_in_certificate_verified$&"
13931 This variable is set to &"1"& if a TLS certificate was verified when the
13932 message was received, and &"0"& otherwise.
13933
13934 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13935 except when used in the context of an outbound SMTP delivery, when it refers to
13936 the outbound.
13937
13938 .vitem &$tls_out_certificate_verified$&
13939 .vindex "&$tls_out_certificate_verified$&"
13940 This variable is set to &"1"& if a TLS certificate was verified when an
13941 outbound SMTP connection was made,
13942 and &"0"& otherwise.
13943
13944 .vitem &$tls_in_cipher$&
13945 .vindex "&$tls_in_cipher$&"
13946 .vindex "&$tls_cipher$&"
13947 When a message is received from a remote host over an encrypted SMTP
13948 connection, this variable is set to the cipher suite that was negotiated, for
13949 example DES-CBC3-SHA. In other circumstances, in particular, for message
13950 received over unencrypted connections, the variable is empty. Testing
13951 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13952 non-encrypted connections during ACL processing.
13953
13954 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13955 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13956 becomes the same as &$tls_out_cipher$&.
13957
13958 .vitem &$tls_in_cipher_std$&
13959 .vindex "&$tls_in_cipher_std$&"
13960 As above, but returning the RFC standard name for the cipher suite.
13961
13962 .vitem &$tls_out_cipher$&
13963 .vindex "&$tls_out_cipher$&"
13964 This variable is
13965 cleared before any outgoing SMTP connection is made,
13966 and then set to the outgoing cipher suite if one is negotiated. See chapter
13967 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13968 details of the &(smtp)& transport.
13969
13970 .vitem &$tls_out_cipher_std$&
13971 .vindex "&$tls_out_cipher_std$&"
13972 As above, but returning the RFC standard name for the cipher suite.
13973
13974 .vitem &$tls_out_dane$&
13975 .vindex &$tls_out_dane$&
13976 DANE active status.  See section &<<SECDANE>>&.
13977
13978 .vitem &$tls_in_ocsp$&
13979 .vindex "&$tls_in_ocsp$&"
13980 When a message is received from a remote client connection
13981 the result of any OCSP request from the client is encoded in this variable:
13982 .code
13983 0 OCSP proof was not requested (default value)
13984 1 No response to request
13985 2 Response not verified
13986 3 Verification failed
13987 4 Verification succeeded
13988 .endd
13989
13990 .vitem &$tls_out_ocsp$&
13991 .vindex "&$tls_out_ocsp$&"
13992 When a message is sent to a remote host connection
13993 the result of any OCSP request made is encoded in this variable.
13994 See &$tls_in_ocsp$& for values.
13995
13996 .vitem &$tls_in_peerdn$&
13997 .vindex "&$tls_in_peerdn$&"
13998 .vindex "&$tls_peerdn$&"
13999 .cindex certificate "extracting fields"
14000 When a message is received from a remote host over an encrypted SMTP
14001 connection, and Exim is configured to request a certificate from the client,
14002 the value of the Distinguished Name of the certificate is made available in the
14003 &$tls_in_peerdn$& during subsequent processing.
14004 If certificate verification fails it may refer to a failing chain element
14005 which is not the leaf.
14006
14007 The deprecated &$tls_peerdn$& variable refers to the inbound side
14008 except when used in the context of an outbound SMTP delivery, when it refers to
14009 the outbound.
14010
14011 .vitem &$tls_out_peerdn$&
14012 .vindex "&$tls_out_peerdn$&"
14013 When a message is being delivered to a remote host over an encrypted SMTP
14014 connection, and Exim is configured to request a certificate from the server,
14015 the value of the Distinguished Name of the certificate is made available in the
14016 &$tls_out_peerdn$& during subsequent processing.
14017 If certificate verification fails it may refer to a failing chain element
14018 which is not the leaf.
14019
14020
14021 .vitem &$tls_in_resumption$& &&&
14022        &$tls_out_resumption$&
14023 .vindex &$tls_in_resumption$&
14024 .vindex &$tls_out_resumption$&
14025 .cindex TLS resumption
14026 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
14027
14028
14029 .tvar &$tls_in_sni$&
14030 .vindex "&$tls_sni$&"
14031 .cindex "TLS" "Server Name Indication"
14032 .cindex "TLS" SNI
14033 .cindex SNI "observability on server"
14034 When a TLS session is being established, if the client sends the Server
14035 Name Indication extension, the value will be placed in this variable.
14036 If the variable appears in &%tls_certificate%& then this option and
14037 some others, described in &<<SECTtlssni>>&,
14038 will be re-expanded early in the TLS session, to permit
14039 a different certificate to be presented (and optionally a different key to be
14040 used) to the client, based upon the value of the SNI extension.
14041
14042 The deprecated &$tls_sni$& variable refers to the inbound side
14043 except when used in the context of an outbound SMTP delivery, when it refers to
14044 the outbound.
14045
14046 .vitem &$tls_out_sni$&
14047 .vindex "&$tls_out_sni$&"
14048 .cindex "TLS" "Server Name Indication"
14049 .cindex "TLS" SNI
14050 .cindex SNI "observability in client"
14051 During outbound
14052 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14053 the transport.
14054
14055 .vitem &$tls_out_tlsa_usage$&
14056 .vindex &$tls_out_tlsa_usage$&
14057 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14058
14059 .vitem &$tls_in_ver$&
14060 .vindex "&$tls_in_ver$&"
14061 When a message is received from a remote host over an encrypted SMTP connection
14062 this variable is set to the protocol version, eg &'TLS1.2'&.
14063
14064 .vitem &$tls_out_ver$&
14065 .vindex "&$tls_out_ver$&"
14066 When a message is being delivered to a remote host over an encrypted SMTP connection
14067 this variable is set to the protocol version.
14068
14069
14070 .vitem &$tod_bsdinbox$&
14071 .vindex "&$tod_bsdinbox$&"
14072 The time of day and the date, in the format required for BSD-style mailbox
14073 files, for example: Thu Oct 17 17:14:09 1995.
14074
14075 .vitem &$tod_epoch$&
14076 .vindex "&$tod_epoch$&"
14077 The time and date as a number of seconds since the start of the Unix epoch.
14078
14079 .vitem &$tod_epoch_l$&
14080 .vindex "&$tod_epoch_l$&"
14081 The time and date as a number of microseconds since the start of the Unix epoch.
14082
14083 .vitem &$tod_full$&
14084 .vindex "&$tod_full$&"
14085 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14086 +0100. The timezone is always given as a numerical offset from UTC, with
14087 positive values used for timezones that are ahead (east) of UTC, and negative
14088 values for those that are behind (west).
14089
14090 .vitem &$tod_log$&
14091 .vindex "&$tod_log$&"
14092 The time and date in the format used for writing Exim's log files, for example:
14093 1995-10-12 15:32:29, but without a timezone.
14094
14095 .vitem &$tod_logfile$&
14096 .vindex "&$tod_logfile$&"
14097 This variable contains the date in the format yyyymmdd. This is the format that
14098 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14099 flag.
14100
14101 .vitem &$tod_zone$&
14102 .vindex "&$tod_zone$&"
14103 This variable contains the numerical value of the local timezone, for example:
14104 -0500.
14105
14106 .vitem &$tod_zulu$&
14107 .vindex "&$tod_zulu$&"
14108 This variable contains the UTC date and time in &"Zulu"& format, as specified
14109 by ISO 8601, for example: 20030221154023Z.
14110
14111 .vitem &$transport_name$&
14112 .cindex "transport" "name"
14113 .cindex "name" "of transport"
14114 .vindex "&$transport_name$&"
14115 During the running of a transport, this variable contains its name.
14116
14117 .vitem &$value$&
14118 .vindex "&$value$&"
14119 This variable contains the result of an expansion lookup, extraction operation,
14120 or external command, as described above. It is also used during a
14121 &*reduce*& expansion.
14122
14123 .vitem &$verify_mode$&
14124 .vindex "&$verify_mode$&"
14125 While a router or transport is being run in verify mode or for cutthrough delivery,
14126 contains "S" for sender-verification or "R" for recipient-verification.
14127 Otherwise, empty.
14128
14129 .vitem &$version_number$&
14130 .vindex "&$version_number$&"
14131 The version number of Exim. Same as &$exim_version$&, may be overridden
14132 by the &%exim_version%& main config option.
14133
14134 .vitem &$warn_message_delay$&
14135 .vindex "&$warn_message_delay$&"
14136 This variable is set only during the creation of a message warning about a
14137 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14138
14139 .vitem &$warn_message_recipients$&
14140 .vindex "&$warn_message_recipients$&"
14141 This variable is set only during the creation of a message warning about a
14142 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14143 .endlist
14144 .ecindex IIDstrexp
14145
14146
14147
14148 . ////////////////////////////////////////////////////////////////////////////
14149 . ////////////////////////////////////////////////////////////////////////////
14150
14151 .chapter "Embedded Perl" "CHAPperl"
14152 .scindex IIDperl "Perl" "calling from Exim"
14153 Exim can be built to include an embedded Perl interpreter. When this is done,
14154 Perl subroutines can be called as part of the string expansion process. To make
14155 use of the Perl support, you need version 5.004 or later of Perl installed on
14156 your system. To include the embedded interpreter in the Exim binary, include
14157 the line
14158 .code
14159 EXIM_PERL = perl.o
14160 .endd
14161 in your &_Local/Makefile_& and then build Exim in the normal way.
14162
14163
14164 .section "Setting up so Perl can be used" "SECID85"
14165 .oindex "&%perl_startup%&"
14166 Access to Perl subroutines is via a global configuration option called
14167 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14168 no &%perl_startup%& option in the Exim configuration file then no Perl
14169 interpreter is started and there is almost no overhead for Exim (since none of
14170 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14171 option then the associated value is taken to be Perl code which is executed in
14172 a newly created Perl interpreter.
14173
14174 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14175 need backslashes before any characters to escape special meanings. The option
14176 should usually be something like
14177 .code
14178 perl_startup = do '/etc/exim.pl'
14179 .endd
14180 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14181 use from Exim. Exim can be configured either to start up a Perl interpreter as
14182 soon as it is entered, or to wait until the first time it is needed. Starting
14183 the interpreter at the beginning ensures that it is done while Exim still has
14184 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14185 fact used in a particular run. Also, note that this does not mean that Exim is
14186 necessarily running as root when Perl is called at a later time. By default,
14187 the interpreter is started only when it is needed, but this can be changed in
14188 two ways:
14189
14190 .ilist
14191 .oindex "&%perl_at_start%&"
14192 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14193 a startup when Exim is entered.
14194 .next
14195 The command line option &%-ps%& also requests a startup when Exim is entered,
14196 overriding the setting of &%perl_at_start%&.
14197 .endlist
14198
14199 There is also a command line option &%-pd%& (for delay) which suppresses the
14200 initial startup, even if &%perl_at_start%& is set.
14201
14202 .ilist
14203 .oindex "&%perl_taintmode%&"
14204 .cindex "Perl" "taintmode"
14205 To provide more security executing Perl code via the embedded Perl
14206 interpreter, the &%perl_taintmode%& option can be set. This enables the
14207 taint mode of the Perl interpreter. You are encouraged to set this
14208 option to a true value. To avoid breaking existing installations, it
14209 defaults to false.
14210
14211 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14212
14213
14214 .section "Calling Perl subroutines" "SECID86"
14215 When the configuration file includes a &%perl_startup%& option you can make use
14216 of the string expansion item to call the Perl subroutines that are defined
14217 by the &%perl_startup%& code. The operator is used in any of the following
14218 forms:
14219 .code
14220 ${perl{foo}}
14221 ${perl{foo}{argument}}
14222 ${perl{foo}{argument1}{argument2} ... }
14223 .endd
14224 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14225 arguments may be passed. Passing more than this results in an expansion failure
14226 with an error message of the form
14227 .code
14228 Too many arguments passed to Perl subroutine "foo" (max is 8)
14229 .endd
14230 The return value of the Perl subroutine is evaluated in a scalar context before
14231 it is passed back to Exim to be inserted into the expanded string. If the
14232 return value is &'undef'&, the expansion is forced to fail in the same way as
14233 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14234 by obeying Perl's &%die%& function, the expansion fails with the error message
14235 that was passed to &%die%&.
14236
14237
14238 .section "Calling Exim functions from Perl" "SECID87"
14239 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14240 is available to call back into Exim's string expansion function. For example,
14241 the Perl code
14242 .code
14243 my $lp = Exim::expand_string('$local_part');
14244 .endd
14245 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14246 Note those are single quotes and not double quotes to protect against
14247 &$local_part$& being interpolated as a Perl variable.
14248
14249 If the string expansion is forced to fail by a &"fail"& item, the result of
14250 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14251 expansion string, the Perl call from the original expansion string fails with
14252 an appropriate error message, in the same way as if &%die%& were used.
14253
14254 .cindex "debugging" "from embedded Perl"
14255 .cindex "log" "writing from embedded Perl"
14256 Two other Exim functions are available for use from within Perl code.
14257 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14258 debugging is enabled. If you want a newline at the end, you must supply it.
14259 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14260 timestamp. In this case, you should not supply a terminating newline.
14261
14262
14263 .section "Use of standard output and error by Perl" "SECID88"
14264 .cindex "Perl" "standard output and error"
14265 You should not write to the standard error or output streams from within your
14266 Perl code, as it is not defined how these are set up. In versions of Exim
14267 before 4.50, it is possible for the standard output or error to refer to the
14268 SMTP connection during message reception via the daemon. Writing to this stream
14269 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14270 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14271 avoided, but the output is lost.
14272
14273 .cindex "Perl" "use of &%warn%&"
14274 The Perl &%warn%& statement writes to the standard error stream by default.
14275 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14276 you have no control. When Exim starts up the Perl interpreter, it arranges for
14277 output from the &%warn%& statement to be written to the Exim main log. You can
14278 change this by including appropriate Perl magic somewhere in your Perl code.
14279 For example, to discard &%warn%& output completely, you need this:
14280 .code
14281 $SIG{__WARN__} = sub { };
14282 .endd
14283 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14284 example, the code for the subroutine is empty, so it does nothing, but you can
14285 include any Perl code that you like. The text of the &%warn%& message is passed
14286 as the first subroutine argument.
14287 .ecindex IIDperl
14288
14289
14290 . ////////////////////////////////////////////////////////////////////////////
14291 . ////////////////////////////////////////////////////////////////////////////
14292
14293 .chapter "Starting the daemon and the use of network interfaces" &&&
14294          "CHAPinterfaces" &&&
14295          "Starting the daemon"
14296 .cindex "daemon" "starting"
14297 .cindex "interface" "listening"
14298 .cindex "network interface"
14299 .cindex "interface" "network"
14300 .cindex "IP address" "for listening"
14301 .cindex "daemon" "listening IP addresses"
14302 .cindex "TCP/IP" "setting listening interfaces"
14303 .cindex "TCP/IP" "setting listening ports"
14304 A host that is connected to a TCP/IP network may have one or more physical
14305 hardware network interfaces. Each of these interfaces may be configured as one
14306 or more &"logical"& interfaces, which are the entities that a program actually
14307 works with. Each of these logical interfaces is associated with an IP address.
14308 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14309 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14310 knowledge about the host's interfaces for use in three different circumstances:
14311
14312 .olist
14313 When a listening daemon is started, Exim needs to know which interfaces
14314 and ports to listen on.
14315 .next
14316 When Exim is routing an address, it needs to know which IP addresses
14317 are associated with local interfaces. This is required for the correct
14318 processing of MX lists by removing the local host and others with the
14319 same or higher priority values. Also, Exim needs to detect cases
14320 when an address is routed to an IP address that in fact belongs to the
14321 local host. Unless the &%self%& router option or the &%allow_localhost%&
14322 option of the smtp transport is set (as appropriate), this is treated
14323 as an error situation.
14324 .next
14325 When Exim connects to a remote host, it may need to know which interface to use
14326 for the outgoing connection.
14327 .endlist
14328
14329
14330 Exim's default behaviour is likely to be appropriate in the vast majority
14331 of cases. If your host has only one interface, and you want all its IP
14332 addresses to be treated in the same way, and you are using only the
14333 standard SMTP port, you should not need to take any special action. The
14334 rest of this chapter does not apply to you.
14335
14336 In a more complicated situation you may want to listen only on certain
14337 interfaces, or on different ports, and for this reason there are a number of
14338 options that can be used to influence Exim's behaviour. The rest of this
14339 chapter describes how they operate.
14340
14341 When a message is received over TCP/IP, the interface and port that were
14342 actually used are set in &$received_ip_address$& and &$received_port$&.
14343
14344
14345
14346 .section "Starting a listening daemon" "SECID89"
14347 When a listening daemon is started (by means of the &%-bd%& command line
14348 option), the interfaces and ports on which it listens are controlled by the
14349 following options:
14350
14351 .ilist
14352 &%daemon_smtp_ports%& contains a list of default ports
14353 or service names.
14354 (For backward compatibility, this option can also be specified in the singular.)
14355 .next
14356 &%local_interfaces%& contains list of interface IP addresses on which to
14357 listen. Each item may optionally also specify a port.
14358 .endlist
14359
14360 The default list separator in both cases is a colon, but this can be changed as
14361 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14362 it is usually best to change the separator to avoid having to double all the
14363 colons. For example:
14364 .code
14365 local_interfaces = <; 127.0.0.1 ; \
14366                       192.168.23.65 ; \
14367                       ::1 ; \
14368                       3ffe:ffff:836f::fe86:a061
14369 .endd
14370 There are two different formats for specifying a port along with an IP address
14371 in &%local_interfaces%&:
14372
14373 .olist
14374 The port is added onto the address with a dot separator. For example, to listen
14375 on port 1234 on two different IP addresses:
14376 .code
14377 local_interfaces = <; 192.168.23.65.1234 ; \
14378                       3ffe:ffff:836f::fe86:a061.1234
14379 .endd
14380 .next
14381 The IP address is enclosed in square brackets, and the port is added
14382 with a colon separator, for example:
14383 .code
14384 local_interfaces = <; [192.168.23.65]:1234 ; \
14385                       [3ffe:ffff:836f::fe86:a061]:1234
14386 .endd
14387 .endlist
14388
14389 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14390 default setting contains just one port:
14391 .code
14392 daemon_smtp_ports = smtp
14393 .endd
14394 If more than one port is listed, each interface that does not have its own port
14395 specified listens on all of them. Ports that are listed in
14396 &%daemon_smtp_ports%& can be identified either by name (defined in
14397 &_/etc/services_&) or by number. However, when ports are given with individual
14398 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14399
14400
14401
14402 .section "Special IP listening addresses" "SECID90"
14403 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14404 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14405 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14406 instead of setting up separate listening sockets for each interface. The
14407 default value of &%local_interfaces%& is
14408 .code
14409 local_interfaces = 0.0.0.0
14410 .endd
14411 when Exim is built without IPv6 support; otherwise it is:
14412 .code
14413 local_interfaces = <; ::0 ; 0.0.0.0
14414 .endd
14415 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14416
14417
14418
14419 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14420 The &%-oX%& command line option can be used to override the values of
14421 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14422 instance. Another way of doing this would be to use macros and the &%-D%&
14423 option. However, &%-oX%& can be used by any admin user, whereas modification of
14424 the runtime configuration by &%-D%& is allowed only when the caller is root or
14425 exim.
14426
14427 The value of &%-oX%& is a list of items. The default colon separator can be
14428 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14429 If there are any items that do not
14430 contain dots or colons (that is, are not IP addresses), the value of
14431 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14432 items that do contain dots or colons, the value of &%local_interfaces%& is
14433 replaced by those items. Thus, for example,
14434 .code
14435 -oX 1225
14436 .endd
14437 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14438 whereas
14439 .code
14440 -oX 192.168.34.5.1125
14441 .endd
14442 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14443 (However, since &%local_interfaces%& now contains no items without ports, the
14444 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14445
14446
14447
14448 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14449 .cindex "submissions protocol"
14450 .cindex "ssmtp protocol"
14451 .cindex "smtps protocol"
14452 .cindex "SMTP" "ssmtp protocol"
14453 .cindex "SMTP" "smtps protocol"
14454 Exim supports the use of TLS-on-connect, used by mail clients in the
14455 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14456 For some years, IETF Standards Track documents only blessed the
14457 STARTTLS-based Submission service (port 587) while common practice was to support
14458 the same feature set on port 465, but using TLS-on-connect.
14459 If your installation needs to provide service to mail clients
14460 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14461 the 465 TCP ports.
14462
14463 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14464 service names, connections to those ports must first establish TLS, before
14465 proceeding to the application layer use of the SMTP protocol.
14466
14467 The common use of this option is expected to be
14468 .code
14469 tls_on_connect_ports = 465
14470 .endd
14471 per RFC 8314.
14472 There is also a command line option &%-tls-on-connect%&, which forces all ports
14473 to behave in this way when a daemon is started.
14474
14475 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14476 daemon to listen on those ports. You must still specify them in
14477 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14478 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14479 connections via the daemon.)
14480
14481
14482
14483
14484 .section "IPv6 address scopes" "SECID92"
14485 .cindex "IPv6" "address scopes"
14486 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14487 can, in principle, have the same link-local IPv6 address on different
14488 interfaces. Thus, additional information is needed, over and above the IP
14489 address, to distinguish individual interfaces. A convention of using a
14490 percent sign followed by something (often the interface name) has been
14491 adopted in some cases, leading to addresses like this:
14492 .code
14493 fe80::202:b3ff:fe03:45c1%eth0
14494 .endd
14495 To accommodate this usage, a percent sign followed by an arbitrary string is
14496 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14497 to convert a textual IPv6 address for actual use. This function recognizes the
14498 percent convention in operating systems that support it, and it processes the
14499 address appropriately. Unfortunately, some older libraries have problems with
14500 &[getaddrinfo()]&. If
14501 .code
14502 IPV6_USE_INET_PTON=yes
14503 .endd
14504 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14505 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14506 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14507 function.) Of course, this means that the additional functionality of
14508 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14509
14510 .section "Disabling IPv6" "SECID93"
14511 .cindex "IPv6" "disabling"
14512 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14513 run on a host whose kernel does not support IPv6. The binary will fall back to
14514 using IPv4, but it may waste resources looking up AAAA records, and trying to
14515 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14516 .oindex "&%disable_ipv6%&"
14517 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14518 activities take place. AAAA records are never looked up, and any IPv6 addresses
14519 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14520 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14521 to handle IPv6 literal addresses.
14522
14523 On the other hand, when IPv6 is in use, there may be times when you want to
14524 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14525 option to globally suppress the lookup of AAAA records for specified domains,
14526 and you can use the &%ignore_target_hosts%& generic router option to ignore
14527 IPv6 addresses in an individual router.
14528
14529
14530
14531 .section "Examples of starting a listening daemon" "SECID94"
14532 The default case in an IPv6 environment is
14533 .code
14534 daemon_smtp_ports = smtp
14535 local_interfaces = <; ::0 ; 0.0.0.0
14536 .endd
14537 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14538 Either one or two sockets may be used, depending on the characteristics of
14539 the TCP/IP stack. (This is complicated and messy; for more information,
14540 read the comments in the &_daemon.c_& source file.)
14541
14542 To specify listening on ports 25 and 26 on all interfaces:
14543 .code
14544 daemon_smtp_ports = 25 : 26
14545 .endd
14546 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14547 .code
14548 local_interfaces = <; ::0.25     ; ::0.26 \
14549                       0.0.0.0.25 ; 0.0.0.0.26
14550 .endd
14551 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14552 IPv4 loopback address only:
14553 .code
14554 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14555 .endd
14556 To specify listening on the default port on specific interfaces only:
14557 .code
14558 local_interfaces = 10.0.0.67 : 192.168.34.67
14559 .endd
14560 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14561
14562
14563
14564 .section "Recognizing the local host" "SECTreclocipadd"
14565 The &%local_interfaces%& option is also used when Exim needs to determine
14566 whether or not an IP address refers to the local host. That is, the IP
14567 addresses of all the interfaces on which a daemon is listening are always
14568 treated as local.
14569
14570 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14571 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14572 available interfaces from the operating system, and extracts the relevant
14573 (that is, IPv4 or IPv6) addresses to use for checking.
14574
14575 Some systems set up large numbers of virtual interfaces in order to provide
14576 many virtual web servers. In this situation, you may want to listen for
14577 email on only a few of the available interfaces, but nevertheless treat all
14578 interfaces as local when routing. You can do this by setting
14579 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14580 &"all"& wildcard values. These addresses are recognized as local, but are not
14581 used for listening. Consider this example:
14582 .code
14583 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14584                       192.168.53.235 ; \
14585                       3ffe:2101:12:1:a00:20ff:fe86:a061
14586
14587 extra_local_interfaces = <; ::0 ; 0.0.0.0
14588 .endd
14589 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14590 address, but all available interface addresses are treated as local when
14591 Exim is routing.
14592
14593 In some environments the local host name may be in an MX list, but with an IP
14594 address that is not assigned to any local interface. In other cases it may be
14595 desirable to treat other host names as if they referred to the local host. Both
14596 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14597 This contains host names rather than IP addresses. When a host is referenced
14598 during routing, either via an MX record or directly, it is treated as the local
14599 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14600 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14601
14602
14603
14604 .section "Delivering to a remote host" "SECID95"
14605 Delivery to a remote host is handled by the smtp transport. By default, it
14606 allows the system's TCP/IP functions to choose which interface to use (if
14607 there is more than one) when connecting to a remote host. However, the
14608 &%interface%& option can be set to specify which interface is used. See the
14609 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14610 details.
14611
14612
14613
14614
14615 . ////////////////////////////////////////////////////////////////////////////
14616 . ////////////////////////////////////////////////////////////////////////////
14617
14618 .chapter "Main configuration" "CHAPmainconfig"
14619 .scindex IIDconfima "configuration file" "main section"
14620 .scindex IIDmaiconf "main configuration"
14621 The first part of the runtime configuration file contains three types of item:
14622
14623 .ilist
14624 Macro definitions: These lines start with an upper case letter. See section
14625 &<<SECTmacrodefs>>& for details of macro processing.
14626 .next
14627 Named list definitions: These lines start with one of the words &"domainlist"&,
14628 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14629 section &<<SECTnamedlists>>&.
14630 .next
14631 Main configuration settings: Each setting occupies one line of the file
14632 (with possible continuations). If any setting is preceded by the word
14633 &"hide"&, the &%-bP%& command line option displays its value to admin users
14634 only. See section &<<SECTcos>>& for a description of the syntax of these option
14635 settings.
14636 .endlist
14637
14638 This chapter specifies all the main configuration options, along with their
14639 types and default values. For ease of finding a particular option, they appear
14640 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14641 are now so many options, they are first listed briefly in functional groups, as
14642 an aid to finding the name of the option you are looking for. Some options are
14643 listed in more than one group.
14644
14645 .section "Miscellaneous" "SECID96"
14646 .table2
14647 .row &%add_environment%&             "environment variables"
14648 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14649 .row &%debug_store%&                 "do extra internal checks"
14650 .row &%disable_ipv6%&                "do no IPv6 processing"
14651 .row &%keep_environment%&            "environment variables"
14652 .row &%keep_malformed%&              "for broken files &-- should not happen"
14653 .row &%localhost_number%&            "for unique message ids in clusters"
14654 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14655 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14656 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14657 .row &%print_topbitchars%&           "top-bit characters are printing"
14658 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14659 .row &%timezone%&                    "force time zone"
14660 .endtable
14661
14662
14663 .section "Exim parameters" "SECID97"
14664 .table2
14665 .row &%exim_group%&                  "override compiled-in value"
14666 .row &%exim_path%&                   "override compiled-in value"
14667 .row &%exim_user%&                   "override compiled-in value"
14668 .row &%primary_hostname%&            "default from &[uname()]&"
14669 .row &%split_spool_directory%&       "use multiple directories"
14670 .row &%spool_directory%&             "override compiled-in value"
14671 .endtable
14672
14673
14674
14675 .section "Privilege controls" "SECID98"
14676 .table2
14677 .row &%admin_groups%&                "groups that are Exim admin users"
14678 .row &%commandline_checks_require_admin%& "require admin for various checks"
14679 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14680 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14681 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14682 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14683 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14684 .row &%never_users%&                 "do not run deliveries as these"
14685 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14686 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14687 .row &%trusted_groups%&              "groups that are trusted"
14688 .row &%trusted_users%&               "users that are trusted"
14689 .endtable
14690
14691
14692
14693 .section "Logging" "SECID99"
14694 .table2
14695 .row &%event_action%&                "custom logging"
14696 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14697 .row &%log_file_path%&               "override compiled-in value"
14698 .row &%log_selector%&                "set/unset optional logging"
14699 .row &%log_timezone%&                "add timezone to log lines"
14700 .row &%message_logs%&                "create per-message logs"
14701 .row &%preserve_message_logs%&       "after message completion"
14702 .row &%panic_coredump%&              "request coredump on fatal errors"
14703 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14704 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14705 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14706 .row &%syslog_facility%&             "set syslog &""facility""& field"
14707 .row &%syslog_pid%&                  "pid in syslog lines"
14708 .row &%syslog_processname%&          "set syslog &""ident""& field"
14709 .row &%syslog_timestamp%&            "timestamp syslog lines"
14710 .row &%write_rejectlog%&             "control use of message log"
14711 .endtable
14712
14713
14714
14715 .section "Frozen messages" "SECID100"
14716 .table2
14717 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14718 .row &%freeze_tell%&                 "send message when freezing"
14719 .row &%move_frozen_messages%&        "to another directory"
14720 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14721 .endtable
14722
14723
14724
14725 .section "Data lookups" "SECID101"
14726 .table2
14727 .row &%ibase_servers%&               "InterBase servers"
14728 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14729 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14730 .row &%ldap_cert_file%&              "client cert file for LDAP"
14731 .row &%ldap_cert_key%&               "client key file for LDAP"
14732 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14733 .row &%ldap_default_servers%&        "used if no server in query"
14734 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14735 .row &%ldap_start_tls%&              "require TLS within LDAP"
14736 .row &%ldap_version%&                "set protocol version"
14737 .row &%lookup_open_max%&             "lookup files held open"
14738 .row &%mysql_servers%&               "default MySQL servers"
14739 .row &%oracle_servers%&              "Oracle servers"
14740 .row &%pgsql_servers%&               "default PostgreSQL servers"
14741 .row &%sqlite_lock_timeout%&         "as it says"
14742 .endtable
14743
14744
14745
14746 .section "Message ids" "SECID102"
14747 .table2
14748 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14749 .row &%message_id_header_text%&      "ditto"
14750 .endtable
14751
14752
14753
14754 .section "Embedded Perl Startup" "SECID103"
14755 .table2
14756 .row &%perl_at_start%&               "always start the interpreter"
14757 .row &%perl_startup%&                "code to obey when starting Perl"
14758 .row &%perl_taintmode%&              "enable taint mode in Perl"
14759 .endtable
14760
14761
14762
14763 .section "Daemon" "SECID104"
14764 .table2
14765 .row &%daemon_smtp_ports%&           "default ports"
14766 .row &%daemon_startup_retries%&      "number of times to retry"
14767 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14768 .row &%extra_local_interfaces%&      "not necessarily listened on"
14769 .row &%local_interfaces%&            "on which to listen, with optional ports"
14770 .row &%notifier_socket%&             "override compiled-in value"
14771 .row &%pid_file_path%&               "override compiled-in value"
14772 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14773 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14774 .endtable
14775
14776
14777
14778 .section "Resource control" "SECID105"
14779 .table2
14780 .row &%check_log_inodes%&            "before accepting a message"
14781 .row &%check_log_space%&             "before accepting a message"
14782 .row &%check_spool_inodes%&          "before accepting a message"
14783 .row &%check_spool_space%&           "before accepting a message"
14784 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14785 .row &%queue_only_load%&             "queue incoming if load high"
14786 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14787 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14788 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14789 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14790 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14791 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14792 .row &%smtp_accept_max_per_connection%& "messages per connection"
14793 .row &%smtp_accept_max_per_host%&    "connections from one host"
14794 .row &%smtp_accept_queue%&           "queue mail if more connections"
14795 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14796                                            connection"
14797 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14798 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14799 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14800 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14801 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14802 .endtable
14803
14804
14805
14806 .section "Policy controls" "SECID106"
14807 .table2
14808 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14809 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14810 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14811 .row &%acl_smtp_auth%&               "ACL for AUTH"
14812 .row &%acl_smtp_connect%&            "ACL for connection"
14813 .row &%acl_smtp_data%&               "ACL for DATA"
14814 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14815 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14816 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14817 .row &%acl_smtp_expn%&               "ACL for EXPN"
14818 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14819 .row &%acl_smtp_mail%&               "ACL for MAIL"
14820 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14821 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14822 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14823 .row &%acl_smtp_predata%&            "ACL for start of data"
14824 .row &%acl_smtp_quit%&               "ACL for QUIT"
14825 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14826 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14827 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14828 .row &%av_scanner%&                  "specify virus scanner"
14829 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14830                                       words""&"
14831 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14832 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14833 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14834 .row &%header_maxsize%&              "total size of message header"
14835 .row &%header_line_maxsize%&         "individual header line limit"
14836 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14837 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14838 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14839 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14840 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14841 .row &%host_lookup%&                 "host name looked up for these hosts"
14842 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14843 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14844 .row &%host_reject_connection%&      "reject connection from these hosts"
14845 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14846 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14847 .row &%message_size_limit%&          "for all messages"
14848 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14849 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14850 .row &%spamd_address%&               "set interface to SpamAssassin"
14851 .row &%strict_acl_vars%&             "object to unset ACL variables"
14852 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14853 .endtable
14854
14855
14856
14857 .section "Callout cache" "SECID107"
14858 .table2
14859 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14860                                          item"
14861 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14862                                          item"
14863 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14864 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14865 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14866 .endtable
14867
14868
14869
14870 .section "TLS" "SECID108"
14871 .table2
14872 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14873 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14874 .row &%hosts_require_alpn%&          "mandatory ALPN"
14875 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14876 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14877 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14878 .row &%tls_alpn%&                    "acceptable protocol names"
14879 .row &%tls_certificate%&             "location of server certificate"
14880 .row &%tls_crl%&                     "certificate revocation list"
14881 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14882 .row &%tls_dhparam%&                 "DH parameters for server"
14883 .row &%tls_eccurve%&                 "EC curve selection for server"
14884 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14885 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14886 .row &%tls_privatekey%&              "location of server private key"
14887 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14888 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14889 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14890 .row &%tls_verify_certificates%&     "expected client certificates"
14891 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14892 .endtable
14893
14894
14895
14896 .section "Local user handling" "SECID109"
14897 .table2
14898 .row &%finduser_retries%&            "useful in NIS environments"
14899 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14900 .row &%gecos_pattern%&               "ditto"
14901 .row &%max_username_length%&         "for systems that truncate"
14902 .row &%unknown_login%&               "used when no login name found"
14903 .row &%unknown_username%&            "ditto"
14904 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14905 .row &%uucp_from_sender%&            "ditto"
14906 .endtable
14907
14908
14909
14910 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14911 .table2
14912 .row &%header_maxsize%&              "total size of message header"
14913 .row &%header_line_maxsize%&         "individual header line limit"
14914 .row &%message_size_limit%&          "applies to all messages"
14915 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14916 .row &%received_header_text%&        "expanded to make &'Received:'&"
14917 .row &%received_headers_max%&        "for mail loop detection"
14918 .row &%recipients_max%&              "limit per message"
14919 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14920 .endtable
14921
14922
14923
14924
14925 .section "Non-SMTP incoming messages" "SECID111"
14926 .table2
14927 .row &%receive_timeout%&             "for non-SMTP messages"
14928 .endtable
14929
14930
14931
14932
14933
14934 .section "Incoming SMTP messages" "SECID112"
14935 See also the &'Policy controls'& section above.
14936
14937 .table2
14938 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14939 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14940 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14941 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14942 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14943 .row &%dmarc_history_file%&          "DMARC results log"
14944 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14945 .row &%host_lookup%&                 "host name looked up for these hosts"
14946 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14947 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14948 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14949 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14950 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14951 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14952 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14953 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14954 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14955 .row &%smtp_accept_max_per_connection%& "messages per connection"
14956 .row &%smtp_accept_max_per_host%&    "connections from one host"
14957 .row &%smtp_accept_queue%&           "queue mail if more connections"
14958 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14959                                            connection"
14960 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14961 .row &%smtp_active_hostname%&        "host name to use in messages"
14962 .row &%smtp_banner%&                 "text for welcome banner"
14963 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14964 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14965 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14966 .row &%smtp_etrn_command%&           "what to run for ETRN"
14967 .row &%smtp_etrn_serialize%&         "only one at once"
14968 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14969 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14970 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14971 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14972 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14973 .row &%smtp_receive_timeout%&        "per command or data line"
14974 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14975 .row &%smtp_return_error_details%&   "give detail on rejections"
14976 .endtable
14977
14978
14979
14980 .section "SMTP extensions" "SECID113"
14981 .table2
14982 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14983 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14984 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14985 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14986 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14987 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14988 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14989 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14990 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14991 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14992 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14993 .endtable
14994
14995
14996
14997 .section "Processing messages" "SECID114"
14998 .table2
14999 .row &%allow_domain_literals%&       "recognize domain literal syntax"
15000 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
15001 .row &%allow_utf8_domains%&          "in addresses"
15002 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
15003                                       words""&"
15004 .row &%delivery_date_remove%&        "from incoming messages"
15005 .row &%envelope_to_remove%&          "from incoming messages"
15006 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
15007 .row &%headers_charset%&             "default for translations"
15008 .row &%qualify_domain%&              "default for senders"
15009 .row &%qualify_recipient%&           "default for recipients"
15010 .row &%return_path_remove%&          "from incoming messages"
15011 .row &%strip_excess_angle_brackets%& "in addresses"
15012 .row &%strip_trailing_dot%&          "at end of addresses"
15013 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
15014 .endtable
15015
15016
15017
15018 .section "System filter" "SECID115"
15019 .table2
15020 .row &%system_filter%&               "locate system filter"
15021 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
15022                                             directory"
15023 .row &%system_filter_file_transport%& "transport for delivery to a file"
15024 .row &%system_filter_group%&         "group for filter running"
15025 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
15026 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
15027 .row &%system_filter_user%&          "user for filter running"
15028 .endtable
15029
15030
15031
15032 .section "Routing and delivery" "SECID116"
15033 .table2
15034 .row &%disable_ipv6%&                "do no IPv6 processing"
15035 .row &%dns_again_means_nonexist%&    "for broken domains"
15036 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15037 .row &%dns_dnssec_ok%&               "parameter for resolver"
15038 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15039 .row &%dns_retrans%&                 "parameter for resolver"
15040 .row &%dns_retry%&                   "parameter for resolver"
15041 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15042 .row &%dns_use_edns0%&               "parameter for resolver"
15043 .row &%hold_domains%&                "hold delivery for these domains"
15044 .row &%local_interfaces%&            "for routing checks"
15045 .row &%queue_domains%&               "no immediate delivery for these"
15046 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15047 .row &%queue_only%&                  "no immediate delivery at all"
15048 .row &%queue_only_file%&             "no immediate delivery if file exists"
15049 .row &%queue_only_load%&             "no immediate delivery if load is high"
15050 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15051 .row &%queue_only_override%&         "allow command line to override"
15052 .row &%queue_run_in_order%&          "order of arrival"
15053 .row &%queue_run_max%&               "of simultaneous queue runners"
15054 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15055 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15056 .row &%remote_sort_domains%&         "order of remote deliveries"
15057 .row &%retry_data_expire%&           "timeout for retry data"
15058 .row &%retry_interval_max%&          "safety net for retry rules"
15059 .endtable
15060
15061
15062
15063 .section "Bounce and warning messages" "SECID117"
15064 .table2
15065 .row &%bounce_message_file%&         "content of bounce"
15066 .row &%bounce_message_text%&         "content of bounce"
15067 .row &%bounce_return_body%&          "include body if returning message"
15068 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15069 .row &%bounce_return_message%&       "include original message in bounce"
15070 .row &%bounce_return_size_limit%&    "limit on returned message"
15071 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15072 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15073 .row &%errors_copy%&                 "copy bounce messages"
15074 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15075 .row &%delay_warning%&               "time schedule"
15076 .row &%delay_warning_condition%&     "condition for warning messages"
15077 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15078 .row &%smtp_return_error_details%&   "give detail on rejections"
15079 .row &%warn_message_file%&           "content of warning message"
15080 .endtable
15081
15082
15083
15084 .section "Alphabetical list of main options" "SECTalomo"
15085 Those options that undergo string expansion before use are marked with
15086 &dagger;.
15087
15088 .option accept_8bitmime main boolean true
15089 .cindex "8BITMIME"
15090 .cindex "8-bit characters"
15091 .cindex "log" "selectors"
15092 .cindex "log" "8BITMIME"
15093 .cindex "ESMTP extensions" 8BITMIME
15094 This option causes Exim to send 8BITMIME in its response to an SMTP
15095 EHLO command, and to accept the BODY= parameter on MAIL commands.
15096 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15097 takes no steps to do anything special with messages received by this route.
15098
15099 Historically Exim kept this option off by default, but the maintainers
15100 feel that in today's Internet, this causes more problems than it solves.
15101 It now defaults to true.
15102 A more detailed analysis of the issues is provided by Dan Bernstein:
15103 .display
15104 &url(https://cr.yp.to/smtp/8bitmime.html)
15105 .endd
15106
15107 To log received 8BITMIME status use
15108 .code
15109 log_selector = +8bitmime
15110 .endd
15111
15112 .option acl_not_smtp main string&!! unset
15113 .cindex "&ACL;" "for non-SMTP messages"
15114 .cindex "non-SMTP messages" "ACLs for"
15115 This option defines the ACL that is run when a non-SMTP message has been
15116 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15117 further details.
15118
15119 .option acl_not_smtp_mime main string&!! unset
15120 This option defines the ACL that is run for individual MIME parts of non-SMTP
15121 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15122 SMTP messages.
15123
15124 .option acl_not_smtp_start main string&!! unset
15125 .cindex "&ACL;" "at start of non-SMTP message"
15126 .cindex "non-SMTP messages" "ACLs for"
15127 This option defines the ACL that is run before Exim starts reading a
15128 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15129
15130 .option acl_smtp_auth main string&!! unset
15131 .cindex "&ACL;" "setting up for SMTP commands"
15132 .cindex "AUTH" "ACL for"
15133 This option defines the ACL that is run when an SMTP AUTH command is
15134 received. See chapter &<<CHAPACL>>& for further details.
15135
15136 .option acl_smtp_connect main string&!! unset
15137 .cindex "&ACL;" "on SMTP connection"
15138 This option defines the ACL that is run when an SMTP connection is received.
15139 See chapter &<<CHAPACL>>& for further details.
15140
15141 .option acl_smtp_data main string&!! unset
15142 .cindex "DATA" "ACL for"
15143 This option defines the ACL that is run after an SMTP DATA command has been
15144 processed and the message itself has been received, but before the final
15145 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15146
15147 .option acl_smtp_data_prdr main string&!! accept
15148 .cindex "PRDR" "ACL for"
15149 .cindex "DATA" "PRDR ACL for"
15150 .cindex "&ACL;" "PRDR-related"
15151 .cindex "&ACL;" "per-user data processing"
15152 This option defines the ACL that,
15153 if the PRDR feature has been negotiated,
15154 is run for each recipient after an SMTP DATA command has been
15155 processed and the message itself has been received, but before the
15156 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15157
15158 .option acl_smtp_dkim main string&!! unset
15159 .cindex DKIM "ACL for"
15160 This option defines the ACL that is run for each DKIM signature
15161 (by default, or as specified in the dkim_verify_signers option)
15162 of a received message.
15163 See section &<<SECDKIMVFY>>& for further details.
15164
15165 .option acl_smtp_etrn main string&!! unset
15166 .cindex "ETRN" "ACL for"
15167 This option defines the ACL that is run when an SMTP ETRN command is
15168 received. See chapter &<<CHAPACL>>& for further details.
15169
15170 .option acl_smtp_expn main string&!! unset
15171 .cindex "EXPN" "ACL for"
15172 This option defines the ACL that is run when an SMTP EXPN command is
15173 received. See chapter &<<CHAPACL>>& for further details.
15174
15175 .option acl_smtp_helo main string&!! unset
15176 .cindex "EHLO" "ACL for"
15177 .cindex "HELO" "ACL for"
15178 This option defines the ACL that is run when an SMTP EHLO or HELO
15179 command is received. See chapter &<<CHAPACL>>& for further details.
15180
15181
15182 .option acl_smtp_mail main string&!! unset
15183 .cindex "MAIL" "ACL for"
15184 This option defines the ACL that is run when an SMTP MAIL command is
15185 received. See chapter &<<CHAPACL>>& for further details.
15186
15187 .option acl_smtp_mailauth main string&!! unset
15188 .cindex "AUTH" "on MAIL command"
15189 This option defines the ACL that is run when there is an AUTH parameter on
15190 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15191 &<<CHAPSMTPAUTH>>& for details of authentication.
15192
15193 .option acl_smtp_mime main string&!! unset
15194 .cindex "MIME content scanning" "ACL for"
15195 This option is available when Exim is built with the content-scanning
15196 extension. It defines the ACL that is run for each MIME part in a message. See
15197 section &<<SECTscanmimepart>>& for details.
15198
15199 .option acl_smtp_notquit main string&!! unset
15200 .cindex "not-QUIT, ACL for"
15201 This option defines the ACL that is run when an SMTP session
15202 ends without a QUIT command being received.
15203 See chapter &<<CHAPACL>>& for further details.
15204
15205 .option acl_smtp_predata main string&!! unset
15206 This option defines the ACL that is run when an SMTP DATA command is
15207 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15208 further details.
15209
15210 .option acl_smtp_quit main string&!! unset
15211 .cindex "QUIT, ACL for"
15212 This option defines the ACL that is run when an SMTP QUIT command is
15213 received. See chapter &<<CHAPACL>>& for further details.
15214
15215 .option acl_smtp_rcpt main string&!! unset
15216 .cindex "RCPT" "ACL for"
15217 This option defines the ACL that is run when an SMTP RCPT command is
15218 received. See chapter &<<CHAPACL>>& for further details.
15219
15220 .option acl_smtp_starttls main string&!! unset
15221 .cindex "STARTTLS, ACL for"
15222 This option defines the ACL that is run when an SMTP STARTTLS command is
15223 received. See chapter &<<CHAPACL>>& for further details.
15224
15225 .option acl_smtp_vrfy main string&!! unset
15226 .cindex "VRFY" "ACL for"
15227 This option defines the ACL that is run when an SMTP VRFY command is
15228 received. See chapter &<<CHAPACL>>& for further details.
15229
15230 .option add_environment main "string list" empty
15231 .cindex "environment" "set values"
15232 This option adds individual environment variables that the
15233 currently linked libraries and programs in child processes may use.
15234 Each list element should be of the form &"name=value"&.
15235
15236 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15237
15238 .option admin_groups main "string list&!!" unset
15239 .cindex "admin user"
15240 This option is expanded just once, at the start of Exim's processing. If the
15241 current group or any of the supplementary groups of an Exim caller is in this
15242 colon-separated list, the caller has admin privileges. If all your system
15243 programmers are in a specific group, for example, you can give them all Exim
15244 admin privileges by putting that group in &%admin_groups%&. However, this does
15245 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15246 To permit this, you have to add individuals to the Exim group.
15247
15248 .option allow_domain_literals main boolean false
15249 .cindex "domain literal"
15250 If this option is set, the RFC 2822 domain literal format is permitted in
15251 email addresses. The option is not set by default, because the domain literal
15252 format is not normally required these days, and few people know about it. It
15253 has, however, been exploited by mail abusers.
15254
15255 Unfortunately, it seems that some DNS black list maintainers are using this
15256 format to report black listing to postmasters. If you want to accept messages
15257 addressed to your hosts by IP address, you need to set
15258 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15259 domains (defined in the named domain list &%local_domains%& in the default
15260 configuration). This &"magic string"& matches the domain literal form of all
15261 the local host's IP addresses.
15262
15263 .option allow_mx_to_ip main boolean false
15264 .cindex "MX record" "pointing to IP address"
15265 It appears that more and more DNS zone administrators are breaking the rules
15266 and putting domain names that look like IP addresses on the right hand side of
15267 MX records. Exim follows the rules and rejects this, giving an error message
15268 that explains the misconfiguration. However, some other MTAs support this
15269 practice, so to avoid &"Why can't Exim do this?"& complaints,
15270 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15271 recommended, except when you have no other choice.
15272
15273 .option allow_utf8_domains main boolean false
15274 .cindex "domain" "UTF-8 characters in"
15275 .cindex "UTF-8" "in domain name"
15276 Lots of discussion is going on about internationalized domain names. One
15277 camp is strongly in favour of just using UTF-8 characters, and it seems
15278 that at least two other MTAs permit this.
15279 This option allows Exim users to experiment if they wish.
15280
15281 If it is set true, Exim's domain parsing function allows valid
15282 UTF-8 multicharacters to appear in domain name components, in addition to
15283 letters, digits, and hyphens.
15284
15285 If Exim is built with internationalization support
15286 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15287 this option can be left as default.
15288 Without that,
15289 if you want to look up such domain names in the DNS, you must also
15290 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15291 suitable setting is:
15292 .code
15293 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15294   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15295 .endd
15296 Alternatively, you can just disable this feature by setting
15297 .code
15298 dns_check_names_pattern =
15299 .endd
15300 That is, set the option to an empty string so that no check is done.
15301
15302
15303 .option auth_advertise_hosts main "host list&!!" *
15304 .cindex "authentication" "advertising"
15305 .cindex "AUTH" "advertising"
15306 .cindex "ESMTP extensions" AUTH
15307 If any server authentication mechanisms are configured, Exim advertises them in
15308 response to an EHLO command only if the calling host matches this list.
15309 Otherwise, Exim does not advertise AUTH.
15310 Exim does not accept AUTH commands from clients to which it has not
15311 advertised the availability of AUTH. The advertising of individual
15312 authentication mechanisms can be controlled by the use of the
15313 &%server_advertise_condition%& generic authenticator option on the individual
15314 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15315
15316 Certain mail clients (for example, Netscape) require the user to provide a name
15317 and password for authentication if AUTH is advertised, even though it may
15318 not be needed (the host may accept messages from hosts on its local LAN without
15319 authentication, for example). The &%auth_advertise_hosts%& option can be used
15320 to make these clients more friendly by excluding them from the set of hosts to
15321 which Exim advertises AUTH.
15322
15323 .cindex "AUTH" "advertising when encrypted"
15324 If you want to advertise the availability of AUTH only when the connection
15325 is encrypted using TLS, you can make use of the fact that the value of this
15326 option is expanded, with a setting like this:
15327 .code
15328 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15329 .endd
15330 .vindex "&$tls_in_cipher$&"
15331 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15332 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15333 expansion is *, which matches all hosts.
15334
15335
15336 .option auto_thaw main time 0s
15337 .cindex "thawing messages"
15338 .cindex "unfreezing messages"
15339 If this option is set to a time greater than zero, a queue runner will try a
15340 new delivery attempt on any frozen message, other than a bounce message, if
15341 this much time has passed since it was frozen. This may result in the message
15342 being re-frozen if nothing has changed since the last attempt. It is a way of
15343 saying &"keep on trying, even though there are big problems"&.
15344
15345 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15346 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15347 thought to be very useful any more, and its use should probably be avoided.
15348
15349
15350 .option av_scanner main string "see below"
15351 This option is available if Exim is built with the content-scanning extension.
15352 It specifies which anti-virus scanner to use. The default value is:
15353 .code
15354 sophie:/var/run/sophie
15355 .endd
15356 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15357 before use. See section &<<SECTscanvirus>>& for further details.
15358
15359
15360 .option bi_command main string unset
15361 .oindex "&%-bi%&"
15362 This option supplies the name of a command that is run when Exim is called with
15363 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15364 just the command name, it is not a complete command line. If an argument is
15365 required, it must come from the &%-oA%& command line option.
15366
15367
15368 .option bounce_message_file main string&!! unset
15369 .cindex "bounce message" "customizing"
15370 .cindex "customizing" "bounce message"
15371 This option defines a template file containing paragraphs of text to be used
15372 for constructing bounce messages.  Details of the file's contents are given in
15373 chapter &<<CHAPemsgcust>>&.
15374 .cindex bounce_message_file "tainted data"
15375 The option is expanded to give the file path, which must be
15376 absolute and untainted.
15377 See also &%warn_message_file%&.
15378
15379
15380 .option bounce_message_text main string unset
15381 When this option is set, its contents are included in the default bounce
15382 message immediately after &"This message was created automatically by mail
15383 delivery software."& It is not used if &%bounce_message_file%& is set.
15384
15385 .option bounce_return_body main boolean true
15386 .cindex "bounce message" "including body"
15387 This option controls whether the body of an incoming message is included in a
15388 bounce message when &%bounce_return_message%& is true. The default setting
15389 causes the entire message, both header and body, to be returned (subject to the
15390 value of &%bounce_return_size_limit%&). If this option is false, only the
15391 message header is included. In the case of a non-SMTP message containing an
15392 error that is detected during reception, only those header lines preceding the
15393 point at which the error was detected are returned.
15394 .cindex "bounce message" "including original"
15395
15396 .option bounce_return_linesize_limit main integer 998
15397 .cindex "size" "of bounce lines, limit"
15398 .cindex "bounce message" "line length limit"
15399 .cindex "limit" "bounce message line length"
15400 This option sets a limit in bytes on the line length of messages
15401 that are returned to senders due to delivery problems,
15402 when &%bounce_return_message%& is true.
15403 The default value corresponds to RFC limits.
15404 If the message being returned has lines longer than this value it is
15405 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15406
15407 The option also applies to bounces returned when an error is detected
15408 during reception of a message.
15409 In this case lines from the original are truncated.
15410
15411 The option does not apply to messages generated by an &(autoreply)& transport.
15412
15413
15414 .option bounce_return_message main boolean true
15415 If this option is set false, none of the original message is included in
15416 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15417 &%bounce_return_body%&.
15418
15419
15420 .option bounce_return_size_limit main integer 100K
15421 .cindex "size" "of bounce, limit"
15422 .cindex "bounce message" "size limit"
15423 .cindex "limit" "bounce message size"
15424 This option sets a limit in bytes on the size of messages that are returned to
15425 senders as part of bounce messages when &%bounce_return_message%& is true. The
15426 limit should be less than the value of the global &%message_size_limit%& and of
15427 any &%message_size_limit%& settings on transports, to allow for the bounce text
15428 that Exim generates. If this option is set to zero there is no limit.
15429
15430 When the body of any message that is to be included in a bounce message is
15431 greater than the limit, it is truncated, and a comment pointing this out is
15432 added at the top. The actual cutoff may be greater than the value given, owing
15433 to the use of buffering for transferring the message in chunks (typically 8K in
15434 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15435 messages.
15436
15437 .option bounce_sender_authentication main string unset
15438 .cindex "bounce message" "sender authentication"
15439 .cindex "authentication" "bounce message"
15440 .cindex "AUTH" "on bounce message"
15441 This option provides an authenticated sender address that is sent with any
15442 bounce messages generated by Exim that are sent over an authenticated SMTP
15443 connection. A typical setting might be:
15444 .code
15445 bounce_sender_authentication = mailer-daemon@my.domain.example
15446 .endd
15447 which would cause bounce messages to be sent using the SMTP command:
15448 .code
15449 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15450 .endd
15451 The value of &%bounce_sender_authentication%& must always be a complete email
15452 address.
15453
15454 .option callout_domain_negative_expire main time 3h
15455 .cindex "caching" "callout timeouts"
15456 .cindex "callout" "caching timeouts"
15457 This option specifies the expiry time for negative callout cache data for a
15458 domain. See section &<<SECTcallver>>& for details of callout verification, and
15459 section &<<SECTcallvercache>>& for details of the caching.
15460
15461
15462 .option callout_domain_positive_expire main time 7d
15463 This option specifies the expiry time for positive callout cache data for a
15464 domain. See section &<<SECTcallver>>& for details of callout verification, and
15465 section &<<SECTcallvercache>>& for details of the caching.
15466
15467
15468 .option callout_negative_expire main time 2h
15469 This option specifies the expiry time for negative callout cache data for an
15470 address. See section &<<SECTcallver>>& for details of callout verification, and
15471 section &<<SECTcallvercache>>& for details of the caching.
15472
15473
15474 .option callout_positive_expire main time 24h
15475 This option specifies the expiry time for positive callout cache data for an
15476 address. See section &<<SECTcallver>>& for details of callout verification, and
15477 section &<<SECTcallvercache>>& for details of the caching.
15478
15479
15480 .option callout_random_local_part main string&!! "see below"
15481 This option defines the &"random"& local part that can be used as part of
15482 callout verification. The default value is
15483 .code
15484 $primary_hostname-$tod_epoch-testing
15485 .endd
15486 See section &<<CALLaddparcall>>& for details of how this value is used.
15487
15488
15489 .options check_log_inodes main integer 100 &&&
15490          check_log_space main integer 10M
15491 See &%check_spool_space%& below.
15492
15493 .oindex "&%check_rfc2047_length%&"
15494 .cindex "RFC 2047" "disabling length check"
15495 .option check_rfc2047_length main boolean true
15496 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15497 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15498 word; strings to be encoded that exceed this length are supposed to use
15499 multiple encoded words. By default, Exim does not recognize encoded words that
15500 exceed the maximum length. However, it seems that some software, in violation
15501 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15502 set false, Exim recognizes encoded words of any length.
15503
15504
15505 .options check_spool_inodes main integer 100 &&&
15506          check_spool_space main integer 10M
15507 .cindex "checking disk space"
15508 .cindex "disk space, checking"
15509 .cindex "spool directory" "checking space"
15510 The four &%check_...%& options allow for checking of disk resources before a
15511 message is accepted.
15512
15513 .vindex "&$log_inodes$&"
15514 .vindex "&$log_space$&"
15515 .vindex "&$spool_inodes$&"
15516 .vindex "&$spool_space$&"
15517 When any of these options are nonzero, they apply to all incoming messages. If you
15518 want to apply different checks to different kinds of message, you can do so by
15519 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15520 &$spool_space$& in an ACL with appropriate additional conditions.
15521
15522
15523 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15524 either value is greater than zero, for example:
15525 .code
15526 check_spool_space = 100M
15527 check_spool_inodes = 100
15528 .endd
15529 The spool partition is the one that contains the directory defined by
15530 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15531 transit.
15532
15533 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15534 files are written if either is greater than zero. These should be set only if
15535 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15536
15537 If there is less space or fewer inodes than requested, Exim refuses to accept
15538 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15539 error response to the MAIL command. If ESMTP is in use and there was a
15540 SIZE parameter on the MAIL command, its value is added to the
15541 &%check_spool_space%& value, and the check is performed even if
15542 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15543
15544 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15545 number of kilobytes (though specified in bytes).
15546 If a non-multiple of 1024 is specified, it is rounded up.
15547
15548 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15549 failure a message is written to stderr and Exim exits with a non-zero code, as
15550 it obviously cannot send an error message of any kind.
15551
15552 There is a slight performance penalty for these checks.
15553 Versions of Exim preceding 4.88 had these disabled by default;
15554 high-rate installations confident they will never run out of resources
15555 may wish to deliberately disable them.
15556
15557 .option chunking_advertise_hosts main "host list&!!" *
15558 .cindex CHUNKING advertisement
15559 .cindex "RFC 3030" "CHUNKING"
15560 .cindex "ESMTP extensions" CHUNKING
15561 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15562 these hosts.
15563 Hosts may use the BDAT command as an alternate to DATA.
15564
15565 .option commandline_checks_require_admin main boolean &`false`&
15566 .cindex "restricting access to features"
15567 This option restricts various basic checking features to require an
15568 administrative user.
15569 This affects most of the &%-b*%& options, such as &%-be%&.
15570
15571 .option debug_store main boolean &`false`&
15572 .cindex debugging "memory corruption"
15573 .cindex memory debugging
15574 This option, when true, enables extra checking in Exim's internal memory
15575 management.  For use when a memory corruption issue is being investigated,
15576 it should normally be left as default.
15577
15578 .option daemon_smtp_ports main string &`smtp`&
15579 .cindex "port" "for daemon"
15580 .cindex "TCP/IP" "setting listening ports"
15581 This option specifies one or more default SMTP ports on which the Exim daemon
15582 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15583 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15584
15585 .options daemon_startup_retries main integer 9 &&&
15586          daemon_startup_sleep main time 30s
15587 .cindex "daemon startup, retrying"
15588 These options control the retrying done by
15589 the daemon at startup when it cannot immediately bind a listening socket
15590 (typically because the socket is already in use): &%daemon_startup_retries%&
15591 defines the number of retries after the first failure, and
15592 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15593
15594 .option delay_warning main "time list" 24h
15595 .cindex "warning of delay"
15596 .cindex "delay warning, specifying"
15597 .cindex "queue" "delay warning"
15598 When a message is delayed, Exim sends a warning message to the sender at
15599 intervals specified by this option. The data is a colon-separated list of times
15600 after which to send warning messages. If the value of the option is an empty
15601 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15602 message has been in the queue for longer than the last time, the last interval
15603 between the times is used to compute subsequent warning times. For example,
15604 with
15605 .code
15606 delay_warning = 4h:8h:24h
15607 .endd
15608 the first message is sent after 4 hours, the second after 8 hours, and
15609 the third one after 24 hours. After that, messages are sent every 16 hours,
15610 because that is the interval between the last two times on the list. If you set
15611 just one time, it specifies the repeat interval. For example, with:
15612 .code
15613 delay_warning = 6h
15614 .endd
15615 messages are repeated every six hours. To stop warnings after a given time, set
15616 a very large time at the end of the list. For example:
15617 .code
15618 delay_warning = 2h:12h:99d
15619 .endd
15620 Note that the option is only evaluated at the time a delivery attempt fails,
15621 which depends on retry and queue-runner configuration.
15622 Typically retries will be configured more frequently than warning messages.
15623
15624 .option delay_warning_condition main string&!! "see below"
15625 .vindex "&$domain$&"
15626 The string is expanded at the time a warning message might be sent. If all the
15627 deferred addresses have the same domain, it is set in &$domain$& during the
15628 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15629 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15630 &"false"& (the comparison being done caselessly) then the warning message is
15631 not sent. The default is:
15632 .code
15633 delay_warning_condition = ${if or {\
15634   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15635   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15636   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15637   } {no}{yes}}
15638 .endd
15639 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15640 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15641 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15642 &"auto-replied"& in an &'Auto-Submitted:'& header.
15643
15644 .option deliver_drop_privilege main boolean false
15645 .cindex "unprivileged delivery"
15646 .cindex "delivery" "unprivileged"
15647 If this option is set true, Exim drops its root privilege at the start of a
15648 delivery process, and runs as the Exim user throughout. This severely restricts
15649 the kinds of local delivery that are possible, but is viable in certain types
15650 of configuration. There is a discussion about the use of root privilege in
15651 chapter &<<CHAPsecurity>>&.
15652
15653 .option deliver_queue_load_max main fixed-point unset
15654 .cindex "load average"
15655 .cindex "queue runner" "abandoning"
15656 When this option is set, a queue run is abandoned if the system load average
15657 becomes greater than the value of the option. The option has no effect on
15658 ancient operating systems on which Exim cannot determine the load average.
15659 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15660
15661
15662 .option delivery_date_remove main boolean true
15663 .cindex "&'Delivery-date:'& header line"
15664 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15665 message when it is delivered, in exactly the same way as &'Return-path:'& is
15666 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15667 should not be present in incoming messages, and this option causes them to be
15668 removed at the time the message is received, to avoid any problems that might
15669 occur when a delivered message is subsequently sent on to some other recipient.
15670
15671 .option disable_fsync main boolean false
15672 .cindex "&[fsync()]&, disabling"
15673 This option is available only if Exim was built with the compile-time option
15674 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15675 a runtime configuration generates an &"unknown option"& error. You should not
15676 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15677 really, really, really understand what you are doing. &'No pre-compiled
15678 distributions of Exim should ever make this option available.'&
15679
15680 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15681 updated files' data to be written to disc before continuing. Unexpected events
15682 such as crashes and power outages may cause data to be lost or scrambled.
15683 Here be Dragons. &*Beware.*&
15684
15685
15686 .option disable_ipv6 main boolean false
15687 .cindex "IPv6" "disabling"
15688 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15689 activities take place. AAAA records are never looked up, and any IPv6 addresses
15690 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15691 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15692 to handle IPv6 literal addresses.
15693
15694
15695 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15696 .cindex DKIM "selecting signature algorithms"
15697 This option gives a list of hash types which are acceptable in signatures,
15698 and an order of processing.
15699 Signatures with algorithms not in the list will be ignored.
15700
15701 Acceptable values include:
15702 .code
15703 sha1
15704 sha256
15705 sha512
15706 .endd
15707
15708 Note that the acceptance of sha1 violates RFC 8301.
15709
15710 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15711 This option gives a list of key types which are acceptable in signatures,
15712 and an order of processing.
15713 Signatures with algorithms not in the list will be ignored.
15714
15715
15716 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15717 This option gives a list of key sizes which are acceptable in signatures.
15718 The list is keyed by the algorithm type for the key; the values are in bits.
15719 Signatures with keys smaller than given by this option will fail verification.
15720
15721 The default enforces the RFC 8301 minimum key size for RSA signatures.
15722
15723 .option dkim_verify_minimal main boolean false
15724 If set to true, verification of signatures will terminate after the
15725 first success.
15726
15727 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15728 .cindex DKIM "controlling calls to the ACL"
15729 This option gives a list of DKIM domains for which the DKIM ACL is run.
15730 It is expanded after the message is received; by default it runs
15731 the ACL once for each signature in the message.
15732 See section &<<SECDKIMVFY>>&.
15733
15734
15735 .option dmarc_forensic_sender main string&!! unset
15736 .option dmarc_history_file main string unset
15737 .option dmarc_tld_file main string unset
15738 .cindex DMARC "main section options"
15739 These options control DMARC processing.
15740 See section &<<SECDMARC>>& for details.
15741
15742
15743 .option dns_again_means_nonexist main "domain list&!!" unset
15744 .cindex "DNS" "&""try again""& response; overriding"
15745 DNS lookups give a &"try again"& response for the DNS errors
15746 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15747 keep trying to deliver a message, or to give repeated temporary errors to
15748 incoming mail. Sometimes the effect is caused by a badly set up name server and
15749 may persist for a long time. If a domain which exhibits this problem matches
15750 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15751 This option should be used with care. You can make it apply to reverse lookups
15752 by a setting such as this:
15753 .code
15754 dns_again_means_nonexist = *.in-addr.arpa
15755 .endd
15756 This option applies to all DNS lookups that Exim does,
15757 .new
15758 except for TLSA lookups (where knowing about such failures
15759 is security-relevant).
15760 .wen
15761 It also applies when the
15762 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15763 since these are most likely to be caused by DNS lookup problems. The
15764 &(dnslookup)& router has some options of its own for controlling what happens
15765 when lookups for MX or SRV records give temporary errors. These more specific
15766 options are applied after this global option.
15767
15768 .option dns_check_names_pattern main string "see below"
15769 .cindex "DNS" "pre-check of name syntax"
15770 When this option is set to a non-empty string, it causes Exim to check domain
15771 names for characters that are not allowed in host names before handing them to
15772 the DNS resolver, because some resolvers give temporary errors for names that
15773 contain unusual characters. If a domain name contains any unwanted characters,
15774 a &"not found"& result is forced, and the resolver is not called. The check is
15775 done by matching the domain name against a regular expression, which is the
15776 value of this option. The default pattern is
15777 .code
15778 dns_check_names_pattern = \
15779   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15780 .endd
15781 which permits only letters, digits, slashes, and hyphens in components, but
15782 they must start and end with a letter or digit. Slashes are not, in fact,
15783 permitted in host names, but they are found in certain NS records (which can be
15784 accessed in Exim by using a &%dnsdb%& lookup). If you set
15785 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15786 empty string.
15787
15788 .option dns_csa_search_limit main integer 5
15789 This option controls the depth of parental searching for CSA SRV records in the
15790 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15791
15792 .option dns_csa_use_reverse main boolean true
15793 This option controls whether or not an IP address, given as a CSA domain, is
15794 reversed and looked up in the reverse DNS, as described in more detail in
15795 section &<<SECTverifyCSA>>&.
15796
15797 .option dns_cname_loops main integer 1
15798 .cindex DNS "CNAME following"
15799 This option controls the following of CNAME chains, needed if the resolver does
15800 not do it internally.
15801 As of 2018 most should, and the default can be left.
15802 If you have an ancient one, a value of 10 is likely needed.
15803
15804 The default value of one CNAME-follow is needed
15805 thanks to the observed return for an MX request,
15806 given no MX presence but a CNAME to an A, of the CNAME.
15807
15808
15809 .option dns_dnssec_ok main integer -1
15810 .cindex "DNS" "resolver options"
15811 .cindex "DNS" "DNSSEC"
15812 If this option is set to a non-negative number then Exim will initialise the
15813 DNS resolver library to either use or not use DNSSEC, overriding the system
15814 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15815
15816 If the resolver library does not support DNSSEC then this option has no effect.
15817
15818 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15819 will default to stripping out a successful validation status.
15820 This will break a previously working Exim installation.
15821 Provided that you do trust the resolver (ie, is on localhost) you can tell
15822 glibc to pass through any successful validation with a new option in
15823 &_/etc/resolv.conf_&:
15824 .code
15825 options trust-ad
15826 .endd
15827
15828
15829 .option dns_ipv4_lookup main "domain list&!!" unset
15830 .cindex "IPv6" "DNS lookup for AAAA records"
15831 .cindex "DNS" "IPv6 lookup for AAAA records"
15832 .cindex DNS "IPv6 disabling"
15833 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15834 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15835 (A records) when trying to find IP addresses for hosts, unless the host's
15836 domain matches this list.
15837
15838 This is a fudge to help with name servers that give big delays or otherwise do
15839 not work for the AAAA record type. In due course, when the world's name
15840 servers have all been upgraded, there should be no need for this option.
15841 Note that all lookups, including those done for verification, are affected;
15842 this will result in verify failure for IPv6 connections or ones using names
15843 only valid for IPv6 addresses.
15844
15845
15846 .option dns_retrans main time 0s
15847 .cindex "DNS" "resolver options"
15848 .cindex timeout "dns lookup"
15849 .cindex "DNS" timeout
15850 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15851 retransmission and retry parameters for DNS lookups. Values of zero (the
15852 defaults) leave the system default settings unchanged. The first value is the
15853 time between retries, and the second is the number of retries. It isn't
15854 totally clear exactly how these settings affect the total time a DNS lookup may
15855 take. I haven't found any documentation about timeouts on DNS lookups; these
15856 parameter values are available in the external resolver interface structure,
15857 but nowhere does it seem to describe how they are used or what you might want
15858 to set in them.
15859 See also the &%slow_lookup_log%& option.
15860
15861
15862 .option dns_retry main integer 0
15863 See &%dns_retrans%& above.
15864
15865
15866 .option dns_trust_aa main "domain list&!!" unset
15867 .cindex "DNS" "resolver options"
15868 .cindex "DNS" "DNSSEC"
15869 If this option is set then lookup results marked with the AA bit
15870 (Authoritative Answer) are trusted the same way as if they were
15871 DNSSEC-verified. The authority section's name of the answer must
15872 match with this expanded domain list.
15873
15874 Use this option only if you talk directly to a resolver that is
15875 authoritative for some zones and does not set the AD (Authentic Data)
15876 bit in the answer. Some DNS servers may have an configuration option to
15877 mark the answers from their own zones as verified (they set the AD bit).
15878 Others do not have this option. It is considered as poor practice using
15879 a resolver that is an authoritative server for some zones.
15880
15881 Use this option only if you really have to (e.g. if you want
15882 to use DANE for remote delivery to a server that is listed in the DNS
15883 zones that your resolver is authoritative for).
15884
15885 If the DNS answer packet has the AA bit set and contains resource record
15886 in the answer section, the name of the first NS record appearing in the
15887 authority section is compared against the list. If the answer packet is
15888 authoritative but the answer section is empty, the name of the first SOA
15889 record in the authoritative section is used instead.
15890
15891 .cindex "DNS" "resolver options"
15892 .option dns_use_edns0 main integer -1
15893 .cindex "DNS" "resolver options"
15894 .cindex "DNS" "EDNS0"
15895 .cindex "DNS" "OpenBSD
15896 If this option is set to a non-negative number then Exim will initialise the
15897 DNS resolver library to either use or not use EDNS0 extensions, overriding
15898 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15899 on.
15900
15901 If the resolver library does not support EDNS0 then this option has no effect.
15902
15903 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15904 means that DNSSEC will not work with Exim on that platform either, unless Exim
15905 is linked against an alternative DNS client library.
15906
15907
15908 .option drop_cr main boolean false
15909 This is an obsolete option that is now a no-op. It used to affect the way Exim
15910 handled CR and LF characters in incoming messages. What happens now is
15911 described in section &<<SECTlineendings>>&.
15912
15913 .option dsn_advertise_hosts main "host list&!!" unset
15914 .cindex "bounce messages" "success"
15915 .cindex "DSN" "success"
15916 .cindex "Delivery Status Notification" "success"
15917 .cindex "ESMTP extensions" DSN
15918 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15919 and accepted from, these hosts.
15920 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15921 and RET and ENVID options on MAIL FROM commands.
15922 A NOTIFY=SUCCESS option requests success-DSN messages.
15923 A NOTIFY= option with no argument requests that no delay or failure DSNs
15924 are sent.
15925 &*Note*&: Supplying success-DSN messages has been criticised
15926 on privacy grounds; it can leak details of internal forwarding.
15927
15928 .option dsn_from main "string&!!" "see below"
15929 .cindex "&'From:'& header line" "in bounces"
15930 .cindex "bounce messages" "&'From:'& line, specifying"
15931 This option can be used to vary the contents of &'From:'& header lines in
15932 bounces and other automatically generated messages (&"Delivery Status
15933 Notifications"& &-- hence the name of the option). The default setting is:
15934 .code
15935 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15936 .endd
15937 The value is expanded every time it is needed. If the expansion fails, a
15938 panic is logged, and the default value is used.
15939
15940 .option envelope_to_remove main boolean true
15941 .cindex "&'Envelope-to:'& header line"
15942 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15943 message when it is delivered, in exactly the same way as &'Return-path:'& is
15944 handled. &'Envelope-to:'& records the original recipient address from the
15945 message's envelope that caused the delivery to happen. Such headers should not
15946 be present in incoming messages, and this option causes them to be removed at
15947 the time the message is received, to avoid any problems that might occur when a
15948 delivered message is subsequently sent on to some other recipient.
15949
15950
15951 .option errors_copy main "string list&!!" unset
15952 .cindex "bounce message" "copy to other address"
15953 .cindex "copy of bounce message"
15954 Setting this option causes Exim to send bcc copies of bounce messages that it
15955 generates to other addresses. &*Note*&: This does not apply to bounce messages
15956 coming from elsewhere. The value of the option is a colon-separated list of
15957 items. Each item consists of a pattern, terminated by white space, followed by
15958 a comma-separated list of email addresses. If a pattern contains spaces, it
15959 must be enclosed in double quotes.
15960
15961 Each pattern is processed in the same way as a single item in an address list
15962 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15963 the bounce message, the message is copied to the addresses on the list. The
15964 items are scanned in order, and once a matching one is found, no further items
15965 are examined. For example:
15966 .code
15967 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15968               rqps@mydomain   hostmaster@mydomain.example,\
15969                               postmaster@mydomain.example
15970 .endd
15971 .vindex "&$domain$&"
15972 .vindex "&$local_part$&"
15973 The address list is expanded before use. The expansion variables &$local_part$&
15974 and &$domain$& are set from the original recipient of the error message, and if
15975 there was any wildcard matching in the pattern, the expansion
15976 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15977 variables &$0$&, &$1$&, etc. are set in the normal way.
15978
15979
15980 .option errors_reply_to main string unset
15981 .cindex "bounce message" "&'Reply-to:'& in"
15982 By default, Exim's bounce and delivery warning messages contain the header line
15983 .display
15984 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15985 .endd
15986 .oindex &%quota_warn_message%&
15987 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15988 A warning message that is generated by the &%quota_warn_message%& option in an
15989 &(appendfile)& transport may contain its own &'From:'& header line that
15990 overrides the default.
15991
15992 Experience shows that people reply to bounce messages. If the
15993 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15994 and warning messages. For example:
15995 .code
15996 errors_reply_to = postmaster@my.domain.example
15997 .endd
15998 The value of the option is not expanded. It must specify a valid RFC 2822
15999 address. However, if a warning message that is generated by the
16000 &%quota_warn_message%& option in an &(appendfile)& transport contain its
16001 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
16002 not used.
16003
16004
16005 .option event_action main string&!! unset
16006 .cindex events
16007 This option declares a string to be expanded for Exim's events mechanism.
16008 For details see chapter &<<CHAPevents>>&.
16009
16010
16011 .option exim_group main string "compile-time configured"
16012 .cindex "gid (group id)" "Exim's own"
16013 .cindex "Exim group"
16014 This option changes the gid under which Exim runs when it gives up root
16015 privilege. The default value is compiled into the binary. The value of this
16016 option is used only when &%exim_user%& is also set. Unless it consists entirely
16017 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
16018 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
16019 security issues.
16020
16021
16022 .option exim_path main string "see below"
16023 .cindex "Exim binary, path name"
16024 This option specifies the path name of the Exim binary, which is used when Exim
16025 needs to re-exec itself. The default is set up to point to the file &'exim'& in
16026 the directory configured at compile time by the BIN_DIRECTORY setting. It
16027 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16028 other place.
16029 &*Warning*&: Do not use a macro to define the value of this option, because
16030 you will break those Exim utilities that scan the configuration file to find
16031 where the binary is. (They then use the &%-bP%& option to extract option
16032 settings such as the value of &%spool_directory%&.)
16033
16034
16035 .option exim_user main string "compile-time configured"
16036 .cindex "uid (user id)" "Exim's own"
16037 .cindex "Exim user"
16038 This option changes the uid under which Exim runs when it gives up root
16039 privilege. The default value is compiled into the binary. Ownership of the run
16040 time configuration file and the use of the &%-C%& and &%-D%& command line
16041 options is checked against the values in the binary, not what is set here.
16042
16043 Unless it consists entirely of digits, the string is looked up using
16044 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16045 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16046 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16047
16048
16049 .option exim_version main string "current version"
16050 .cindex "Exim version"
16051 .cindex customizing "version number"
16052 .cindex "version number of Exim" override
16053 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16054 various places.  Use with care; this may fool stupid security scanners.
16055
16056
16057 .option extra_local_interfaces main "string list" unset
16058 This option defines network interfaces that are to be considered local when
16059 routing, but which are not used for listening by the daemon. See section
16060 &<<SECTreclocipadd>>& for details.
16061
16062
16063 . Allow this long option name to split; give it unsplit as a fifth argument
16064 . for the automatic .oindex that is generated by .option.
16065
16066 .option "extract_addresses_remove_arguments" main boolean true &&&
16067          extract_addresses_remove_arguments
16068 .oindex "&%-t%&"
16069 .cindex "command line" "addresses with &%-t%&"
16070 .cindex "Sendmail compatibility" "&%-t%& option"
16071 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16072 are present on the command line when the &%-t%& option is used to build an
16073 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16074 line addresses are removed from the recipients list. This is also how Smail
16075 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16076 command line addresses are added to those obtained from the header lines. When
16077 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16078 argument headers. If it is set false, Exim adds rather than removes argument
16079 addresses.
16080
16081
16082 .option finduser_retries main integer 0
16083 .cindex "NIS, retrying user lookups"
16084 On systems running NIS or other schemes in which user and group information is
16085 distributed from a remote system, there can be times when &[getpwnam()]& and
16086 related functions fail, even when given valid data, because things time out.
16087 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16088 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16089 many extra times to find a user or a group, waiting for one second between
16090 retries.
16091
16092 .cindex "&_/etc/passwd_&" "multiple reading of"
16093 You should not set this option greater than zero if your user information is in
16094 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16095 search the file multiple times for non-existent users, and also cause delay.
16096
16097
16098
16099 .option freeze_tell main "string list, comma separated" unset
16100 .cindex "freezing messages" "sending a message when freezing"
16101 .cindex "frozen messages" "sending a message when freezing"
16102 On encountering certain errors, or when configured to do so in a system filter,
16103 ACL, or special router, Exim freezes a message. This means that no further
16104 delivery attempts take place until an administrator thaws the message, or the
16105 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16106 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16107 warning message whenever it freezes something, unless the message it is
16108 freezing is a locally-generated bounce message. (Without this exception there
16109 is the possibility of looping.) The warning message is sent to the addresses
16110 supplied as the comma-separated value of this option. If several of the
16111 message's addresses cause freezing, only a single message is sent. If the
16112 freezing was automatic, the reason(s) for freezing can be found in the message
16113 log. If you configure freezing in a filter or ACL, you must arrange for any
16114 logging that you require.
16115
16116
16117 .options gecos_name main string&!! unset &&&
16118          gecos_pattern main string unset
16119 .cindex "HP-UX"
16120 .cindex "&""gecos""& field, parsing"
16121 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16122 password file to hold other information in addition to users' real names. Exim
16123 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16124 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16125 of the field are used unchanged, except that, if an ampersand is encountered,
16126 it is replaced by the user's login name with the first character forced to
16127 upper case, since this is a convention that is observed on many systems.
16128
16129 When these options are set, &%gecos_pattern%& is treated as a regular
16130 expression that is to be applied to the field (again with && replaced by the
16131 login name), and if it matches, &%gecos_name%& is expanded and used as the
16132 user's name.
16133
16134 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16135 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16136 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16137 name terminates at the first comma, the following can be used:
16138 .code
16139 gecos_pattern = ([^,]*)
16140 gecos_name = $1
16141 .endd
16142
16143
16144 .option gnutls_compat_mode main boolean unset
16145 This option controls whether GnuTLS is used in compatibility mode in an Exim
16146 server. This reduces security slightly, but improves interworking with older
16147 implementations of TLS.
16148
16149
16150 .option gnutls_allow_auto_pkcs11 main boolean unset
16151 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16152 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16153
16154 See
16155 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16156 for documentation.
16157
16158
16159
16160 .option headers_charset main string "see below"
16161 This option sets a default character set for translating from encoded MIME
16162 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16163 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16164 ultimate default is ISO-8859-1. For more details see the description of header
16165 insertions in section &<<SECTexpansionitems>>&.
16166
16167
16168
16169 .option header_maxsize main integer "see below"
16170 .cindex "header section" "maximum size of"
16171 .cindex "limit" "size of message header section"
16172 This option controls the overall maximum size of a message's header
16173 section. The default is the value of HEADER_MAXSIZE in
16174 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16175 sections are rejected.
16176
16177
16178 .option header_line_maxsize main integer 0
16179 .cindex "header lines" "maximum size of"
16180 .cindex "limit" "size of one header line"
16181 This option limits the length of any individual header line in a message, after
16182 all the continuations have been joined together. Messages with individual
16183 header lines that are longer than the limit are rejected. The default value of
16184 zero means &"no limit"&.
16185
16186
16187
16188
16189 .option helo_accept_junk_hosts main "host list&!!" unset
16190 .cindex "HELO" "accepting junk data"
16191 .cindex "EHLO" "accepting junk data"
16192 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16193 mail, and gives an error response for invalid data. Unfortunately, there are
16194 some SMTP clients that send syntactic junk. They can be accommodated by setting
16195 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16196 if you want to do semantic checking.
16197 See also &%helo_allow_chars%& for a way of extending the permitted character
16198 set.
16199
16200
16201 .option helo_allow_chars main string unset
16202 .cindex "HELO" "underscores in"
16203 .cindex "EHLO" "underscores in"
16204 .cindex "underscore in EHLO/HELO"
16205 This option can be set to a string of rogue characters that are permitted in
16206 all EHLO and HELO names in addition to the standard letters, digits,
16207 hyphens, and dots. If you really must allow underscores, you can set
16208 .code
16209 helo_allow_chars = _
16210 .endd
16211 Note that the value is one string, not a list.
16212
16213
16214 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16215 .cindex "HELO" "forcing reverse lookup"
16216 .cindex "EHLO" "forcing reverse lookup"
16217 If the domain given by a client in a HELO or EHLO command matches this
16218 list, a reverse lookup is done in order to establish the host's true name. The
16219 default forces a lookup if the client host gives the server's name or any of
16220 its IP addresses (in brackets), something that broken clients have been seen to
16221 do.
16222
16223
16224 .option helo_try_verify_hosts main "host list&!!" unset
16225 .cindex "HELO verifying" "optional"
16226 .cindex "EHLO" "verifying, optional"
16227 By default, Exim just checks the syntax of HELO and EHLO commands (see
16228 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16229 to do more extensive checking of the data supplied by these commands. The ACL
16230 condition &`verify = helo`& is provided to make this possible.
16231 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16232 to force the check to occur. From release 4.53 onwards, this is no longer
16233 necessary. If the check has not been done before &`verify = helo`& is
16234 encountered, it is done at that time. Consequently, this option is obsolete.
16235 Its specification is retained here for backwards compatibility.
16236
16237 When an EHLO or HELO command is received, if the calling host matches
16238 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16239 EHLO command either:
16240
16241 .ilist
16242 is an IP literal matching the calling address of the host, or
16243 .next
16244 .cindex "DNS" "reverse lookup"
16245 .cindex "reverse DNS lookup"
16246 matches the host name that Exim obtains by doing a reverse lookup of the
16247 calling host address, or
16248 .next
16249 when looked up in DNS yields the calling host address.
16250 .endlist
16251
16252 However, the EHLO or HELO command is not rejected if any of the checks
16253 fail. Processing continues, but the result of the check is remembered, and can
16254 be detected later in an ACL by the &`verify = helo`& condition.
16255
16256 If DNS was used for successful verification, the variable
16257 .cindex "DNS" "DNSSEC"
16258 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16259
16260 .option helo_verify_hosts main "host list&!!" unset
16261 .cindex "HELO verifying" "mandatory"
16262 .cindex "EHLO" "verifying, mandatory"
16263 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16264 backwards compatibility. For hosts that match this option, Exim checks the host
16265 name given in the HELO or EHLO in the same way as for
16266 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16267 rejected with a 550 error, and entries are written to the main and reject logs.
16268 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16269 error.
16270
16271 .option hold_domains main "domain list&!!" unset
16272 .cindex "domain" "delaying delivery"
16273 .cindex "delivery" "delaying certain domains"
16274 This option allows mail for particular domains to be held in the queue
16275 manually. The option is overridden if a message delivery is forced with the
16276 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16277 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16278 item in &%hold_domains%&, no routing or delivery for that address is done, and
16279 it is deferred every time the message is looked at.
16280
16281 This option is intended as a temporary operational measure for delaying the
16282 delivery of mail while some problem is being sorted out, or some new
16283 configuration tested. If you just want to delay the processing of some
16284 domains until a queue run occurs, you should use &%queue_domains%& or
16285 &%queue_smtp_domains%&, not &%hold_domains%&.
16286
16287 A setting of &%hold_domains%& does not override Exim's code for removing
16288 messages from the queue if they have been there longer than the longest retry
16289 time in any retry rule. If you want to hold messages for longer than the normal
16290 retry times, insert a dummy retry rule with a long retry time.
16291
16292
16293 .option host_lookup main "host list&!!" unset
16294 .cindex "host name" "lookup, forcing"
16295 Exim does not look up the name of a calling host from its IP address unless it
16296 is required to compare against some host list, or the host matches
16297 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16298 option (which normally contains IP addresses rather than host names). The
16299 default configuration file contains
16300 .code
16301 host_lookup = *
16302 .endd
16303 which causes a lookup to happen for all hosts. If the expense of these lookups
16304 is felt to be too great, the setting can be changed or removed.
16305
16306 After a successful reverse lookup, Exim does a forward lookup on the name it
16307 has obtained, to verify that it yields the IP address that it started with. If
16308 this check fails, Exim behaves as if the name lookup failed.
16309
16310 .vindex "&$host_lookup_failed$&"
16311 .vindex "&$sender_host_name$&"
16312 After any kind of failure, the host name (in &$sender_host_name$&) remains
16313 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16314 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16315 &`verify = reverse_host_lookup`& in ACLs.
16316
16317
16318 .option host_lookup_order main "string list" &`bydns:byaddr`&
16319 This option specifies the order of different lookup methods when Exim is trying
16320 to find a host name from an IP address. The default is to do a DNS lookup
16321 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16322 if that fails. You can change the order of these lookups, or omit one entirely,
16323 if you want.
16324
16325 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16326 multiple PTR records in the DNS and the IP address is not listed in
16327 &_/etc/hosts_&. Different operating systems give different results in this
16328 case. That is why the default tries a DNS lookup first.
16329
16330
16331
16332 .option host_reject_connection main "host list&!!" unset
16333 .cindex "host" "rejecting connections from"
16334 If this option is set, incoming SMTP calls from the hosts listed are rejected
16335 as soon as the connection is made.
16336 This option is obsolete, and retained only for backward compatibility, because
16337 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16338 connections immediately.
16339
16340 .new
16341 If the connection is on a TLS-on-connect port then the TCP connection is
16342 just dropped.  Otherwise, an SMTP error is sent first.
16343 .wen
16344
16345 The ability to give an immediate rejection (either by this option or using an
16346 ACL) is provided for use in unusual cases. Many hosts will just try again,
16347 sometimes without much delay. Normally, it is better to use an ACL to reject
16348 incoming messages at a later stage, such as after RCPT commands. See
16349 chapter &<<CHAPACL>>&.
16350
16351
16352 .option hosts_connection_nolog main "host list&!!" unset
16353 .cindex "host" "not logging connections from"
16354 This option defines a list of hosts for which connection logging does not
16355 happen, even though the &%smtp_connection%& log selector is set. For example,
16356 you might want not to log SMTP connections from local processes, or from
16357 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16358 the daemon; you should therefore strive to restrict its value to a short inline
16359 list of IP addresses and networks. To disable logging SMTP connections from
16360 local processes, you must create a host list with an empty item. For example:
16361 .code
16362 hosts_connection_nolog = :
16363 .endd
16364 .new
16365 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16366 lines, as may commonly be produced by a monitoring system.
16367 .wen
16368
16369
16370 .option hosts_require_alpn main "host list&!!" unset
16371 .cindex ALPN "require negotiation in server"
16372 .cindex TLS ALPN
16373 .cindex TLS "Application Layer Protocol Names"
16374 If the TLS library supports ALPN
16375 then a successful negotiation of ALPN will be required for any client
16376 matching the list, for TLS to be used.
16377 See also the &%tls_alpn%& option.
16378
16379 &*Note*&: prevention of fallback to in-clear connection is not
16380 managed by this option, and should be done separately.
16381
16382
16383 .option hosts_require_helo main "host list&!!" *
16384 .cindex "HELO/EHLO" requiring
16385 Exim will require an accepted HELO or EHLO command from a host matching
16386 this list, before accepting a MAIL command.
16387
16388
16389 .option hosts_proxy main "host list&!!" unset
16390 .cindex proxy "proxy protocol"
16391 This option enables use of Proxy Protocol proxies for incoming
16392 connections.  For details see section &<<SECTproxyInbound>>&.
16393
16394
16395 .option hosts_treat_as_local main "domain list&!!" unset
16396 .cindex "local host" "domains treated as"
16397 .cindex "host" "treated as local"
16398 If this option is set, any host names that match the domain list are treated as
16399 if they were the local host when Exim is scanning host lists obtained from MX
16400 records
16401 or other sources. Note that the value of this option is a domain list, not a
16402 host list, because it is always used to check host names, not IP addresses.
16403
16404 This option also applies when Exim is matching the special items
16405 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16406 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16407 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16408 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16409 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16410 interfaces and recognizing the local host.
16411
16412
16413 .option ibase_servers main "string list" unset
16414 .cindex "InterBase" "server list"
16415 This option provides a list of InterBase servers and associated connection data,
16416 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16417 The option is available only if Exim has been built with InterBase support.
16418
16419
16420
16421 .option ignore_bounce_errors_after main time 10w
16422 .cindex "bounce message" "discarding"
16423 .cindex "discarding bounce message"
16424 This option affects the processing of bounce messages that cannot be delivered,
16425 that is, those that suffer a permanent delivery failure. (Bounce messages that
16426 suffer temporary delivery failures are of course retried in the usual way.)
16427
16428 After a permanent delivery failure, bounce messages are frozen,
16429 because there is no sender to whom they can be returned. When a frozen bounce
16430 message has been in the queue for more than the given time, it is unfrozen at
16431 the next queue run, and a further delivery is attempted. If delivery fails
16432 again, the bounce message is discarded. This makes it possible to keep failed
16433 bounce messages around for a shorter time than the normal maximum retry time
16434 for frozen messages. For example,
16435 .code
16436 ignore_bounce_errors_after = 12h
16437 .endd
16438 retries failed bounce message deliveries after 12 hours, discarding any further
16439 failures. If the value of this option is set to a zero time period, bounce
16440 failures are discarded immediately. Setting a very long time (as in the default
16441 value) has the effect of disabling this option. For ways of automatically
16442 dealing with other kinds of frozen message, see &%auto_thaw%& and
16443 &%timeout_frozen_after%&.
16444
16445
16446 .options ignore_fromline_hosts main "host list&!!" unset &&&
16447          ignore_fromline_local main boolean false
16448 .cindex "&""From""& line"
16449 .cindex "UUCP" "&""From""& line"
16450 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16451 the headers of a message. By default this is treated as the start of the
16452 message's body, which means that any following headers are not recognized as
16453 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16454 match those hosts that insist on sending it. If the sender is actually a local
16455 process rather than a remote host, and is using &%-bs%& to inject the messages,
16456 &%ignore_fromline_local%& must be set to achieve this effect.
16457
16458
16459
16460 .option keep_environment main "string list" unset
16461 .cindex "environment" "values from"
16462 This option contains a string list of environment variables to keep.
16463 You have to trust these variables or you have to be sure that
16464 these variables do not impose any security risk. Keep in mind that
16465 during the startup phase Exim is running with an effective UID 0 in most
16466 installations. As the default value is an empty list, the default
16467 environment for using libraries, running embedded Perl code, or running
16468 external binaries is empty, and does not not even contain PATH or HOME.
16469
16470 Actually the list is interpreted as a list of patterns
16471 (&<<SECTlistexpand>>&), except that it is not expanded first.
16472
16473 WARNING: Macro substitution is still done first, so having a macro
16474 FOO and having FOO_HOME in your &%keep_environment%& option may have
16475 unexpected results. You may work around this using a regular expression
16476 that does not match the macro name: ^[F]OO_HOME$.
16477
16478 Current versions of Exim issue a warning during startup if you do not mention
16479 &%keep_environment%& in your runtime configuration file and if your
16480 current environment is not empty. Future versions may not issue that warning
16481 anymore.
16482
16483 See the &%add_environment%& main config option for a way to set
16484 environment variables to a fixed value.  The environment for &(pipe)&
16485 transports is handled separately, see section &<<SECTpipeenv>>& for
16486 details.
16487
16488
16489 .option keep_malformed main time 4d
16490 This option specifies the length of time to keep messages whose spool files
16491 have been corrupted in some way. This should, of course, never happen. At the
16492 next attempt to deliver such a message, it gets removed. The incident is
16493 logged.
16494
16495
16496 .option ldap_ca_cert_dir main string unset
16497 .cindex "LDAP", "TLS CA certificate directory"
16498 .cindex certificate "directory for LDAP"
16499 This option indicates which directory contains CA certificates for verifying
16500 a TLS certificate presented by an LDAP server.
16501 While Exim does not provide a default value, your SSL library may.
16502 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16503 and constrained to be a directory.
16504
16505
16506 .option ldap_ca_cert_file main string unset
16507 .cindex "LDAP", "TLS CA certificate file"
16508 .cindex certificate "file for LDAP"
16509 This option indicates which file contains CA certificates for verifying
16510 a TLS certificate presented by an LDAP server.
16511 While Exim does not provide a default value, your SSL library may.
16512 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16513 and constrained to be a file.
16514
16515
16516 .option ldap_cert_file main string unset
16517 .cindex "LDAP" "TLS client certificate file"
16518 .cindex certificate "file for LDAP"
16519 This option indicates which file contains an TLS client certificate which
16520 Exim should present to the LDAP server during TLS negotiation.
16521 Should be used together with &%ldap_cert_key%&.
16522
16523
16524 .option ldap_cert_key main string unset
16525 .cindex "LDAP" "TLS client key file"
16526 .cindex certificate "key for LDAP"
16527 This option indicates which file contains the secret/private key to use
16528 to prove identity to the LDAP server during TLS negotiation.
16529 Should be used together with &%ldap_cert_file%&, which contains the
16530 identity to be proven.
16531
16532
16533 .option ldap_cipher_suite main string unset
16534 .cindex "LDAP" "TLS cipher suite"
16535 This controls the TLS cipher-suite negotiation during TLS negotiation with
16536 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16537 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16538
16539
16540 .option ldap_default_servers main "string list" unset
16541 .cindex "LDAP" "default servers"
16542 This option provides a list of LDAP servers which are tried in turn when an
16543 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16544 details of LDAP queries. This option is available only when Exim has been built
16545 with LDAP support.
16546
16547
16548 .option ldap_require_cert main string unset.
16549 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16550 This should be one of the values "hard", "demand", "allow", "try" or "never".
16551 A value other than one of these is interpreted as "never".
16552 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16553 Although Exim does not set a default, the LDAP library probably defaults
16554 to hard/demand.
16555
16556
16557 .option ldap_start_tls main boolean false
16558 .cindex "LDAP" "whether or not to negotiate TLS"
16559 If set, Exim will attempt to negotiate TLS with the LDAP server when
16560 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16561 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16562 of SSL-on-connect.
16563 In the event of failure to negotiate TLS, the action taken is controlled
16564 by &%ldap_require_cert%&.
16565 This option is ignored for &`ldapi`& connections.
16566
16567
16568 .option ldap_version main integer unset
16569 .cindex "LDAP" "protocol version, forcing"
16570 This option can be used to force Exim to set a specific protocol version for
16571 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16572 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16573 the LDAP headers; otherwise it is 2. This option is available only when Exim
16574 has been built with LDAP support.
16575
16576
16577
16578 .option local_from_check main boolean true
16579 .cindex "&'Sender:'& header line" "disabling addition of"
16580 .cindex "&'From:'& header line" "disabling checking of"
16581 When a message is submitted locally (that is, not over a TCP/IP connection) by
16582 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16583 checks that the &'From:'& header line matches the login of the calling user and
16584 the domain specified by &%qualify_domain%&.
16585
16586 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16587 locally submitted message is automatically qualified by Exim, unless the
16588 &%-bnq%& command line option is used.
16589
16590 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16591 on the local part. If the &'From:'& header line does not match, Exim adds a
16592 &'Sender:'& header with an address constructed from the calling user's login
16593 and the default qualify domain.
16594
16595 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16596 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16597 &'Sender:'& header lines supplied by untrusted users, you must also set
16598 &%local_sender_retain%& to be true.
16599
16600 .cindex "envelope from"
16601 .cindex "envelope sender"
16602 These options affect only the header lines in the message. The envelope sender
16603 is still forced to be the login id at the qualify domain unless
16604 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16605
16606 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16607 request similar header line checking. See section &<<SECTthesenhea>>&, which
16608 has more details about &'Sender:'& processing.
16609
16610
16611
16612
16613 .options local_from_prefix main string unset &&&
16614          local_from_suffix main string unset
16615 When Exim checks the &'From:'& header line of locally submitted messages for
16616 matching the login id (see &%local_from_check%& above), it can be configured to
16617 ignore certain prefixes and suffixes in the local part of the address. This is
16618 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16619 appropriate lists, in the same form as the &%local_part_prefix%& and
16620 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16621 example, if
16622 .code
16623 local_from_prefix = *-
16624 .endd
16625 is set, a &'From:'& line containing
16626 .code
16627 From: anything-user@your.domain.example
16628 .endd
16629 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16630 matches the actual sender address that is constructed from the login name and
16631 qualify domain.
16632
16633
16634 .option local_interfaces main "string list" "see below"
16635 This option controls which network interfaces are used by the daemon for
16636 listening; they are also used to identify the local host when routing. Chapter
16637 &<<CHAPinterfaces>>& contains a full description of this option and the related
16638 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16639 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16640 &%local_interfaces%& is
16641 .code
16642 local_interfaces = 0.0.0.0
16643 .endd
16644 when Exim is built without IPv6 support; otherwise it is
16645 .code
16646 local_interfaces = <; ::0 ; 0.0.0.0
16647 .endd
16648
16649 .option local_scan_timeout main time 5m
16650 .cindex "timeout" "for &[local_scan()]& function"
16651 .cindex "&[local_scan()]& function" "timeout"
16652 This timeout applies to the &[local_scan()]& function (see chapter
16653 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16654 the incoming message is rejected with a temporary error if it is an SMTP
16655 message. For a non-SMTP message, the message is dropped and Exim ends with a
16656 non-zero code. The incident is logged on the main and reject logs.
16657
16658
16659
16660 .option local_sender_retain main boolean false
16661 .cindex "&'Sender:'& header line" "retaining from local submission"
16662 When a message is submitted locally (that is, not over a TCP/IP connection) by
16663 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16664 do not want this to happen, you must set &%local_sender_retain%&, and you must
16665 also set &%local_from_check%& to be false (Exim will complain if you do not).
16666 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16667 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16668
16669
16670
16671
16672 .option localhost_number main string&!! unset
16673 .cindex "host" "locally unique number for"
16674 .cindex "message ids" "with multiple hosts"
16675 .vindex "&$localhost_number$&"
16676 Exim's message ids are normally unique only within the local host. If
16677 uniqueness among a set of hosts is required, each host must set a different
16678 value for the &%localhost_number%& option. The string is expanded immediately
16679 after reading the configuration file (so that a number can be computed from the
16680 host name, for example) and the result of the expansion must be a number in the
16681 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16682 systems). This is available in subsequent string expansions via the variable
16683 &$localhost_number$&. When &%localhost_number is set%&, the final two
16684 characters of the message id, instead of just being a fractional part of the
16685 time, are computed from the time and the local host number as described in
16686 section &<<SECTmessiden>>&.
16687
16688
16689
16690 .option log_file_path main "string list&!!" "set at compile time"
16691 .cindex "log" "file path for"
16692 This option sets the path which is used to determine the names of Exim's log
16693 files, or indicates that logging is to be to syslog, or both. It is expanded
16694 when Exim is entered, so it can, for example, contain a reference to the host
16695 name. If no specific path is set for the log files at compile or runtime,
16696 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16697 they are written in a sub-directory called &_log_& in Exim's spool directory.
16698 A path must start with a slash.
16699 To send to syslog, use the word &"syslog"&.
16700 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16701 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16702 used. If this string is fixed at your installation (contains no expansion
16703 variables) it is recommended that you do not set this option in the
16704 configuration file, but instead supply the path using LOG_FILE_PATH in
16705 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16706 early on &-- in particular, failure to read the configuration file.
16707
16708
16709 .option log_selector main string unset
16710 .cindex "log" "selectors"
16711 This option can be used to reduce or increase the number of things that Exim
16712 writes to its log files. Its argument is made up of names preceded by plus or
16713 minus characters. For example:
16714 .code
16715 log_selector = +arguments -retry_defer
16716 .endd
16717 A list of possible names and what they control is given in the chapter on
16718 logging, in section &<<SECTlogselector>>&.
16719
16720
16721 .option log_timezone main boolean false
16722 .cindex "log" "timezone for entries"
16723 .vindex "&$tod_log$&"
16724 .vindex "&$tod_zone$&"
16725 By default, the timestamps on log lines are in local time without the
16726 timezone. This means that if your timezone changes twice a year, the timestamps
16727 in log lines are ambiguous for an hour when the clocks go back. One way of
16728 avoiding this problem is to set the timezone to UTC. An alternative is to set
16729 &%log_timezone%& true. This turns on the addition of the timezone offset to
16730 timestamps in log lines. Turning on this option can add quite a lot to the size
16731 of log files because each line is extended by 6 characters. Note that the
16732 &$tod_log$& variable contains the log timestamp without the zone, but there is
16733 another variable called &$tod_zone$& that contains just the timezone offset.
16734
16735
16736 .option lookup_open_max main integer 25
16737 .cindex "too many open files"
16738 .cindex "open files, too many"
16739 .cindex "file" "too many open"
16740 .cindex "lookup" "maximum open files"
16741 .cindex "limit" "open files for lookups"
16742 This option limits the number of simultaneously open files for single-key
16743 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16744 Exim normally keeps these files open during routing, because often the same
16745 file is required several times. If the limit is reached, Exim closes the least
16746 recently used file. Note that if you are using the &'ndbm'& library, it
16747 actually opens two files for each logical DBM database, though it still counts
16748 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16749 open files"& errors with NDBM, you need to reduce the value of
16750 &%lookup_open_max%&.
16751
16752
16753 .option max_username_length main integer 0
16754 .cindex "length of login name"
16755 .cindex "user name" "maximum length"
16756 .cindex "limit" "user name length"
16757 Some operating systems are broken in that they truncate long arguments to
16758 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16759 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16760 an argument that is longer behaves as if &[getpwnam()]& failed.
16761
16762
16763 .option message_body_newlines main bool false
16764 .cindex "message body" "newlines in variables"
16765 .cindex "newline" "in message body variables"
16766 .vindex "&$message_body$&"
16767 .vindex "&$message_body_end$&"
16768 By default, newlines in the message body are replaced by spaces when setting
16769 the &$message_body$& and &$message_body_end$& expansion variables. If this
16770 option is set true, this no longer happens.
16771
16772
16773 .option message_body_visible main integer 500
16774 .cindex "body of message" "visible size"
16775 .cindex "message body" "visible size"
16776 .vindex "&$message_body$&"
16777 .vindex "&$message_body_end$&"
16778 This option specifies how much of a message's body is to be included in the
16779 &$message_body$& and &$message_body_end$& expansion variables.
16780
16781
16782 .option message_id_header_domain main string&!! unset
16783 .cindex "&'Message-ID:'& header line"
16784 If this option is set, the string is expanded and used as the right hand side
16785 (domain) of the &'Message-ID:'& header that Exim creates if a
16786 locally-originated incoming message does not have one. &"Locally-originated"&
16787 means &"not received over TCP/IP."&
16788 Otherwise, the primary host name is used.
16789 Only letters, digits, dot and hyphen are accepted; any other characters are
16790 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16791 empty string, the option is ignored.
16792
16793
16794 .option message_id_header_text main string&!! unset
16795 If this variable is set, the string is expanded and used to augment the text of
16796 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16797 message does not have one. The text of this header is required by RFC 2822 to
16798 take the form of an address. By default, Exim uses its internal message id as
16799 the local part, and the primary host name as the domain. If this option is set,
16800 it is expanded, and provided the expansion is not forced to fail, and does not
16801 yield an empty string, the result is inserted into the header immediately
16802 before the @, separated from the internal message id by a dot. Any characters
16803 that are illegal in an address are automatically converted into hyphens. This
16804 means that variables such as &$tod_log$& can be used, because the spaces and
16805 colons will become hyphens.
16806
16807
16808 .option message_logs main boolean true
16809 .cindex "message logs" "disabling"
16810 .cindex "log" "message log; disabling"
16811 If this option is turned off, per-message log files are not created in the
16812 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16813 Exim, by reducing the number of files involved in handling a message from a
16814 minimum of four (header spool file, body spool file, delivery journal, and
16815 per-message log) to three. The other major I/O activity is Exim's main log,
16816 which is not affected by this option.
16817
16818
16819 .option message_size_limit main string&!! 50M
16820 .cindex "message" "size limit"
16821 .cindex "limit" "message size"
16822 .cindex "size" "of message, limit"
16823 This option limits the maximum size of message that Exim will process. The
16824 value is expanded for each incoming connection so, for example, it can be made
16825 to depend on the IP address of the remote host for messages arriving via
16826 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16827 optionally followed by K or M.
16828
16829 .cindex "SIZE" "ESMTP extension, advertising"
16830 .cindex "ESMTP extensions" SIZE
16831 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16832 service extension keyword.
16833
16834 &*Note*&: This limit cannot be made to depend on a message's sender or any
16835 other properties of an individual message, because it has to be advertised in
16836 the server's response to EHLO. String expansion failure causes a temporary
16837 error. A value of zero means no limit, but its use is not recommended. See also
16838 &%bounce_return_size_limit%&.
16839
16840 Incoming SMTP messages are failed with a 552 error if the limit is
16841 exceeded; locally-generated messages either get a stderr message or a delivery
16842 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16843 an oversized message is logged in both the main and the reject logs. See also
16844 the generic transport option &%message_size_limit%&, which limits the size of
16845 message that an individual transport can process.
16846
16847 If you use a virus-scanner and set this option to to a value larger than the
16848 maximum size that your virus-scanner is configured to support, you may get
16849 failures triggered by large mails.  The right size to configure for the
16850 virus-scanner depends upon what data is passed and the options in use but it's
16851 probably safest to just set it to a little larger than this value.  E.g., with a
16852 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16853 some problems may result.
16854
16855 A value of 0 will disable size limit checking; Exim will still advertise the
16856 SIZE extension in an EHLO response, but without a limit, so as to permit
16857 SMTP clients to still indicate the message size along with the MAIL verb.
16858
16859
16860 .option move_frozen_messages main boolean false
16861 .cindex "frozen messages" "moving"
16862 This option, which is available only if Exim has been built with the setting
16863 .code
16864 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16865 .endd
16866 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16867 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16868 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16869 standard utilities for handling such moved messages, and they do not show up in
16870 lists generated by &%-bp%& or by the Exim monitor.
16871
16872
16873 .option mua_wrapper main boolean false
16874 Setting this option true causes Exim to run in a very restrictive mode in which
16875 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16876 contains a full description of this facility.
16877
16878
16879
16880 .option mysql_servers main "string list" unset
16881 .cindex "MySQL" "server list"
16882 This option provides a list of MySQL servers and associated connection data, to
16883 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16884 option is available only if Exim has been built with MySQL support.
16885
16886
16887 .option never_users main "string list&!!" unset
16888 This option is expanded just once, at the start of Exim's processing. Local
16889 message deliveries are normally run in processes that are setuid to the
16890 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16891 It is usually desirable to prevent any deliveries from running as root, as a
16892 safety precaution.
16893
16894 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16895 list of users that must not be used for local deliveries. This list is fixed in
16896 the binary and cannot be overridden by the configuration file. By default, it
16897 contains just the single user name &"root"&. The &%never_users%& runtime option
16898 can be used to add more users to the fixed list.
16899
16900 If a message is to be delivered as one of the users on the fixed list or the
16901 &%never_users%& list, an error occurs, and delivery is deferred. A common
16902 example is
16903 .code
16904 never_users = root:daemon:bin
16905 .endd
16906 Including root is redundant if it is also on the fixed list, but it does no
16907 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16908 transport driver.
16909
16910
16911 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16912 This option gives the name for a unix-domain socket on which the daemon
16913 listens for work and information-requests.
16914 Only installations running multiple daemons sharing a spool directory
16915 should need to modify the default.
16916
16917 The option is expanded before use.
16918 If the platform supports Linux-style abstract socket names, the result
16919 is used with a nul byte prefixed.
16920 Otherwise,
16921 it should be a full path name and use a directory accessible
16922 to Exim.
16923
16924 If this option is set as empty,
16925 or the command line &%-oY%& option is used, or
16926 the command line uses a &%-oX%& option and does not use &%-oP%&,
16927 then a notifier socket is not created.
16928
16929
16930 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16931 .cindex "OpenSSL "compatibility options"
16932 This option allows an administrator to adjust the SSL options applied
16933 by OpenSSL to connections.  It is given as a space-separated list of items,
16934 each one to be +added or -subtracted from the current value.
16935
16936 This option is only available if Exim is built against OpenSSL.  The values
16937 available for this option vary according to the age of your OpenSSL install.
16938 The &"all"& value controls a subset of flags which are available, typically
16939 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16940 list the values known on your system and Exim should support all the
16941 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16942 names lose the leading &"SSL_OP_"& and are lower-cased.
16943
16944 Note that adjusting the options can have severe impact upon the security of
16945 SSL as used by Exim.  It is possible to disable safety checks and shoot
16946 yourself in the foot in various unpleasant ways.  This option should not be
16947 adjusted lightly.  An unrecognised item will be detected at startup, by
16948 invoking Exim with the &%-bV%& flag.
16949
16950 The option affects Exim operating both as a server and as a client.
16951
16952 Historical note: prior to release 4.80, Exim defaulted this value to
16953 "+dont_insert_empty_fragments", which may still be needed for compatibility
16954 with some clients, but which lowers security by increasing exposure to
16955 some now infamous attacks.
16956
16957 Examples:
16958 .code
16959 # Make both old MS and old Eudora happy:
16960 openssl_options = -all +microsoft_big_sslv3_buffer \
16961                        +dont_insert_empty_fragments
16962
16963 # Disable older protocol versions:
16964 openssl_options = +no_sslv2 +no_sslv3
16965 .endd
16966
16967 Possible options may include:
16968 .ilist
16969 &`all`&
16970 .next
16971 &`allow_unsafe_legacy_renegotiation`&
16972 .next
16973 &`cipher_server_preference`&
16974 .next
16975 &`dont_insert_empty_fragments`&
16976 .next
16977 &`ephemeral_rsa`&
16978 .next
16979 &`legacy_server_connect`&
16980 .next
16981 &`microsoft_big_sslv3_buffer`&
16982 .next
16983 &`microsoft_sess_id_bug`&
16984 .next
16985 &`msie_sslv2_rsa_padding`&
16986 .next
16987 &`netscape_challenge_bug`&
16988 .next
16989 &`netscape_reuse_cipher_change_bug`&
16990 .next
16991 &`no_compression`&
16992 .next
16993 &`no_session_resumption_on_renegotiation`&
16994 .next
16995 &`no_sslv2`&
16996 .next
16997 &`no_sslv3`&
16998 .next
16999 &`no_ticket`&
17000 .next
17001 &`no_tlsv1`&
17002 .next
17003 &`no_tlsv1_1`&
17004 .next
17005 &`no_tlsv1_2`&
17006 .next
17007 &`safari_ecdhe_ecdsa_bug`&
17008 .next
17009 &`single_dh_use`&
17010 .next
17011 &`single_ecdh_use`&
17012 .next
17013 &`ssleay_080_client_dh_bug`&
17014 .next
17015 &`sslref2_reuse_cert_type_bug`&
17016 .next
17017 &`tls_block_padding_bug`&
17018 .next
17019 &`tls_d5_bug`&
17020 .next
17021 &`tls_rollback_bug`&
17022 .endlist
17023
17024 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
17025 all clients connecting using the MacOS SecureTransport TLS facility prior
17026 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17027 to negotiate TLS then this option value might help, provided that your OpenSSL
17028 release is new enough to contain this work-around.  This may be a situation
17029 where you have to upgrade OpenSSL to get buggy clients working.
17030
17031
17032 .option oracle_servers main "string list" unset
17033 .cindex "Oracle" "server list"
17034 This option provides a list of Oracle servers and associated connection data,
17035 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17036 The option is available only if Exim has been built with Oracle support.
17037
17038
17039 .new
17040 .option panic_coredump main boolean false
17041 This option is rarely needed but can help for some debugging investigations.
17042 If set, when an internal error is detected by Exim which is sufficient
17043 to terminate the process
17044 (all such are logged in the paniclog)
17045 then a coredump is requested.
17046
17047 Note that most systems require additional administrative configuration
17048 to permit write a core file for a setuid program, which is Exim's
17049 common installed configuration.
17050 .wen
17051
17052 .option percent_hack_domains main "domain list&!!" unset
17053 .cindex "&""percent hack""&"
17054 .cindex "source routing" "in email address"
17055 .cindex "address" "source-routed"
17056 The &"percent hack"& is the convention whereby a local part containing a
17057 percent sign is re-interpreted as a new email address, with the percent
17058 replaced by @. This is sometimes called &"source routing"&, though that term is
17059 also applied to RFC 2822 addresses that begin with an @ character. If this
17060 option is set, Exim implements the percent facility for those domains listed,
17061 but no others. This happens before an incoming SMTP address is tested against
17062 an ACL.
17063
17064 &*Warning*&: The &"percent hack"& has often been abused by people who are
17065 trying to get round relaying restrictions. For this reason, it is best avoided
17066 if at all possible. Unfortunately, a number of less security-conscious MTAs
17067 implement it unconditionally. If you are running Exim on a gateway host, and
17068 routing mail through to internal MTAs without processing the local parts, it is
17069 a good idea to reject recipient addresses with percent characters in their
17070 local parts. Exim's default configuration does this.
17071
17072
17073 .options perl_at_start main boolean false &&&
17074          perl_startup main string unset
17075 .cindex "Perl"
17076 These options are available only when Exim is built with an embedded Perl
17077 interpreter. See chapter &<<CHAPperl>>& for details of their use.
17078
17079 .option perl_taintmode main boolean false
17080 .cindex "Perl"
17081 This option enables the taint mode of the embedded Perl interpreter.
17082
17083
17084 .option pgsql_servers main "string list" unset
17085 .cindex "PostgreSQL lookup type" "server list"
17086 This option provides a list of PostgreSQL servers and associated connection
17087 data, to be used in conjunction with &(pgsql)& lookups (see section
17088 &<<SECID72>>&). The option is available only if Exim has been built with
17089 PostgreSQL support.
17090
17091
17092 .option pid_file_path main string&!! "set at compile time"
17093 .cindex "daemon" "pid file path"
17094 .cindex "pid file, path for"
17095 This option sets the name of the file to which the Exim daemon writes its
17096 process id. The string is expanded, so it can contain, for example, references
17097 to the host name:
17098 .code
17099 pid_file_path = /var/log/$primary_hostname/exim.pid
17100 .endd
17101 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17102 spool directory.
17103 The value set by the option can be overridden by the &%-oP%& command line
17104 option. A pid file is not written if a &"non-standard"& daemon is run by means
17105 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17106
17107
17108 .option pipelining_advertise_hosts main "host list&!!" *
17109 .cindex "PIPELINING" "suppressing advertising"
17110 .cindex "ESMTP extensions" PIPELINING
17111 This option can be used to suppress the advertisement of the SMTP
17112 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17113 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17114 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17115 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17116 that clients will use it; &"out of order"& commands that are &"expected"& do
17117 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17118
17119 .option pipelining_connect_advertise_hosts main "host list&!!" *
17120 .cindex "pipelining" "early connection"
17121 .cindex "pipelining" PIPECONNECT
17122 .cindex "ESMTP extensions" PIPECONNECT
17123 If Exim is built without the DISABLE_PIPE_CONNECT build option
17124 this option controls which hosts the facility is advertised to
17125 and from which pipeline early-connection (before MAIL) SMTP
17126 commands are acceptable.
17127 When used, the pipelining saves on roundtrip times.
17128
17129 See also the &%hosts_pipe_connect%& smtp transport option.
17130
17131 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17132 it permits the client to pipeline
17133 TCP connection and hello command (inclear phase),
17134 or TLS-establishment and hello command (encrypted phase),
17135 on later connections to the same host.
17136
17137
17138 .option prdr_enable main boolean false
17139 .cindex "PRDR" "enabling on server"
17140 .cindex "ESMTP extensions" PRDR
17141 This option can be used to enable the Per-Recipient Data Response extension
17142 to SMTP, defined by Eric Hall.
17143 If the option is set, PRDR is advertised by Exim when operating as a server.
17144 If the client requests PRDR, and more than one recipient, for a message
17145 an additional ACL is called for each recipient after the message content
17146 is received.  See section &<<SECTPRDRACL>>&.
17147
17148 .option preserve_message_logs main boolean false
17149 .cindex "message logs" "preserving"
17150 If this option is set, message log files are not deleted when messages are
17151 completed. Instead, they are moved to a sub-directory of the spool directory
17152 called &_msglog.OLD_&, where they remain available for statistical or debugging
17153 purposes. This is a dangerous option to set on systems with any appreciable
17154 volume of mail. Use with care!
17155
17156
17157 .option primary_hostname main string "see below"
17158 .cindex "name" "of local host"
17159 .cindex "host" "name of local"
17160 .cindex "local host" "name of"
17161 .vindex "&$primary_hostname$&"
17162 This specifies the name of the current host. It is used in the default EHLO or
17163 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17164 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17165 The value is also used by default in some SMTP response messages from an Exim
17166 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17167
17168 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17169 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17170 contains only one component, Exim passes it to &[gethostbyname()]& (or
17171 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17172 version. The variable &$primary_hostname$& contains the host name, whether set
17173 explicitly by this option, or defaulted.
17174
17175
17176 .option print_topbitchars main boolean false
17177 .cindex "printing characters"
17178 .cindex "8-bit characters"
17179 By default, Exim considers only those characters whose codes lie in the range
17180 32&--126 to be printing characters. In a number of circumstances (for example,
17181 when writing log entries) non-printing characters are converted into escape
17182 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17183 is set, code values of 128 and above are also considered to be printing
17184 characters.
17185
17186 This option also affects the header syntax checks performed by the
17187 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17188 the user's full name when constructing From: and Sender: addresses (as
17189 described in section &<<SECTconstr>>&). Setting this option can cause
17190 Exim to generate eight bit message headers that do not conform to the
17191 standards.
17192
17193
17194 .option process_log_path main string unset
17195 .cindex "process log path"
17196 .cindex "log" "process log"
17197 .cindex "&'exiwhat'&"
17198 This option sets the name of the file to which an Exim process writes its
17199 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17200 utility script. If this option is unset, the file called &_exim-process.info_&
17201 in Exim's spool directory is used. The ability to specify the name explicitly
17202 can be useful in environments where two different Exims are running, using
17203 different spool directories.
17204
17205
17206 .option prod_requires_admin main boolean true
17207 .cindex "restricting access to features"
17208 .oindex "&%-M%&"
17209 .oindex "&%-R%&"
17210 .oindex "&%-q%&"
17211 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17212 admin user unless &%prod_requires_admin%& is set false. See also
17213 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17214
17215
17216 .option proxy_protocol_timeout main time 3s
17217 .cindex proxy "proxy protocol"
17218 This option sets the timeout for proxy protocol negotiation.
17219 For details see section &<<SECTproxyInbound>>&.
17220
17221
17222 .option qualify_domain main string "see below"
17223 .cindex "domain" "for qualifying addresses"
17224 .cindex "address" "qualification"
17225 This option specifies the domain name that is added to any envelope sender
17226 addresses that do not have a domain qualification. It also applies to
17227 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17228 are accepted by default only for locally-generated messages. Qualification is
17229 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17230 locally-generated messages, unless the &%-bnq%& command line option is used.
17231
17232 Messages from external sources must always contain fully qualified addresses,
17233 unless the sending host matches &%sender_unqualified_hosts%& or
17234 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17235 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17236 necessary. Internally, Exim always works with fully qualified envelope
17237 addresses. If &%qualify_domain%& is not set, it defaults to the
17238 &%primary_hostname%& value.
17239
17240
17241 .option qualify_recipient main string "see below"
17242 This option allows you to specify a different domain for qualifying recipient
17243 addresses to the one that is used for senders. See &%qualify_domain%& above.
17244
17245
17246
17247 .option queue_domains main "domain list&!!" unset
17248 .cindex "domain" "specifying non-immediate delivery"
17249 .cindex "queueing incoming messages"
17250 .cindex "message" "queueing certain domains"
17251 This option lists domains for which immediate delivery is not required.
17252 A delivery process is started whenever a message is received, but only those
17253 domains that do not match are processed. All other deliveries wait until the
17254 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17255
17256
17257 .option queue_fast_ramp main boolean true
17258 .cindex "queue runner" "two phase"
17259 .cindex "queue" "double scanning"
17260 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17261 command line, may start parallel delivery processes during their first
17262 phase.  This will be done when a threshold number of messages have been
17263 routed for a single host.
17264
17265
17266 .option queue_list_requires_admin main boolean true
17267 .cindex "restricting access to features"
17268 .oindex "&%-bp%&"
17269 The &%-bp%& command-line option, which lists the messages that are on the
17270 queue, requires the caller to be an admin user unless
17271 &%queue_list_requires_admin%& is set false.
17272 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17273
17274
17275 .option queue_only main boolean false
17276 .cindex "queueing incoming messages"
17277 .cindex "message" "queueing unconditionally"
17278 If &%queue_only%& is set, a delivery process is not automatically started
17279 whenever a message is received. Instead, the message waits in the queue for the
17280 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17281 delivered immediately when certain conditions (such as heavy load) occur.
17282
17283 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17284 and &%-odi%& command line options override &%queue_only%& unless
17285 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17286 &%queue_only_load%&, and &%smtp_accept_queue%&.
17287
17288
17289 .option queue_only_file main "string list" unset
17290 .cindex "queueing incoming messages"
17291 .cindex "message" "queueing by file existence"
17292 This option can be set to a colon-separated list of absolute path names, each
17293 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17294 it tests for the existence of each listed path using a call to &[stat()]&. For
17295 each path that exists, the corresponding queueing option is set.
17296 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17297 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17298 .code
17299 queue_only_file = smtp/some/file
17300 .endd
17301 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17302 &_/some/file_& exists.
17303
17304
17305 .option queue_only_load main fixed-point unset
17306 .cindex "load average"
17307 .cindex "queueing incoming messages"
17308 .cindex "message" "queueing by load"
17309 If the system load average is higher than this value, incoming messages from
17310 all sources are queued, and no automatic deliveries are started. If this
17311 happens during local or remote SMTP input, all subsequent messages received on
17312 the same SMTP connection are queued by default, whatever happens to the load in
17313 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17314 false.
17315
17316 Deliveries will subsequently be performed by queue runner processes. This
17317 option has no effect on ancient operating systems on which Exim cannot
17318 determine the load average. See also &%deliver_queue_load_max%& and
17319 &%smtp_load_reserve%&.
17320
17321
17322 .option queue_only_load_latch main boolean true
17323 .cindex "load average" "re-evaluating per message"
17324 When this option is true (the default), once one message has been queued
17325 because the load average is higher than the value set by &%queue_only_load%&,
17326 all subsequent messages received on the same SMTP connection are also queued.
17327 This is a deliberate choice; even though the load average may fall below the
17328 threshold, it doesn't seem right to deliver later messages on the same
17329 connection when not delivering earlier ones. However, there are special
17330 circumstances such as very long-lived connections from scanning appliances
17331 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17332 should be set false. This causes the value of the load average to be
17333 re-evaluated for each message.
17334
17335
17336 .option queue_only_override main boolean true
17337 .cindex "queueing incoming messages"
17338 When this option is true, the &%-od%&&'x'& command line options override the
17339 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17340 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17341 to override; they are accepted, but ignored.
17342
17343
17344 .option queue_run_in_order main boolean false
17345 .cindex "queue runner" "processing messages in order"
17346 If this option is set, queue runs happen in order of message arrival instead of
17347 in an arbitrary order. For this to happen, a complete list of the entire queue
17348 must be set up before the deliveries start. When the queue is all held in a
17349 single directory (the default), a single list is created for both the ordered
17350 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17351 single list is not created when &%queue_run_in_order%& is false. In this case,
17352 the sub-directories are processed one at a time (in a random order), and this
17353 avoids setting up one huge list for the whole queue. Thus, setting
17354 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17355 when the queue is large, because of the extra work in setting up the single,
17356 large list. In most situations, &%queue_run_in_order%& should not be set.
17357
17358
17359
17360 .option queue_run_max main integer&!! 5
17361 .cindex "queue runner" "maximum number of"
17362 This controls the maximum number of queue runner processes that an Exim daemon
17363 can run simultaneously. This does not mean that it starts them all at once,
17364 but rather that if the maximum number are still running when the time comes to
17365 start another one, it refrains from starting another one. This can happen with
17366 very large queues and/or very sluggish deliveries. This option does not,
17367 however, interlock with other processes, so additional queue runners can be
17368 started by other means, or by killing and restarting the daemon.
17369
17370 Setting this option to zero does not suppress queue runs; rather, it disables
17371 the limit, allowing any number of simultaneous queue runner processes to be
17372 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17373 the daemon's command line.
17374
17375 .cindex queues named
17376 .cindex "named queues" "resource limit"
17377 To set limits for different named queues use
17378 an expansion depending on the &$queue_name$& variable.
17379
17380 .option queue_smtp_domains main "domain list&!!" unset
17381 .cindex "queueing incoming messages"
17382 .cindex "message" "queueing remote deliveries"
17383 .cindex "first pass routing"
17384 When this option is set, a delivery process is started whenever a message is
17385 received, routing is performed, and local deliveries take place.
17386 However, if any SMTP deliveries are required for domains that match
17387 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17388 message waits in the queue for the next queue run. Since routing of the message
17389 has taken place, Exim knows to which remote hosts it must be delivered, and so
17390 when the queue run happens, multiple messages for the same host are delivered
17391 over a single SMTP connection. The &%-odqs%& command line option causes all
17392 SMTP deliveries to be queued in this way, and is equivalent to setting
17393 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17394 &%queue_domains%&.
17395
17396
17397 .option receive_timeout main time 0s
17398 .cindex "timeout" "for non-SMTP input"
17399 This option sets the timeout for accepting a non-SMTP message, that is, the
17400 maximum time that Exim waits when reading a message on the standard input. If
17401 the value is zero, it will wait forever. This setting is overridden by the
17402 &%-or%& command line option. The timeout for incoming SMTP messages is
17403 controlled by &%smtp_receive_timeout%&.
17404
17405 .option received_header_text main string&!! "see below"
17406 .cindex "customizing" "&'Received:'& header"
17407 .cindex "&'Received:'& header line" "customizing"
17408 This string defines the contents of the &'Received:'& message header that is
17409 added to each message, except for the timestamp, which is automatically added
17410 on at the end (preceded by a semicolon). The string is expanded each time it is
17411 used. If the expansion yields an empty string, no &'Received:'& header line is
17412 added to the message. Otherwise, the string should start with the text
17413 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17414 header lines.
17415 The default setting is:
17416
17417 .code
17418 received_header_text = Received: \
17419   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17420     {${if def:sender_ident \
17421       {from ${quote_local_part:$sender_ident} }}\
17422         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17423   by $primary_hostname \
17424   ${if def:received_protocol {with $received_protocol }}\
17425   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17426   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17427   (Exim $version_number)\n\t\
17428   ${if def:sender_address \
17429   {(envelope-from <$sender_address>)\n\t}}\
17430   id $message_exim_id\
17431   ${if def:received_for {\n\tfor $received_for}}
17432 .endd
17433
17434 The references to the TLS version and cipher are
17435 omitted when Exim is built without TLS
17436 support. The use of conditional expansions ensures that this works for both
17437 locally generated messages and messages received from remote hosts, giving
17438 header lines such as the following:
17439 .code
17440 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17441 by marley.carol.example with esmtp (Exim 4.00)
17442 (envelope-from <bob@carol.example>)
17443 id 16IOWa-00019l-00
17444 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17445 Received: by scrooge.carol.example with local (Exim 4.00)
17446 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17447 .endd
17448 Until the body of the message has been received, the timestamp is the time when
17449 the message started to be received. Once the body has arrived, and all policy
17450 checks have taken place, the timestamp is updated to the time at which the
17451 message was accepted.
17452
17453
17454 .option received_headers_max main integer 30
17455 .cindex "loop" "prevention"
17456 .cindex "mail loop prevention"
17457 .cindex "&'Received:'& header line" "counting"
17458 When a message is to be delivered, the number of &'Received:'& headers is
17459 counted, and if it is greater than this parameter, a mail loop is assumed to
17460 have occurred, the delivery is abandoned, and an error message is generated.
17461 This applies to both local and remote deliveries.
17462
17463
17464 .option recipient_unqualified_hosts main "host list&!!" unset
17465 .cindex "unqualified addresses"
17466 .cindex "host" "unqualified addresses from"
17467 This option lists those hosts from which Exim is prepared to accept unqualified
17468 recipient addresses in message envelopes. The addresses are made fully
17469 qualified by the addition of the &%qualify_recipient%& value. This option also
17470 affects message header lines. Exim does not reject unqualified recipient
17471 addresses in headers, but it qualifies them only if the message came from a
17472 host that matches &%recipient_unqualified_hosts%&,
17473 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17474 option was not set.
17475
17476
17477 .option recipients_max main integer 50000
17478 .cindex "limit" "number of recipients"
17479 .cindex "recipient" "maximum number"
17480 If this option is set greater than zero, it specifies the maximum number of
17481 original recipients for any message. Additional recipients that are generated
17482 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17483 all recipients over the limit; earlier recipients are delivered as normal.
17484 Non-SMTP messages with too many recipients are failed, and no deliveries are
17485 done.
17486
17487 .cindex "RCPT" "maximum number of incoming"
17488 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17489 RCPT commands in a single message.
17490
17491
17492 .option recipients_max_reject main boolean false
17493 If this option is set true, Exim rejects SMTP messages containing too many
17494 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17495 error to the eventual DATA command. Otherwise (the default) it gives a 452
17496 error to the surplus RCPT commands and accepts the message on behalf of the
17497 initial set of recipients. The remote server should then re-send the message
17498 for the remaining recipients at a later time.
17499
17500
17501 .option remote_max_parallel main integer 4
17502 .cindex "delivery" "parallelism for remote"
17503 This option controls parallel delivery of one message to a number of remote
17504 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17505 does all the remote deliveries for a message one by one. Otherwise, if a single
17506 message has to be delivered to more than one remote host, or if several copies
17507 have to be sent to the same remote host, up to &%remote_max_parallel%&
17508 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17509 deliveries are required, the maximum number of processes are started, and as
17510 each one finishes, another is begun. The order of starting processes is the
17511 same as if sequential delivery were being done, and can be controlled by the
17512 &%remote_sort_domains%& option. If parallel delivery takes place while running
17513 with debugging turned on, the debugging output from each delivery process is
17514 tagged with its process id.
17515
17516 This option controls only the maximum number of parallel deliveries for one
17517 message in one Exim delivery process. Because Exim has no central queue
17518 manager, there is no way of controlling the total number of simultaneous
17519 deliveries if the configuration allows a delivery attempt as soon as a message
17520 is received.
17521
17522 See also the &%max_parallel%& generic transport option,
17523 and the &%serialize_hosts%& smtp transport option.
17524
17525 .cindex "number of deliveries"
17526 .cindex "delivery" "maximum number of"
17527 If you want to control the total number of deliveries on the system, you
17528 need to set the &%queue_only%& option. This ensures that all incoming messages
17529 are added to the queue without starting a delivery process. Then set up an Exim
17530 daemon to start queue runner processes at appropriate intervals (probably
17531 fairly often, for example, every minute), and limit the total number of queue
17532 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17533 delivers only one message at a time, the maximum number of deliveries that can
17534 then take place at once is &%queue_run_max%& multiplied by
17535 &%remote_max_parallel%&.
17536
17537 If it is purely remote deliveries you want to control, use
17538 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17539 doing the SMTP routing before queueing, so that several messages for the same
17540 host will eventually get delivered down the same connection.
17541
17542
17543 .option remote_sort_domains main "domain list&!!" unset
17544 .cindex "sorting remote deliveries"
17545 .cindex "delivery" "sorting remote"
17546 When there are a number of remote deliveries for a message, they are sorted by
17547 domain into the order given by this list. For example,
17548 .code
17549 remote_sort_domains = *.cam.ac.uk:*.uk
17550 .endd
17551 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17552 then to those in the &%uk%& domain, then to any others.
17553
17554
17555 .option retry_data_expire main time 7d
17556 .cindex "hints database" "data expiry"
17557 This option sets a &"use before"& time on retry information in Exim's hints
17558 database. Any older retry data is ignored. This means that, for example, once a
17559 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17560 past failures.
17561
17562
17563 .option retry_interval_max main time 24h
17564 .cindex "retry" "limit on interval"
17565 .cindex "limit" "on retry interval"
17566 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17567 intervals between delivery attempts for messages that cannot be delivered
17568 straight away. This option sets an overall limit to the length of time between
17569 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17570 the default value.
17571
17572
17573 .option return_path_remove main boolean true
17574 .cindex "&'Return-path:'& header line" "removing"
17575 RFC 2821, section 4.4, states that an SMTP server must insert a
17576 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17577 The &'Return-path:'& header preserves the sender address as received in the
17578 MAIL command. This description implies that this header should not be present
17579 in an incoming message. If &%return_path_remove%& is true, any existing
17580 &'Return-path:'& headers are removed from messages at the time they are
17581 received. Exim's transports have options for adding &'Return-path:'& headers at
17582 the time of delivery. They are normally used only for final local deliveries.
17583
17584
17585 .option return_size_limit main integer 100K
17586 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17587
17588
17589 .option rfc1413_hosts main "host list&!!" @[]
17590 .cindex "RFC 1413"
17591 .cindex "host" "for RFC 1413 calls"
17592 RFC 1413 identification calls are made to any client host which matches
17593 an item in the list.
17594 The default value specifies just this host, being any local interface
17595 for the system.
17596
17597 .option rfc1413_query_timeout main time 0s
17598 .cindex "RFC 1413" "query timeout"
17599 .cindex "timeout" "for RFC 1413 call"
17600 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17601 no RFC 1413 calls are ever made.
17602
17603
17604 .option sender_unqualified_hosts main "host list&!!" unset
17605 .cindex "unqualified addresses"
17606 .cindex "host" "unqualified addresses from"
17607 This option lists those hosts from which Exim is prepared to accept unqualified
17608 sender addresses. The addresses are made fully qualified by the addition of
17609 &%qualify_domain%&. This option also affects message header lines. Exim does
17610 not reject unqualified addresses in headers that contain sender addresses, but
17611 it qualifies them only if the message came from a host that matches
17612 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17613 using TCP/IP), and the &%-bnq%& option was not set.
17614
17615
17616 .option slow_lookup_log main integer 0
17617 .cindex "logging" "slow lookups"
17618 .cindex "dns" "logging slow lookups"
17619 This option controls logging of slow lookups.
17620 If the value is nonzero it is taken as a number of milliseconds
17621 and lookups taking longer than this are logged.
17622 Currently this applies only to DNS lookups.
17623
17624
17625
17626 .option smtp_accept_keepalive main boolean true
17627 .cindex "keepalive" "on incoming connection"
17628 This option controls the setting of the SO_KEEPALIVE option on incoming
17629 TCP/IP socket connections. When set, it causes the kernel to probe idle
17630 connections periodically, by sending packets with &"old"& sequence numbers. The
17631 other end of the connection should send an acknowledgment if the connection is
17632 still okay or a reset if the connection has been aborted. The reason for doing
17633 this is that it has the beneficial effect of freeing up certain types of
17634 connection that can get stuck when the remote host is disconnected without
17635 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17636 hours to detect unreachable hosts.
17637
17638
17639
17640 .option smtp_accept_max main integer 20
17641 .cindex "limit" "incoming SMTP connections"
17642 .cindex "SMTP" "incoming connection count"
17643 .cindex "inetd"
17644 This option specifies the maximum number of simultaneous incoming SMTP calls
17645 that Exim will accept. It applies only to the listening daemon; there is no
17646 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17647 value is set to zero, no limit is applied. However, it is required to be
17648 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17649 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17650
17651 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17652 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17653 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17654 and &%smtp_load_reserve%& are then checked before accepting the connection.
17655
17656
17657 .option smtp_accept_max_nonmail main integer 10
17658 .cindex "limit" "non-mail SMTP commands"
17659 .cindex "SMTP" "limiting non-mail commands"
17660 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17661 the connection if there are too many. This option defines &"too many"&. The
17662 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17663 client looping sending EHLO, for example. The check is applied only if the
17664 client host matches &%smtp_accept_max_nonmail_hosts%&.
17665
17666 When a new message is expected, one occurrence of RSET is not counted. This
17667 allows a client to send one RSET between messages (this is not necessary,
17668 but some clients do it). Exim also allows one uncounted occurrence of HELO
17669 or EHLO, and one occurrence of STARTTLS between messages. After
17670 starting up a TLS session, another EHLO is expected, and so it too is not
17671 counted. The first occurrence of AUTH in a connection, or immediately
17672 following STARTTLS is not counted. Otherwise, all commands other than
17673 MAIL, RCPT, DATA, and QUIT are counted.
17674
17675
17676 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17677 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17678 check by setting this option. The default value makes it apply to all hosts. By
17679 changing the value, you can exclude any badly-behaved hosts that you have to
17680 live with.
17681
17682
17683 . Allow this long option name to split; give it unsplit as a fifth argument
17684 . for the automatic .oindex that is generated by .option.
17685 . We insert " &~&~" which is both pretty nasty visually and results in
17686 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17687 . zero-width-space, which would be nicer visually and results in (at least)
17688 . html that Firefox will split on when it's forced to reflow (rather than
17689 . inserting a horizontal scrollbar).  However, the text is still not
17690 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17691 . the option name to split.
17692
17693 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17694          smtp_accept_max_per_connection
17695 .cindex "SMTP" "limiting incoming message count"
17696 .cindex "limit" "messages per SMTP connection"
17697 The value of this option limits the number of MAIL commands that Exim is
17698 prepared to accept over a single SMTP connection, whether or not each command
17699 results in the transfer of a message. After the limit is reached, a 421
17700 response is given to subsequent MAIL commands. This limit is a safety
17701 precaution against a client that goes mad (incidents of this type have been
17702 seen).
17703 The option is expanded after the HELO or EHLO is received
17704 and may depend on values available at that time.
17705 An empty or zero value after expansion removes the limit.
17706
17707
17708 .option smtp_accept_max_per_host main string&!! unset
17709 .cindex "limit" "SMTP connections from one host"
17710 .cindex "host" "limiting SMTP connections from"
17711 This option restricts the number of simultaneous IP connections from a single
17712 host (strictly, from a single IP address) to the Exim daemon. The option is
17713 expanded, to enable different limits to be applied to different hosts by
17714 reference to &$sender_host_address$&. Once the limit is reached, additional
17715 connection attempts from the same host are rejected with error code 421. This
17716 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17717 of zero imposes no limit. If this option is set greater than zero, it is
17718 required that &%smtp_accept_max%& be non-zero.
17719
17720 &*Warning*&: When setting this option you should not use any expansion
17721 constructions that take an appreciable amount of time. The expansion and test
17722 happen in the main daemon loop, in order to reject additional connections
17723 without forking additional processes (otherwise a denial-of-service attack
17724 could cause a vast number or processes to be created). While the daemon is
17725 doing this processing, it cannot accept any other incoming connections.
17726
17727
17728
17729 .option smtp_accept_queue main integer 0
17730 .cindex "SMTP" "incoming connection count"
17731 .cindex "queueing incoming messages"
17732 .cindex "message" "queueing by SMTP connection count"
17733 If the number of simultaneous incoming SMTP connections being handled via the
17734 listening daemon exceeds this value, messages received by SMTP are just placed
17735 in the queue; no delivery processes are started automatically. The count is
17736 fixed at the start of an SMTP connection. It cannot be updated in the
17737 subprocess that receives messages, and so the queueing or not queueing applies
17738 to all messages received in the same connection.
17739
17740 A value of zero implies no limit, and clearly any non-zero value is useful only
17741 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17742 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17743 various &%-od%&&'x'& command line options.
17744
17745
17746 . See the comment on smtp_accept_max_per_connection
17747
17748 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17749          smtp_accept_queue_per_connection
17750 .cindex "queueing incoming messages"
17751 .cindex "message" "queueing by message count"
17752 This option limits the number of delivery processes that Exim starts
17753 automatically when receiving messages via SMTP, whether via the daemon or by
17754 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17755 and the number of messages received in a single SMTP session exceeds this
17756 number, subsequent messages are placed in the queue, but no delivery processes
17757 are started. This helps to limit the number of Exim processes when a server
17758 restarts after downtime and there is a lot of mail waiting for it on other
17759 systems. On large systems, the default should probably be increased, and on
17760 dial-in client systems it should probably be set to zero (that is, disabled).
17761
17762
17763 .option smtp_accept_reserve main integer 0
17764 .cindex "SMTP" "incoming call count"
17765 .cindex "host" "reserved"
17766 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17767 number of SMTP connections that are reserved for connections from the hosts
17768 that are specified in &%smtp_reserve_hosts%&. The value set in
17769 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17770 restricted to this number of connections; the option specifies a minimum number
17771 of connection slots for them, not a maximum. It is a guarantee that this group
17772 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17773 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17774 individual host.
17775
17776 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17777 set to 5, once there are 45 active connections (from any hosts), new
17778 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17779 provided the other criteria for acceptance are met.
17780
17781
17782 .option smtp_active_hostname main string&!! unset
17783 .cindex "host" "name in SMTP responses"
17784 .cindex "SMTP" "host name in responses"
17785 .vindex "&$primary_hostname$&"
17786 This option is provided for multi-homed servers that want to masquerade as
17787 several different hosts. At the start of an incoming SMTP connection, its value
17788 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17789 responses. For example, it is used as domain name in the response to an
17790 incoming HELO or EHLO command.
17791
17792 .vindex "&$smtp_active_hostname$&"
17793 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17794 is saved with any messages that are received. It is therefore available for use
17795 in routers and transports when the message is later delivered.
17796
17797 If this option is unset, or if its expansion is forced to fail, or if the
17798 expansion results in an empty string, the value of &$primary_hostname$& is
17799 used. Other expansion failures cause a message to be written to the main and
17800 panic logs, and the SMTP command receives a temporary error. Typically, the
17801 value of &%smtp_active_hostname%& depends on the incoming interface address.
17802 For example:
17803 .code
17804 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17805   {cox.mydomain}{box.mydomain}}
17806 .endd
17807
17808 Although &$smtp_active_hostname$& is primarily concerned with incoming
17809 messages, it is also used as the default for HELO commands in callout
17810 verification if there is no remote transport from which to obtain a
17811 &%helo_data%& value.
17812
17813 .option smtp_backlog_monitor main integer 0
17814 .cindex "connection backlog" monitoring
17815 If this option is set to greater than zero, and the backlog of available
17816 TCP connections on a socket listening for SMTP is larger than it, a line
17817 is logged giving the value and the socket address and port.
17818 The value is retrived jsut before an accept call.
17819 This facility is only available on Linux.
17820
17821 .option smtp_banner main string&!! "see below"
17822 .cindex "SMTP" "welcome banner"
17823 .cindex "banner for SMTP"
17824 .cindex "welcome banner for SMTP"
17825 .cindex "customizing" "SMTP banner"
17826 If a connect ACL does not supply a message,
17827 this string (which is expanded every time it is used) is output as the initial
17828 positive response to an SMTP connection. The default setting is:
17829 .code
17830 smtp_banner = $smtp_active_hostname ESMTP Exim \
17831   $version_number $tod_full
17832 .endd
17833 .new
17834 Failure to expand the string causes a panic error;
17835 a forced fail just closes the connection.
17836 .wen
17837 If you want to create a
17838 multiline response to the initial SMTP connection, use &"\n"& in the string at
17839 appropriate points, but not at the end. Note that the 220 code is not included
17840 in this string. Exim adds it automatically (several times in the case of a
17841 multiline response).
17842
17843
17844 .option smtp_check_spool_space main boolean true
17845 .cindex "checking disk space"
17846 .cindex "disk space, checking"
17847 .cindex "spool directory" "checking space"
17848 When this option is set, if an incoming SMTP session encounters the SIZE
17849 option on a MAIL command, it checks that there is enough space in the
17850 spool directory's partition to accept a message of that size, while still
17851 leaving free the amount specified by &%check_spool_space%& (even if that value
17852 is zero). If there isn't enough space, a temporary error code is returned.
17853
17854
17855 .option smtp_connect_backlog main integer 20
17856 .cindex "connection backlog" "set maximum"
17857 .cindex "SMTP" "connection backlog"
17858 .cindex "backlog of connections"
17859 This option specifies a maximum number of waiting SMTP connections. Exim passes
17860 this value to the TCP/IP system when it sets up its listener. Once this number
17861 of connections are waiting for the daemon's attention, subsequent connection
17862 attempts are refused at the TCP/IP level. At least, that is what the manuals
17863 say; in some circumstances such connection attempts have been observed to time
17864 out instead. For large systems it is probably a good idea to increase the
17865 value (to 50, say). It also gives some protection against denial-of-service
17866 attacks by SYN flooding.
17867
17868
17869 .option smtp_enforce_sync main boolean true
17870 .cindex "SMTP" "synchronization checking"
17871 .cindex "synchronization checking in SMTP"
17872 The SMTP protocol specification requires the client to wait for a response from
17873 the server at certain points in the dialogue. Without PIPELINING these
17874 synchronization points are after every command; with PIPELINING they are
17875 fewer, but they still exist.
17876
17877 Some spamming sites send out a complete set of SMTP commands without waiting
17878 for any response. Exim protects against this by rejecting a message if the
17879 client has sent further input when it should not have. The error response &"554
17880 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17881 for this error cannot be perfect because of transmission delays (unexpected
17882 input may be on its way but not yet received when Exim checks). However, it
17883 does detect many instances.
17884
17885 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17886 If you want to disable the check selectively (for example, only for certain
17887 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17888 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17889
17890
17891
17892 .option smtp_etrn_command main string&!! unset
17893 .cindex "ETRN" "command to be run"
17894 .cindex "ESMTP extensions" ETRN
17895 .vindex "&$domain$&"
17896 If this option is set, the given command is run whenever an SMTP ETRN
17897 command is received from a host that is permitted to issue such commands (see
17898 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17899 are independently expanded. The expansion variable &$domain$& is set to the
17900 argument of the ETRN command, and no syntax checking is done on it. For
17901 example:
17902 .code
17903 smtp_etrn_command = /etc/etrn_command $domain \
17904                     $sender_host_address
17905 .endd
17906 If the option is not set, the argument for the ETRN command must
17907 be a &'#'& followed by an address string.
17908 In this case an &'exim -R <string>'& command is used;
17909 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17910
17911 A new process is created to run the command, but Exim does not wait for it to
17912 complete. Consequently, its status cannot be checked. If the command cannot be
17913 run, a line is written to the panic log, but the ETRN caller still receives
17914 a 250 success response. Exim is normally running under its own uid when
17915 receiving SMTP, so it is not possible for it to change the uid before running
17916 the command.
17917
17918
17919 .option smtp_etrn_serialize main boolean true
17920 .cindex "ETRN" "serializing"
17921 When this option is set, it prevents the simultaneous execution of more than
17922 one identical command as a result of ETRN in an SMTP connection. See
17923 section &<<SECTETRN>>& for details.
17924
17925
17926 .option smtp_load_reserve main fixed-point unset
17927 .cindex "load average"
17928 If the system load average ever gets higher than this, incoming SMTP calls are
17929 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17930 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17931 the load is over the limit. The option has no effect on ancient operating
17932 systems on which Exim cannot determine the load average. See also
17933 &%deliver_queue_load_max%& and &%queue_only_load%&.
17934
17935
17936
17937 .option smtp_max_synprot_errors main integer 3
17938 .cindex "SMTP" "limiting syntax and protocol errors"
17939 .cindex "limit" "SMTP syntax and protocol errors"
17940 Exim rejects SMTP commands that contain syntax or protocol errors. In
17941 particular, a syntactically invalid email address, as in this command:
17942 .code
17943 RCPT TO:<abc xyz@a.b.c>
17944 .endd
17945 causes immediate rejection of the command, before any other tests are done.
17946 (The ACL cannot be run if there is no valid address to set up for it.) An
17947 example of a protocol error is receiving RCPT before MAIL. If there are
17948 too many syntax or protocol errors in one SMTP session, the connection is
17949 dropped. The limit is set by this option.
17950
17951 .cindex "PIPELINING" "expected errors"
17952 When the PIPELINING extension to SMTP is in use, some protocol errors are
17953 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17954 Exim assumes that PIPELINING will be used if it advertises it (see
17955 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17956 not count towards the limit.
17957
17958
17959
17960 .option smtp_max_unknown_commands main integer 3
17961 .cindex "SMTP" "limiting unknown commands"
17962 .cindex "limit" "unknown SMTP commands"
17963 If there are too many unrecognized commands in an incoming SMTP session, an
17964 Exim server drops the connection. This is a defence against some kinds of abuse
17965 that subvert web
17966 clients
17967 into making connections to SMTP ports; in these circumstances, a number of
17968 non-SMTP command lines are sent first.
17969
17970
17971
17972 .options smtp_ratelimit_hosts main "host list&!!" unset &&&
17973          smtp_ratelimit_mail main string unset &&&
17974          smtp_ratelimit_rcpt main string unset
17975 .cindex "SMTP" "rate limiting"
17976 .cindex "limit" "rate of message arrival"
17977 .cindex "RCPT" "rate limiting"
17978 Some sites find it helpful to be able to limit the rate at which certain hosts
17979 can send them messages, and the rate at which an individual message can specify
17980 recipients.
17981
17982 Exim has two rate-limiting facilities. This section describes the older
17983 facility, which can limit rates within a single connection. The newer
17984 &%ratelimit%& ACL condition can limit rates across all connections. See section
17985 &<<SECTratelimiting>>& for details of the newer facility.
17986
17987 When a host matches &%smtp_ratelimit_hosts%&, the values of
17988 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17989 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17990 respectively. Each option, if set, must contain a set of four comma-separated
17991 values:
17992
17993 .ilist
17994 A threshold, before which there is no rate limiting.
17995 .next
17996 An initial time delay. Unlike other times in Exim, numbers with decimal
17997 fractional parts are allowed here.
17998 .next
17999 A factor by which to increase the delay each time.
18000 .next
18001 A maximum value for the delay. This should normally be less than 5 minutes,
18002 because after that time, the client is liable to timeout the SMTP command.
18003 .endlist
18004
18005 For example, these settings have been used successfully at the site which
18006 first suggested this feature, for controlling mail from their customers:
18007 .code
18008 smtp_ratelimit_mail = 2,0.5s,1.05,4m
18009 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
18010 .endd
18011 The first setting specifies delays that are applied to MAIL commands after
18012 two have been received over a single connection. The initial delay is 0.5
18013 seconds, increasing by a factor of 1.05 each time. The second setting applies
18014 delays to RCPT commands when more than four occur in a single message.
18015
18016
18017
18018 .option smtp_receive_timeout main time&!! 5m
18019 .cindex "timeout" "for SMTP input"
18020 .cindex "SMTP" "input timeout"
18021 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
18022 input, including batch SMTP. If a line of input (either an SMTP command or a
18023 data line) is not received within this time, the SMTP connection is dropped and
18024 the message is abandoned.
18025 A line is written to the log containing one of the following messages:
18026 .code
18027 SMTP command timeout on connection from...
18028 SMTP data timeout on connection from...
18029 .endd
18030 The former means that Exim was expecting to read an SMTP command; the latter
18031 means that it was in the DATA phase, reading the contents of a message.
18032
18033 If the first character of the option is a &"$"& the option is
18034 expanded before use and may depend on
18035 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18036
18037
18038 .oindex "&%-os%&"
18039 The value set by this option can be overridden by the
18040 &%-os%& command-line option. A setting of zero time disables the timeout, but
18041 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18042 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18043 timeout is controlled by &%receive_timeout%& and &%-or%&.
18044
18045
18046 .option smtp_reserve_hosts main "host list&!!" unset
18047 This option defines hosts for which SMTP connections are reserved; see
18048 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18049
18050
18051 .option smtp_return_error_details main boolean false
18052 .cindex "SMTP" "details policy failures"
18053 .cindex "policy control" "rejection, returning details"
18054 In the default state, Exim uses bland messages such as
18055 &"Administrative prohibition"& when it rejects SMTP commands for policy
18056 reasons. Many sysadmins like this because it gives away little information
18057 to spammers. However, some other sysadmins who are applying strict checking
18058 policies want to give out much fuller information about failures. Setting
18059 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18060 example, instead of &"Administrative prohibition"&, it might give:
18061 .code
18062 550-Rejected after DATA: '>' missing at end of address:
18063 550 failing address in "From" header is: <user@dom.ain
18064 .endd
18065
18066
18067 .option smtputf8_advertise_hosts main "host list&!!" *
18068 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18069 .cindex "ESMTP extensions" SMTPUTF8
18070 When Exim is built with support for internationalised mail names,
18071 the availability thereof is advertised in
18072 response to EHLO only to those client hosts that match this option. See
18073 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18074
18075
18076 .option spamd_address main string "127.0.0.1 783"
18077 This option is available when Exim is compiled with the content-scanning
18078 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18079 See section &<<SECTscanspamass>>& for more details.
18080
18081
18082
18083 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18084 This option is available when Exim is compiled with SPF support.
18085 See section &<<SECSPF>>& for more details.
18086
18087 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18088 This option is available when Exim is compiled with SPF support.  It
18089 allows the customisation of the SMTP comment that the SPF library
18090 generates.  You are strongly encouraged to link to your own explanative
18091 site. The template must not contain spaces. If you need spaces in the
18092 output, use the proper placeholder. If libspf2 can not parse the
18093 template, it uses a built-in default broken link. The following placeholders
18094 (along with Exim variables (but see below)) are allowed in the template:
18095 .ilist
18096 &*%_*&: A space.
18097 .next
18098 &*%{L}*&: Envelope sender's local part.
18099 .next
18100 &*%{S}*&: Envelope sender.
18101 .next
18102 &*%{O}*&: Envelope sender's domain.
18103 .next
18104 &*%{D}*&: Current(?) domain.
18105 .next
18106 &*%{I}*&: SMTP client Ip.
18107 .next
18108 &*%{C}*&: SMTP client pretty IP.
18109 .next
18110 &*%{T}*&: Epoch time (UTC).
18111 .next
18112 &*%{P}*&: SMTP client domain name.
18113 .next
18114 &*%{V}*&: IP version.
18115 .next
18116 &*%{H}*&: EHLO/HELO domain.
18117 .next
18118 &*%{R}*&: Receiving domain.
18119 .endlist
18120 The capitalized placeholders do proper URL encoding, if you use them
18121 lowercased, no encoding takes place.  This list was compiled from the
18122 libspf2 sources.
18123
18124 A note on using Exim variables: As
18125 currently the SPF library is initialized before the SMTP EHLO phase,
18126 the variables useful for expansion are quite limited.
18127
18128
18129 .option split_spool_directory main boolean false
18130 .cindex "multiple spool directories"
18131 .cindex "spool directory" "split"
18132 .cindex "directories, multiple"
18133 If this option is set, it causes Exim to split its input directory into 62
18134 subdirectories, each with a single alphanumeric character as its name. The
18135 sixth character of the message id is used to allocate messages to
18136 subdirectories; this is the least significant base-62 digit of the time of
18137 arrival of the message.
18138
18139 Splitting up the spool in this way may provide better performance on systems
18140 where there are long mail queues, by reducing the number of files in any one
18141 directory. The msglog directory is also split up in a similar way to the input
18142 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18143 are still placed in the single directory &_msglog.OLD_&.
18144
18145 It is not necessary to take any special action for existing messages when
18146 changing &%split_spool_directory%&. Exim notices messages that are in the
18147 &"wrong"& place, and continues to process them. If the option is turned off
18148 after a period of being on, the subdirectories will eventually empty and be
18149 automatically deleted.
18150
18151 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18152 changes. Instead of creating a list of all messages in the queue, and then
18153 trying to deliver each one, in turn, it constructs a list of those in one
18154 sub-directory and tries to deliver them, before moving on to the next
18155 sub-directory. The sub-directories are processed in a random order. This
18156 spreads out the scanning of the input directories, and uses less memory. It is
18157 particularly beneficial when there are lots of messages in the queue. However,
18158 if &%queue_run_in_order%& is set, none of this new processing happens. The
18159 entire queue has to be scanned and sorted before any deliveries can start.
18160
18161
18162 .option spool_directory main string&!! "set at compile time"
18163 .cindex "spool directory" "path to"
18164 This defines the directory in which Exim keeps its spool, that is, the messages
18165 it is waiting to deliver. The default value is taken from the compile-time
18166 configuration setting, if there is one. If not, this option must be set. The
18167 string is expanded, so it can contain, for example, a reference to
18168 &$primary_hostname$&.
18169
18170 If the spool directory name is fixed on your installation, it is recommended
18171 that you set it at build time rather than from this option, particularly if the
18172 log files are being written to the spool directory (see &%log_file_path%&).
18173 Otherwise log files cannot be used for errors that are detected early on, such
18174 as failures in the configuration file.
18175
18176 By using this option to override the compiled-in path, it is possible to run
18177 tests of Exim without using the standard spool.
18178
18179 .option spool_wireformat main boolean false
18180 .cindex "spool directory" "file formats"
18181 If this option is set, Exim may for some messages use an alternative format
18182 for data-files in the spool which matches the wire format.
18183 Doing this permits more efficient message reception and transmission.
18184 Currently it is only done for messages received using the ESMTP CHUNKING
18185 option.
18186
18187 The following variables will not have useful values:
18188 .code
18189 $max_received_linelength
18190 $body_linecount
18191 $body_zerocount
18192 .endd
18193
18194 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18195 and any external programs which are passed a reference to a message data file
18196 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18197 will need to be aware of the different formats potentially available.
18198
18199 Using any of the ACL conditions noted will negate the reception benefit
18200 (as a Unix-mbox-format file is constructed for them).
18201 The transmission benefit is maintained.
18202
18203 .option sqlite_lock_timeout main time 5s
18204 .cindex "sqlite lookup type" "lock timeout"
18205 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18206 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18207
18208 .option strict_acl_vars main boolean false
18209 .cindex "&ACL;" "variables, handling unset"
18210 This option controls what happens if a syntactically valid but undefined ACL
18211 variable is referenced. If it is false (the default), an empty string
18212 is substituted; if it is true, an error is generated. See section
18213 &<<SECTaclvariables>>& for details of ACL variables.
18214
18215 .option strip_excess_angle_brackets main boolean false
18216 .cindex "angle brackets, excess"
18217 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18218 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18219 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18220 passed on to another MTA, the excess angle brackets are not passed on. If this
18221 option is not set, multiple pairs of angle brackets cause a syntax error.
18222
18223
18224 .option strip_trailing_dot main boolean false
18225 .cindex "trailing dot on domain"
18226 .cindex "dot" "trailing on domain"
18227 If this option is set, a trailing dot at the end of a domain in an address is
18228 ignored. If this is in the envelope and the message is passed on to another
18229 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18230 domain causes a syntax error.
18231 However, addresses in header lines are checked only when an ACL requests header
18232 syntax checking.
18233
18234
18235 .option syslog_duplication main boolean true
18236 .cindex "syslog" "duplicate log lines; suppressing"
18237 When Exim is logging to syslog, it writes the log lines for its three
18238 separate logs at different syslog priorities so that they can in principle
18239 be separated on the logging hosts. Some installations do not require this
18240 separation, and in those cases, the duplication of certain log lines is a
18241 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18242 particular log line is written to syslog. For lines that normally go to
18243 both the main log and the reject log, the reject log version (possibly
18244 containing message header lines) is written, at LOG_NOTICE priority.
18245 Lines that normally go to both the main and the panic log are written at
18246 the LOG_ALERT priority.
18247
18248
18249 .option syslog_facility main string unset
18250 .cindex "syslog" "facility; setting"
18251 This option sets the syslog &"facility"& name, used when Exim is logging to
18252 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18253 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18254 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18255 details of Exim's logging.
18256
18257
18258 .option syslog_pid main boolean true
18259 .cindex "syslog" "pid"
18260 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18261 omitted when these lines are sent to syslog. (Syslog normally prefixes
18262 the log lines with the PID of the logging process automatically.) You need
18263 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18264 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18265
18266
18267
18268 .option syslog_processname main string &`exim`&
18269 .cindex "syslog" "process name; setting"
18270 This option sets the syslog &"ident"& name, used when Exim is logging to
18271 syslog. The value must be no longer than 32 characters. See chapter
18272 &<<CHAPlog>>& for details of Exim's logging.
18273
18274
18275
18276 .option syslog_timestamp main boolean true
18277 .cindex "syslog" "timestamps"
18278 .cindex timestamps syslog
18279 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18280 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18281 details of Exim's logging.
18282
18283
18284 .option system_filter main string&!! unset
18285 .cindex "filter" "system filter"
18286 .cindex "system filter" "specifying"
18287 .cindex "Sieve filter" "not available for system filter"
18288 This option specifies an Exim filter file that is applied to all messages at
18289 the start of each delivery attempt, before any routing is done. System filters
18290 must be Exim filters; they cannot be Sieve filters. If the system filter
18291 generates any deliveries to files or pipes, or any new mail messages, the
18292 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18293 which transports are to be used. Details of this facility are given in chapter
18294 &<<CHAPsystemfilter>>&.
18295 A forced expansion failure results in no filter operation.
18296
18297
18298 .option system_filter_directory_transport main string&!! unset
18299 .vindex "&$address_file$&"
18300 This sets the name of the transport driver that is to be used when the
18301 &%save%& command in a system message filter specifies a path ending in &"/"&,
18302 implying delivery of each message into a separate file in some directory.
18303 During the delivery, the variable &$address_file$& contains the path name.
18304
18305
18306 .option system_filter_file_transport main string&!! unset
18307 .cindex "file" "transport for system filter"
18308 This sets the name of the transport driver that is to be used when the &%save%&
18309 command in a system message filter specifies a path not ending in &"/"&. During
18310 the delivery, the variable &$address_file$& contains the path name.
18311
18312 .option system_filter_group main string unset
18313 .cindex "gid (group id)" "system filter"
18314 This option is used only when &%system_filter_user%& is also set. It sets the
18315 gid under which the system filter is run, overriding any gid that is associated
18316 with the user. The value may be numerical or symbolic.
18317
18318 .option system_filter_pipe_transport main string&!! unset
18319 .cindex "&(pipe)& transport" "for system filter"
18320 .vindex "&$address_pipe$&"
18321 This specifies the transport driver that is to be used when a &%pipe%& command
18322 is used in a system filter. During the delivery, the variable &$address_pipe$&
18323 contains the pipe command.
18324
18325
18326 .option system_filter_reply_transport main string&!! unset
18327 .cindex "&(autoreply)& transport" "for system filter"
18328 This specifies the transport driver that is to be used when a &%mail%& command
18329 is used in a system filter.
18330
18331
18332 .option system_filter_user main string unset
18333 .cindex "uid (user id)" "system filter"
18334 If this option is set to root, the system filter is run in the main Exim
18335 delivery process, as root.  Otherwise, the system filter runs in a separate
18336 process, as the given user, defaulting to the Exim run-time user.
18337 Unless the string consists entirely of digits, it
18338 is looked up in the password data. Failure to find the named user causes a
18339 configuration error. The gid is either taken from the password data, or
18340 specified by &%system_filter_group%&. When the uid is specified numerically,
18341 &%system_filter_group%& is required to be set.
18342
18343 If the system filter generates any pipe, file, or reply deliveries, the uid
18344 under which the filter is run is used when transporting them, unless a
18345 transport option overrides.
18346
18347
18348 .option tcp_nodelay main boolean true
18349 .cindex "daemon" "TCP_NODELAY on sockets"
18350 .cindex "Nagle algorithm"
18351 .cindex "TCP_NODELAY on listening sockets"
18352 If this option is set false, it stops the Exim daemon setting the
18353 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18354 turns off the &"Nagle algorithm"&, which is a way of improving network
18355 performance in interactive (character-by-character) situations. Turning it off
18356 should improve Exim's performance a bit, so that is what happens by default.
18357 However, it appears that some broken clients cannot cope, and time out. Hence
18358 this option. It affects only those sockets that are set up for listening by the
18359 daemon. Sockets created by the smtp transport for delivering mail always set
18360 TCP_NODELAY.
18361
18362
18363 .option timeout_frozen_after main time 0s
18364 .cindex "frozen messages" "timing out"
18365 .cindex "timeout" "frozen messages"
18366 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18367 message of any kind that has been in the queue for longer than the given time
18368 is automatically cancelled at the next queue run. If the frozen message is a
18369 bounce message, it is just discarded; otherwise, a bounce is sent to the
18370 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18371 If you want to timeout frozen bounce messages earlier than other kinds of
18372 frozen message, see &%ignore_bounce_errors_after%&.
18373
18374 &*Note:*& the default value of zero means no timeouts; with this setting,
18375 frozen messages remain in the queue forever (except for any frozen bounce
18376 messages that are released by &%ignore_bounce_errors_after%&).
18377
18378
18379 .option timezone main string unset
18380 .cindex "timezone, setting"
18381 .cindex "environment" "values from"
18382 The value of &%timezone%& is used to set the environment variable TZ while
18383 running Exim (if it is different on entry). This ensures that all timestamps
18384 created by Exim are in the required timezone. If you want all your timestamps
18385 to be in UTC (aka GMT) you should set
18386 .code
18387 timezone = UTC
18388 .endd
18389 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18390 or, if that is not set, from the value of the TZ environment variable when Exim
18391 is built. If &%timezone%& is set to the empty string, either at build or run
18392 time, any existing TZ variable is removed from the environment when Exim
18393 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18394 unfortunately not all, operating systems.
18395
18396
18397 .option tls_advertise_hosts main "host list&!!" *
18398 .cindex "TLS" "advertising"
18399 .cindex "encryption" "on SMTP connection"
18400 .cindex "SMTP" "encrypted connection"
18401 .cindex "ESMTP extensions" STARTTLS
18402 When Exim is built with support for TLS encrypted connections, the availability
18403 of the STARTTLS command to set up an encrypted session is advertised in
18404 response to EHLO only to those client hosts that match this option. See
18405 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18406 Note that the default value requires that a certificate be supplied
18407 using the &%tls_certificate%& option.  If TLS support for incoming connections
18408 is not required the &%tls_advertise_hosts%& option should be set empty.
18409
18410
18411 .option tls_alpn main "string list&!!" "smtp : esmtp"
18412 .cindex TLS "Application Layer Protocol Names"
18413 .cindex TLS ALPN
18414 .cindex ALPN "set acceptable names for server"
18415 If this option is set,
18416 the TLS library supports ALPN,
18417 and the client offers either more than one
18418 ALPN name or a name which does not match the list,
18419 the TLS connection is declined.
18420
18421
18422 .option tls_certificate main "string list&!!" unset
18423 .cindex "TLS" "server certificate; location of"
18424 .cindex "certificate" "server, location of"
18425 The value of this option is expanded, and must then be a list of absolute paths to
18426 files which contain the server's certificates (in PEM format).
18427 Commonly only one file is needed.
18428 The server's private key is also
18429 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18430 &<<CHAPTLS>>& for further details.
18431
18432 &*Note*&: The certificates defined by this option are used only when Exim is
18433 receiving incoming messages as a server. If you want to supply certificates for
18434 use when sending messages as a client, you must set the &%tls_certificate%&
18435 option in the relevant &(smtp)& transport.
18436
18437 &*Note*&: If you use filenames based on IP addresses, change the list
18438 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18439
18440 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18441 when a list of more than one
18442 file is used, the &$tls_in_ourcert$& variable is unreliable.
18443 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18444
18445 .cindex SNI "selecting server certificate based on"
18446 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18447 if the OpenSSL build supports TLS extensions and the TLS client sends the
18448 Server Name Indication extension, then this option and others documented in
18449 &<<SECTtlssni>>& will be re-expanded.
18450
18451 If this option is unset or empty a self-signed certificate will be
18452 used.
18453 Under Linux this is generated at daemon startup; on other platforms it will be
18454 generated fresh for every connection.
18455
18456 .option tls_crl main string&!! unset
18457 .cindex "TLS" "server certificate revocation list"
18458 .cindex "certificate" "revocation list for server"
18459 This option specifies a certificate revocation list. The expanded value must
18460 be the name of a file that contains CRLs in PEM format.
18461
18462 Under OpenSSL the option can specify a directory with CRL files.
18463
18464 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18465 for each signing element of the certificate chain (i.e. all but the leaf).
18466 For the file variant this can be multiple PEM blocks in the one file.
18467
18468 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18469
18470
18471 .option tls_dh_max_bits main integer 2236
18472 .cindex "TLS" "D-H bit count"
18473 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18474 the chosen TLS library.  That value might prove to be too high for
18475 interoperability.  This option provides a maximum clamp on the value
18476 suggested, trading off security for interoperability.
18477
18478 The value must be at least 1024.
18479
18480 The value 2236 was chosen because, at time of adding the option, it was the
18481 hard-coded maximum value supported by the NSS cryptographic library, as used
18482 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18483
18484 If you prefer more security and are willing to break some clients, raise this
18485 number.
18486
18487 Note that the value passed to GnuTLS for *generating* a new prime may be a
18488 little less than this figure, because GnuTLS is inexact and may produce a
18489 larger prime than requested.
18490
18491
18492 .option tls_dhparam main string&!! unset
18493 .cindex "TLS" "D-H parameters for server"
18494 The value of this option is expanded and indicates the source of DH parameters
18495 to be used by Exim.
18496
18497 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18498 local DH parameters*&, which has been supported across all versions of Exim.  The
18499 other specific constants available are a fallback so that even when
18500 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18501
18502 If &%tls_dhparam%& is a filename starting with a &`/`&,
18503 then it names a file from which DH
18504 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18505 PKCS#3 representation of the DH prime.  If the file does not exist, for
18506 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18507 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18508 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18509 and treated as though the &%tls_dhparam%& were set to "none".
18510
18511 If this option expands to the string "none", then no DH parameters will be
18512 loaded by Exim.
18513
18514 If this option expands to the string "historic" and Exim is using GnuTLS, then
18515 Exim will attempt to load a file from inside the spool directory.  If the file
18516 does not exist, Exim will attempt to create it.
18517 See section &<<SECTgnutlsparam>>& for further details.
18518
18519 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18520 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18521
18522 In older versions of Exim the default was the 2048 bit prime described in section
18523 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18524 in IKE is assigned number 23.
18525
18526 Otherwise, the option must expand to the name used by Exim for any of a number
18527 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18528 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18529 the number used by IKE, or "default" which corresponds to
18530 &`exim.dev.20160529.3`&.
18531
18532 The available standard primes are:
18533 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18534 &`ike1`&, &`ike2`&, &`ike5`&,
18535 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18536 &`ike22`&, &`ike23`& and &`ike24`&.
18537
18538 The available additional primes are:
18539 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18540
18541 Some of these will be too small to be accepted by clients.
18542 Some may be too large to be accepted by clients.
18543 The open cryptographic community has suspicions about the integrity of some
18544 of the later IKE values, which led into RFC7919 providing new fixed constants
18545 (the "ffdhe" identifiers).
18546
18547 At this point, all of the "ike" values should be considered obsolete;
18548 they are still in Exim to avoid breaking unusual configurations, but are
18549 candidates for removal the next time we have backwards-incompatible changes.
18550 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18551 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18552 SHOULD NOT.
18553 Because of this, Exim regards them as deprecated; if either of the first pair
18554 are used, warnings will be logged in the paniclog, and if any are used then
18555 warnings will be logged in the mainlog.
18556 All four will be removed in a future Exim release.
18557
18558 The TLS protocol does not negotiate an acceptable size for this; clients tend
18559 to hard-drop connections if what is offered by the server is unacceptable,
18560 whether too large or too small, and there's no provision for the client to
18561 tell the server what these constraints are.  Thus, as a server operator, you
18562 need to make an educated guess as to what is most likely to work for your
18563 userbase.
18564
18565 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18566 is most likely to maximise interoperability.  The upper bound comes from
18567 applications using the Mozilla Network Security Services (NSS) library, which
18568 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18569 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18570 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18571 acceptable bound from 1024 to 2048.
18572
18573
18574 .option tls_eccurve main string list&!! &`auto`&
18575 .cindex TLS "EC cryptography"
18576 This option selects EC curves for use by Exim when used with OpenSSL.
18577 It has no effect when Exim is used with GnuTLS
18578 (the equivalent can be done using a priority string for the
18579 &%tls_require_ciphers%& option).
18580
18581 After expansion it must contain
18582 .new
18583 one or (only for OpenSSL versiona 1.1.1 onwards) more
18584 .wen
18585 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18586 Consult your OpenSSL manual for valid curve names.
18587
18588 For OpenSSL versions before (and not including) 1.0.2, the string
18589 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18590 &`auto`& tells the library to choose.
18591
18592 .new
18593 If the option expands to an empty string, the effect is undefined.
18594 .wen
18595
18596
18597 .option tls_ocsp_file main string&!! unset
18598 .cindex TLS "certificate status"
18599 .cindex TLS "OCSP proof file"
18600 This option
18601 must if set expand to the absolute path to a file which contains a current
18602 status proof for the server's certificate, as obtained from the
18603 Certificate Authority.
18604
18605 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18606 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18607
18608 For OpenSSL 1.1.0 or later, and
18609 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18610 of files, to match a list given for the &%tls_certificate%& option.
18611 The ordering of the two lists must match.
18612 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18613
18614 The file(s) should be in DER format,
18615 except for GnuTLS 3.6.3 or later
18616 or for OpenSSL,
18617 when an optional filetype prefix can be used.
18618 The prefix must be one of "DER" or "PEM", followed by
18619 a single space.  If one is used it sets the format for subsequent
18620 files in the list; the initial format is DER.
18621 If multiple proofs are wanted, for multiple chain elements
18622 (this only works under TLS1.3)
18623 they must be coded as a combined OCSP response.
18624
18625 Although GnuTLS will accept PEM files with multiple separate
18626 PEM blobs (ie. separate OCSP responses), it sends them in the
18627 TLS Certificate record interleaved with the certificates of the chain;
18628 although a GnuTLS client is happy with that, an OpenSSL client is not.
18629
18630 .option tls_on_connect_ports main "string list" unset
18631 .cindex SSMTP
18632 .cindex SMTPS
18633 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18634 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18635 set up without waiting for the client to issue a STARTTLS command. For
18636 further details, see section &<<SECTsupobssmt>>&.
18637
18638
18639
18640 .option tls_privatekey main "string list&!!" unset
18641 .cindex "TLS" "server private key; location of"
18642 The value of this option is expanded, and must then be a list of absolute paths to
18643 files which contains the server's private keys.
18644 If this option is unset, or if
18645 the expansion is forced to fail, or the result is an empty string, the private
18646 key is assumed to be in the same file as the server's certificates. See chapter
18647 &<<CHAPTLS>>& for further details.
18648
18649 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18650
18651
18652 .option tls_remember_esmtp main boolean false
18653 .cindex "TLS" "esmtp state; remembering"
18654 .cindex "TLS" "broken clients"
18655 If this option is set true, Exim violates the RFCs by remembering that it is in
18656 &"esmtp"& state after successfully negotiating a TLS session. This provides
18657 support for broken clients that fail to send a new EHLO after starting a
18658 TLS session.
18659
18660
18661 .option tls_require_ciphers main string&!! unset
18662 .cindex "TLS" "requiring specific ciphers"
18663 .cindex "cipher" "requiring specific"
18664 This option controls which ciphers can be used for incoming TLS connections.
18665 The &(smtp)& transport has an option of the same name for controlling outgoing
18666 connections. This option is expanded for each connection, so can be varied for
18667 different clients if required. The value of this option must be a list of
18668 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18669 in somewhat different ways. If GnuTLS is being used, the client controls the
18670 preference order of the available ciphers. Details are given in sections
18671 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18672
18673
18674 .option tls_resumption_hosts main "host list&!!" unset
18675 .cindex TLS resumption
18676 This option controls which connections to offer the TLS resumption feature.
18677 See &<<SECTresumption>>& for details.
18678
18679
18680 .option tls_try_verify_hosts main "host list&!!" unset
18681 .cindex "TLS" "client certificate verification"
18682 .cindex "certificate" "verification of client"
18683 See &%tls_verify_hosts%& below.
18684
18685
18686 .option tls_verify_certificates main string&!! system
18687 .cindex "TLS" "client certificate verification"
18688 .cindex "certificate" "verification of client"
18689 The value of this option is expanded, and must then be either the
18690 word "system"
18691 or the absolute path to
18692 a file or directory containing permitted certificates for clients that
18693 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18694
18695 The "system" value for the option will use a
18696 system default location compiled into the SSL library.
18697 This is not available for GnuTLS versions preceding 3.0.20,
18698 and will be taken as empty; an explicit location
18699 must be specified.
18700
18701 The use of a directory for the option value is not available for GnuTLS versions
18702 preceding 3.3.6 and a single file must be used.
18703
18704 With OpenSSL the certificates specified
18705 explicitly
18706 either by file or directory
18707 are added to those given by the system default location.
18708
18709 These certificates should be for the certificate authorities trusted, rather
18710 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18711 the value is a file then the certificates are sent by Exim as a server to
18712 connecting clients, defining the list of accepted certificate authorities.
18713 Thus the values defined should be considered public data.  To avoid this,
18714 use the explicit directory version. (If your peer is Exim up to 4.85,
18715 using GnuTLS, you may need to send the CAs (thus using the file
18716 variant). Otherwise the peer doesn't send its certificate.)
18717
18718 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18719
18720 A forced expansion failure or setting to an empty string is equivalent to
18721 being unset.
18722
18723
18724 .option tls_verify_hosts main "host list&!!" unset
18725 .cindex "TLS" "client certificate verification"
18726 .cindex "certificate" "verification of client"
18727 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18728 certificates from clients. The expected certificates are defined by
18729 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18730 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18731 &%tls_verify_certificates%& is not set.
18732
18733 Any client that matches &%tls_verify_hosts%& is constrained by
18734 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18735 present one of the listed certificates. If it does not, the connection is
18736 aborted.
18737 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18738 the host to use TLS. It can still send SMTP commands through unencrypted
18739 connections. Forcing a client to use TLS has to be done separately using an
18740 ACL to reject inappropriate commands when the connection is not encrypted.
18741
18742 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18743 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18744 certificate and checks it against &%tls_verify_certificates%&, but does not
18745 abort the connection if there is no certificate or if it does not match. This
18746 state can be detected in an ACL, which makes it possible to implement policies
18747 such as &"accept for relay only if a verified certificate has been received,
18748 but accept for local delivery if encrypted, even without a verified
18749 certificate"&.
18750
18751 Client hosts that match neither of these lists are not asked to present
18752 certificates.
18753
18754
18755 .option trusted_groups main "string list&!!" unset
18756 .cindex "trusted groups"
18757 .cindex "groups" "trusted"
18758 This option is expanded just once, at the start of Exim's processing. If this
18759 option is set, any process that is running in one of the listed groups, or
18760 which has one of them as a supplementary group, is trusted. The groups can be
18761 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18762 details of what trusted callers are permitted to do. If neither
18763 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18764 are trusted.
18765
18766 .option trusted_users main "string list&!!" unset
18767 .cindex "trusted users"
18768 .cindex "user" "trusted"
18769 This option is expanded just once, at the start of Exim's processing. If this
18770 option is set, any process that is running as one of the listed users is
18771 trusted. The users can be specified numerically or by name. See section
18772 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18773 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18774 Exim user are trusted.
18775
18776 .option unknown_login main string&!! unset
18777 .cindex "uid (user id)" "unknown caller"
18778 .vindex "&$caller_uid$&"
18779 This is a specialized feature for use in unusual configurations. By default, if
18780 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18781 gives up. The &%unknown_login%& option can be used to set a login name to be
18782 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18783 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18784 is used for the user's real name (gecos field), unless this has been set by the
18785 &%-F%& option.
18786
18787 .option unknown_username main string unset
18788 See &%unknown_login%&.
18789
18790 .option untrusted_set_sender main "address list&!!" unset
18791 .cindex "trusted users"
18792 .cindex "sender" "setting by untrusted user"
18793 .cindex "untrusted user setting sender"
18794 .cindex "user" "untrusted setting sender"
18795 .cindex "envelope from"
18796 .cindex "envelope sender"
18797 When an untrusted user submits a message to Exim using the standard input, Exim
18798 normally creates an envelope sender address from the user's login and the
18799 default qualification domain. Data from the &%-f%& option (for setting envelope
18800 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18801 is used) is ignored.
18802
18803 However, untrusted users are permitted to set an empty envelope sender address,
18804 to declare that a message should never generate any bounces. For example:
18805 .code
18806 exim -f '<>' user@domain.example
18807 .endd
18808 .vindex "&$sender_ident$&"
18809 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18810 other envelope sender addresses in a controlled way. When it is set, untrusted
18811 users are allowed to set envelope sender addresses that match any of the
18812 patterns in the list. Like all address lists, the string is expanded. The
18813 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18814 users to setting senders that start with their login ids
18815 followed by a hyphen
18816 by a setting like this:
18817 .code
18818 untrusted_set_sender = ^$sender_ident-
18819 .endd
18820 If you want to allow untrusted users to set envelope sender addresses without
18821 restriction, you can use
18822 .code
18823 untrusted_set_sender = *
18824 .endd
18825 The &%untrusted_set_sender%& option applies to all forms of local input, but
18826 only to the setting of the envelope sender. It does not permit untrusted users
18827 to use the other options which trusted user can use to override message
18828 parameters. Furthermore, it does not stop Exim from removing an existing
18829 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18830 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18831 overriding these actions. The handling of the &'Sender:'& header is also
18832 described in section &<<SECTthesenhea>>&.
18833
18834 The log line for a message's arrival shows the envelope sender following
18835 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18836 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18837 envelope sender address, the user's login is shown in parentheses after the
18838 sender address.
18839
18840
18841 .option uucp_from_pattern main string "see below"
18842 .cindex "&""From""& line"
18843 .cindex "UUCP" "&""From""& line"
18844 Some applications that pass messages to an MTA via a command line interface use
18845 an initial line starting with &"From&~"& to pass the envelope sender. In
18846 particular, this is used by UUCP software. Exim recognizes such a line by means
18847 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18848 matches, the sender address is constructed by expanding the contents of
18849 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18850 default pattern recognizes lines in the following two forms:
18851 .code
18852 From ph10 Fri Jan  5 12:35 GMT 1996
18853 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18854 .endd
18855 The pattern can be seen by running
18856 .code
18857 exim -bP uucp_from_pattern
18858 .endd
18859 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18860 year in the second case. The first word after &"From&~"& is matched in the
18861 regular expression by a parenthesized subpattern. The default value for
18862 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18863 (&"ph10"& in the example above) as the message's sender. See also
18864 &%ignore_fromline_hosts%&.
18865
18866
18867 .option uucp_from_sender main string&!! &`$1`&
18868 See &%uucp_from_pattern%& above.
18869
18870
18871 .option warn_message_file main string&!! unset
18872 .cindex "warning of delay" "customizing the message"
18873 .cindex "customizing" "warning message"
18874 This option defines a template file containing paragraphs of text to be used
18875 for constructing the warning message which is sent by Exim when a message has
18876 been in the queue for a specified amount of time, as specified by
18877 &%delay_warning%&. Details of the file's contents are given in chapter
18878 &<<CHAPemsgcust>>&.
18879 .cindex warn_message_file "tainted data"
18880 The option is expanded to give the file path, which must be
18881 absolute and untainted.
18882 See also &%bounce_message_file%&.
18883
18884
18885 .option write_rejectlog main boolean true
18886 .cindex "reject log" "disabling"
18887 If this option is set false, Exim no longer writes anything to the reject log.
18888 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18889 .ecindex IIDconfima
18890 .ecindex IIDmaiconf
18891
18892
18893
18894
18895 . ////////////////////////////////////////////////////////////////////////////
18896 . ////////////////////////////////////////////////////////////////////////////
18897
18898 .chapter "Generic options for routers" "CHAProutergeneric"
18899 .scindex IIDgenoprou1 "options" "generic; for routers"
18900 .scindex IIDgenoprou2 "generic options" "router"
18901 This chapter describes the generic options that apply to all routers.
18902 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18903
18904 For a general description of how a router operates, see sections
18905 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18906 which the preconditions are tested. The order of expansion of the options that
18907 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18908 &%headers_remove%&, &%transport%&.
18909
18910 The name of a router is limited to be &drivernamemax; ASCII characters long;
18911 prior to Exim 4.95 names would be silently truncated at this length, but now
18912 it is enforced.
18913
18914
18915 .option address_data routers string&!! unset
18916 .cindex "router" "data attached to address"
18917 The string is expanded just before the router is run, that is, after all the
18918 precondition tests have succeeded. If the expansion is forced to fail, the
18919 router declines, the value of &%address_data%& remains unchanged, and the
18920 &%more%& option controls what happens next. Other expansion failures cause
18921 delivery of the address to be deferred.
18922
18923 .vindex "&$address_data$&"
18924 When the expansion succeeds, the value is retained with the address, and can be
18925 accessed using the variable &$address_data$& in the current router, subsequent
18926 routers, and the eventual transport.
18927
18928 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18929 that runs a user's filter file, the contents of &$address_data$& are accessible
18930 in the filter. This is not normally a problem, because such data is usually
18931 either not confidential or it &"belongs"& to the current user, but if you do
18932 put confidential data into &$address_data$& you need to remember this point.
18933
18934 Even if the router declines or passes, the value of &$address_data$& remains
18935 with the address, though it can be changed by another &%address_data%& setting
18936 on a subsequent router. If a router generates child addresses, the value of
18937 &$address_data$& propagates to them. This also applies to the special kind of
18938 &"child"& that is generated by a router with the &%unseen%& option.
18939
18940 The idea of &%address_data%& is that you can use it to look up a lot of data
18941 for the address once, and then pick out parts of the data later. For example,
18942 you could use a single LDAP lookup to return a string of the form
18943 .code
18944 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18945 .endd
18946 In the transport you could pick out the mailbox by a setting such as
18947 .code
18948 file = ${extract{mailbox}{$address_data}}
18949 .endd
18950 This makes the configuration file less messy, and also reduces the number of
18951 lookups (though Exim does cache lookups).
18952
18953 See also the &%set%& option below.
18954
18955 .vindex "&$sender_address_data$&"
18956 .vindex "&$address_data$&"
18957 The &%address_data%& facility is also useful as a means of passing information
18958 from one router to another, and from a router to a transport. In addition, if
18959 &$address_data$& is set by a router when verifying a recipient address from an
18960 ACL, it remains available for use in the rest of the ACL statement. After
18961 verifying a sender, the value is transferred to &$sender_address_data$&.
18962
18963
18964
18965 .option address_test routers&!? boolean true
18966 .oindex "&%-bt%&"
18967 .cindex "router" "skipping when address testing"
18968 If this option is set false, the router is skipped when routing is being tested
18969 by means of the &%-bt%& command line option. This can be a convenience when
18970 your first router sends messages to an external scanner, because it saves you
18971 having to set the &"already scanned"& indicator when testing real address
18972 routing.
18973
18974
18975
18976 .option cannot_route_message routers string&!! unset
18977 .cindex "router" "customizing &""cannot route""& message"
18978 .cindex "customizing" "&""cannot route""& message"
18979 This option specifies a text message that is used when an address cannot be
18980 routed because Exim has run out of routers. The default message is
18981 &"Unrouteable address"&. This option is useful only on routers that have
18982 &%more%& set false, or on the very last router in a configuration, because the
18983 value that is used is taken from the last router that is considered. This
18984 includes a router that is skipped because its preconditions are not met, as
18985 well as a router that declines. For example, using the default configuration,
18986 you could put:
18987 .code
18988 cannot_route_message = Remote domain not found in DNS
18989 .endd
18990 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18991 and
18992 .code
18993 cannot_route_message = Unknown local user
18994 .endd
18995 on the final router that checks for local users. If string expansion fails for
18996 this option, the default message is used. Unless the expansion failure was
18997 explicitly forced, a message about the failure is written to the main and panic
18998 logs, in addition to the normal message about the routing failure.
18999
19000
19001 .option caseful_local_part routers boolean false
19002 .cindex "case of local parts"
19003 .cindex "router" "case of local parts"
19004 By default, routers handle the local parts of addresses in a case-insensitive
19005 manner, though the actual case is preserved for transmission with the message.
19006 If you want the case of letters to be significant in a router, you must set
19007 this option true. For individual router options that contain address or local
19008 part lists (for example, &%local_parts%&), case-sensitive matching can be
19009 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
19010 more details.
19011
19012 .vindex "&$local_part$&"
19013 .vindex "&$original_local_part$&"
19014 .vindex "&$parent_local_part$&"
19015 The value of the &$local_part$& variable is forced to lower case while a
19016 router is running unless &%caseful_local_part%& is set. When a router assigns
19017 an address to a transport, the value of &$local_part$& when the transport runs
19018 is the same as it was in the router. Similarly, when a router generates child
19019 addresses by aliasing or forwarding, the values of &$original_local_part$&
19020 and &$parent_local_part$& are those that were used by the redirecting router.
19021
19022 This option applies to the processing of an address by a router. When a
19023 recipient address is being processed in an ACL, there is a separate &%control%&
19024 modifier that can be used to specify case-sensitive processing within the ACL
19025 (see section &<<SECTcontrols>>&).
19026
19027
19028
19029 .option check_local_user routers&!? boolean false
19030 .cindex "local user, checking in router"
19031 .cindex "router" "checking for local user"
19032 .cindex "&_/etc/passwd_&"
19033 .vindex "&$home$&"
19034 When this option is true, Exim checks that the local part of the recipient
19035 address (with affixes removed if relevant) is the name of an account on the
19036 local system. The check is done by calling the &[getpwnam()]& function rather
19037 than trying to read &_/etc/passwd_& directly. This means that other methods of
19038 holding password data (such as NIS) are supported. If the local part is a local
19039 user,
19040 .cindex "tainted data" "de-tainting"
19041 .cindex "de-tainting" "using router check_local_user option"
19042 &$local_part_data$& is set to an untainted version of the local part and
19043 &$home$& is set from the password data. The latter can be tested in other
19044 preconditions that are evaluated after this one (the order of evaluation is
19045 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19046 overridden by &%router_home_directory%&. If the local part is not a local user,
19047 the router is skipped.
19048
19049 If you want to check that the local part is either the name of a local user
19050 or matches something else, you cannot combine &%check_local_user%& with a
19051 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19052 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19053 setting to achieve this. For example:
19054 .code
19055 local_parts = passwd;$local_part : lsearch;/etc/other/users
19056 .endd
19057 Note, however, that the side effects of &%check_local_user%& (such as setting
19058 up a home directory) do not occur when a &(passwd)& lookup is used in a
19059 &%local_parts%& (or any other) precondition.
19060
19061
19062
19063 .option condition routers&!? string&!! unset
19064 .cindex "router" "customized precondition"
19065 This option specifies a general precondition test that has to succeed for the
19066 router to be called. The &%condition%& option is the last precondition to be
19067 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19068 result is a forced failure, or an empty string, or one of the strings &"0"& or
19069 &"no"& or &"false"& (checked without regard to the case of the letters), the
19070 router is skipped, and the address is offered to the next one.
19071
19072 If the result is any other value, the router is run (as this is the last
19073 precondition to be evaluated, all the other preconditions must be true).
19074
19075 This option is unusual in that multiple &%condition%& options may be present.
19076 All &%condition%& options must succeed.
19077
19078 The &%condition%& option provides a means of applying custom conditions to the
19079 running of routers. Note that in the case of a simple conditional expansion,
19080 the default expansion values are exactly what is wanted. For example:
19081 .code
19082 condition = ${if >{$message_age}{600}}
19083 .endd
19084 Because of the default behaviour of the string expansion, this is equivalent to
19085 .code
19086 condition = ${if >{$message_age}{600}{true}{}}
19087 .endd
19088
19089 A multiple condition example, which succeeds:
19090 .code
19091 condition = ${if >{$message_age}{600}}
19092 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19093 condition = foobar
19094 .endd
19095
19096 If the expansion fails (other than forced failure) delivery is deferred. Some
19097 of the other precondition options are common special cases that could in fact
19098 be specified using &%condition%&.
19099
19100 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19101 are far older, and use one set of semantics.  ACLs are newer and when
19102 they were created, the ACL &%condition%& process was given far stricter
19103 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19104 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19105 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19106 Router rules processing behavior.
19107
19108 This is best illustrated in an example:
19109 .code
19110 # If used in an ACL condition will fail with a syntax error, but
19111 # in a router condition any extra characters are treated as a string
19112
19113 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19114 true {yes} {no}}
19115
19116 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19117  {yes} {no}}
19118 .endd
19119 In each example above, the &%if%& statement actually ends after
19120 &"{google.com}}"&.  Since no true or false braces were defined, the
19121 default &%if%& behavior is to return a boolean true or a null answer
19122 (which evaluates to false). The rest of the line is then treated as a
19123 string. So the first example resulted in the boolean answer &"true"&
19124 with the string &" {yes} {no}}"& appended to it. The second example
19125 resulted in the null output (indicating false) with the string
19126 &" {yes} {no}}"& appended to it.
19127
19128 In fact you can put excess forward braces in too.  In the router
19129 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19130 mean something, like after a &"$"& or when required as part of a
19131 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19132 string characters.
19133
19134 Thus, in a Router, the above expansion strings will both always evaluate
19135 true, as the result of expansion is a non-empty string which doesn't
19136 match an explicit false value.  This can be tricky to debug.  By
19137 contrast, in an ACL either of those strings will always result in an
19138 expansion error because the result doesn't look sufficiently boolean.
19139
19140
19141 .option debug_print routers string&!! unset
19142 .cindex "testing" "variables in drivers"
19143 If this option is set and debugging is enabled (see the &%-d%& command line
19144 option) or in address-testing mode (see the &%-bt%& command line option),
19145 the string is expanded and included in the debugging output.
19146 If expansion of the string fails, the error message is written to the debugging
19147 output, and Exim carries on processing.
19148 This option is provided to help with checking out the values of variables and
19149 so on when debugging router configurations. For example, if a &%condition%&
19150 option appears not to be working, &%debug_print%& can be used to output the
19151 variables it references. The output happens after checks for &%domains%&,
19152 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19153 are tested. A newline is added to the text if it does not end with one.
19154 The variable &$router_name$& contains the name of the router.
19155
19156
19157
19158 .option disable_logging routers boolean false
19159 If this option is set true, nothing is logged for any routing errors
19160 or for any deliveries caused by this router. You should not set this option
19161 unless you really, really know what you are doing. See also the generic
19162 transport option of the same name.
19163
19164 .option dnssec_request_domains routers "domain list&!!" *
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_request_domains%& will be done with
19170 the DNSSEC request bit set.
19171 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19172
19173 .option dnssec_require_domains routers "domain list&!!" unset
19174 .cindex "MX record" "security"
19175 .cindex "DNSSEC" "MX lookup"
19176 .cindex "security" "MX lookup"
19177 .cindex "DNS" "DNSSEC"
19178 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19179 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19180 (AD bit) set will be ignored and logged as a host-lookup failure.
19181 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19182
19183
19184 .option domains routers&!? "domain list&!!" unset
19185 .cindex "router" "restricting to specific domains"
19186 .vindex "&$domain_data$&"
19187 If this option is set, the router is skipped unless the current domain matches
19188 the list.
19189 The data returned by the list check
19190 is placed in &$domain_data$& for use in string
19191 expansions of the driver's private options and in the transport.
19192 See section &<<SECTrouprecon>>& for
19193 a list of the order in which preconditions are evaluated.
19194
19195 A complex example, using a file like:
19196 .code
19197 alice@dom1
19198 bill@dom1
19199 maggie@dom1
19200 .endd
19201 and checking both domain and local_part
19202 .code
19203 domains =         ${domain:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19204 local_parts = ${local_part:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19205 .endd
19206
19207
19208
19209 .option driver routers string unset
19210 This option must always be set. It specifies which of the available routers is
19211 to be used.
19212
19213
19214 .option dsn_lasthop routers boolean false
19215 .cindex "DSN" "success"
19216 .cindex "Delivery Status Notification" "success"
19217 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19218 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19219 instead send a success DSN as if the next hop does not support DSN.
19220 Not effective on redirect routers.
19221
19222
19223
19224 .option errors_to routers string&!! unset
19225 .cindex "envelope from"
19226 .cindex "envelope sender"
19227 .cindex "router" "changing address for errors"
19228 If a router successfully handles an address, it may assign the address to a
19229 transport for delivery or it may generate child addresses. In both cases, if
19230 there is a delivery problem during later processing, the resulting bounce
19231 message is sent to the address that results from expanding this string,
19232 provided that the address verifies successfully. The &%errors_to%& option is
19233 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19234
19235 The &%errors_to%& setting associated with an address can be overridden if it
19236 subsequently passes through other routers that have their own &%errors_to%&
19237 settings, or if the message is delivered by a transport with a &%return_path%&
19238 setting.
19239
19240 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19241 the expansion fails to verify, the errors address associated with the incoming
19242 address is used. At top level, this is the envelope sender. A non-forced
19243 expansion failure causes delivery to be deferred.
19244
19245 If an address for which &%errors_to%& has been set ends up being delivered over
19246 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19247 any bounces that are generated by other MTAs on the delivery route are also
19248 sent there. You can set &%errors_to%& to the empty string by either of these
19249 settings:
19250 .code
19251 errors_to =
19252 errors_to = ""
19253 .endd
19254 An expansion item that yields an empty string has the same effect. If you do
19255 this, a locally detected delivery error for addresses processed by this router
19256 no longer gives rise to a bounce message; the error is discarded. If the
19257 address is delivered to a remote host, the return path is set to &`<>`&, unless
19258 overridden by the &%return_path%& option on the transport.
19259
19260 .vindex "&$address_data$&"
19261 If for some reason you want to discard local errors, but use a non-empty
19262 MAIL command for remote delivery, you can preserve the original return
19263 path in &$address_data$& in the router, and reinstate it in the transport by
19264 setting &%return_path%&.
19265
19266 The most common use of &%errors_to%& is to direct mailing list bounces to the
19267 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19268 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19269
19270
19271
19272 .option expn routers&!? boolean true
19273 .cindex "address" "testing"
19274 .cindex "testing" "addresses"
19275 .cindex "EXPN" "router skipping"
19276 .cindex "router" "skipping for EXPN"
19277 If this option is turned off, the router is skipped when testing an address
19278 as a result of processing an SMTP EXPN command. You might, for example,
19279 want to turn it off on a router for users' &_.forward_& files, while leaving it
19280 on for the system alias file.
19281 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19282 are evaluated.
19283
19284 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19285 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19286 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19287
19288
19289
19290 .option fail_verify routers boolean false
19291 .cindex "router" "forcing verification failure"
19292 Setting this option has the effect of setting both &%fail_verify_sender%& and
19293 &%fail_verify_recipient%& to the same value.
19294
19295
19296
19297 .option fail_verify_recipient routers boolean false
19298 If this option is true and an address is accepted by this router when
19299 verifying a recipient, verification fails.
19300
19301
19302
19303 .option fail_verify_sender routers boolean false
19304 If this option is true and an address is accepted by this router when
19305 verifying a sender, verification fails.
19306
19307
19308
19309 .option fallback_hosts routers "string list" unset
19310 .cindex "router" "fallback hosts"
19311 .cindex "fallback" "hosts specified on router"
19312 String expansion is not applied to this option. The argument must be a
19313 colon-separated list of host names or IP addresses. The list separator can be
19314 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19315 each name or address. In fact, the format of each item is exactly the same as
19316 defined for the list of hosts in a &(manualroute)& router (see section
19317 &<<SECTformatonehostitem>>&).
19318
19319 If a router queues an address for a remote transport, this host list is
19320 associated with the address, and used instead of the transport's fallback host
19321 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19322 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19323 transport for further details.
19324
19325
19326 .option group routers string&!! "see below"
19327 .cindex "gid (group id)" "local delivery"
19328 .cindex "local transports" "uid and gid"
19329 .cindex "transport" "local"
19330 .cindex "router" "setting group"
19331 When a router queues an address for a transport, and the transport does not
19332 specify a group, the group given here is used when running the delivery
19333 process.
19334 The group may be specified numerically or by name. If expansion fails, the
19335 error is logged and delivery is deferred.
19336 The default is unset, unless &%check_local_user%& is set, when the default
19337 is taken from the password information. See also &%initgroups%& and &%user%&
19338 and the discussion in chapter &<<CHAPenvironment>>&.
19339
19340
19341
19342 .option headers_add routers list&!! unset
19343 .cindex "header lines" "adding"
19344 .cindex "router" "adding header lines"
19345 This option specifies a list of text headers,
19346 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19347 that is associated with any addresses that are accepted by the router.
19348 Each item is separately expanded, at routing time.  However, this
19349 option has no effect when an address is just being verified. The way in which
19350 the text is used to add header lines at transport time is described in section
19351 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19352 message is in the process of being transported. This means that references to
19353 header lines in string expansions in the transport's configuration do not
19354 &"see"& the added header lines.
19355
19356 The &%headers_add%& option is expanded after &%errors_to%&, but before
19357 &%headers_remove%& and &%transport%&. If an item is empty, or if
19358 an item expansion is forced to fail, the item has no effect. Other expansion
19359 failures are treated as configuration errors.
19360
19361 Unlike most options, &%headers_add%& can be specified multiple times
19362 for a router; all listed headers are added.
19363
19364 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19365 router that has the &%one_time%& option set.
19366
19367 .cindex "duplicate addresses"
19368 .oindex "&%unseen%&"
19369 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19370 additions are deleted when the address is passed on to subsequent routers.
19371 For a &%redirect%& router, if a generated address is the same as the incoming
19372 address, this can lead to duplicate addresses with different header
19373 modifications. Exim does not do duplicate deliveries (except, in certain
19374 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19375 which of the duplicates is discarded, so this ambiguous situation should be
19376 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19377
19378
19379
19380 .option headers_remove routers list&!! unset
19381 .cindex "header lines" "removing"
19382 .cindex "router" "removing header lines"
19383 This option specifies a list of text headers,
19384 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19385 that is associated with any addresses that are accepted by the router.
19386 However, the option has no effect when an address is just being verified.
19387 Each list item is separately expanded, at transport time.
19388 If an item ends in *, it will match any header with the given prefix.
19389 The way in which
19390 the text is used to remove header lines at transport time is described in
19391 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19392 the message is in the process of being transported. This means that references
19393 to header lines in string expansions in the transport's configuration still
19394 &"see"& the original header lines.
19395
19396 The &%headers_remove%& option is handled after &%errors_to%& and
19397 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19398 the item has no effect. Other expansion failures are treated as configuration
19399 errors.
19400
19401 Unlike most options, &%headers_remove%& can be specified multiple times
19402 for a router; all listed headers are removed.
19403
19404 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19405 router that has the &%one_time%& option set.
19406
19407 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19408 removal requests are deleted when the address is passed on to subsequent
19409 routers, and this can lead to problems with duplicates -- see the similar
19410 warning for &%headers_add%& above.
19411
19412 &*Warning 3*&: Because of the separate expansion of the list items,
19413 items that contain a list separator must have it doubled.
19414 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19415
19416
19417
19418 .option ignore_target_hosts routers "host list&!!" unset
19419 .cindex "IP address" "discarding"
19420 .cindex "router" "discarding IP addresses"
19421 Although this option is a host list, it should normally contain IP address
19422 entries rather than names. If any host that is looked up by the router has an
19423 IP address that matches an item in this list, Exim behaves as if that IP
19424 address did not exist. This option allows you to cope with rogue DNS entries
19425 like
19426 .code
19427 remote.domain.example.  A  127.0.0.1
19428 .endd
19429 by setting
19430 .code
19431 ignore_target_hosts = 127.0.0.1
19432 .endd
19433 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19434 discarded in this way, the router declines. In a conventional configuration, an
19435 attempt to mail to such a domain would normally provoke the &"unrouteable
19436 domain"& error, and an attempt to verify an address in the domain would fail.
19437 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19438 router declines if presented with one of the listed addresses.
19439
19440 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19441 means of the first or the second of the following settings, respectively:
19442 .code
19443 ignore_target_hosts = 0.0.0.0/0
19444 ignore_target_hosts = <; 0::0/0
19445 .endd
19446 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19447 in the second line matches all IPv6 addresses.
19448
19449 This option may also be useful for ignoring link-local and site-local IPv6
19450 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19451 is expanded before use as a list, it is possible to make it dependent on the
19452 domain that is being routed.
19453
19454 .vindex "&$host_address$&"
19455 During its expansion, &$host_address$& is set to the IP address that is being
19456 checked.
19457
19458 .option initgroups routers boolean false
19459 .cindex "additional groups"
19460 .cindex "groups" "additional"
19461 .cindex "local transports" "uid and gid"
19462 .cindex "transport" "local"
19463 If the router queues an address for a transport, and this option is true, and
19464 the uid supplied by the router is not overridden by the transport, the
19465 &[initgroups()]& function is called when running the transport to ensure that
19466 any additional groups associated with the uid are set up. See also &%group%&
19467 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19468
19469
19470
19471 .option local_part_prefix routers&!? "string list" unset
19472 .cindex affix "router precondition"
19473 .cindex "router" "prefix for local part"
19474 .cindex "prefix" "for local part, used in router"
19475 If this option is set, the router is skipped unless the local part starts with
19476 one of the given strings, or &%local_part_prefix_optional%& is true. See
19477 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19478 evaluated.
19479
19480 The list is scanned from left to right, and the first prefix that matches is
19481 used. A limited form of wildcard is available; if the prefix begins with an
19482 asterisk, it matches the longest possible sequence of arbitrary characters at
19483 the start of the local part. An asterisk should therefore always be followed by
19484 some character that does not occur in normal local parts.
19485 .cindex "multiple mailboxes"
19486 .cindex "mailbox" "multiple"
19487 Wildcarding can be used to set up multiple user mailboxes, as described in
19488 section &<<SECTmulbox>>&.
19489
19490 .vindex "&$local_part$&"
19491 .vindex "&$local_part_prefix$&"
19492 During the testing of the &%local_parts%& option, and while the router is
19493 running, the prefix is removed from the local part, and is available in the
19494 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19495 the router accepts the address, this remains true during subsequent delivery by
19496 a transport. In particular, the local part that is transmitted in the RCPT
19497 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19498 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19499 the relevant transport.
19500
19501 .vindex &$local_part_prefix_v$&
19502 If wildcarding (above) was used then the part of the prefix matching the
19503 wildcard is available in &$local_part_prefix_v$&.
19504
19505 When an address is being verified, &%local_part_prefix%& affects only the
19506 behaviour of the router. If the callout feature of verification is in use, this
19507 means that the full address, including the prefix, will be used during the
19508 callout.
19509
19510 The prefix facility is commonly used to handle local parts of the form
19511 &%owner-something%&. Another common use is to support local parts of the form
19512 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19513 to tell a user their forwarding is broken &-- by placing a router like this one
19514 immediately before the router that handles &_.forward_& files:
19515 .code
19516 real_localuser:
19517   driver = accept
19518   local_part_prefix = real-
19519   check_local_user
19520   transport = local_delivery
19521 .endd
19522 For security, it would probably be a good idea to restrict the use of this
19523 router to locally-generated messages, using a condition such as this:
19524 .code
19525   condition = ${if match {$sender_host_address}\
19526                          {\N^(|127\.0\.0\.1)$\N}}
19527 .endd
19528
19529 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19530 both conditions must be met if not optional. Care must be taken if wildcards
19531 are used in both a prefix and a suffix on the same router. Different
19532 separator characters must be used to avoid ambiguity.
19533
19534
19535 .option local_part_prefix_optional routers boolean false
19536 See &%local_part_prefix%& above.
19537
19538
19539
19540 .option local_part_suffix routers&!? "string list" unset
19541 .cindex "router" "suffix for local part"
19542 .cindex "suffix for local part" "used in router"
19543 This option operates in the same way as &%local_part_prefix%&, except that the
19544 local part must end (rather than start) with the given string, the
19545 &%local_part_suffix_optional%& option determines whether the suffix is
19546 mandatory, and the wildcard * character, if present, must be the last
19547 character of the suffix. This option facility is commonly used to handle local
19548 parts of the form &%something-request%& and multiple user mailboxes of the form
19549 &%username-foo%&.
19550
19551
19552 .option local_part_suffix_optional routers boolean false
19553 See &%local_part_suffix%& above.
19554
19555
19556
19557 .option local_parts routers&!? "local part list&!!" unset
19558 .cindex "router" "restricting to specific local parts"
19559 .cindex "local part" "checking in router"
19560 The router is run only if the local part of the address matches the list.
19561 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19562 are evaluated, and
19563 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19564 string is expanded, it is possible to make it depend on the domain, for
19565 example:
19566 .code
19567 local_parts = dbm;/usr/local/specials/$domain_data
19568 .endd
19569 .vindex "&$local_part_data$&"
19570 the data returned by the list check
19571 for the local part is placed in the variable &$local_part_data$& for use in
19572 expansions of the router's private options or in the transport.
19573 You might use this option, for
19574 example, if you have a large number of local virtual domains, and you want to
19575 send all postmaster mail to the same place without having to set up an alias in
19576 each virtual domain:
19577 .code
19578 postmaster:
19579   driver = redirect
19580   local_parts = postmaster
19581   data = postmaster@real.domain.example
19582 .endd
19583
19584
19585 .option log_as_local routers boolean "see below"
19586 .cindex "log" "delivery line"
19587 .cindex "delivery" "log line format"
19588 Exim has two logging styles for delivery, the idea being to make local
19589 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19590 recipient address is given just as the local part, without a domain. The use of
19591 this style is controlled by this option. It defaults to true for the &(accept)&
19592 router, and false for all the others. This option applies only when a
19593 router assigns an address to a transport. It has no effect on routers that
19594 redirect addresses.
19595
19596
19597
19598 .option more routers boolean&!! true
19599 The result of string expansion for this option must be a valid boolean value,
19600 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19601 result causes an error, and delivery is deferred. If the expansion is forced to
19602 fail, the default value for the option (true) is used. Other failures cause
19603 delivery to be deferred.
19604
19605 If this option is set false, and the router declines to handle the address, no
19606 further routers are tried, routing fails, and the address is bounced.
19607 .oindex "&%self%&"
19608 However, if the router explicitly passes an address to the following router by
19609 means of the setting
19610 .code
19611 self = pass
19612 .endd
19613 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19614 does not affect the behaviour if one of the precondition tests fails. In that
19615 case, the address is always passed to the next router.
19616
19617 Note that &%address_data%& is not considered to be a precondition. If its
19618 expansion is forced to fail, the router declines, and the value of &%more%&
19619 controls what happens next.
19620
19621
19622 .option pass_on_timeout routers boolean false
19623 .cindex "timeout" "of router"
19624 .cindex "router" "timeout"
19625 If a router times out during a host lookup, it normally causes deferral of the
19626 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19627 router, overriding &%no_more%&. This may be helpful for systems that are
19628 intermittently connected to the Internet, or those that want to pass to a smart
19629 host any messages that cannot immediately be delivered.
19630
19631 There are occasional other temporary errors that can occur while doing DNS
19632 lookups. They are treated in the same way as a timeout, and this option
19633 applies to all of them.
19634
19635
19636
19637 .option pass_router routers string unset
19638 .cindex "router" "go to after &""pass""&"
19639 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19640 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19641 routing to continue, and overriding a false setting of &%more%&. When one of
19642 these routers returns &"pass"&, the address is normally handed on to the next
19643 router in sequence. This can be changed by setting &%pass_router%& to the name
19644 of another router. However (unlike &%redirect_router%&) the named router must
19645 be below the current router, to avoid loops. Note that this option applies only
19646 to the special case of &"pass"&. It does not apply when a router returns
19647 &"decline"& because it cannot handle an address.
19648
19649
19650
19651 .option redirect_router routers string unset
19652 .cindex "router" "start at after redirection"
19653 Sometimes an administrator knows that it is pointless to reprocess addresses
19654 generated from alias or forward files with the same router again. For
19655 example, if an alias file translates real names into login ids there is no
19656 point searching the alias file a second time, especially if it is a large file.
19657
19658 The &%redirect_router%& option can be set to the name of any router instance.
19659 It causes the routing of any generated addresses to start at the named router
19660 instead of at the first router. This option has no effect if the router in
19661 which it is set does not generate new addresses.
19662
19663
19664
19665 .option require_files routers&!? "string list&!!" unset
19666 .cindex "file" "requiring for router"
19667 .cindex "router" "requiring file existence"
19668 This option provides a general mechanism for predicating the running of a
19669 router on the existence or non-existence of certain files or directories.
19670 Before running a router, as one of its precondition tests, Exim works its way
19671 through the &%require_files%& list, expanding each item separately.
19672
19673 Because the list is split before expansion, any colons in expansion items must
19674 be doubled, or the facility for using a different list separator must be used
19675 (&<<SECTlistsepchange>>&).
19676 If any expansion is forced to fail, the item is ignored. Other expansion
19677 failures cause routing of the address to be deferred.
19678
19679 If any expanded string is empty, it is ignored. Otherwise, except as described
19680 below, each string must be a fully qualified file path, optionally preceded by
19681 &"!"&. The paths are passed to the &[stat()]& function to test for the
19682 existence of the files or directories. The router is skipped if any paths not
19683 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19684
19685 .cindex "NFS"
19686 If &[stat()]& cannot determine whether a file exists or not, delivery of
19687 the message is deferred. This can happen when NFS-mounted filesystems are
19688 unavailable.
19689
19690 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19691 options, so you cannot use it to check for the existence of a file in which to
19692 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19693 full list of the order in which preconditions are evaluated.) However, as
19694 these options are all expanded, you can use the &%exists%& expansion condition
19695 to make such tests. The &%require_files%& option is intended for checking files
19696 that the router may be going to use internally, or which are needed by a
19697 transport (e.g., &_.procmailrc_&).
19698
19699 During delivery, the &[stat()]& function is run as root, but there is a
19700 facility for some checking of the accessibility of a file by another user.
19701 This is not a proper permissions check, but just a &"rough"& check that
19702 operates as follows:
19703
19704 If an item in a &%require_files%& list does not contain any forward slash
19705 characters, it is taken to be the user (and optional group, separated by a
19706 comma) to be checked for subsequent files in the list. If no group is specified
19707 but the user is specified symbolically, the gid associated with the uid is
19708 used. For example:
19709 .code
19710 require_files = mail:/some/file
19711 require_files = $local_part_data:$home/.procmailrc
19712 .endd
19713 If a user or group name in a &%require_files%& list does not exist, the
19714 &%require_files%& condition fails.
19715
19716 Exim performs the check by scanning along the components of the file path, and
19717 checking the access for the given uid and gid. It checks for &"x"& access on
19718 directories, and &"r"& access on the final file. Note that this means that file
19719 access control lists, if the operating system has them, are ignored.
19720
19721 &*Warning 1*&: When the router is being run to verify addresses for an
19722 incoming SMTP message, Exim is not running as root, but under its own uid. This
19723 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19724 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19725 user is not permitted to read one of the directories on the file's path.
19726
19727 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19728 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19729 without root access. In this case, if a check for access by a particular user
19730 is requested, Exim creates a subprocess that runs as that user, and tries the
19731 check again in that process.
19732
19733 The default action for handling an unresolved EACCES is to consider it to
19734 be caused by a configuration error, and routing is deferred because the
19735 existence or non-existence of the file cannot be determined. However, in some
19736 circumstances it may be desirable to treat this condition as if the file did
19737 not exist. If the filename (or the exclamation mark that precedes the filename
19738 for non-existence) is preceded by a plus sign, the EACCES error is treated
19739 as if the file did not exist. For example:
19740 .code
19741 require_files = +/some/file
19742 .endd
19743 If the router is not an essential part of verification (for example, it
19744 handles users' &_.forward_& files), another solution is to set the &%verify%&
19745 option false so that the router is skipped when verifying.
19746
19747
19748
19749 .option retry_use_local_part routers boolean "see below"
19750 .cindex "hints database" "retry keys"
19751 .cindex "local part" "in retry keys"
19752 When a delivery suffers a temporary routing failure, a retry record is created
19753 in Exim's hints database. For addresses whose routing depends only on the
19754 domain, the key for the retry record should not involve the local part, but for
19755 other addresses, both the domain and the local part should be included.
19756 Usually, remote routing is of the former kind, and local routing is of the
19757 latter kind.
19758
19759 This option controls whether the local part is used to form the key for retry
19760 hints for addresses that suffer temporary errors while being handled by this
19761 router. The default value is true for any router that has any of
19762 &%check_local_user%&,
19763 &%local_parts%&,
19764 &%condition%&,
19765 &%local_part_prefix%&,
19766 &%local_part_suffix%&,
19767 &%senders%& or
19768 &%require_files%&
19769 set, and false otherwise. Note that this option does not apply to hints keys
19770 for transport delays; they are controlled by a generic transport option of the
19771 same name.
19772
19773 Failing to set this option when it is needed
19774 (because a remote router handles only some of the local-parts for a domain)
19775 can result in incorrect error messages being generated.
19776
19777 The setting of &%retry_use_local_part%& applies only to the router on which it
19778 appears. If the router generates child addresses, they are routed
19779 independently; this setting does not become attached to them.
19780
19781
19782
19783 .option router_home_directory routers string&!! unset
19784 .cindex "router" "home directory for"
19785 .cindex "home directory" "for router"
19786 .vindex "&$home$&"
19787 This option sets a home directory for use while the router is running. (Compare
19788 &%transport_home_directory%&, which sets a home directory for later
19789 transporting.) In particular, if used on a &(redirect)& router, this option
19790 sets a value for &$home$& while a filter is running. The value is expanded;
19791 forced expansion failure causes the option to be ignored &-- other failures
19792 cause the router to defer.
19793
19794 Expansion of &%router_home_directory%& happens immediately after the
19795 &%check_local_user%& test (if configured), before any further expansions take
19796 place.
19797 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19798 are evaluated.)
19799 While the router is running, &%router_home_directory%& overrides the value of
19800 &$home$& that came from &%check_local_user%&.
19801
19802 When a router accepts an address and assigns it to a local transport (including
19803 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19804 delivery), the home directory setting for the transport is taken from the first
19805 of these values that is set:
19806
19807 .ilist
19808 The &%home_directory%& option on the transport;
19809 .next
19810 The &%transport_home_directory%& option on the router;
19811 .next
19812 The password data if &%check_local_user%& is set on the router;
19813 .next
19814 The &%router_home_directory%& option on the router.
19815 .endlist
19816
19817 In other words, &%router_home_directory%& overrides the password data for the
19818 router, but not for the transport.
19819
19820
19821
19822 .option self routers string freeze
19823 .cindex "MX record" "pointing to local host"
19824 .cindex "local host" "MX pointing to"
19825 This option applies to those routers that use a recipient address to find a
19826 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19827 and &(manualroute)& routers.
19828 Certain configurations of the &(queryprogram)& router can also specify a list
19829 of remote hosts.
19830 Usually such routers are configured to send the message to a remote host via an
19831 &(smtp)& transport. The &%self%& option specifies what happens when the first
19832 host on the list turns out to be the local host.
19833 The way in which Exim checks for the local host is described in section
19834 &<<SECTreclocipadd>>&.
19835
19836 Normally this situation indicates either an error in Exim's configuration (for
19837 example, the router should be configured not to process this domain), or an
19838 error in the DNS (for example, the MX should not point to this host). For this
19839 reason, the default action is to log the incident, defer the address, and
19840 freeze the message. The following alternatives are provided for use in special
19841 cases:
19842
19843 .vlist
19844 .vitem &%defer%&
19845 Delivery of the message is tried again later, but the message is not frozen.
19846
19847 .vitem "&%reroute%&: <&'domain'&>"
19848 The domain is changed to the given domain, and the address is passed back to
19849 be reprocessed by the routers. No rewriting of headers takes place. This
19850 behaviour is essentially a redirection.
19851
19852 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19853 The domain is changed to the given domain, and the address is passed back to be
19854 reprocessed by the routers. Any headers that contain the original domain are
19855 rewritten.
19856
19857 .vitem &%pass%&
19858 .oindex "&%more%&"
19859 .vindex "&$self_hostname$&"
19860 The router passes the address to the next router, or to the router named in the
19861 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19862 subsequent routing and delivery, the variable &$self_hostname$& contains the
19863 name of the local host that the router encountered. This can be used to
19864 distinguish between different cases for hosts with multiple names. The
19865 combination
19866 .code
19867 self = pass
19868 no_more
19869 .endd
19870 ensures that only those addresses that routed to the local host are passed on.
19871 Without &%no_more%&, addresses that were declined for other reasons would also
19872 be passed to the next router.
19873
19874 .vitem &%fail%&
19875 Delivery fails and an error report is generated.
19876
19877 .vitem &%send%&
19878 .cindex "local host" "sending to"
19879 The anomaly is ignored and the address is queued for the transport. This
19880 setting should be used with extreme caution. For an &(smtp)& transport, it
19881 makes sense only in cases where the program that is listening on the SMTP port
19882 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19883 different configuration file that handles the domain in another way.
19884 .endlist
19885
19886
19887
19888 .option senders routers&!? "address list&!!" unset
19889 .cindex "router" "checking senders"
19890 If this option is set, the router is skipped unless the message's sender
19891 address matches something on the list.
19892 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19893 are evaluated.
19894
19895 There are issues concerning verification when the running of routers is
19896 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19897 setting, it sets the sender to the null string. When using the &%-bt%& option
19898 to check a configuration file, it is necessary also to use the &%-f%& option to
19899 set an appropriate sender. For incoming mail, the sender is unset when
19900 verifying the sender, but is available when verifying any recipients. If the
19901 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19902 matters.
19903
19904
19905 .option set routers "string list" unset
19906 .cindex router variables
19907 This option may be used multiple times on a router;
19908 because of this the list aspect is mostly irrelevant.
19909 The list separator is a semicolon but can be changed in the
19910 usual way.
19911
19912 Each list-element given must be of the form &"name = value"&
19913 and the names used must start with the string &"r_"&.
19914 Values containing a list-separator should have them doubled.
19915 When a router runs, the strings are evaluated in order,
19916 to create variables which are added to the set associated with
19917 the address.
19918 This is done immediately after all the preconditions, before the
19919 evaluation of the &%address_data%& option.
19920 The variable is set with the expansion of the value.
19921 The variables can be used by the router options
19922 (not including any preconditions)
19923 and by the transport.
19924 Later definitions of a given named variable will override former ones.
19925 Variable use is via the usual &$r_...$& syntax.
19926
19927 This is similar to the &%address_data%& option, except that
19928 many independent variables can be used, with choice of naming.
19929
19930
19931 .option translate_ip_address routers string&!! unset
19932 .cindex "IP address" "translating"
19933 .cindex "packet radio"
19934 .cindex "router" "IP address translation"
19935 There exist some rare networking situations (for example, packet radio) where
19936 it is helpful to be able to translate IP addresses generated by normal routing
19937 mechanisms into other IP addresses, thus performing a kind of manual IP
19938 routing. This should be done only if the normal IP routing of the TCP/IP stack
19939 is inadequate or broken. Because this is an extremely uncommon requirement, the
19940 code to support this option is not included in the Exim binary unless
19941 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19942
19943 .vindex "&$host_address$&"
19944 The &%translate_ip_address%& string is expanded for every IP address generated
19945 by the router, with the generated address set in &$host_address$&. If the
19946 expansion is forced to fail, no action is taken.
19947 For any other expansion error, delivery of the message is deferred.
19948 If the result of the expansion is an IP address, that replaces the original
19949 address; otherwise the result is assumed to be a host name &-- this is looked
19950 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19951 produce one or more replacement IP addresses. For example, to subvert all IP
19952 addresses in some specific networks, this could be added to a router:
19953 .code
19954 translate_ip_address = \
19955   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19956     {$value}fail}}
19957 .endd
19958 The file would contain lines like
19959 .code
19960 10.2.3.128/26    some.host
19961 10.8.4.34/26     10.44.8.15
19962 .endd
19963 You should not make use of this facility unless you really understand what you
19964 are doing.
19965
19966
19967
19968 .option transport routers string&!! unset
19969 This option specifies the transport to be used when a router accepts an address
19970 and sets it up for delivery. A transport is never needed if a router is used
19971 only for verification. The value of the option is expanded at routing time,
19972 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19973 and result must be the name of one of the configured transports. If it is not,
19974 delivery is deferred.
19975
19976 The &%transport%& option is not used by the &(redirect)& router, but it does
19977 have some private options that set up transports for pipe and file deliveries
19978 (see chapter &<<CHAPredirect>>&).
19979
19980
19981
19982 .option transport_current_directory routers string&!! unset
19983 .cindex "current directory for local transport"
19984 This option associates a current directory with any address that is routed
19985 to a local transport. This can happen either because a transport is
19986 explicitly configured for the router, or because it generates a delivery to a
19987 file or a pipe. During the delivery process (that is, at transport time), this
19988 option string is expanded and is set as the current directory, unless
19989 overridden by a setting on the transport.
19990 If the expansion fails for any reason, including forced failure, an error is
19991 logged, and delivery is deferred.
19992 See chapter &<<CHAPenvironment>>& for details of the local delivery
19993 environment.
19994
19995
19996
19997
19998 .option transport_home_directory routers string&!! "see below"
19999 .cindex "home directory" "for local transport"
20000 This option associates a home directory with any address that is routed to a
20001 local transport. This can happen either because a transport is explicitly
20002 configured for the router, or because it generates a delivery to a file or a
20003 pipe. During the delivery process (that is, at transport time), the option
20004 string is expanded and is set as the home directory, unless overridden by a
20005 setting of &%home_directory%& on the transport.
20006 If the expansion fails for any reason, including forced failure, an error is
20007 logged, and delivery is deferred.
20008
20009 If the transport does not specify a home directory, and
20010 &%transport_home_directory%& is not set for the router, the home directory for
20011 the transport is taken from the password data if &%check_local_user%& is set for
20012 the router. Otherwise it is taken from &%router_home_directory%& if that option
20013 is set; if not, no home directory is set for the transport.
20014
20015 See chapter &<<CHAPenvironment>>& for further details of the local delivery
20016 environment.
20017
20018
20019
20020
20021 .option unseen routers boolean&!! false
20022 .cindex "router" "carrying on after success"
20023 The result of string expansion for this option must be a valid boolean value,
20024 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
20025 result causes an error, and delivery is deferred. If the expansion is forced to
20026 fail, the default value for the option (false) is used. Other failures cause
20027 delivery to be deferred.
20028
20029 When this option is set true, routing does not cease if the router accepts the
20030 address. Instead, a copy of the incoming address is passed to the next router,
20031 overriding a false setting of &%more%&. There is little point in setting
20032 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
20033 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20034 sometimes true and sometimes false).
20035
20036 .cindex "copy of message (&%unseen%& option)"
20037 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20038 qualifier in filter files. It can be used to cause copies of messages to be
20039 delivered to some other destination, while also carrying out a normal delivery.
20040 In effect, the current address is made into a &"parent"& that has two children
20041 &-- one that is delivered as specified by this router, and a clone that goes on
20042 to be routed further. For this reason, &%unseen%& may not be combined with the
20043 &%one_time%& option in a &(redirect)& router.
20044
20045 &*Warning*&: Header lines added to the address (or specified for removal) by
20046 this router or by previous routers affect the &"unseen"& copy of the message
20047 only. The clone that continues to be processed by further routers starts with
20048 no added headers and none specified for removal. For a &%redirect%& router, if
20049 a generated address is the same as the incoming address, this can lead to
20050 duplicate addresses with different header modifications. Exim does not do
20051 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20052 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20053 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20054 &%redirect%& router may be of help.
20055
20056 Unlike the handling of header modifications, any data that was set by the
20057 &%address_data%& option in the current or previous routers &'is'& passed on to
20058 subsequent routers.
20059
20060
20061 .option user routers string&!! "see below"
20062 .cindex "uid (user id)" "local delivery"
20063 .cindex "local transports" "uid and gid"
20064 .cindex "transport" "local"
20065 .cindex "router" "user for filter processing"
20066 .cindex "filter" "user for processing"
20067 When a router queues an address for a transport, and the transport does not
20068 specify a user, the user given here is used when running the delivery process.
20069 The user may be specified numerically or by name. If expansion fails, the
20070 error is logged and delivery is deferred.
20071 This user is also used by the &(redirect)& router when running a filter file.
20072 The default is unset, except when &%check_local_user%& is set. In this case,
20073 the default is taken from the password information. If the user is specified as
20074 a name, and &%group%& is not set, the group associated with the user is used.
20075 See also &%initgroups%& and &%group%& and the discussion in chapter
20076 &<<CHAPenvironment>>&.
20077
20078
20079
20080 .option verify routers&!? boolean true
20081 Setting this option has the effect of setting &%verify_sender%& and
20082 &%verify_recipient%& to the same value.
20083
20084
20085 .option verify_only routers&!? boolean false
20086 .cindex "EXPN" "with &%verify_only%&"
20087 .oindex "&%-bv%&"
20088 .cindex "router" "used only when verifying"
20089 If this option is set, the router is used only when verifying an address,
20090 delivering in cutthrough mode or
20091 testing with the &%-bv%& option, not when actually doing a delivery, testing
20092 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20093 restricted to verifying only senders or recipients by means of
20094 &%verify_sender%& and &%verify_recipient%&.
20095
20096 &*Warning*&: When the router is being run to verify addresses for an incoming
20097 SMTP message, Exim is not running as root, but under its own uid. If the router
20098 accesses any files, you need to make sure that they are accessible to the Exim
20099 user or group.
20100
20101
20102 .option verify_recipient routers&!? boolean true
20103 If this option is false, the router is skipped when verifying recipient
20104 addresses,
20105 delivering in cutthrough mode
20106 or testing recipient verification using &%-bv%&.
20107 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20108 are evaluated.
20109 See also the &$verify_mode$& variable.
20110
20111
20112 .option verify_sender routers&!? boolean true
20113 If this option is false, the router is skipped when verifying sender addresses
20114 or testing sender verification using &%-bvs%&.
20115 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20116 are evaluated.
20117 See also the &$verify_mode$& variable.
20118 .ecindex IIDgenoprou1
20119 .ecindex IIDgenoprou2
20120
20121
20122
20123
20124
20125
20126 . ////////////////////////////////////////////////////////////////////////////
20127 . ////////////////////////////////////////////////////////////////////////////
20128
20129 .chapter "The accept router" "CHID4"
20130 .cindex "&(accept)& router"
20131 .cindex "routers" "&(accept)&"
20132 The &(accept)& router has no private options of its own. Unless it is being
20133 used purely for verification (see &%verify_only%&) a transport is required to
20134 be defined by the generic &%transport%& option. If the preconditions that are
20135 specified by generic options are met, the router accepts the address and queues
20136 it for the given transport. The most common use of this router is for setting
20137 up deliveries to local mailboxes. For example:
20138 .code
20139 localusers:
20140   driver = accept
20141   domains = mydomain.example
20142   check_local_user
20143   transport = local_delivery
20144 .endd
20145 The &%domains%& condition in this example checks the domain of the address, and
20146 &%check_local_user%& checks that the local part is the login of a local user.
20147 When both preconditions are met, the &(accept)& router runs, and queues the
20148 address for the &(local_delivery)& transport.
20149
20150
20151
20152
20153
20154
20155 . ////////////////////////////////////////////////////////////////////////////
20156 . ////////////////////////////////////////////////////////////////////////////
20157
20158 .chapter "The dnslookup router" "CHAPdnslookup"
20159 .scindex IIDdnsrou1 "&(dnslookup)& router"
20160 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20161 The &(dnslookup)& router looks up the hosts that handle mail for the
20162 recipient's domain in the DNS. A transport must always be set for this router,
20163 unless &%verify_only%& is set.
20164
20165 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20166 SRV records. If none are found, or if SRV support is not configured,
20167 MX records are looked up. If no MX records exist, address records are sought.
20168 However, &%mx_domains%& can be set to disable the direct use of address
20169 records.
20170
20171 MX records of equal priority are sorted by Exim into a random order. Exim then
20172 looks for address records for the host names obtained from MX or SRV records.
20173 When a host has more than one IP address, they are sorted into a random order,
20174 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20175 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20176 generic option, the router declines.
20177
20178 Unless they have the highest priority (lowest MX value), MX records that point
20179 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20180 are discarded, together with any other MX records of equal or lower priority.
20181
20182 .cindex "MX record" "pointing to local host"
20183 .cindex "local host" "MX pointing to"
20184 .oindex "&%self%&" "in &(dnslookup)& router"
20185 If the host pointed to by the highest priority MX record, or looked up as an
20186 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20187 happens is controlled by the generic &%self%& option.
20188
20189
20190 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20191 There have been problems with DNS servers when SRV records are looked up.
20192 Some misbehaving servers return a DNS error or timeout when a non-existent
20193 SRV record is sought. Similar problems have in the past been reported for
20194 MX records. The global &%dns_again_means_nonexist%& option can help with this
20195 problem, but it is heavy-handed because it is a global option.
20196
20197 For this reason, there are two options, &%srv_fail_domains%& and
20198 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20199 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20200 an attempt to look up an SRV or MX record causes one of these results, and the
20201 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20202 such record"&. In the case of an SRV lookup, this means that the router
20203 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20204 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20205 case routing fails.
20206
20207
20208 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20209 .cindex "&(dnslookup)& router" "declines"
20210 There are a few cases where a &(dnslookup)& router will decline to accept
20211 an address; if such a router is expected to handle "all remaining non-local
20212 domains", then it is important to set &%no_more%&.
20213
20214 The router will defer rather than decline if the domain
20215 is found in the &%fail_defer_domains%& router option.
20216
20217 Reasons for a &(dnslookup)& router to decline currently include:
20218 .ilist
20219 The domain does not exist in DNS
20220 .next
20221 The domain exists but the MX record's host part is just "."; this is a common
20222 convention (borrowed from SRV) used to indicate that there is no such service
20223 for this domain and to not fall back to trying A/AAAA records.
20224 .next
20225 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20226 .next
20227 MX record points to a non-existent host.
20228 .next
20229 MX record points to an IP address and the main section option
20230 &%allow_mx_to_ip%& is not set.
20231 .next
20232 MX records exist and point to valid hosts, but all hosts resolve only to
20233 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20234 .next
20235 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20236 &%dns_check_names_pattern%& for handling one variant of this)
20237 .next
20238 &%check_secondary_mx%& is set on this router but the local host can
20239 not be found in the MX records (see below)
20240 .endlist
20241
20242
20243
20244
20245 .section "Private options for dnslookup" "SECID118"
20246 .cindex "options" "&(dnslookup)& router"
20247 The private options for the &(dnslookup)& router are as follows:
20248
20249 .option check_secondary_mx dnslookup boolean false
20250 .cindex "MX record" "checking for secondary"
20251 If this option is set, the router declines unless the local host is found in
20252 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20253 process domains for which the local host is a secondary mail exchanger
20254 differently to other domains. The way in which Exim decides whether a host is
20255 the local host is described in section &<<SECTreclocipadd>>&.
20256
20257
20258 .option check_srv dnslookup string&!! unset
20259 .cindex "SRV record" "enabling use of"
20260 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20261 addition to MX and address records. The support is disabled by default. To
20262 enable SRV support, set the &%check_srv%& option to the name of the service
20263 required. For example,
20264 .code
20265 check_srv = smtp
20266 .endd
20267 looks for SRV records that refer to the normal smtp service. The option is
20268 expanded, so the service name can vary from message to message or address
20269 to address. This might be helpful if SRV records are being used for a
20270 submission service. If the expansion is forced to fail, the &%check_srv%&
20271 option is ignored, and the router proceeds to look for MX records in the
20272 normal way.
20273
20274 When the expansion succeeds, the router searches first for SRV records for
20275 the given service (it assumes TCP protocol). A single SRV record with a
20276 host name that consists of just a single dot indicates &"no such service for
20277 this domain"&; if this is encountered, the router declines. If other kinds of
20278 SRV record are found, they are used to construct a host list for delivery
20279 according to the rules of RFC 2782. MX records are not sought in this case.
20280
20281 When no SRV records are found, MX records (and address records) are sought in
20282 the traditional way. In other words, SRV records take precedence over MX
20283 records, just as MX records take precedence over address records. Note that
20284 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20285 defined it. It is apparently believed that MX records are sufficient for email
20286 and that SRV records should not be used for this purpose. However, SRV records
20287 have an additional &"weight"& feature which some people might find useful when
20288 trying to split an SMTP load between hosts of different power.
20289
20290 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20291 when there is a DNS lookup error.
20292
20293
20294
20295
20296 .option fail_defer_domains dnslookup "domain list&!!" unset
20297 .cindex "MX record" "not found"
20298 DNS lookups for domains matching &%fail_defer_domains%&
20299 which find no matching record will cause the router to defer
20300 rather than the default behaviour of decline.
20301 This maybe be useful for queueing messages for a newly created
20302 domain while the DNS configuration is not ready.
20303 However, it will result in any message with mistyped domains
20304 also being queued.
20305
20306
20307 .option ipv4_only "string&!!" unset
20308 .cindex IPv6 disabling
20309 .cindex DNS "IPv6 disabling"
20310 The string is expanded, and if the result is anything but a forced failure,
20311 or an empty string, or one of the strings “0” or “no” or “false”
20312 (checked without regard to the case of the letters),
20313 only A records are used.
20314
20315 .option ipv4_prefer "string&!!" unset
20316 .cindex IPv4 preference
20317 .cindex DNS "IPv4 preference"
20318 The string is expanded, and if the result is anything but a forced failure,
20319 or an empty string, or one of the strings “0” or “no” or “false”
20320 (checked without regard to the case of the letters),
20321 A records are sorted before AAAA records (inverting the default).
20322
20323 .option mx_domains dnslookup "domain list&!!" unset
20324 .cindex "MX record" "required to exist"
20325 .cindex "SRV record" "required to exist"
20326 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20327 record in order to be recognized. (The name of this option could be improved.)
20328 For example, if all the mail hosts in &'fict.example'& are known to have MX
20329 records, except for those in &'discworld.fict.example'&, you could use this
20330 setting:
20331 .code
20332 mx_domains = ! *.discworld.fict.example : *.fict.example
20333 .endd
20334 This specifies that messages addressed to a domain that matches the list but
20335 has no MX record should be bounced immediately instead of being routed using
20336 the address record.
20337
20338
20339 .option mx_fail_domains dnslookup "domain list&!!" unset
20340 If the DNS lookup for MX records for one of the domains in this list causes a
20341 DNS lookup error, Exim behaves as if no MX records were found. See section
20342 &<<SECTprowitdnsloo>>& for more discussion.
20343
20344
20345
20346
20347 .option qualify_single dnslookup boolean true
20348 .cindex "DNS" "resolver options"
20349 .cindex "DNS" "qualifying single-component names"
20350 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20351 lookups. Typically, but not standardly, this causes the resolver to qualify
20352 single-component names with the default domain. For example, on a machine
20353 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20354 &'thesaurus.ref.example'& inside the resolver. For details of what your
20355 resolver actually does, consult your man pages for &'resolver'& and
20356 &'resolv.conf'&.
20357
20358
20359
20360 .option rewrite_headers dnslookup boolean true
20361 .cindex "rewriting" "header lines"
20362 .cindex "header lines" "rewriting"
20363 If the domain name in the address that is being processed is not fully
20364 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20365 an address is specified as &'dormouse@teaparty'&, the domain might be
20366 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20367 occur as a result of setting the &%widen_domains%& option. If
20368 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20369 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20370 header lines of the message are rewritten with the full domain name.
20371
20372 This option should be turned off only when it is known that no message is
20373 ever going to be sent outside an environment where the abbreviation makes
20374 sense.
20375
20376 When an MX record is looked up in the DNS and matches a wildcard record, name
20377 servers normally return a record containing the name that has been looked up,
20378 making it impossible to detect whether a wildcard was present or not. However,
20379 some name servers have recently been seen to return the wildcard entry. If the
20380 name returned by a DNS lookup begins with an asterisk, it is not used for
20381 header rewriting.
20382
20383
20384 .option same_domain_copy_routing dnslookup boolean false
20385 .cindex "address" "copying routing"
20386 Addresses with the same domain are normally routed by the &(dnslookup)& router
20387 to the same list of hosts. However, this cannot be presumed, because the router
20388 options and preconditions may refer to the local part of the address. By
20389 default, therefore, Exim routes each address in a message independently. DNS
20390 servers run caches, so repeated DNS lookups are not normally expensive, and in
20391 any case, personal messages rarely have more than a few recipients.
20392
20393 If you are running mailing lists with large numbers of subscribers at the same
20394 domain, and you are using a &(dnslookup)& router which is independent of the
20395 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20396 lookups for identical domains in one message. In this case, when &(dnslookup)&
20397 routes an address to a remote transport, any other unrouted addresses in the
20398 message that have the same domain are automatically given the same routing
20399 without processing them independently,
20400 provided the following conditions are met:
20401
20402 .ilist
20403 No router that processed the address specified &%headers_add%& or
20404 &%headers_remove%&.
20405 .next
20406 The router did not change the address in any way, for example, by &"widening"&
20407 the domain.
20408 .endlist
20409
20410
20411
20412
20413 .option search_parents dnslookup boolean false
20414 .cindex "DNS" "resolver options"
20415 When this option is true, the resolver option RES_DNSRCH is set for DNS
20416 lookups. This is different from the &%qualify_single%& option in that it
20417 applies to domains containing dots. Typically, but not standardly, it causes
20418 the resolver to search for the name in the current domain and in parent
20419 domains. For example, on a machine in the &'fict.example'& domain, if looking
20420 up &'teaparty.wonderland'& failed, the resolver would try
20421 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20422 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20423
20424 Setting this option true can cause problems in domains that have a wildcard MX
20425 record, because any domain that does not have its own MX record matches the
20426 local wildcard.
20427
20428
20429
20430 .option srv_fail_domains dnslookup "domain list&!!" unset
20431 If the DNS lookup for SRV records for one of the domains in this list causes a
20432 DNS lookup error, Exim behaves as if no SRV records were found. See section
20433 &<<SECTprowitdnsloo>>& for more discussion.
20434
20435
20436
20437
20438 .option widen_domains dnslookup "string list" unset
20439 .cindex "domain" "partial; widening"
20440 If a DNS lookup fails and this option is set, each of its strings in turn is
20441 added onto the end of the domain, and the lookup is tried again. For example,
20442 if
20443 .code
20444 widen_domains = fict.example:ref.example
20445 .endd
20446 is set and a lookup of &'klingon.dictionary'& fails,
20447 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20448 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20449 and &%search_parents%& options can cause some widening to be undertaken inside
20450 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20451 when verifying, unless &%rewrite_headers%& is false (not the default).
20452
20453
20454 .section "Effect of qualify_single and search_parents" "SECID119"
20455 When a domain from an envelope recipient is changed by the resolver as a result
20456 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20457 corresponding address in the message's header lines unless &%rewrite_headers%&
20458 is set false. Exim then re-routes the address, using the full domain.
20459
20460 These two options affect only the DNS lookup that takes place inside the router
20461 for the domain of the address that is being routed. They do not affect lookups
20462 such as that implied by
20463 .code
20464 domains = @mx_any
20465 .endd
20466 that may happen while processing a router precondition before the router is
20467 entered. No widening ever takes place for these lookups.
20468 .ecindex IIDdnsrou1
20469 .ecindex IIDdnsrou2
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479 . ////////////////////////////////////////////////////////////////////////////
20480 . ////////////////////////////////////////////////////////////////////////////
20481
20482 .chapter "The ipliteral router" "CHID5"
20483 .cindex "&(ipliteral)& router"
20484 .cindex "domain literal" "routing"
20485 .cindex "routers" "&(ipliteral)&"
20486 This router has no private options. Unless it is being used purely for
20487 verification (see &%verify_only%&) a transport is required to be defined by the
20488 generic &%transport%& option. The router accepts the address if its domain part
20489 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20490 router handles the address
20491 .code
20492 root@[192.168.1.1]
20493 .endd
20494 by setting up delivery to the host with that IP address. IPv4 domain literals
20495 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20496 are similar, but the address is preceded by &`ipv6:`&. For example:
20497 .code
20498 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20499 .endd
20500 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20501 grounds that sooner or later somebody will try it.
20502
20503 .oindex "&%self%&" "in &(ipliteral)& router"
20504 If the IP address matches something in &%ignore_target_hosts%&, the router
20505 declines. If an IP literal turns out to refer to the local host, the generic
20506 &%self%& option determines what happens.
20507
20508 The RFCs require support for domain literals; however, their use is
20509 controversial in today's Internet. If you want to use this router, you must
20510 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20511 Exim will not recognize the domain literal syntax in addresses.
20512
20513
20514
20515 . ////////////////////////////////////////////////////////////////////////////
20516 . ////////////////////////////////////////////////////////////////////////////
20517
20518 .chapter "The iplookup router" "CHID6"
20519 .cindex "&(iplookup)& router"
20520 .cindex "routers" "&(iplookup)&"
20521 The &(iplookup)& router was written to fulfil a specific requirement in
20522 Cambridge University (which in fact no longer exists). For this reason, it is
20523 not included in the binary of Exim by default. If you want to include it, you
20524 must set
20525 .code
20526 ROUTER_IPLOOKUP=yes
20527 .endd
20528 in your &_Local/Makefile_& configuration file.
20529
20530 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20531 connection to one or more specific hosts. The host can then return the same or
20532 a different address &-- in effect rewriting the recipient address in the
20533 message's envelope. The new address is then passed on to subsequent routers. If
20534 this process fails, the address can be passed on to other routers, or delivery
20535 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20536 must not be specified for it.
20537
20538 .cindex "options" "&(iplookup)& router"
20539 .option hosts iplookup string unset
20540 This option must be supplied. Its value is a colon-separated list of host
20541 names. The hosts are looked up using &[gethostbyname()]&
20542 (or &[getipnodebyname()]& when available)
20543 and are tried in order until one responds to the query. If none respond, what
20544 happens is controlled by &%optional%&.
20545
20546
20547 .option optional iplookup boolean false
20548 If &%optional%& is true, if no response is obtained from any host, the address
20549 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20550 delivery to the address is deferred.
20551
20552
20553 .option port iplookup integer 0
20554 .cindex "port" "&(iplookup)& router"
20555 This option must be supplied. It specifies the port number for the TCP or UDP
20556 call.
20557
20558
20559 .option protocol iplookup string udp
20560 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20561 protocols is to be used.
20562
20563
20564 .option query iplookup string&!! "see below"
20565 This defines the content of the query that is sent to the remote hosts. The
20566 default value is:
20567 .code
20568 $local_part@$domain $local_part@$domain
20569 .endd
20570 The repetition serves as a way of checking that a response is to the correct
20571 query in the default case (see &%response_pattern%& below).
20572
20573
20574 .option reroute iplookup string&!! unset
20575 If this option is not set, the rerouted address is precisely the byte string
20576 returned by the remote host, up to the first white space, if any. If set, the
20577 string is expanded to form the rerouted address. It can include parts matched
20578 in the response by &%response_pattern%& by means of numeric variables such as
20579 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20580 whether or not a pattern is in use. In all cases, the rerouted address must end
20581 up in the form &'local_part@domain'&.
20582
20583
20584 .option response_pattern iplookup string unset
20585 This option can be set to a regular expression that is applied to the string
20586 returned from the remote host. If the pattern does not match the response, the
20587 router declines. If &%response_pattern%& is not set, no checking of the
20588 response is done, unless the query was defaulted, in which case there is a
20589 check that the text returned after the first white space is the original
20590 address. This checks that the answer that has been received is in response to
20591 the correct question. For example, if the response is just a new domain, the
20592 following could be used:
20593 .code
20594 response_pattern = ^([^@]+)$
20595 reroute = $local_part@$1
20596 .endd
20597
20598 .option timeout iplookup time 5s
20599 This specifies the amount of time to wait for a response from the remote
20600 machine. The same timeout is used for the &[connect()]& function for a TCP
20601 call. It does not apply to UDP.
20602
20603
20604
20605
20606 . ////////////////////////////////////////////////////////////////////////////
20607 . ////////////////////////////////////////////////////////////////////////////
20608
20609 .chapter "The manualroute router" "CHID7"
20610 .scindex IIDmanrou1 "&(manualroute)& router"
20611 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20612 .cindex "domain" "manually routing"
20613 The &(manualroute)& router is so-called because it provides a way of manually
20614 routing an address according to its domain. It is mainly used when you want to
20615 route addresses to remote hosts according to your own rules, bypassing the
20616 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20617 route to local transports, a facility that may be useful if you want to save
20618 messages for dial-in hosts in local files.
20619
20620 The &(manualroute)& router compares a list of domain patterns with the domain
20621 it is trying to route. If there is no match, the router declines. Each pattern
20622 has associated with it a list of hosts and some other optional data, which may
20623 include a transport. The combination of a pattern and its data is called a
20624 &"routing rule"&. For patterns that do not have an associated transport, the
20625 generic &%transport%& option must specify a transport, unless the router is
20626 being used purely for verification (see &%verify_only%&).
20627
20628 .vindex "&$host$&"
20629 In the case of verification, matching the domain pattern is sufficient for the
20630 router to accept the address. When actually routing an address for delivery,
20631 an address that matches a domain pattern is queued for the associated
20632 transport. If the transport is not a local one, a host list must be associated
20633 with the pattern; IP addresses are looked up for the hosts, and these are
20634 passed to the transport along with the mail address. For local transports, a
20635 host list is optional. If it is present, it is passed in &$host$& as a single
20636 text string.
20637
20638 The list of routing rules can be provided as an inline string in
20639 &%route_list%&, or the data can be obtained by looking up the domain in a file
20640 or database by setting &%route_data%&. Only one of these settings may appear in
20641 any one instance of &(manualroute)&. The format of routing rules is described
20642 below, following the list of private options.
20643
20644
20645 .section "Private options for manualroute" "SECTprioptman"
20646
20647 .cindex "options" "&(manualroute)& router"
20648 The private options for the &(manualroute)& router are as follows:
20649
20650 .option host_all_ignored manualroute string defer
20651 See &%host_find_failed%&.
20652
20653 .option host_find_failed manualroute string freeze
20654 This option controls what happens when &(manualroute)& tries to find an IP
20655 address for a host, and the host does not exist. The option can be set to one
20656 of the following values:
20657 .code
20658 decline
20659 defer
20660 fail
20661 freeze
20662 ignore
20663 pass
20664 .endd
20665 The default (&"freeze"&) assumes that this state is a serious configuration
20666 error. The difference between &"pass"& and &"decline"& is that the former
20667 forces the address to be passed to the next router (or the router defined by
20668 &%pass_router%&),
20669 .oindex "&%more%&"
20670 overriding &%no_more%&, whereas the latter passes the address to the next
20671 router only if &%more%& is true.
20672
20673 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20674 cannot be found. If all the hosts in the list are ignored, the behaviour is
20675 controlled by the &%host_all_ignored%& option. This takes the same values
20676 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20677
20678 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20679 state; if a host lookup gets a temporary error, delivery is deferred unless the
20680 generic &%pass_on_timeout%& option is set.
20681
20682
20683 .option hosts_randomize manualroute boolean false
20684 .cindex "randomized host list"
20685 .cindex "host" "list of; randomized"
20686 If this option is set, the order of the items in a host list in a routing rule
20687 is randomized each time the list is used, unless an option in the routing rule
20688 overrides (see below). Randomizing the order of a host list can be used to do
20689 crude load sharing. However, if more than one mail address is routed by the
20690 same router to the same host list, the host lists are considered to be the same
20691 (even though they may be randomized into different orders) for the purpose of
20692 deciding whether to batch the deliveries into a single SMTP transaction.
20693
20694 When &%hosts_randomize%& is true, a host list may be split
20695 into groups whose order is separately randomized. This makes it possible to
20696 set up MX-like behaviour. The boundaries between groups are indicated by an
20697 item that is just &`+`& in the host list. For example:
20698 .code
20699 route_list = * host1:host2:host3:+:host4:host5
20700 .endd
20701 The order of the first three hosts and the order of the last two hosts is
20702 randomized for each use, but the first three always end up before the last two.
20703 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20704 randomized host list is passed to an &(smtp)& transport that also has
20705 &%hosts_randomize set%&, the list is not re-randomized.
20706
20707
20708 .option route_data manualroute string&!! unset
20709 If this option is set, it must expand to yield the data part of a routing rule.
20710 Typically, the expansion string includes a lookup based on the domain. For
20711 example:
20712 .code
20713 route_data = ${lookup{$domain}dbm{/etc/routes}}
20714 .endd
20715 If the expansion is forced to fail, or the result is an empty string, the
20716 router declines. Other kinds of expansion failure cause delivery to be
20717 deferred.
20718
20719
20720 .option route_list manualroute "string list" unset
20721 This string is a list of routing rules, in the form defined below. Note that,
20722 unlike most string lists, the items are separated by semicolons. This is so
20723 that they may contain colon-separated host lists.
20724
20725
20726 .option same_domain_copy_routing manualroute boolean false
20727 .cindex "address" "copying routing"
20728 Addresses with the same domain are normally routed by the &(manualroute)&
20729 router to the same list of hosts. However, this cannot be presumed, because the
20730 router options and preconditions may refer to the local part of the address. By
20731 default, therefore, Exim routes each address in a message independently. DNS
20732 servers run caches, so repeated DNS lookups are not normally expensive, and in
20733 any case, personal messages rarely have more than a few recipients.
20734
20735 If you are running mailing lists with large numbers of subscribers at the same
20736 domain, and you are using a &(manualroute)& router which is independent of the
20737 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20738 lookups for identical domains in one message. In this case, when
20739 &(manualroute)& routes an address to a remote transport, any other unrouted
20740 addresses in the message that have the same domain are automatically given the
20741 same routing without processing them independently. However, this is only done
20742 if &%headers_add%& and &%headers_remove%& are unset.
20743
20744
20745
20746
20747 .section "Routing rules in route_list" "SECID120"
20748 The value of &%route_list%& is a string consisting of a sequence of routing
20749 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20750 entered as two semicolons. Alternatively, the list separator can be changed as
20751 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20752 Empty rules are ignored. The format of each rule is
20753 .display
20754 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20755 .endd
20756 The following example contains two rules, each with a simple domain pattern and
20757 no options:
20758 .code
20759 route_list = \
20760   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20761   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20762 .endd
20763 The three parts of a rule are separated by white space. The pattern and the
20764 list of hosts can be enclosed in quotes if necessary, and if they are, the
20765 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20766 single domain pattern, which is the only mandatory item in the rule. The
20767 pattern is in the same format as one item in a domain list (see section
20768 &<<SECTdomainlist>>&),
20769 except that it may not be the name of an interpolated file.
20770 That is, it may be wildcarded, or a regular expression, or a file or database
20771 lookup (with semicolons doubled, because of the use of semicolon as a separator
20772 in a &%route_list%&).
20773
20774 The rules in &%route_list%& are searched in order until one of the patterns
20775 matches the domain that is being routed. The list of hosts and then options are
20776 then used as described below. If there is no match, the router declines. When
20777 &%route_list%& is set, &%route_data%& must not be set.
20778
20779
20780
20781 .section "Routing rules in route_data" "SECID121"
20782 The use of &%route_list%& is convenient when there are only a small number of
20783 routing rules. For larger numbers, it is easier to use a file or database to
20784 hold the routing information, and use the &%route_data%& option instead.
20785 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20786 Most commonly, &%route_data%& is set as a string that contains an
20787 expansion lookup. For example, suppose we place two routing rules in a file
20788 like this:
20789 .code
20790 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20791 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20792 .endd
20793 This data can be accessed by setting
20794 .code
20795 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20796 .endd
20797 Failure of the lookup results in an empty string, causing the router to
20798 decline. However, you do not have to use a lookup in &%route_data%&. The only
20799 requirement is that the result of expanding the string is a list of hosts,
20800 possibly followed by options, separated by white space. The list of hosts must
20801 be enclosed in quotes if it contains white space.
20802
20803
20804
20805
20806 .section "Format of the list of hosts" "SECID122"
20807 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20808 always separately expanded before use. If the expansion fails, the router
20809 declines. The result of the expansion must be a colon-separated list of names
20810 and/or IP addresses, optionally also including ports.
20811 If the list is written with spaces, it must be protected with quotes.
20812 The format of each item
20813 in the list is described in the next section. The list separator can be changed
20814 as described in section &<<SECTlistsepchange>>&.
20815
20816 If the list of hosts was obtained from a &%route_list%& item, the following
20817 variables are set during its expansion:
20818
20819 .ilist
20820 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20821 If the domain was matched against a regular expression, the numeric variables
20822 &$1$&, &$2$&, etc. may be set. For example:
20823 .code
20824 route_list = ^domain(\d+)   host-$1.text.example
20825 .endd
20826 .next
20827 &$0$& is always set to the entire domain.
20828 .next
20829 &$1$& is also set when partial matching is done in a file lookup.
20830
20831 .next
20832 .vindex "&$value$&"
20833 If the pattern that matched the domain was a lookup item, the data that was
20834 looked up is available in the expansion variable &$value$&. For example:
20835 .code
20836 route_list = lsearch;;/some/file.routes  $value
20837 .endd
20838 .endlist
20839
20840 Note the doubling of the semicolon in the pattern that is necessary because
20841 semicolon is the default route list separator.
20842
20843
20844
20845 .section "Format of one host item" "SECTformatonehostitem"
20846 Each item in the list of hosts can be either a host name or an IP address,
20847 optionally with an attached port number, or it can be a single "+"
20848 (see &%hosts_randomize%&).
20849 When no port is given, an IP address
20850 is not enclosed in brackets. When a port is specified, it overrides the port
20851 specification on the transport. The port is separated from the name or address
20852 by a colon. This leads to some complications:
20853
20854 .ilist
20855 Because colon is the default separator for the list of hosts, either
20856 the colon that specifies a port must be doubled, or the list separator must
20857 be changed. The following two examples have the same effect:
20858 .code
20859 route_list = * "host1.tld::1225 : host2.tld::1226"
20860 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20861 .endd
20862 .next
20863 When IPv6 addresses are involved, it gets worse, because they contain
20864 colons of their own. To make this case easier, it is permitted to
20865 enclose an IP address (either v4 or v6) in square brackets if a port
20866 number follows. For example:
20867 .code
20868 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20869 .endd
20870 .endlist
20871
20872 .section "How the list of hosts is used" "SECThostshowused"
20873 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20874 the hosts is tried, in the order specified, when carrying out the SMTP
20875 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20876 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20877 transport.
20878
20879 Hosts may be listed by name or by IP address. An unadorned name in the list of
20880 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20881 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20882 records in the DNS. For example:
20883 .code
20884 route_list = *  x.y.z:p.q.r/MX:e.f.g
20885 .endd
20886 If this feature is used with a port specifier, the port must come last. For
20887 example:
20888 .code
20889 route_list = *  dom1.tld/mx::1225
20890 .endd
20891 If the &%hosts_randomize%& option is set, the order of the items in the list is
20892 randomized before any lookups are done. Exim then scans the list; for any name
20893 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20894 be an interface on the local host and the item is not the first in the list,
20895 Exim discards it and any subsequent items. If it is the first item, what
20896 happens is controlled by the
20897 .oindex "&%self%&" "in &(manualroute)& router"
20898 &%self%& option of the router.
20899
20900 A name on the list that is followed by &`/MX`& is replaced with the list of
20901 hosts obtained by looking up MX records for the name. This is always a DNS
20902 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20903 below) are not relevant here. The order of these hosts is determined by the
20904 preference values in the MX records, according to the usual rules. Because
20905 randomizing happens before the MX lookup, it does not affect the order that is
20906 defined by MX preferences.
20907
20908 If the local host is present in the sublist obtained from MX records, but is
20909 not the most preferred host in that list, it and any equally or less
20910 preferred hosts are removed before the sublist is inserted into the main list.
20911
20912 If the local host is the most preferred host in the MX list, what happens
20913 depends on where in the original list of hosts the &`/MX`& item appears. If it
20914 is not the first item (that is, there are previous hosts in the main list),
20915 Exim discards this name and any subsequent items in the main list.
20916
20917 If the MX item is first in the list of hosts, and the local host is the
20918 most preferred host, what happens is controlled by the &%self%& option of the
20919 router.
20920
20921 DNS failures when lookup up the MX records are treated in the same way as DNS
20922 failures when looking up IP addresses: &%pass_on_timeout%& and
20923 &%host_find_failed%& are used when relevant.
20924
20925 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20926 whether obtained from an MX lookup or not.
20927
20928
20929
20930 .section "How the options are used" "SECThowoptused"
20931 The options are a sequence of words, space-separated.
20932 One of the words can be the name of a transport; this overrides the
20933 &%transport%& option on the router for this particular routing rule only. The
20934 other words (if present) control randomization of the list of hosts on a
20935 per-rule basis, and how the IP addresses of the hosts are to be found when
20936 routing to a remote transport. These options are as follows:
20937
20938 .ilist
20939 &%randomize%&: randomize the order of the hosts in this list, overriding the
20940 setting of &%hosts_randomize%& for this routing rule only.
20941 .next
20942 &%no_randomize%&: do not randomize the order of the hosts in this list,
20943 overriding the setting of &%hosts_randomize%& for this routing rule only.
20944 .next
20945 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20946 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20947 also look in &_/etc/hosts_& or other sources of information.
20948 .next
20949 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20950 no address records are found. If there is a temporary DNS error (such as a
20951 timeout), delivery is deferred.
20952 .next
20953 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20954 .next
20955 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20956 .endlist
20957
20958 For example:
20959 .code
20960 route_list = domain1  host1:host2:host3  randomize bydns;\
20961              domain2  host4:host5
20962 .endd
20963 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20964 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20965 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20966 or &[gethostbyname()]&, and the result of the lookup is the result of that
20967 call.
20968
20969 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20970 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20971 instead of TRY_AGAIN. That is why the default action is to try a DNS
20972 lookup first. Only if that gives a definite &"no such host"& is the local
20973 function called.
20974
20975 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20976 inadvertent constraint that a transport name as an option had to be the last
20977 option specified.
20978
20979
20980
20981 If no IP address for a host can be found, what happens is controlled by the
20982 &%host_find_failed%& option.
20983
20984 .vindex "&$host$&"
20985 When an address is routed to a local transport, IP addresses are not looked up.
20986 The host list is passed to the transport in the &$host$& variable.
20987
20988
20989
20990 .section "Manualroute examples" "SECID123"
20991 In some of the examples that follow, the presence of the &%remote_smtp%&
20992 transport, as defined in the default configuration file, is assumed:
20993
20994 .ilist
20995 .cindex "smart host" "example router"
20996 The &(manualroute)& router can be used to forward all external mail to a
20997 &'smart host'&. If you have set up, in the main part of the configuration, a
20998 named domain list that contains your local domains, for example:
20999 .code
21000 domainlist local_domains = my.domain.example
21001 .endd
21002 You can arrange for all other domains to be routed to a smart host by making
21003 your first router something like this:
21004 .code
21005 smart_route:
21006   driver = manualroute
21007   domains = !+local_domains
21008   transport = remote_smtp
21009   route_list = * smarthost.ref.example
21010 .endd
21011 This causes all non-local addresses to be sent to the single host
21012 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
21013 they are tried in order
21014 (but you can use &%hosts_randomize%& to vary the order each time).
21015 Another way of configuring the same thing is this:
21016 .code
21017 smart_route:
21018   driver = manualroute
21019   transport = remote_smtp
21020   route_list = !+local_domains  smarthost.ref.example
21021 .endd
21022 There is no difference in behaviour between these two routers as they stand.
21023 However, they behave differently if &%no_more%& is added to them. In the first
21024 example, the router is skipped if the domain does not match the &%domains%&
21025 precondition; the following router is always tried. If the router runs, it
21026 always matches the domain and so can never decline. Therefore, &%no_more%&
21027 would have no effect. In the second case, the router is never skipped; it
21028 always runs. However, if it doesn't match the domain, it declines. In this case
21029 &%no_more%& would prevent subsequent routers from running.
21030
21031 .next
21032 .cindex "mail hub example"
21033 A &'mail hub'& is a host which receives mail for a number of domains via MX
21034 records in the DNS and delivers it via its own private routing mechanism. Often
21035 the final destinations are behind a firewall, with the mail hub being the one
21036 machine that can connect to machines both inside and outside the firewall. The
21037 &(manualroute)& router is usually used on a mail hub to route incoming messages
21038 to the correct hosts. For a small number of domains, the routing can be inline,
21039 using the &%route_list%& option, but for a larger number a file or database
21040 lookup is easier to manage.
21041
21042 If the domain names are in fact the names of the machines to which the mail is
21043 to be sent by the mail hub, the configuration can be quite simple. For
21044 example:
21045 .code
21046 hub_route:
21047   driver = manualroute
21048   transport = remote_smtp
21049   route_list = *.rhodes.tvs.example  $domain
21050 .endd
21051 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21052 whose names are the same as the mail domains. A similar approach can be taken
21053 if the host name can be obtained from the domain name by a string manipulation
21054 that the expansion facilities can handle. Otherwise, a lookup based on the
21055 domain can be used to find the host:
21056 .code
21057 through_firewall:
21058   driver = manualroute
21059   transport = remote_smtp
21060   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21061 .endd
21062 The result of the lookup must be the name or IP address of the host (or
21063 hosts) to which the address is to be routed. If the lookup fails, the route
21064 data is empty, causing the router to decline. The address then passes to the
21065 next router.
21066
21067 .next
21068 .cindex "batched SMTP output example"
21069 .cindex "SMTP" "batched outgoing; example"
21070 You can use &(manualroute)& to deliver messages to pipes or files in batched
21071 SMTP format for onward transportation by some other means. This is one way of
21072 storing mail for a dial-up host when it is not connected. The route list entry
21073 can be as simple as a single domain name in a configuration like this:
21074 .code
21075 save_in_file:
21076   driver = manualroute
21077   transport = batchsmtp_appendfile
21078   route_list = saved.domain.example
21079 .endd
21080 though often a pattern is used to pick up more than one domain. If there are
21081 several domains or groups of domains with different transport requirements,
21082 different transports can be listed in the routing information:
21083 .code
21084 save_in_file:
21085   driver = manualroute
21086   route_list = \
21087     *.saved.domain1.example  $domain  batch_appendfile; \
21088     *.saved.domain2.example  \
21089       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21090       batch_pipe
21091 .endd
21092 .vindex "&$domain$&"
21093 .vindex "&$host$&"
21094 The first of these just passes the domain in the &$host$& variable, which
21095 doesn't achieve much (since it is also in &$domain$&), but the second does a
21096 file lookup to find a value to pass, causing the router to decline to handle
21097 the address if the lookup fails.
21098
21099 .next
21100 .cindex "UUCP" "example of router for"
21101 Routing mail directly to UUCP software is a specific case of the use of
21102 &(manualroute)& in a gateway to another mail environment. This is an example of
21103 one way it can be done:
21104 .code
21105 # Transport
21106 uucp:
21107   driver = pipe
21108   user = nobody
21109   command = /usr/local/bin/uux -r - \
21110     ${substr_-5:$host}!rmail ${local_part}
21111   return_fail_output = true
21112
21113 # Router
21114 uucphost:
21115   transport = uucp
21116   driver = manualroute
21117   route_data = \
21118     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21119 .endd
21120 The file &_/usr/local/exim/uucphosts_& contains entries like
21121 .code
21122 darksite.ethereal.example:           darksite.UUCP
21123 .endd
21124 It can be set up more simply without adding and removing &".UUCP"& but this way
21125 makes clear the distinction between the domain name
21126 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21127 .endlist
21128 .ecindex IIDmanrou1
21129 .ecindex IIDmanrou2
21130
21131
21132
21133
21134
21135
21136
21137
21138 . ////////////////////////////////////////////////////////////////////////////
21139 . ////////////////////////////////////////////////////////////////////////////
21140
21141 .chapter "The queryprogram router" "CHAPdriverlast"
21142 .scindex IIDquerou1 "&(queryprogram)& router"
21143 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21144 .cindex "routing" "by external program"
21145 The &(queryprogram)& router routes an address by running an external command
21146 and acting on its output. This is an expensive way to route, and is intended
21147 mainly for use in lightly-loaded systems, or for performing experiments.
21148 However, if it is possible to use the precondition options (&%domains%&,
21149 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21150 be used in special cases, even on a busy host. There are the following private
21151 options:
21152 .cindex "options" "&(queryprogram)& router"
21153
21154 .option command queryprogram string&!! unset
21155 This option must be set. It specifies the command that is to be run. The
21156 command is split up into a command name and arguments, and then each is
21157 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21158 &<<CHAPpipetransport>>&).
21159
21160
21161 .option command_group queryprogram string unset
21162 .cindex "gid (group id)" "in &(queryprogram)& router"
21163 This option specifies a gid to be set when running the command while routing an
21164 address for deliver. It must be set if &%command_user%& specifies a numerical
21165 uid. If it begins with a digit, it is interpreted as the numerical value of the
21166 gid. Otherwise it is looked up using &[getgrnam()]&.
21167
21168
21169 .option command_user queryprogram string unset
21170 .cindex "uid (user id)" "for &(queryprogram)&"
21171 This option must be set. It specifies the uid which is set when running the
21172 command while routing an address for delivery. If the value begins with a digit,
21173 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21174 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21175 not set, a value for the gid also.
21176
21177 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21178 root, which it does during a normal delivery in a conventional configuration.
21179 However, when an address is being verified during message reception, Exim is
21180 usually running as the Exim user, not as root. If the &(queryprogram)& router
21181 is called from a non-root process, Exim cannot change uid or gid before running
21182 the command. In this circumstance the command runs under the current uid and
21183 gid.
21184
21185
21186 .option current_directory queryprogram string /
21187 This option specifies an absolute path which is made the current directory
21188 before running the command.
21189
21190
21191 .option timeout queryprogram time 1h
21192 If the command does not complete within the timeout period, its process group
21193 is killed and the message is frozen. A value of zero time specifies no
21194 timeout.
21195
21196
21197 The standard output of the command is connected to a pipe, which is read when
21198 the command terminates. It should consist of a single line of output,
21199 containing up to five fields, separated by white space. The maximum length of
21200 the line is 1023 characters. Longer lines are silently truncated. The first
21201 field is one of the following words (case-insensitive):
21202
21203 .ilist
21204 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21205 below).
21206 .next
21207 &'Decline'&: the router declines; pass the address to the next router, unless
21208 &%no_more%& is set.
21209 .next
21210 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21211 subsequent text on the line is an error message. If the router is run as part
21212 of address verification during an incoming SMTP message, the message is
21213 included in the SMTP response.
21214 .next
21215 &'Defer'&: routing could not be completed at this time; try again later. Any
21216 subsequent text on the line is an error message which is logged. It is not
21217 included in any SMTP response.
21218 .next
21219 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21220 .next
21221 &'Pass'&: pass the address to the next router (or the router specified by
21222 &%pass_router%&), overriding &%no_more%&.
21223 .next
21224 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21225 new addresses, which are routed independently, starting with the first router,
21226 or the router specified by &%redirect_router%&, if set.
21227 .endlist
21228
21229 When the first word is &'accept'&, the remainder of the line consists of a
21230 number of keyed data values, as follows (split into two lines here, to fit on
21231 the page):
21232 .code
21233 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21234 LOOKUP=byname|bydns DATA=<text>
21235 .endd
21236 The data items can be given in any order, and all are optional. If no transport
21237 is included, the transport specified by the generic &%transport%& option is
21238 used. The list of hosts and the lookup type are needed only if the transport is
21239 an &(smtp)& transport that does not itself supply a list of hosts.
21240
21241 The format of the list of hosts is the same as for the &(manualroute)& router.
21242 As well as host names and IP addresses with optional port numbers, as described
21243 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21244 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21245 (see section &<<SECThostshowused>>&).
21246
21247 If the lookup type is not specified, Exim behaves as follows when trying to
21248 find an IP address for each host: First, a DNS lookup is done. If this yields
21249 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21250 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21251 result of the lookup is the result of that call.
21252
21253 .vindex "&$address_data$&"
21254 If the DATA field is set, its value is placed in the &$address_data$&
21255 variable. For example, this return line
21256 .code
21257 accept hosts=x1.y.example:x2.y.example data="rule1"
21258 .endd
21259 routes the address to the default transport, passing a list of two hosts. When
21260 the transport runs, the string &"rule1"& is in &$address_data$&.
21261 .ecindex IIDquerou1
21262 .ecindex IIDquerou2
21263
21264
21265
21266
21267 . ////////////////////////////////////////////////////////////////////////////
21268 . ////////////////////////////////////////////////////////////////////////////
21269
21270 .chapter "The redirect router" "CHAPredirect"
21271 .scindex IIDredrou1 "&(redirect)& router"
21272 .scindex IIDredrou2 "routers" "&(redirect)&"
21273 .cindex "alias file" "in a &(redirect)& router"
21274 .cindex "address redirection" "&(redirect)& router"
21275 The &(redirect)& router handles several kinds of address redirection. Its most
21276 common uses are for resolving local part aliases from a central alias file
21277 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21278 files, but it has many other potential uses. The incoming address can be
21279 redirected in several different ways:
21280
21281 .ilist
21282 It can be replaced by one or more new addresses which are themselves routed
21283 independently.
21284 .next
21285 It can be routed to be delivered to a given file or directory.
21286 .next
21287 It can be routed to be delivered to a specified pipe command.
21288 .next
21289 It can cause an automatic reply to be generated.
21290 .next
21291 It can be forced to fail, optionally with a custom error message.
21292 .next
21293 It can be temporarily deferred, optionally with a custom message.
21294 .next
21295 It can be discarded.
21296 .endlist
21297
21298 The generic &%transport%& option must not be set for &(redirect)& routers.
21299 However, there are some private options which define transports for delivery to
21300 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21301 &%pipe_transport%& and &%reply_transport%& descriptions below.
21302
21303 If success DSNs have been requested
21304 .cindex "DSN" "success"
21305 .cindex "Delivery Status Notification" "success"
21306 redirection triggers one and the DSN options are not passed any further.
21307
21308
21309
21310 .section "Redirection data" "SECID124"
21311 The router operates by interpreting a text string which it obtains either by
21312 expanding the contents of the &%data%& option, or by reading the entire
21313 contents of a file whose name is given in the &%file%& option. These two
21314 options are mutually exclusive. The first is commonly used for handling system
21315 aliases, in a configuration like this:
21316 .code
21317 system_aliases:
21318   driver = redirect
21319   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21320 .endd
21321 If the lookup fails, the expanded string in this example is empty. When the
21322 expansion of &%data%& results in an empty string, the router declines. A forced
21323 expansion failure also causes the router to decline; other expansion failures
21324 cause delivery to be deferred.
21325
21326 A configuration using &%file%& is commonly used for handling users'
21327 &_.forward_& files, like this:
21328 .code
21329 userforward:
21330   driver = redirect
21331   check_local_user
21332   file = $home/.forward
21333   no_verify
21334 .endd
21335 If the file does not exist, or causes no action to be taken (for example, it is
21336 empty or consists only of comments), the router declines. &*Warning*&: This
21337 is not the case when the file contains syntactically valid items that happen to
21338 yield empty addresses, for example, items containing only RFC 2822 address
21339 comments.
21340
21341 .cindex "tainted data" "in filenames"
21342 .cindex redirect "tainted data"
21343 Tainted data may not be used for a filename.
21344
21345 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21346 directly for redirection,
21347 as they are provided by a potential attacker.
21348 In the examples above, &$local_part$& is used for looking up data held locally
21349 on the system, and not used directly (the second example derives &$home$& via
21350 the passsword file or database, using &$local_part$&).
21351
21352
21353
21354 .section "Forward files and address verification" "SECID125"
21355 .cindex "address redirection" "while verifying"
21356 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21357 &_.forward_& files, as in the example above. There are two reasons for this:
21358
21359 .ilist
21360 When Exim is receiving an incoming SMTP message from a remote host, it is
21361 running under the Exim uid, not as root. Exim is unable to change uid to read
21362 the file as the user, and it may not be able to read it as the Exim user. So in
21363 practice the router may not be able to operate.
21364 .next
21365 However, even when the router can operate, the existence of a &_.forward_& file
21366 is unimportant when verifying an address. What should be checked is whether the
21367 local part is a valid user name or not. Cutting out the redirection processing
21368 saves some resources.
21369 .endlist
21370
21371
21372
21373
21374
21375
21376 .section "Interpreting redirection data" "SECID126"
21377 .cindex "Sieve filter" "specifying in redirection data"
21378 .cindex "filter" "specifying in redirection data"
21379 The contents of the data string, whether obtained from &%data%& or &%file%&,
21380 can be interpreted in two different ways:
21381
21382 .ilist
21383 If the &%allow_filter%& option is set true, and the data begins with the text
21384 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21385 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21386 respectively. Details of the syntax and semantics of filter files are described
21387 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21388 document is intended for use by end users.
21389 .next
21390 Otherwise, the data must be a comma-separated list of redirection items, as
21391 described in the next section.
21392 .endlist
21393
21394 When a message is redirected to a file (a &"mail folder"&), the filename given
21395 in a non-filter redirection list must always be an absolute path. A filter may
21396 generate a relative path &-- how this is handled depends on the transport's
21397 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21398 for the &(appendfile)& transport.
21399
21400
21401
21402 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21403 .cindex "address redirection" "non-filter list items"
21404 When the redirection data is not an Exim or Sieve filter, for example, if it
21405 comes from a conventional alias or forward file, it consists of a list of
21406 addresses, filenames, pipe commands, or certain special items (see section
21407 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21408 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21409 depending on their default values. The items in the list are separated by
21410 commas or newlines.
21411 If a comma is required in an item, the entire item must be enclosed in double
21412 quotes.
21413
21414 Lines starting with a # character are comments, and are ignored, and # may
21415 also appear following a comma, in which case everything between the # and the
21416 next newline character is ignored.
21417
21418 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21419 double quotes are retained because some forms of mail address require their use
21420 (but never to enclose the entire address). In the following description,
21421 &"item"& refers to what remains after any surrounding double quotes have been
21422 removed.
21423
21424 .vindex "&$local_part$&"
21425 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21426 and the expansion contains a reference to &$local_part$&, you should make use
21427 of the &%quote_local_part%& expansion operator, in case the local part contains
21428 special characters. For example, to redirect all mail for the domain
21429 &'obsolete.example'&, retaining the existing local part, you could use this
21430 setting:
21431 .code
21432 data = ${quote_local_part:$local_part}@newdomain.example
21433 .endd
21434
21435
21436 .section "Redirecting to a local mailbox" "SECTredlocmai"
21437 .cindex "routing" "loops in"
21438 .cindex "loop" "while routing, avoidance of"
21439 .cindex "address redirection" "to local mailbox"
21440 A redirection item may safely be the same as the address currently under
21441 consideration. This does not cause a routing loop, because a router is
21442 automatically skipped if any ancestor of the address that is being processed
21443 is the same as the current address and was processed by the current router.
21444 Such an address is therefore passed to the following routers, so it is handled
21445 as if there were no redirection. When making this loop-avoidance test, the
21446 complete local part, including any prefix or suffix, is used.
21447
21448 .cindex "address redirection" "local part without domain"
21449 Specifying the same local part without a domain is a common usage in personal
21450 filter files when the user wants to have messages delivered to the local
21451 mailbox and also forwarded elsewhere. For example, the user whose login is
21452 &'cleo'& might have a &_.forward_& file containing this:
21453 .code
21454 cleo, cleopatra@egypt.example
21455 .endd
21456 .cindex "backslash in alias file"
21457 .cindex "alias file" "backslash in"
21458 For compatibility with other MTAs, such unqualified local parts may be
21459 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21460 it does make a difference if more than one domain is being handled
21461 synonymously.
21462
21463 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21464 2822 address that does not include a domain, the item is qualified using the
21465 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21466 addresses are qualified using the value in &%qualify_recipient%&, but you can
21467 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21468
21469 Care must be taken if there are alias names for local users.
21470 Consider an MTA handling a single local domain where the system alias file
21471 contains:
21472 .code
21473 Sam.Reman: spqr
21474 .endd
21475 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21476 messages in the local mailbox, and also forward copies elsewhere. He creates
21477 this forward file:
21478 .code
21479 Sam.Reman, spqr@reme.elsewhere.example
21480 .endd
21481 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21482 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21483 second time round, because it has previously routed it,
21484 and the following routers presumably cannot handle the alias. The forward file
21485 should really contain
21486 .code
21487 spqr, spqr@reme.elsewhere.example
21488 .endd
21489 but because this is such a common error, the &%check_ancestor%& option (see
21490 below) exists to provide a way to get round it. This is normally set on a
21491 &(redirect)& router that is handling users' &_.forward_& files.
21492
21493
21494
21495 .section "Special items in redirection lists" "SECTspecitredli"
21496 In addition to addresses, the following types of item may appear in redirection
21497 lists (that is, in non-filter redirection data):
21498
21499 .ilist
21500 .cindex "pipe" "in redirection list"
21501 .cindex "address redirection" "to pipe"
21502 An item is treated as a pipe command if it begins with &"|"& and does not parse
21503 as a valid RFC 2822 address that includes a domain. A transport for running the
21504 command must be specified by the &%pipe_transport%& option.
21505 Normally, either the router or the transport specifies a user and a group under
21506 which to run the delivery. The default is to use the Exim user and group.
21507
21508 Single or double quotes can be used for enclosing the individual arguments of
21509 the pipe command; no interpretation of escapes is done for single quotes. If
21510 the command contains a comma character, it is necessary to put the whole item
21511 in double quotes, for example:
21512 .code
21513 "|/some/command ready,steady,go"
21514 .endd
21515 since items in redirection lists are terminated by commas. Do not, however,
21516 quote just the command. An item such as
21517 .code
21518 |"/some/command ready,steady,go"
21519 .endd
21520 is interpreted as a pipe with a rather strange command name, and no arguments.
21521
21522 Note that the above example assumes that the text comes from a lookup source
21523 of some sort, so that the quotes are part of the data.  If composing a
21524 redirect router with a &%data%& option directly specifying this command, the
21525 quotes will be used by the configuration parser to define the extent of one
21526 string, but will not be passed down into the redirect router itself.  There
21527 are two main approaches to get around this: escape quotes to be part of the
21528 data itself, or avoid using this mechanism and instead create a custom
21529 transport with the &%command%& option set and reference that transport from
21530 an &%accept%& router.
21531
21532 .next
21533 .cindex "file" "in redirection list"
21534 .cindex "address redirection" "to file"
21535 An item is interpreted as a path name if it begins with &"/"& and does not
21536 parse as a valid RFC 2822 address that includes a domain. For example,
21537 .code
21538 /home/world/minbari
21539 .endd
21540 is treated as a filename, but
21541 .code
21542 /s=molari/o=babylon/@x400gate.way
21543 .endd
21544 is treated as an address. For a filename, a transport must be specified using
21545 the &%file_transport%& option. However, if the generated path name ends with a
21546 forward slash character, it is interpreted as a directory name rather than a
21547 filename, and &%directory_transport%& is used instead.
21548
21549 Normally, either the router or the transport specifies a user and a group under
21550 which to run the delivery. The default is to use the Exim user and group.
21551
21552 .cindex "&_/dev/null_&"
21553 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21554 bypassed at a high level, and the log entry shows &"**bypassed**"&
21555 instead of a transport name. In this case the user and group are not used.
21556
21557 .next
21558 .cindex "included address list"
21559 .cindex "address redirection" "included external list"
21560 If an item is of the form
21561 .code
21562 :include:<path name>
21563 .endd
21564 a list of further items is taken from the given file and included at that
21565 point. &*Note*&: Such a file can not be a filter file; it is just an
21566 out-of-line addition to the list. The items in the included list are separated
21567 by commas or newlines and are not subject to expansion. If this is the first
21568 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21569 the alias name. This example is incorrect:
21570 .code
21571 list1    :include:/opt/lists/list1
21572 .endd
21573 It must be given as
21574 .code
21575 list1:   :include:/opt/lists/list1
21576 .endd
21577 .cindex "tainted data" "in filenames"
21578 .cindex redirect "tainted data"
21579 Tainted data may not be used for a filename.
21580 .next
21581 .cindex "address redirection" "to black hole"
21582 .cindex "delivery" "discard"
21583 .cindex "delivery" "blackhole"
21584 .cindex "black hole"
21585 .cindex "abandoning mail"
21586 Sometimes you want to throw away mail to a particular local part.  Making the
21587 &%data%& option expand to an empty string does not work, because that causes
21588 the router to decline. Instead, the alias item
21589 .code
21590 :blackhole:
21591 .endd
21592 can be used. It does what its name implies. No delivery is
21593 done, and no error message is generated. This has the same effect as specifying
21594 &_/dev/null_& as a destination, but it can be independently disabled.
21595
21596 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21597 delivery is done for the original local part, even if other redirection items
21598 are present. If you are generating a multi-item list (for example, by reading a
21599 database) and need the ability to provide a no-op item, you must use
21600 &_/dev/null_&.
21601
21602 .next
21603 .cindex "delivery" "forcing failure"
21604 .cindex "delivery" "forcing deferral"
21605 .cindex "failing delivery" "forcing"
21606 .cindex "deferred delivery, forcing"
21607 .cindex "customizing" "failure message"
21608 An attempt to deliver a particular address can be deferred or forced to fail by
21609 redirection items of the form
21610 .code
21611 :defer:
21612 :fail:
21613 .endd
21614 respectively. When a redirection list contains such an item, it applies
21615 to the entire redirection; any other items in the list are ignored. Any
21616 text following &':fail:'& or &':defer:'& is placed in the error text
21617 associated with the failure. For example, an alias file might contain:
21618 .code
21619 X.Employee:  :fail: Gone away, no forwarding address
21620 .endd
21621 In the case of an address that is being verified from an ACL or as the subject
21622 of a
21623 .cindex "VRFY" "error text, display of"
21624 VRFY command, the text is included in the SMTP error response by
21625 default.
21626 .cindex "EXPN" "error text, display of"
21627 The text is not included in the response to an EXPN command. In non-SMTP cases
21628 the text is included in the error message that Exim generates.
21629
21630 .cindex "SMTP" "error codes"
21631 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21632 &':fail:'&. However, if the message starts with three digits followed by a
21633 space, optionally followed by an extended code of the form &'n.n.n'&, also
21634 followed by a space, and the very first digit is the same as the default error
21635 code, the code from the message is used instead. If the very first digit is
21636 incorrect, a panic error is logged, and the default code is used. You can
21637 suppress the use of the supplied code in a redirect router by setting the
21638 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21639 ignored.
21640
21641 .vindex "&$acl_verify_message$&"
21642 In an ACL, an explicitly provided message overrides the default, but the
21643 default message is available in the variable &$acl_verify_message$& and can
21644 therefore be included in a custom message if this is desired.
21645
21646 Normally the error text is the rest of the redirection list &-- a comma does
21647 not terminate it &-- but a newline does act as a terminator. Newlines are not
21648 normally present in alias expansions. In &(lsearch)& lookups they are removed
21649 as part of the continuation process, but they may exist in other kinds of
21650 lookup and in &':include:'& files.
21651
21652 During routing for message delivery (as opposed to verification), a redirection
21653 containing &':fail:'& causes an immediate failure of the incoming address,
21654 whereas &':defer:'& causes the message to remain in the queue so that a
21655 subsequent delivery attempt can happen at a later time. If an address is
21656 deferred for too long, it will ultimately fail, because the normal retry
21657 rules still apply.
21658
21659 .next
21660 .cindex "alias file" "exception to default"
21661 Sometimes it is useful to use a single-key search type with a default (see
21662 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21663 for exceptions to the default. These can be handled by aliasing them to
21664 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21665 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21666 results in an empty redirection list has the same effect.
21667 .endlist
21668
21669
21670 .section "Duplicate addresses" "SECTdupaddr"
21671 .cindex "duplicate addresses"
21672 .cindex "address duplicate, discarding"
21673 .cindex "pipe" "duplicated"
21674 Exim removes duplicate addresses from the list to which it is delivering, so as
21675 to deliver just one copy to each address. This does not apply to deliveries
21676 routed to pipes by different immediate parent addresses, but an indirect
21677 aliasing scheme of the type
21678 .code
21679 pipe:       |/some/command $local_part
21680 localpart1: pipe
21681 localpart2: pipe
21682 .endd
21683 does not work with a message that is addressed to both local parts, because
21684 when the second is aliased to the intermediate local part &"pipe"& it gets
21685 discarded as being the same as a previously handled address. However, a scheme
21686 such as
21687 .code
21688 localpart1: |/some/command $local_part
21689 localpart2: |/some/command $local_part
21690 .endd
21691 does result in two different pipe deliveries, because the immediate parents of
21692 the pipes are distinct.
21693
21694
21695
21696 .section "Repeated redirection expansion" "SECID128"
21697 .cindex "repeated redirection expansion"
21698 .cindex "address redirection" "repeated for each delivery attempt"
21699 When a message cannot be delivered to all of its recipients immediately,
21700 leading to two or more delivery attempts, redirection expansion is carried out
21701 afresh each time for those addresses whose children were not all previously
21702 delivered. If redirection is being used as a mailing list, this can lead to new
21703 members of the list receiving copies of old messages. The &%one_time%& option
21704 can be used to avoid this.
21705
21706
21707 .section "Errors in redirection lists" "SECID129"
21708 .cindex "address redirection" "errors"
21709 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21710 error is skipped, and an entry is written to the main log. This may be useful
21711 for mailing lists that are automatically managed. Otherwise, if an error is
21712 detected while generating the list of new addresses, the original address is
21713 deferred. See also &%syntax_errors_to%&.
21714
21715
21716
21717 .section "Private options for the redirect router" "SECID130"
21718
21719 .cindex "options" "&(redirect)& router"
21720 The private options for the &(redirect)& router are as follows:
21721
21722
21723 .option allow_defer redirect boolean false
21724 Setting this option allows the use of &':defer:'& in non-filter redirection
21725 data, or the &%defer%& command in an Exim filter file.
21726
21727
21728 .option allow_fail redirect boolean false
21729 .cindex "failing delivery" "from filter"
21730 If this option is true, the &':fail:'& item can be used in a redirection list,
21731 and the &%fail%& command may be used in an Exim filter file.
21732
21733
21734 .option allow_filter redirect boolean false
21735 .cindex "filter" "enabling use of"
21736 .cindex "Sieve filter" "enabling use of"
21737 Setting this option allows Exim to interpret redirection data that starts with
21738 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21739 are some features of Exim filter files that some administrators may wish to
21740 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21741
21742 It is also possible to lock out Exim filters or Sieve filters while allowing
21743 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21744
21745
21746 The filter is run using the uid and gid set by the generic &%user%& and
21747 &%group%& options. These take their defaults from the password data if
21748 &%check_local_user%& is set, so in the normal case of users' personal filter
21749 files, the filter is run as the relevant user. When &%allow_filter%& is set
21750 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21751
21752
21753
21754 .option allow_freeze redirect boolean false
21755 .cindex "freezing messages" "allowing in filter"
21756 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21757 This command is more normally encountered in system filters, and is disabled by
21758 default for redirection filters because it isn't something you usually want to
21759 let ordinary users do.
21760
21761
21762
21763 .option check_ancestor redirect boolean false
21764 This option is concerned with handling generated addresses that are the same
21765 as some address in the list of redirection ancestors of the current address.
21766 Although it is turned off by default in the code, it is set in the default
21767 configuration file for handling users' &_.forward_& files. It is recommended
21768 for this use of the &(redirect)& router.
21769
21770 When &%check_ancestor%& is set, if a generated address (including the domain)
21771 is the same as any ancestor of the current address, it is replaced by a copy of
21772 the current address. This helps in the case where local part A is aliased to B,
21773 and B has a &_.forward_& file pointing back to A. For example, within a single
21774 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21775 &_&~jb/.forward_& contains:
21776 .code
21777 \Joe.Bloggs, <other item(s)>
21778 .endd
21779 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21780 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21781 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21782 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21783 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21784 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21785 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21786 original address. See also the &%repeat_use%& option below.
21787
21788
21789 .option check_group redirect boolean "see below"
21790 When the &%file%& option is used, the group owner of the file is checked only
21791 when this option is set. The permitted groups are those listed in the
21792 &%owngroups%& option, together with the user's default group if
21793 &%check_local_user%& is set. If the file has the wrong group, routing is
21794 deferred. The default setting for this option is true if &%check_local_user%&
21795 is set and the &%modemask%& option permits the group write bit, or if the
21796 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21797
21798
21799
21800 .option check_owner redirect boolean "see below"
21801 When the &%file%& option is used, the owner of the file is checked only when
21802 this option is set. If &%check_local_user%& is set, the local user is
21803 permitted; otherwise the owner must be one of those listed in the &%owners%&
21804 option. The default value for this option is true if &%check_local_user%& or
21805 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21806
21807
21808 .option data redirect string&!! unset
21809 This option is mutually exclusive with &%file%&. One or other of them must be
21810 set, but not both. The contents of &%data%& are expanded, and then used as the
21811 list of forwarding items, or as a set of filtering instructions. If the
21812 expansion is forced to fail, or the result is an empty string or a string that
21813 has no effect (consists entirely of comments), the router declines.
21814
21815 When filtering instructions are used, the string must begin with &"#Exim
21816 filter"&, and all comments in the string, including this initial one, must be
21817 terminated with newline characters. For example:
21818 .code
21819 data = #Exim filter\n\
21820        if $h_to: contains Exim then save $home/mail/exim endif
21821 .endd
21822 If you are reading the data from a database where newlines cannot be included,
21823 you can use the &${sg}$& expansion item to turn the escape string of your
21824 choice into a newline.
21825
21826
21827 .option directory_transport redirect string&!! unset
21828 A &(redirect)& router sets up a direct delivery to a directory when a path name
21829 ending with a slash is specified as a new &"address"&. The transport used is
21830 specified by this option, which, after expansion, must be the name of a
21831 configured transport. This should normally be an &(appendfile)& transport.
21832
21833
21834 .option file redirect string&!! unset
21835 This option specifies the name of a file that contains the redirection data. It
21836 is mutually exclusive with the &%data%& option. The string is expanded before
21837 use; if the expansion is forced to fail, the router declines. Other expansion
21838 failures cause delivery to be deferred. The result of a successful expansion
21839 must be an absolute path. The entire file is read and used as the redirection
21840 data. If the data is an empty string or a string that has no effect (consists
21841 entirely of comments), the router declines.
21842
21843 .cindex "NFS" "checking for file existence"
21844 If the attempt to open the file fails with a &"does not exist"& error, Exim
21845 runs a check on the containing directory,
21846 unless &%ignore_enotdir%& is true (see below).
21847 If the directory does not appear to exist, delivery is deferred. This can
21848 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21849 is a mount problem. If the containing directory does exist, but the file does
21850 not, the router declines.
21851
21852
21853 .option file_transport redirect string&!! unset
21854 .vindex "&$address_file$&"
21855 A &(redirect)& router sets up a direct delivery to a file when a path name not
21856 ending in a slash is specified as a new &"address"&. The transport used is
21857 specified by this option, which, after expansion, must be the name of a
21858 configured transport. This should normally be an &(appendfile)& transport. When
21859 it is running, the filename is in &$address_file$&.
21860
21861
21862 .option filter_prepend_home redirect boolean true
21863 When this option is true, if a &(save)& command in an Exim filter specifies a
21864 relative path, and &$home$& is defined, it is automatically prepended to the
21865 relative path. If this option is set false, this action does not happen. The
21866 relative path is then passed to the transport unmodified.
21867
21868
21869 .option forbid_blackhole redirect boolean false
21870 .cindex "restricting access to features"
21871 .cindex "filter" "locking out certain features"
21872 If this option is true, the &':blackhole:'& item may not appear in a
21873 redirection list.
21874
21875
21876 .option forbid_exim_filter redirect boolean false
21877 .cindex "restricting access to features"
21878 .cindex "filter" "locking out certain features"
21879 If this option is set true, only Sieve filters are permitted when
21880 &%allow_filter%& is true.
21881
21882
21883
21884
21885 .option forbid_file redirect boolean false
21886 .cindex "restricting access to features"
21887 .cindex "delivery" "to file; forbidding"
21888 .cindex "filter" "locking out certain features"
21889 .cindex "Sieve filter" "forbidding delivery to a file"
21890 .cindex "Sieve filter" "&""keep""& facility; disabling"
21891 If this option is true, this router may not generate a new address that
21892 specifies delivery to a local file or directory, either from a filter or from a
21893 conventional forward file. This option is forced to be true if &%one_time%& is
21894 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21895 locks out the Sieve's &"keep"& facility.
21896
21897
21898 .option forbid_filter_dlfunc redirect boolean false
21899 .cindex "restricting access to features"
21900 .cindex "filter" "locking out certain features"
21901 If this option is true, string expansions in Exim filters are not allowed to
21902 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21903 functions.
21904
21905 .option forbid_filter_existstest redirect boolean false
21906 .cindex "restricting access to features"
21907 .cindex "filter" "locking out certain features"
21908 .cindex "expansion" "statting a file"
21909 If this option is true, string expansions in Exim filters are not allowed to
21910 make use of the &%exists%& condition or the &%stat%& expansion item.
21911
21912 .option forbid_filter_logwrite redirect boolean false
21913 .cindex "restricting access to features"
21914 .cindex "filter" "locking out certain features"
21915 If this option is true, use of the logging facility in Exim filters is not
21916 permitted. Logging is in any case available only if the filter is being run
21917 under some unprivileged uid (which is normally the case for ordinary users'
21918 &_.forward_& files).
21919
21920
21921 .option forbid_filter_lookup 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 &%lookup%& items.
21926
21927
21928 .option forbid_filter_perl redirect boolean false
21929 .cindex "restricting access to features"
21930 .cindex "filter" "locking out certain features"
21931 This option has an effect only if Exim is built with embedded Perl support. If
21932 it is true, string expansions in Exim filter files are not allowed to make use
21933 of the embedded Perl support.
21934
21935
21936 .option forbid_filter_readfile redirect boolean false
21937 .cindex "restricting access to features"
21938 .cindex "filter" "locking out certain features"
21939 If this option is true, string expansions in Exim filter files are not allowed
21940 to make use of &%readfile%& items.
21941
21942
21943 .option forbid_filter_readsocket redirect boolean false
21944 .cindex "restricting access to features"
21945 .cindex "filter" "locking out certain features"
21946 If this option is true, string expansions in Exim filter files are not allowed
21947 to make use of &%readsocket%& items.
21948
21949
21950 .option forbid_filter_reply redirect boolean false
21951 .cindex "restricting access to features"
21952 .cindex "filter" "locking out certain features"
21953 If this option is true, this router may not generate an automatic reply
21954 message. Automatic replies can be generated only from Exim or Sieve filter
21955 files, not from traditional forward files. This option is forced to be true if
21956 &%one_time%& is set.
21957
21958
21959 .option forbid_filter_run redirect boolean false
21960 .cindex "restricting access to features"
21961 .cindex "filter" "locking out certain features"
21962 If this option is true, string expansions in Exim filter files are not allowed
21963 to make use of &%run%& items.
21964
21965
21966 .option forbid_include redirect boolean false
21967 .cindex "restricting access to features"
21968 .cindex "filter" "locking out certain features"
21969 If this option is true, items of the form
21970 .code
21971 :include:<path name>
21972 .endd
21973 are not permitted in non-filter redirection lists.
21974
21975
21976 .option forbid_pipe redirect boolean false
21977 .cindex "restricting access to features"
21978 .cindex "filter" "locking out certain features"
21979 .cindex "delivery" "to pipe; forbidding"
21980 If this option is true, this router may not generate a new address which
21981 specifies delivery to a pipe, either from an Exim filter or from a conventional
21982 forward file. This option is forced to be true if &%one_time%& is set.
21983
21984
21985 .option forbid_sieve_filter redirect boolean false
21986 .cindex "restricting access to features"
21987 .cindex "filter" "locking out certain features"
21988 If this option is set true, only Exim filters are permitted when
21989 &%allow_filter%& is true.
21990
21991
21992 .cindex "SMTP" "error codes"
21993 .option forbid_smtp_code redirect boolean false
21994 If this option is set true, any SMTP error codes that are present at the start
21995 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21996 the default codes (451 and 550, respectively) are always used.
21997
21998
21999
22000
22001 .option hide_child_in_errmsg redirect boolean false
22002 .cindex "bounce message" "redirection details; suppressing"
22003 If this option is true, it prevents Exim from quoting a child address if it
22004 generates a bounce or delay message for it. Instead it says &"an address
22005 generated from <&'the top level address'&>"&. Of course, this applies only to
22006 bounces generated locally. If a message is forwarded to another host, &'its'&
22007 bounce may well quote the generated address.
22008
22009
22010 .option ignore_eacces redirect boolean false
22011 .cindex "EACCES"
22012 If this option is set and an attempt to open a redirection file yields the
22013 EACCES error (permission denied), the &(redirect)& router behaves as if the
22014 file did not exist.
22015
22016
22017 .option ignore_enotdir redirect boolean false
22018 .cindex "ENOTDIR"
22019 If this option is set and an attempt to open a redirection file yields the
22020 ENOTDIR error (something on the path is not a directory), the &(redirect)&
22021 router behaves as if the file did not exist.
22022
22023 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
22024 router that has the &%file%& option set discovers that the file does not exist
22025 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
22026 against unmounted NFS directories. If the parent can not be statted, delivery
22027 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
22028 is set, because that option tells Exim to ignore &"something on the path is not
22029 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
22030 that some operating systems give ENOENT where others give ENOTDIR.
22031
22032
22033
22034 .option include_directory redirect string unset
22035 If this option is set, the path names of any &':include:'& items in a
22036 redirection list must start with this directory.
22037
22038
22039 .option modemask redirect "octal integer" 022
22040 This specifies mode bits which must not be set for a file specified by the
22041 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22042
22043
22044 .option one_time redirect boolean false
22045 .cindex "one-time aliasing/forwarding expansion"
22046 .cindex "alias file" "one-time expansion"
22047 .cindex "forward file" "one-time expansion"
22048 .cindex "mailing lists" "one-time expansion"
22049 .cindex "address redirection" "one-time expansion"
22050 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22051 files each time it tries to deliver a message causes a problem when one or more
22052 of the generated addresses fails be delivered at the first attempt. The problem
22053 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22054 but of what happens when the redirection list changes during the time that the
22055 message is on Exim's queue. This is particularly true in the case of mailing
22056 lists, where new subscribers might receive copies of messages that were posted
22057 before they subscribed.
22058
22059 If &%one_time%& is set and any addresses generated by the router fail to
22060 deliver at the first attempt, the failing addresses are added to the message as
22061 &"top level"& addresses, and the parent address that generated them is marked
22062 &"delivered"&. Thus, redirection does not happen again at the next delivery
22063 attempt.
22064
22065 &*Warning 1*&: Any header line addition or removal that is specified by this
22066 router would be lost if delivery did not succeed at the first attempt. For this
22067 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22068 permitted when &%one_time%& is set.
22069
22070 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22071 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22072 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22073
22074 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22075 &%one_time%&.
22076
22077 The original top-level address is remembered with each of the generated
22078 addresses, and is output in any log messages. However, any intermediate parent
22079 addresses are not recorded. This makes a difference to the log only if
22080 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22081 typically be used for mailing lists, where there is normally just one level of
22082 expansion.
22083
22084
22085 .option owners redirect "string list" unset
22086 .cindex "ownership" "alias file"
22087 .cindex "ownership" "forward file"
22088 .cindex "alias file" "ownership"
22089 .cindex "forward file" "ownership"
22090 This specifies a list of permitted owners for the file specified by &%file%&.
22091 This list is in addition to the local user when &%check_local_user%& is set.
22092 See &%check_owner%& above.
22093
22094
22095 .option owngroups redirect "string list" unset
22096 This specifies a list of permitted groups for the file specified by &%file%&.
22097 The list is in addition to the local user's primary group when
22098 &%check_local_user%& is set. See &%check_group%& above.
22099
22100
22101 .option pipe_transport redirect string&!! unset
22102 .vindex "&$address_pipe$&"
22103 A &(redirect)& router sets up a direct delivery to a pipe when a string
22104 starting with a vertical bar character is specified as a new &"address"&. The
22105 transport used is specified by this option, which, after expansion, must be the
22106 name of a configured transport. This should normally be a &(pipe)& transport.
22107 When the transport is run, the pipe command is in &$address_pipe$&.
22108
22109
22110 .option qualify_domain redirect string&!! unset
22111 .vindex "&$qualify_recipient$&"
22112 If this option is set, and an unqualified address (one without a domain) is
22113 generated, and that address would normally be qualified by the global setting
22114 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22115 expanding this string. If the expansion fails, the router declines. If you want
22116 to revert to the default, you can have the expansion generate
22117 &$qualify_recipient$&.
22118
22119 This option applies to all unqualified addresses generated by Exim filters,
22120 but for traditional &_.forward_& files, it applies only to addresses that are
22121 not preceded by a backslash. Sieve filters cannot generate unqualified
22122 addresses.
22123
22124 .option qualify_preserve_domain redirect boolean false
22125 .cindex "domain" "in redirection; preserving"
22126 .cindex "preserving domain in redirection"
22127 .cindex "address redirection" "domain; preserving"
22128 If this option is set, the router's local &%qualify_domain%& option must not be
22129 set (a configuration error occurs if it is). If an unqualified address (one
22130 without a domain) is generated, it is qualified with the domain of the parent
22131 address (the immediately preceding ancestor) instead of the global
22132 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22133 this applies whether or not the address is preceded by a backslash.
22134
22135
22136 .option repeat_use redirect boolean true
22137 If this option is set false, the router is skipped for a child address that has
22138 any ancestor that was routed by this router. This test happens before any of
22139 the other preconditions are tested. Exim's default anti-looping rules skip
22140 only when the ancestor is the same as the current address. See also
22141 &%check_ancestor%& above and the generic &%redirect_router%& option.
22142
22143
22144 .option reply_transport redirect string&!! unset
22145 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22146 &%vacation%& command is used in a filter file. The transport used is specified
22147 by this option, which, after expansion, must be the name of a configured
22148 transport. This should normally be an &(autoreply)& transport. Other transports
22149 are unlikely to do anything sensible or useful.
22150
22151
22152 .option rewrite redirect boolean true
22153 .cindex "address redirection" "disabling rewriting"
22154 If this option is set false, addresses generated by the router are not
22155 subject to address rewriting. Otherwise, they are treated like new addresses
22156 and are rewritten according to the global rewriting rules.
22157
22158
22159 .option sieve_subaddress redirect string&!! unset
22160 The value of this option is passed to a Sieve filter to specify the
22161 :subaddress part of an address.
22162
22163 .option sieve_useraddress redirect string&!! unset
22164 The value of this option is passed to a Sieve filter to specify the :user part
22165 of an address. However, if it is unset, the entire original local part
22166 (including any prefix or suffix) is used for :user.
22167
22168
22169 .option sieve_vacation_directory redirect string&!! unset
22170 .cindex "Sieve filter" "vacation directory"
22171 To enable the &"vacation"& extension for Sieve filters, you must set
22172 &%sieve_vacation_directory%& to the directory where vacation databases are held
22173 (do not put anything else in that directory), and ensure that the
22174 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22175 needs their own directory; Exim will create it if necessary.
22176
22177
22178
22179 .option skip_syntax_errors redirect boolean false
22180 .cindex "forward file" "broken"
22181 .cindex "address redirection" "broken files"
22182 .cindex "alias file" "broken"
22183 .cindex "broken alias or forward files"
22184 .cindex "ignoring faulty addresses"
22185 .cindex "skipping faulty addresses"
22186 .cindex "error" "skipping bad syntax"
22187 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22188 non-filter redirection data are skipped, and each failing address is logged. If
22189 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22190 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22191 are expanded and placed at the head of the error message generated by
22192 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22193 be the same address as the generic &%errors_to%& option. The
22194 &%skip_syntax_errors%& option is often used when handling mailing lists.
22195
22196 If all the addresses in a redirection list are skipped because of syntax
22197 errors, the router declines to handle the original address, and it is passed to
22198 the following routers.
22199
22200 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22201 error in the filter causes filtering to be abandoned without any action being
22202 taken. The incident is logged, and the router declines to handle the address,
22203 so it is passed to the following routers.
22204
22205 .cindex "Sieve filter" "syntax errors in"
22206 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22207 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22208 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22209
22210 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22211 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22212 option, used with an address that does not get redirected, can be used to
22213 notify users of these errors, by means of a router like this:
22214 .code
22215 userforward:
22216   driver = redirect
22217   allow_filter
22218   check_local_user
22219   file = $home/.forward
22220   file_transport = address_file
22221   pipe_transport = address_pipe
22222   reply_transport = address_reply
22223   no_verify
22224   skip_syntax_errors
22225   syntax_errors_to = real-$local_part@$domain
22226   syntax_errors_text = \
22227    This is an automatically generated message. An error has\n\
22228    been found in your .forward file. Details of the error are\n\
22229    reported below. While this error persists, you will receive\n\
22230    a copy of this message for every message that is addressed\n\
22231    to you. If your .forward file is a filter file, or if it is\n\
22232    a non-filter file containing no valid forwarding addresses,\n\
22233    a copy of each incoming message will be put in your normal\n\
22234    mailbox. If a non-filter file contains at least one valid\n\
22235    forwarding address, forwarding to the valid addresses will\n\
22236    happen, and those will be the only deliveries that occur.
22237 .endd
22238 You also need a router to ensure that local addresses that are prefixed by
22239 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22240 put this immediately before the &(userforward)& router:
22241 .code
22242 real_localuser:
22243   driver = accept
22244   check_local_user
22245   local_part_prefix = real-
22246   transport = local_delivery
22247 .endd
22248 For security, it would probably be a good idea to restrict the use of this
22249 router to locally-generated messages, using a condition such as this:
22250 .code
22251   condition = ${if match {$sender_host_address}\
22252                          {\N^(|127\.0\.0\.1)$\N}}
22253 .endd
22254
22255
22256 .option syntax_errors_text redirect string&!! unset
22257 See &%skip_syntax_errors%& above.
22258
22259
22260 .option syntax_errors_to redirect string unset
22261 See &%skip_syntax_errors%& above.
22262 .ecindex IIDredrou1
22263 .ecindex IIDredrou2
22264
22265
22266
22267
22268
22269
22270 . ////////////////////////////////////////////////////////////////////////////
22271 . ////////////////////////////////////////////////////////////////////////////
22272
22273 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22274          "Environment for local transports"
22275 .scindex IIDenvlotra1 "local transports" "environment for"
22276 .scindex IIDenvlotra2 "environment" "local transports"
22277 .scindex IIDenvlotra3 "transport" "local; environment for"
22278 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22279 transport can be thought of as similar to a pipe.) Exim always runs transports
22280 in subprocesses, under specified uids and gids. Typical deliveries to local
22281 mailboxes run under the uid and gid of the local user.
22282
22283 Exim also sets a specific current directory while running the transport; for
22284 some transports a home directory setting is also relevant. The &(pipe)&
22285 transport is the only one that sets up environment variables; see section
22286 &<<SECTpipeenv>>& for details.
22287
22288 The values used for the uid, gid, and the directories may come from several
22289 different places. In many cases, the router that handles the address associates
22290 settings with that address as a result of its &%check_local_user%&, &%group%&,
22291 or &%user%& options. However, values may also be given in the transport's own
22292 configuration, and these override anything that comes from the router.
22293
22294
22295
22296 .section "Concurrent deliveries" "SECID131"
22297 .cindex "concurrent deliveries"
22298 .cindex "simultaneous deliveries"
22299 If two different messages for the same local recipient arrive more or less
22300 simultaneously, the two delivery processes are likely to run concurrently. When
22301 the &(appendfile)& transport is used to write to a file, Exim applies locking
22302 rules to stop concurrent processes from writing to the same file at the same
22303 time.
22304
22305 However, when you use a &(pipe)& transport, it is up to you to arrange any
22306 locking that is needed. Here is a silly example:
22307 .code
22308 my_transport:
22309   driver = pipe
22310   command = /bin/sh -c 'cat >>/some/file'
22311 .endd
22312 This is supposed to write the message at the end of the file. However, if two
22313 messages arrive at the same time, the file will be scrambled. You can use the
22314 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22315 file using the same algorithm that Exim itself uses.
22316
22317
22318
22319
22320 .section "Uids and gids" "SECTenvuidgid"
22321 .cindex "local transports" "uid and gid"
22322 .cindex "transport" "local; uid and gid"
22323 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22324 overrides any group that the router set in the address, even if &%user%& is not
22325 set for the transport. This makes it possible, for example, to run local mail
22326 delivery under the uid of the recipient (set by the router), but in a special
22327 group (set by the transport). For example:
22328 .code
22329 # Routers ...
22330 # User/group are set by check_local_user in this router
22331 local_users:
22332   driver = accept
22333   check_local_user
22334   transport = group_delivery
22335
22336 # Transports ...
22337 # This transport overrides the group
22338 group_delivery:
22339   driver = appendfile
22340   file = /var/spool/mail/$local_part_data
22341   group = mail
22342 .endd
22343 If &%user%& is set for a transport, its value overrides what is set in the
22344 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22345 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22346 set.
22347
22348 .oindex "&%initgroups%&"
22349 When the uid is taken from the transport's configuration, the &[initgroups()]&
22350 function is called for the groups associated with that uid if the
22351 &%initgroups%& option is set for the transport. When the uid is not specified
22352 by the transport, but is associated with the address by a router, the option
22353 for calling &[initgroups()]& is taken from the router configuration.
22354
22355 .cindex "&(pipe)& transport" "uid for"
22356 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22357 is set and &%user%& is not set, the uid of the process that called Exim to
22358 receive the message is used, and if &%group%& is not set, the corresponding
22359 original gid is also used.
22360
22361 This is the detailed preference order for obtaining a gid; the first of the
22362 following that is set is used:
22363
22364 .ilist
22365 A &%group%& setting of the transport;
22366 .next
22367 A &%group%& setting of the router;
22368 .next
22369 A gid associated with a user setting of the router, either as a result of
22370 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22371 .next
22372 The group associated with a non-numeric &%user%& setting of the transport;
22373 .next
22374 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22375 the uid is the creator's uid;
22376 .next
22377 The Exim gid if the Exim uid is being used as a default.
22378 .endlist
22379
22380 If, for example, the user is specified numerically on the router and there are
22381 no group settings, no gid is available. In this situation, an error occurs.
22382 This is different for the uid, for which there always is an ultimate default.
22383 The first of the following that is set is used:
22384
22385 .ilist
22386 A &%user%& setting of the transport;
22387 .next
22388 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22389 .next
22390 A &%user%& setting of the router;
22391 .next
22392 A &%check_local_user%& setting of the router;
22393 .next
22394 The Exim uid.
22395 .endlist
22396
22397 Of course, an error will still occur if the uid that is chosen is on the
22398 &%never_users%& list.
22399
22400
22401
22402
22403
22404 .section "Current and home directories" "SECID132"
22405 .cindex "current directory for local transport"
22406 .cindex "home directory" "for local transport"
22407 .cindex "transport" "local; home directory for"
22408 .cindex "transport" "local; current directory for"
22409 Routers may set current and home directories for local transports by means of
22410 the &%transport_current_directory%& and &%transport_home_directory%& options.
22411 However, if the transport's &%current_directory%& or &%home_directory%& options
22412 are set, they override the router's values. In detail, the home directory
22413 for a local transport is taken from the first of these values that is set:
22414
22415 .ilist
22416 The &%home_directory%& option on the transport;
22417 .next
22418 The &%transport_home_directory%& option on the router;
22419 .next
22420 The password data if &%check_local_user%& is set on the router;
22421 .next
22422 The &%router_home_directory%& option on the router.
22423 .endlist
22424
22425 The current directory is taken from the first of these values that is set:
22426
22427 .ilist
22428 The &%current_directory%& option on the transport;
22429 .next
22430 The &%transport_current_directory%& option on the router.
22431 .endlist
22432
22433
22434 If neither the router nor the transport sets a current directory, Exim uses the
22435 value of the home directory, if it is set. Otherwise it sets the current
22436 directory to &_/_& before running a local transport.
22437
22438
22439
22440 .section "Expansion variables derived from the address" "SECID133"
22441 .vindex "&$domain$&"
22442 .vindex "&$local_part$&"
22443 .vindex "&$original_domain$&"
22444 Normally a local delivery is handling a single address, and in that case the
22445 variables such as &$domain$& and &$local_part$& are set during local
22446 deliveries. However, in some circumstances more than one address may be handled
22447 at once (for example, while writing batch SMTP for onward transmission by some
22448 other means). In this case, the variables associated with the local part are
22449 never set, &$domain$& is set only if all the addresses have the same domain,
22450 and &$original_domain$& is never set.
22451 .ecindex IIDenvlotra1
22452 .ecindex IIDenvlotra2
22453 .ecindex IIDenvlotra3
22454
22455
22456
22457
22458
22459
22460
22461 . ////////////////////////////////////////////////////////////////////////////
22462 . ////////////////////////////////////////////////////////////////////////////
22463
22464 .chapter "Generic options for transports" "CHAPtransportgeneric"
22465 .scindex IIDgenoptra1 "generic options" "transport"
22466 .scindex IIDgenoptra2 "options" "generic; for transports"
22467 .scindex IIDgenoptra3 "transport" "generic options for"
22468 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22469 prior to Exim 4.95 names would be silently truncated at this length, but now
22470 it is enforced.
22471
22472 The following generic options apply to all transports:
22473
22474
22475 .option body_only transports boolean false
22476 .cindex "transport" "body only"
22477 .cindex "message" "transporting body only"
22478 .cindex "body of message" "transporting"
22479 If this option is set, the message's headers are not transported. It is
22480 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22481 or &(pipe)& transports, the settings of &%message_prefix%& and
22482 &%message_suffix%& should be checked, because this option does not
22483 automatically suppress them.
22484
22485
22486 .option current_directory transports string&!! unset
22487 .cindex "transport" "current directory for"
22488 This specifies the current directory that is to be set while running the
22489 transport, overriding any value that may have been set by the router.
22490 If the expansion fails for any reason, including forced failure, an error is
22491 logged, and delivery is deferred.
22492
22493
22494 .option disable_logging transports boolean false
22495 If this option is set true, nothing is logged for any
22496 deliveries by the transport or for any
22497 transport errors. You should not set this option unless you really, really know
22498 what you are doing.
22499
22500
22501 .option debug_print transports string&!! unset
22502 .cindex "testing" "variables in drivers"
22503 If this option is set and debugging is enabled (see the &%-d%& command line
22504 option), the string is expanded and included in the debugging output when the
22505 transport is run.
22506 If expansion of the string fails, the error message is written to the debugging
22507 output, and Exim carries on processing.
22508 This facility is provided to help with checking out the values of variables and
22509 so on when debugging driver configurations. For example, if a &%headers_add%&
22510 option is not working properly, &%debug_print%& could be used to output the
22511 variables it references. A newline is added to the text if it does not end with
22512 one.
22513 The variables &$transport_name$& and &$router_name$& contain the name of the
22514 transport and the router that called it.
22515
22516 .option delivery_date_add transports boolean false
22517 .cindex "&'Delivery-date:'& header line"
22518 If this option is true, a &'Delivery-date:'& header is added to the message.
22519 This gives the actual time the delivery was made. As this is not a standard
22520 header, Exim has a configuration option (&%delivery_date_remove%&) which
22521 requests its removal from incoming messages, so that delivered messages can
22522 safely be resent to other recipients.
22523
22524
22525 .option driver transports string unset
22526 This specifies which of the available transport drivers is to be used.
22527 There is no default, and this option must be set for every transport.
22528
22529
22530 .option envelope_to_add transports boolean false
22531 .cindex "&'Envelope-to:'& header line"
22532 If this option is true, an &'Envelope-to:'& header is added to the message.
22533 This gives the original address(es) in the incoming envelope that caused this
22534 delivery to happen. More than one address may be present if the transport is
22535 configured to handle several addresses at once, or if more than one original
22536 address was redirected to the same final address. As this is not a standard
22537 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22538 its removal from incoming messages, so that delivered messages can safely be
22539 resent to other recipients.
22540
22541 &*Note:*& If used on a transport handling multiple recipients
22542 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22543 transport if &%batch_max%& is greater than 1)
22544 then information about Bcc recipients will be leaked.
22545 Doing so is generally not advised.
22546
22547
22548 .option event_action transports string&!! unset
22549 .cindex events
22550 This option declares a string to be expanded for Exim's events mechanism.
22551 For details see chapter &<<CHAPevents>>&.
22552
22553
22554 .option group transports string&!! "Exim group"
22555 .cindex "transport" "group; specifying"
22556 This option specifies a gid for running the transport process, overriding any
22557 value that the router supplies, and also overriding any value associated with
22558 &%user%& (see below).
22559
22560
22561 .option headers_add transports list&!! unset
22562 .cindex "header lines" "adding in transport"
22563 .cindex "transport" "header lines; adding"
22564 This option specifies a list of text headers,
22565 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22566 which are (separately) expanded and added to the header
22567 portion of a message as it is transported, as described in section
22568 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22569 routers. If the result of the expansion is an empty string, or if the expansion
22570 is forced to fail, no action is taken. Other expansion failures are treated as
22571 errors and cause the delivery to be deferred.
22572
22573 Unlike most options, &%headers_add%& can be specified multiple times
22574 for a transport; all listed headers are added.
22575
22576
22577 .option headers_only transports boolean false
22578 .cindex "transport" "header lines only"
22579 .cindex "message" "transporting headers only"
22580 .cindex "header lines" "transporting"
22581 If this option is set, the message's body is not transported. It is mutually
22582 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22583 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22584 checked, since this option does not automatically suppress them.
22585
22586
22587 .option headers_remove transports list&!! unset
22588 .cindex "header lines" "removing"
22589 .cindex "transport" "header lines; removing"
22590 This option specifies a list of text headers,
22591 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22592 to be removed from the message.
22593 However, the option has no effect when an address is just being verified.
22594 Each list item is separately expanded.
22595 If the result of the expansion is an empty string, or if the expansion
22596 is forced to fail, no action is taken. Other expansion failures are treated as
22597 errors and cause the delivery to be deferred.
22598 If an item ends in *, it will match any header with the given prefix.
22599
22600 Matching headers are omitted from the message as it is transported, as described
22601 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22602 routers.
22603
22604 Unlike most options, &%headers_remove%& can be specified multiple times
22605 for a transport; all listed headers are removed.
22606
22607 &*Warning*&: Because of the separate expansion of the list items,
22608 items that contain a list separator must have it doubled.
22609 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22610
22611
22612
22613 .option headers_rewrite transports string unset
22614 .cindex "transport" "header lines; rewriting"
22615 .cindex "rewriting" "at transport time"
22616 This option allows addresses in header lines to be rewritten at transport time,
22617 that is, as the message is being copied to its destination. The contents of the
22618 option are a colon-separated list of rewriting rules. Each rule is in exactly
22619 the same form as one of the general rewriting rules that are applied when a
22620 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22621 example,
22622 .code
22623 headers_rewrite = a@b c@d f : \
22624                   x@y w@z
22625 .endd
22626 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22627 &'w@z'& in all address-bearing header lines. The rules are applied to the
22628 header lines just before they are written out at transport time, so they affect
22629 only those copies of the message that pass through the transport. However, only
22630 the message's original header lines, and any that were added by a system
22631 filter, are rewritten. If a router or transport adds header lines, they are not
22632 affected by this option. These rewriting rules are &'not'& applied to the
22633 envelope. You can change the return path using &%return_path%&, but you cannot
22634 change envelope recipients at this time.
22635
22636
22637 .option home_directory transports string&!! unset
22638 .cindex "transport" "home directory for"
22639 .vindex "&$home$&"
22640 This option specifies a home directory setting for a local transport,
22641 overriding any value that may be set by the router. The home directory is
22642 placed in &$home$& while expanding the transport's private options. It is also
22643 used as the current directory if no current directory is set by the
22644 &%current_directory%& option on the transport or the
22645 &%transport_current_directory%& option on the router. If the expansion fails
22646 for any reason, including forced failure, an error is logged, and delivery is
22647 deferred.
22648
22649
22650 .option initgroups transports boolean false
22651 .cindex "additional groups"
22652 .cindex "groups" "additional"
22653 .cindex "transport" "group; additional"
22654 If this option is true and the uid for the delivery process is provided by the
22655 transport, the &[initgroups()]& function is called when running the transport
22656 to ensure that any additional groups associated with the uid are set up.
22657
22658
22659 .option max_parallel transports integer&!! unset
22660 .cindex limit "transport parallelism"
22661 .cindex transport "parallel processes"
22662 .cindex transport "concurrency limit"
22663 .cindex "delivery" "parallelism for transport"
22664 If this option is set and expands to an integer greater than zero
22665 it limits the number of concurrent runs of the transport.
22666 The control does not apply to shadow transports.
22667
22668 .cindex "hints database" "transport concurrency control"
22669 Exim implements this control by means of a hints database in which a record is
22670 incremented whenever a transport process is being created. The record
22671 is decremented and possibly removed when the process terminates.
22672 Obviously there is scope for
22673 records to get left lying around if there is a system or program crash. To
22674 guard against this, Exim ignores any records that are more than six hours old.
22675
22676 If you use this option, you should also arrange to delete the
22677 relevant hints database whenever your system reboots. The names of the files
22678 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22679 may be one or two files, depending on the type of DBM in use. The same files
22680 are used for ETRN and smtp transport serialization.
22681
22682
22683 .option message_size_limit transports string&!! 0
22684 .cindex "limit" "message size per transport"
22685 .cindex "size" "of message, limit"
22686 .cindex "transport" "message size; limiting"
22687 This option controls the size of messages passed through the transport. It is
22688 expanded before use; the result of the expansion must be a sequence of decimal
22689 digits, optionally followed by K or M. If the expansion fails for any reason,
22690 including forced failure, or if the result is not of the required form,
22691 delivery is deferred. If the value is greater than zero and the size of a
22692 message exceeds this limit, the address is failed. If there is any chance that
22693 the resulting bounce message could be routed to the same transport, you should
22694 ensure that &%return_size_limit%& is less than the transport's
22695 &%message_size_limit%&, as otherwise the bounce message will fail to get
22696 delivered.
22697
22698
22699
22700 .option rcpt_include_affixes transports boolean false
22701 .cindex "prefix" "for local part, including in envelope"
22702 .cindex "suffix for local part" "including in envelope"
22703 .cindex "local part" "prefix"
22704 .cindex "local part" "suffix"
22705 When this option is false (the default), and an address that has had any
22706 affixes (prefixes or suffixes) removed from the local part is delivered by any
22707 form of SMTP or LMTP, the affixes are not included. For example, if a router
22708 that contains
22709 .code
22710 local_part_prefix = *-
22711 .endd
22712 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22713 is delivered with
22714 .code
22715 RCPT TO:<xyz@some.domain>
22716 .endd
22717 This is also the case when an ACL-time callout is being used to verify a
22718 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22719 whole local part is included in the RCPT command. This option applies to BSMTP
22720 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22721 &(lmtp)& and &(smtp)& transports.
22722
22723
22724 .option retry_use_local_part transports boolean "see below"
22725 .cindex "hints database" "retry keys"
22726 When a delivery suffers a temporary failure, a retry record is created
22727 in Exim's hints database. For remote deliveries, the key for the retry record
22728 is based on the name and/or IP address of the failing remote host. For local
22729 deliveries, the key is normally the entire address, including both the local
22730 part and the domain. This is suitable for most common cases of local delivery
22731 temporary failure &-- for example, exceeding a mailbox quota should delay only
22732 deliveries to that mailbox, not to the whole domain.
22733
22734 However, in some special cases you may want to treat a temporary local delivery
22735 as a failure associated with the domain, and not with a particular local part.
22736 (For example, if you are storing all mail for some domain in files.) You can do
22737 this by setting &%retry_use_local_part%& false.
22738
22739 For all the local transports, its default value is true. For remote transports,
22740 the default value is false for tidiness, but changing the value has no effect
22741 on a remote transport in the current implementation.
22742
22743
22744 .option return_path transports string&!! unset
22745 .cindex "envelope sender"
22746 .cindex "envelope from"
22747 .cindex "transport" "return path; changing"
22748 .cindex "return path" "changing in transport"
22749 If this option is set, the string is expanded at transport time and replaces
22750 the existing return path (envelope sender) value in the copy of the message
22751 that is being delivered. An empty return path is permitted. This feature is
22752 designed for remote deliveries, where the value of this option is used in the
22753 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22754 only effect is to change the address that is placed in the &'Return-path:'&
22755 header line, if one is added to the message (see the next option).
22756
22757 &*Note:*& A changed return path is not logged unless you add
22758 &%return_path_on_delivery%& to the log selector.
22759
22760 .vindex "&$return_path$&"
22761 The expansion can refer to the existing value via &$return_path$&. This is
22762 either the message's envelope sender, or an address set by the
22763 &%errors_to%& option on a router. If the expansion is forced to fail, no
22764 replacement occurs; if it fails for another reason, delivery is deferred. This
22765 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22766 section &<<SECTverp>>&.
22767
22768 &*Note*&: If a delivery error is detected locally, including the case when a
22769 remote server rejects a message at SMTP time, the bounce message is not sent to
22770 the value of this option. It is sent to the previously set errors address.
22771 This defaults to the incoming sender address, but can be changed by setting
22772 &%errors_to%& in a router.
22773
22774
22775
22776 .option return_path_add transports boolean false
22777 .chindex Return-path:
22778 If this option is true, a &'Return-path:'& header is added to the message.
22779 Although the return path is normally available in the prefix line of BSD
22780 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22781 have easy access to it.
22782
22783 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22784 the delivery SMTP server makes the final delivery"&. This implies that this
22785 header should not be present in incoming messages. Exim has a configuration
22786 option, &%return_path_remove%&, which requests removal of this header from
22787 incoming messages, so that delivered messages can safely be resent to other
22788 recipients.
22789
22790
22791 .option shadow_condition transports string&!! unset
22792 See &%shadow_transport%& below.
22793
22794
22795 .option shadow_transport transports string unset
22796 .cindex "shadow transport"
22797 .cindex "transport" "shadow"
22798 A local transport may set the &%shadow_transport%& option to the name of
22799 another local transport. Shadow remote transports are not supported.
22800
22801 Whenever a delivery to the main transport succeeds, and either
22802 &%shadow_condition%& is unset, or its expansion does not result in the empty
22803 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22804 passed to the shadow transport, with the same delivery address or addresses. If
22805 expansion fails, no action is taken except that non-forced expansion failures
22806 cause a log line to be written.
22807
22808 The result of the shadow transport is discarded and does not affect the
22809 subsequent processing of the message. Only a single level of shadowing is
22810 provided; the &%shadow_transport%& option is ignored on any transport when it
22811 is running as a shadow. Options concerned with output from pipes are also
22812 ignored. The log line for the successful delivery has an item added on the end,
22813 of the form
22814 .code
22815 ST=<shadow transport name>
22816 .endd
22817 If the shadow transport did not succeed, the error message is put in
22818 parentheses afterwards. Shadow transports can be used for a number of different
22819 purposes, including keeping more detailed log information than Exim normally
22820 provides, and implementing automatic acknowledgment policies based on message
22821 headers that some sites insist on.
22822
22823
22824 .option transport_filter transports string&!! unset
22825 .cindex "transport" "filter"
22826 .cindex "filter" "transport filter"
22827 This option sets up a filtering (in the Unix shell sense) process for messages
22828 at transport time. It should not be confused with mail filtering as set up by
22829 individual users or via a system filter.
22830 If unset, or expanding to an empty string, no filtering is done.
22831
22832 When the message is about to be written out, the command specified by
22833 &%transport_filter%& is started up in a separate, parallel process, and
22834 the entire message, including the header lines, is passed to it on its standard
22835 input (this in fact is done from a third process, to avoid deadlock). The
22836 command must be specified as an absolute path.
22837
22838 The lines of the message that are written to the transport filter are
22839 terminated by newline (&"\n"&). The message is passed to the filter before any
22840 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22841 lines beginning with a dot, and also before any processing implied by the
22842 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22843 &(pipe)& transports.
22844
22845 The standard error for the filter process is set to the same destination as its
22846 standard output; this is read and written to the message's ultimate
22847 destination. The process that writes the message to the filter, the
22848 filter itself, and the original process that reads the result and delivers it
22849 are all run in parallel, like a shell pipeline.
22850
22851 The filter can perform any transformations it likes, but of course should take
22852 care not to break RFC 2822 syntax. Exim does not check the result, except to
22853 test for a final newline when SMTP is in use. All messages transmitted over
22854 SMTP must end with a newline, so Exim supplies one if it is missing.
22855
22856 .cindex "content scanning" "per user"
22857 A transport filter can be used to provide content-scanning on a per-user basis
22858 at delivery time if the only required effect of the scan is to modify the
22859 message. For example, a content scan could insert a new header line containing
22860 a spam score. This could be interpreted by a filter in the user's MUA. It is
22861 not possible to discard a message at this stage.
22862
22863 .cindex "SIZE" "ESMTP extension"
22864 A problem might arise if the filter increases the size of a message that is
22865 being sent down an SMTP connection. If the receiving SMTP server has indicated
22866 support for the SIZE parameter, Exim will have sent the size of the message
22867 at the start of the SMTP session. If what is actually sent is substantially
22868 more, the server might reject the message. This can be worked round by setting
22869 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22870 additions to the message, or to disable the use of SIZE altogether.
22871
22872 .vindex "&$pipe_addresses$&"
22873 The value of the &%transport_filter%& option is the command string for starting
22874 the filter, which is run directly from Exim, not under a shell. The string is
22875 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22876 Exim breaks it up into arguments and then expands each argument separately (see
22877 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22878 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22879 of arguments, one for each address that applies to this delivery. (This isn't
22880 an ideal name for this feature here, but as it was already implemented for the
22881 &(pipe)& transport, it seemed sensible not to change it.)
22882
22883 .vindex "&$host$&"
22884 .vindex "&$host_address$&"
22885 The expansion variables &$host$& and &$host_address$& are available when the
22886 transport is a remote one. They contain the name and IP address of the host to
22887 which the message is being sent. For example:
22888 . used to have $sender_address in this cmdline, but it's tainted
22889 .code
22890 transport_filter = /some/directory/transport-filter.pl \
22891   $host $host_address $pipe_addresses
22892 .endd
22893
22894 Two problems arise if you want to use more complicated expansion items to
22895 generate transport filter commands, both of which due to the fact that the
22896 command is split up &'before'& expansion.
22897 .ilist
22898 If an expansion item contains white space, you must quote it, so that it is all
22899 part of the same command item. If the entire option setting is one such
22900 expansion item, you have to take care what kind of quoting you use. For
22901 example:
22902 .code
22903 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22904 .endd
22905 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22906 &(/bin/cmd2)& otherwise.
22907
22908 Option strings in general have any fully-surrounding double quote wrapping
22909 removed early in parsing (see &<<SECTstrings>>&).
22910 Then, for this option, quotes protect against whitespace being
22911 regarded as a separator while splitting into the command argument vector.
22912 Either double or single quotes can be used here;
22913 the former interprets backlash-quoted charachters
22914 and the latter does not.
22915
22916 If double quotes had been used in this example, they would have been
22917 stripped by Exim when it read the option's value. When the value is used, if
22918 the single quotes were missing, the line would be split into two items,
22919 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22920 Exim tried to expand the first one.
22921 .next
22922 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22923 expansion cannot generate multiple arguments, or a command name followed by
22924 arguments. Consider this example:
22925 .code
22926 transport_filter = ${lookup{$host}lsearch{/a/file}\
22927                     {$value}{/bin/cat}}
22928 .endd
22929 The result of the lookup is interpreted as the name of the command, even
22930 if it contains white space. The simplest way round this is to use a shell:
22931 .code
22932 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22933                                {$value}{/bin/cat}}
22934 .endd
22935 .endlist
22936
22937 The filter process is run under the same uid and gid as the normal delivery.
22938 For remote deliveries this is the Exim uid/gid by default. The command should
22939 normally yield a zero return code. Transport filters are not supposed to fail.
22940 A non-zero code is taken to mean that the transport filter encountered some
22941 serious problem. Delivery of the message is deferred; the message remains on
22942 the queue and is tried again later. It is not possible to cause a message to be
22943 bounced from a transport filter.
22944
22945 If a transport filter is set on an autoreply transport, the original message is
22946 passed through the filter as it is being copied into the newly generated
22947 message, which happens if the &%return_message%& option is set.
22948
22949
22950 .option transport_filter_timeout transports time 5m
22951 .cindex "transport" "filter, timeout"
22952 When Exim is reading the output of a transport filter, it applies a timeout
22953 that can be set by this option. Exceeding the timeout is normally treated as a
22954 temporary delivery failure. However, if a transport filter is used with a
22955 &(pipe)& transport, a timeout in the transport filter is treated in the same
22956 way as a timeout in the pipe command itself. By default, a timeout is a hard
22957 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22958 becomes a temporary error.
22959
22960
22961 .option user transports string&!! "Exim user"
22962 .cindex "uid (user id)" "local delivery"
22963 .cindex "transport" "user, specifying"
22964 This option specifies the user under whose uid the delivery process is to be
22965 run, overriding any uid that may have been set by the router. If the user is
22966 given as a name, the uid is looked up from the password data, and the
22967 associated group is taken as the value of the gid to be used if the &%group%&
22968 option is not set.
22969
22970 For deliveries that use local transports, a user and group are normally
22971 specified explicitly or implicitly (for example, as a result of
22972 &%check_local_user%&) by the router or transport.
22973
22974 .cindex "hints database" "access by remote transport"
22975 For remote transports, you should leave this option unset unless you really are
22976 sure you know what you are doing. When a remote transport is running, it needs
22977 to be able to access Exim's hints databases, because each host may have its own
22978 retry data.
22979 .ecindex IIDgenoptra1
22980 .ecindex IIDgenoptra2
22981 .ecindex IIDgenoptra3
22982
22983
22984
22985
22986
22987
22988 . ////////////////////////////////////////////////////////////////////////////
22989 . ////////////////////////////////////////////////////////////////////////////
22990
22991 .chapter "Address batching in local transports" "CHAPbatching" &&&
22992          "Address batching"
22993 .cindex "transport" "local; address batching in"
22994 The only remote transport (&(smtp)&) is normally configured to handle more than
22995 one address at a time, so that when several addresses are routed to the same
22996 remote host, just one copy of the message is sent. Local transports, however,
22997 normally handle one address at a time. That is, a separate instance of the
22998 transport is run for each address that is routed to the transport. A separate
22999 copy of the message is delivered each time.
23000
23001 .cindex "batched local delivery"
23002 .oindex "&%batch_max%&"
23003 .oindex "&%batch_id%&"
23004 In special cases, it may be desirable to handle several addresses at once in a
23005 local transport, for example:
23006
23007 .ilist
23008 In an &(appendfile)& transport, when storing messages in files for later
23009 delivery by some other means, a single copy of the message with multiple
23010 recipients saves space.
23011 .next
23012 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
23013 a single copy saves time, and is the normal way LMTP is expected to work.
23014 .next
23015 In a &(pipe)& transport, when passing the message
23016 to a scanner program or
23017 to some other delivery mechanism such as UUCP, multiple recipients may be
23018 acceptable.
23019 .endlist
23020
23021 These three local transports all have the same options for controlling multiple
23022 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
23023 repeating the information for each transport, these options are described here.
23024
23025 The &%batch_max%& option specifies the maximum number of addresses that can be
23026 delivered together in a single run of the transport. Its default value is one
23027 (no batching). When more than one address is routed to a transport that has a
23028 &%batch_max%& value greater than one, the addresses are delivered in a batch
23029 (that is, in a single run of the transport with multiple recipients), subject
23030 to certain conditions:
23031
23032 .ilist
23033 .vindex "&$local_part$&"
23034 If any of the transport's options contain a reference to &$local_part$&, no
23035 batching is possible.
23036 .next
23037 .vindex "&$domain$&"
23038 If any of the transport's options contain a reference to &$domain$&, only
23039 addresses with the same domain are batched.
23040 .next
23041 .cindex "customizing" "batching condition"
23042 If &%batch_id%& is set, it is expanded for each address, and only those
23043 addresses with the same expanded value are batched. This allows you to specify
23044 customized batching conditions. Failure of the expansion for any reason,
23045 including forced failure, disables batching, but it does not stop the delivery
23046 from taking place.
23047 .next
23048 Batched addresses must also have the same errors address (where to send
23049 delivery errors), the same header additions and removals, the same user and
23050 group for the transport, and if a host list is present, the first host must
23051 be the same.
23052 .endlist
23053
23054 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23055 both when the file or pipe command is specified in the transport, and when it
23056 is specified by a &(redirect)& router, but all the batched addresses must of
23057 course be routed to the same file or pipe command. These two transports have an
23058 option called &%use_bsmtp%&, which causes them to deliver the message in
23059 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23060 &%check_string%& and &%escape_string%& options are forced to the values
23061 .code
23062 check_string = "."
23063 escape_string = ".."
23064 .endd
23065 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23066 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23067 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23068
23069 .cindex "&'Envelope-to:'& header line"
23070 If the generic &%envelope_to_add%& option is set for a batching transport, the
23071 &'Envelope-to:'& header that is added to the message contains all the addresses
23072 that are being processed together. If you are using a batching &(appendfile)&
23073 transport without &%use_bsmtp%&, the only way to preserve the recipient
23074 addresses is to set the &%envelope_to_add%& option.
23075
23076 .cindex "&(pipe)& transport" "with multiple addresses"
23077 .vindex "&$pipe_addresses$&"
23078 If you are using a &(pipe)& transport without BSMTP, and setting the
23079 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23080 the command. This is not a true variable; it is a bit of magic that causes each
23081 of the recipient addresses to be inserted into the command as a separate
23082 argument. This provides a way of accessing all the addresses that are being
23083 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23084 are specified by a &(redirect)& router.
23085
23086
23087
23088
23089 . ////////////////////////////////////////////////////////////////////////////
23090 . ////////////////////////////////////////////////////////////////////////////
23091
23092 .chapter "The appendfile transport" "CHAPappendfile"
23093 .scindex IIDapptra1 "&(appendfile)& transport"
23094 .scindex IIDapptra2 "transports" "&(appendfile)&"
23095 .cindex "directory creation"
23096 .cindex "creating directories"
23097 The &(appendfile)& transport delivers a message by appending it to an existing
23098 file, or by creating an entirely new file in a specified directory. Single
23099 files to which messages are appended can be in the traditional Unix mailbox
23100 format, or optionally in the MBX format supported by the Pine MUA and
23101 University of Washington IMAP daemon, &'inter alia'&. When each message is
23102 being delivered as a separate file, &"maildir"& format can optionally be used
23103 to give added protection against failures that happen part-way through the
23104 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23105 supported. For all file formats, Exim attempts to create as many levels of
23106 directory as necessary, provided that &%create_directory%& is set.
23107
23108 The code for the optional formats is not included in the Exim binary by
23109 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23110 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23111 included.
23112
23113 .cindex "quota" "system"
23114 Exim recognizes system quota errors, and generates an appropriate message. Exim
23115 also supports its own quota control within the transport, for use when the
23116 system facility is unavailable or cannot be used for some reason.
23117
23118 If there is an error while appending to a file (for example, quota exceeded or
23119 partition filled), Exim attempts to reset the file's length and last
23120 modification time back to what they were before. If there is an error while
23121 creating an entirely new file, the new file is removed.
23122
23123 Before appending to a file, a number of security checks are made, and the
23124 file is locked. A detailed description is given below, after the list of
23125 private options.
23126
23127 The &(appendfile)& transport is most commonly used for local deliveries to
23128 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23129 putting messages into files for remote delivery by some means other than Exim.
23130 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23131 option).
23132
23133
23134
23135 .section "The file and directory options" "SECTfildiropt"
23136 The &%file%& option specifies a single file, to which the message is appended;
23137 the &%directory%& option specifies a directory, in which a new file containing
23138 the message is created. Only one of these two options can be set, and for
23139 normal deliveries to mailboxes, one of them &'must'& be set.
23140
23141 .vindex "&$address_file$&"
23142 .vindex "&$local_part$&"
23143 However, &(appendfile)& is also used for delivering messages to files or
23144 directories whose names (or parts of names) are obtained from alias,
23145 forwarding, or filtering operations (for example, a &%save%& command in a
23146 user's Exim filter). When such a transport is running, &$local_part$& contains
23147 the local part that was aliased or forwarded, and &$address_file$& contains the
23148 name (or partial name) of the file or directory generated by the redirection
23149 operation. There are two cases:
23150
23151 .ilist
23152 If neither &%file%& nor &%directory%& is set, the redirection operation
23153 must specify an absolute path (one that begins with &`/`&). This is the most
23154 common case when users with local accounts use filtering to sort mail into
23155 different folders. See for example, the &(address_file)& transport in the
23156 default configuration. If the path ends with a slash, it is assumed to be the
23157 name of a directory. A delivery to a directory can also be forced by setting
23158 &%maildir_format%& or &%mailstore_format%&.
23159 .next
23160 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23161 used to determine the file or directory name for the delivery. Normally, the
23162 contents of &$address_file$& are used in some way in the string expansion.
23163 .endlist
23164 If the &%create_file%& option is set to a path which
23165 matches (see the option definition below for details)
23166 a file or directory name
23167 for the delivery, that name becomes de-tainted.
23168
23169 .cindex "tainted data" "in filenames"
23170 .cindex appendfile "tainted data"
23171 Tainted data may not be used for a file or directory name.
23172 This means that, for instance, &$local_part$& cannot be used directly
23173 as a component of a path.  It can however be used as the key for a lookup
23174 which returns a path (or component).
23175
23176
23177 .cindex "Sieve filter" "configuring &(appendfile)&"
23178 .cindex "Sieve filter" "relative mailbox path handling"
23179 As an example of the second case, consider an environment where users do not
23180 have home directories. They may be permitted to use Exim filter commands of the
23181 form:
23182 .code
23183 save folder23
23184 .endd
23185 or Sieve filter commands of the form:
23186 .code
23187 require "fileinto";
23188 fileinto "folder23";
23189 .endd
23190 In this situation, the expansion of &%file%& or &%directory%& in the transport
23191 must transform the relative path into an appropriate absolute filename. In the
23192 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23193 is used as a result of a &"keep"& action in the filter. This example shows one
23194 way of handling this requirement:
23195 .code
23196 file = ${if eq{$address_file}{inbox} \
23197             {/var/mail/$local_part_data} \
23198             {${if eq{${substr_0_1:$address_file}}{/} \
23199                   {$address_file} \
23200                   {$home/mail/$address_file} \
23201             }} \
23202        }
23203 .endd
23204 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23205 location, absolute paths are used without change, and other folders are in the
23206 &_mail_& directory within the home directory.
23207
23208 &*Note 1*&: While processing an Exim filter, a relative path such as
23209 &_folder23_& is turned into an absolute path if a home directory is known to
23210 the router. In particular, this is the case if &%check_local_user%& is set. If
23211 you want to prevent this happening at routing time, you can set
23212 &%router_home_directory%& empty. This forces the router to pass the relative
23213 path to the transport.
23214
23215 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23216 the &%file%& or &%directory%& option is still used if it is set.
23217
23218
23219
23220
23221 .section "Private options for appendfile" "SECID134"
23222 .cindex "options" "&(appendfile)& transport"
23223
23224
23225
23226 .option allow_fifo appendfile boolean false
23227 .cindex "fifo (named pipe)"
23228 .cindex "named pipe (fifo)"
23229 .cindex "pipe" "named (fifo)"
23230 Setting this option permits delivery to named pipes (FIFOs) as well as to
23231 regular files. If no process is reading the named pipe at delivery time, the
23232 delivery is deferred.
23233
23234
23235 .option allow_symlink appendfile boolean false
23236 .cindex "symbolic link" "to mailbox"
23237 .cindex "mailbox" "symbolic link"
23238 By default, &(appendfile)& will not deliver if the path name for the file is
23239 that of a symbolic link. Setting this option relaxes that constraint, but there
23240 are security issues involved in the use of symbolic links. Be sure you know
23241 what you are doing if you set this. Details of exactly what this option affects
23242 are included in the discussion which follows this list of options.
23243
23244
23245 .option batch_id appendfile string&!! unset
23246 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23247 However, batching is automatically disabled for &(appendfile)& deliveries that
23248 happen as a result of forwarding or aliasing or other redirection directly to a
23249 file.
23250
23251
23252 .option batch_max appendfile integer 1
23253 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23254
23255
23256 .option check_group appendfile boolean false
23257 When this option is set, the group owner of the file defined by the &%file%&
23258 option is checked to see that it is the same as the group under which the
23259 delivery process is running. The default setting is false because the default
23260 file mode is 0600, which means that the group is irrelevant.
23261
23262
23263 .option check_owner appendfile boolean true
23264 When this option is set, the owner of the file defined by the &%file%& option
23265 is checked to ensure that it is the same as the user under which the delivery
23266 process is running.
23267
23268
23269 .option check_string appendfile string "see below"
23270 .cindex "&""From""& line"
23271 As &(appendfile)& writes the message, the start of each line is tested for
23272 matching &%check_string%&, and if it does, the initial matching characters are
23273 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23274 a literal string, not a regular expression, and the case of any letters it
23275 contains is significant.
23276
23277 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23278 are forced to &"."& and &".."& respectively, and any settings in the
23279 configuration are ignored. Otherwise, they default to &"From&~"& and
23280 &">From&~"& when the &%file%& option is set, and unset when any of the
23281 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23282
23283 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23284 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23285 &"From&~"& indicates the start of a new message. All four options need changing
23286 if another format is used. For example, to deliver to mailboxes in MMDF format:
23287 .cindex "MMDF format mailbox"
23288 .cindex "mailbox" "MMDF format"
23289 .code
23290 check_string = "\1\1\1\1\n"
23291 escape_string = "\1\1\1\1 \n"
23292 message_prefix = "\1\1\1\1\n"
23293 message_suffix = "\1\1\1\1\n"
23294 .endd
23295 .option create_directory appendfile boolean true
23296 .cindex "directory creation"
23297 When this option is true, Exim attempts to create any missing superior
23298 directories for the file that it is about to write. A created directory's mode
23299 is given by the &%directory_mode%& option.
23300
23301 The group ownership of a newly created directory is highly dependent on the
23302 operating system (and possibly the file system) that is being used. For
23303 example, in Solaris, if the parent directory has the setgid bit set, its group
23304 is propagated to the child; if not, the currently set group is used. However,
23305 in FreeBSD, the parent's group is always used.
23306
23307
23308
23309 .option create_file appendfile string anywhere
23310 This option constrains the location of files and directories that are created
23311 by this transport. It applies to files defined by the &%file%& option and
23312 directories defined by the &%directory%& option. In the case of maildir
23313 delivery, it applies to the top level directory, not the maildir directories
23314 beneath.
23315
23316 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23317 &"belowhome"&, or to an absolute path.
23318
23319 In the second and third cases, a home directory must have been
23320 set for the transport, and the file or directory being created must
23321 reside within it.
23322 The "belowhome" checking additionally checks for attempts to use "../"
23323 to evade the testing.
23324 This option is not useful when an explicit filename is
23325 given for normal mailbox deliveries. It is intended for the case when filenames
23326 are generated from users' &_.forward_& files. These are usually handled
23327 by an &(appendfile)& transport called &%address_file%&. See also
23328 &%file_must_exist%&.
23329
23330 In the fourth case,
23331 the value given for this option must be an absolute path for an
23332 existing directory.
23333 The value is used for checking instead of a home directory;
23334 checking is done in "belowhome" mode.
23335
23336 .cindex "tainted data" "de-tainting"
23337 .cindex "de-tainting" "using appendfile create_file option"
23338 If "belowhome" checking is used, the file or directory path
23339 becomes de-tainted.
23340
23341
23342 .option directory appendfile string&!! unset
23343 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23344 or &%directory%& must be set, unless the delivery is the direct result of a
23345 redirection (see section &<<SECTfildiropt>>&).
23346
23347 When &%directory%& is set, the string is expanded, and the message is delivered
23348 into a new file or files in or below the given directory, instead of being
23349 appended to a single mailbox file. A number of different formats are provided
23350 (see &%maildir_format%& and &%mailstore_format%&), and see section
23351 &<<SECTopdir>>& for further details of this form of delivery.
23352
23353 The result of expansion must not be tainted, unless the &%create_file%& option
23354 specifies a path.
23355
23356
23357 .option directory_file appendfile string&!! "see below"
23358 .cindex "base62"
23359 .vindex "&$inode$&"
23360 When &%directory%& is set, but neither &%maildir_format%& nor
23361 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23362 whose name is obtained by expanding this string. The default value is:
23363 .code
23364 q${base62:$tod_epoch}-$inode
23365 .endd
23366 This generates a unique name from the current time, in base 62 form, and the
23367 inode of the file. The variable &$inode$& is available only when expanding this
23368 option.
23369
23370
23371 .option directory_mode appendfile "octal integer" 0700
23372 If &(appendfile)& creates any directories as a result of the
23373 &%create_directory%& option, their mode is specified by this option.
23374
23375
23376 .option escape_string appendfile string "see description"
23377 See &%check_string%& above.
23378
23379
23380 .option file appendfile string&!! unset
23381 This option is mutually exclusive with the &%directory%& option, but one of
23382 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23383 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23384 specifies a single file, to which the message is appended. One or more of
23385 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23386 &%file%&.
23387
23388 The result of expansion must not be tainted, unless the &%create_file%& option
23389 specifies a path.
23390
23391 .cindex "NFS" "lock file"
23392 .cindex "locking files"
23393 .cindex "lock files"
23394 If you are using more than one host to deliver over NFS into the same
23395 mailboxes, you should always use lock files.
23396
23397 The string value is expanded for each delivery, and must yield an absolute
23398 path. The most common settings of this option are variations on one of these
23399 examples:
23400 .code
23401 file = /var/spool/mail/$local_part_data
23402 file = /home/$local_part_data/inbox
23403 file = $home/inbox
23404 .endd
23405 .cindex "&""sticky""& bit"
23406 In the first example, all deliveries are done into the same directory. If Exim
23407 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23408 create a file in the directory, so the &"sticky"& bit must be turned on for
23409 deliveries to be possible, or alternatively the &%group%& option can be used to
23410 run the delivery under a group id which has write access to the directory.
23411
23412
23413
23414 .option file_format appendfile string unset
23415 .cindex "file" "mailbox; checking existing format"
23416 This option requests the transport to check the format of an existing file
23417 before adding to it. The check consists of matching a specific string at the
23418 start of the file. The value of the option consists of an even number of
23419 colon-separated strings. The first of each pair is the test string, and the
23420 second is the name of a transport. If the transport associated with a matched
23421 string is not the current transport, control is passed over to the other
23422 transport. For example, suppose the standard &(local_delivery)& transport has
23423 this added to it:
23424 .code
23425 file_format = "From       : local_delivery :\
23426                \1\1\1\1\n : local_mmdf_delivery"
23427 .endd
23428 Mailboxes that begin with &"From"& are still handled by this transport, but if
23429 a mailbox begins with four binary ones followed by a newline, control is passed
23430 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23431 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23432 is assumed to match the current transport. If the start of a mailbox doesn't
23433 match any string, or if the transport named for a given string is not defined,
23434 delivery is deferred.
23435
23436
23437 .option file_must_exist appendfile boolean false
23438 If this option is true, the file specified by the &%file%& option must exist.
23439 A temporary error occurs if it does not, causing delivery to be deferred.
23440 If this option is false, the file is created if it does not exist.
23441
23442
23443 .option lock_fcntl_timeout appendfile time 0s
23444 .cindex "timeout" "mailbox locking"
23445 .cindex "mailbox" "locking, blocking and non-blocking"
23446 .cindex "locking files"
23447 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23448 when locking an open mailbox file. If the call fails, the delivery process
23449 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23450 Non-blocking calls are used so that the file is not kept open during the wait
23451 for the lock; the reason for this is to make it as safe as possible for
23452 deliveries over NFS in the case when processes might be accessing an NFS
23453 mailbox without using a lock file. This should not be done, but
23454 misunderstandings and hence misconfigurations are not unknown.
23455
23456 On a busy system, however, the performance of a non-blocking lock approach is
23457 not as good as using a blocking lock with a timeout. In this case, the waiting
23458 is done inside the system call, and Exim's delivery process acquires the lock
23459 and can proceed as soon as the previous lock holder releases it.
23460
23461 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23462 timeout, are used. There may still be some retrying: the maximum number of
23463 retries is
23464 .code
23465 (lock_retries * lock_interval) / lock_fcntl_timeout
23466 .endd
23467 rounded up to the next whole number. In other words, the total time during
23468 which &(appendfile)& is trying to get a lock is roughly the same, unless
23469 &%lock_fcntl_timeout%& is set very large.
23470
23471 You should consider setting this option if you are getting a lot of delayed
23472 local deliveries because of errors of the form
23473 .code
23474 failed to lock mailbox /some/file (fcntl)
23475 .endd
23476
23477 .option lock_flock_timeout appendfile time 0s
23478 This timeout applies to file locking when using &[flock()]& (see
23479 &%use_flock%&); the timeout operates in a similar manner to
23480 &%lock_fcntl_timeout%&.
23481
23482
23483 .option lock_interval appendfile time 3s
23484 This specifies the time to wait between attempts to lock the file. See below
23485 for details of locking.
23486
23487
23488 .option lock_retries appendfile integer 10
23489 This specifies the maximum number of attempts to lock the file. A value of zero
23490 is treated as 1. See below for details of locking.
23491
23492
23493 .option lockfile_mode appendfile "octal integer" 0600
23494 This specifies the mode of the created lock file, when a lock file is being
23495 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23496
23497
23498 .option lockfile_timeout appendfile time 30m
23499 .cindex "timeout" "mailbox locking"
23500 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23501 exists and is older than this value, it is assumed to have been left behind by
23502 accident, and Exim attempts to remove it.
23503
23504
23505 .option mailbox_filecount appendfile string&!! unset
23506 .cindex "mailbox" "specifying size of"
23507 .cindex "size" "of mailbox"
23508 If this option is set, it is expanded, and the result is taken as the current
23509 number of files in the mailbox. It must be a decimal number, optionally
23510 followed by K or M. This provides a way of obtaining this information from an
23511 external source that maintains the data.
23512
23513
23514 .option mailbox_size appendfile string&!! unset
23515 .cindex "mailbox" "specifying size of"
23516 .cindex "size" "of mailbox"
23517 If this option is set, it is expanded, and the result is taken as the current
23518 size the mailbox. It must be a decimal number, optionally followed by K or M.
23519 This provides a way of obtaining this information from an external source that
23520 maintains the data. This is likely to be helpful for maildir deliveries where
23521 it is computationally expensive to compute the size of a mailbox.
23522
23523
23524
23525 .option maildir_format appendfile boolean false
23526 .cindex "maildir format" "specifying"
23527 If this option is set with the &%directory%& option, the delivery is into a new
23528 file, in the &"maildir"& format that is used by other mail software. When the
23529 transport is activated directly from a &(redirect)& router (for example, the
23530 &(address_file)& transport in the default configuration), setting
23531 &%maildir_format%& causes the path received from the router to be treated as a
23532 directory, whether or not it ends with &`/`&. This option is available only if
23533 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23534 &<<SECTmaildirdelivery>>& below for further details.
23535
23536
23537 .option maildir_quota_directory_regex appendfile string "See below"
23538 .cindex "maildir format" "quota; directories included in"
23539 .cindex "quota" "maildir; directories included in"
23540 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23541 a regular expression for specifying directories, relative to the quota
23542 directory (see &%quota_directory%&), that should be included in the quota
23543 calculation. The default value is:
23544 .code
23545 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23546 .endd
23547 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23548 (directories whose names begin with a dot). If you want to exclude the
23549 &_Trash_&
23550 folder from the count (as some sites do), you need to change this setting to
23551 .code
23552 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23553 .endd
23554 This uses a negative lookahead in the regular expression to exclude the
23555 directory whose name is &_.Trash_&. When a directory is excluded from quota
23556 calculations, quota processing is bypassed for any messages that are delivered
23557 directly into that directory.
23558
23559
23560 .option maildir_retries appendfile integer 10
23561 This option specifies the number of times to retry when writing a file in
23562 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23563
23564
23565 .option maildir_tag appendfile string&!! unset
23566 This option applies only to deliveries in maildir format, and is described in
23567 section &<<SECTmaildirdelivery>>& below.
23568
23569
23570 .option maildir_use_size_file appendfile&!! boolean false
23571 .cindex "maildir format" "&_maildirsize_& file"
23572 The result of string expansion for this option must be a valid boolean value.
23573 If it is true, it enables support for &_maildirsize_& files. Exim
23574 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23575 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23576 value is zero. See &%maildir_quota_directory_regex%& above and section
23577 &<<SECTmaildirdelivery>>& below for further details.
23578
23579 .option maildirfolder_create_regex appendfile string unset
23580 .cindex "maildir format" "&_maildirfolder_& file"
23581 .cindex "&_maildirfolder_&, creating"
23582 The value of this option is a regular expression. If it is unset, it has no
23583 effect. Otherwise, before a maildir delivery takes place, the pattern is
23584 matched against the name of the maildir directory, that is, the directory
23585 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23586 delivery. If there is a match, Exim checks for the existence of a file called
23587 &_maildirfolder_& in the directory, and creates it if it does not exist.
23588 See section &<<SECTmaildirdelivery>>& for more details.
23589
23590
23591 .option mailstore_format appendfile boolean false
23592 .cindex "mailstore format" "specifying"
23593 If this option is set with the &%directory%& option, the delivery is into two
23594 new files in  &"mailstore"& format. The option is available only if
23595 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23596 below for further details.
23597
23598
23599 .option mailstore_prefix appendfile string&!! unset
23600 This option applies only to deliveries in mailstore format, and is described in
23601 section &<<SECTopdir>>& below.
23602
23603
23604 .option mailstore_suffix appendfile string&!! unset
23605 This option applies only to deliveries in mailstore format, and is described in
23606 section &<<SECTopdir>>& below.
23607
23608
23609 .option mbx_format appendfile boolean false
23610 .cindex "locking files"
23611 .cindex "file" "locking"
23612 .cindex "file" "MBX format"
23613 .cindex "MBX format, specifying"
23614 This option is available only if Exim has been compiled with SUPPORT_MBX
23615 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23616 the message is appended to the mailbox file in MBX format instead of
23617 traditional Unix format. This format is supported by Pine4 and its associated
23618 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23619
23620 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23621 automatically changed by the use of &%mbx_format%&. They should normally be set
23622 empty when using MBX format, so this option almost always appears in this
23623 combination:
23624 .code
23625 mbx_format = true
23626 message_prefix =
23627 message_suffix =
23628 .endd
23629 If none of the locking options are mentioned in the configuration,
23630 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23631 is possible to specify the other kinds of locking with &%mbx_format%&, but
23632 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23633 interworks with &'c-client'&, providing for shared access to the mailbox. It
23634 should not be used if any program that does not use this form of locking is
23635 going to access the mailbox, nor should it be used if the mailbox file is NFS
23636 mounted, because it works only when the mailbox is accessed from a single host.
23637
23638 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23639 the standard version of &'c-client'&, because as long as it has a mailbox open
23640 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23641 append messages to it.
23642
23643
23644 .option message_prefix appendfile string&!! "see below"
23645 .cindex "&""From""& line"
23646 The string specified here is expanded and output at the start of every message.
23647 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23648 in which case it is:
23649 .code
23650 message_prefix = "From ${if def:return_path{$return_path}\
23651   {MAILER-DAEMON}} $tod_bsdinbox\n"
23652 .endd
23653 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23654 &`\n`& to &`\r\n`& in &%message_prefix%&.
23655
23656 .option message_suffix appendfile string&!! "see below"
23657 The string specified here is expanded and output at the end of every message.
23658 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23659 in which case it is a single newline character. The suffix can be suppressed by
23660 setting
23661 .code
23662 message_suffix =
23663 .endd
23664 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23665 &`\n`& to &`\r\n`& in &%message_suffix%&.
23666
23667 .option mode appendfile "octal integer" 0600
23668 If the output file is created, it is given this mode. If it already exists and
23669 has wider permissions, they are reduced to this mode. If it has narrower
23670 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23671 if the delivery is the result of a &%save%& command in a filter file specifying
23672 a particular mode, the mode of the output file is always forced to take that
23673 value, and this option is ignored.
23674
23675
23676 .option mode_fail_narrower appendfile boolean true
23677 This option applies in the case when an existing mailbox file has a narrower
23678 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23679 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23680 continues with the delivery attempt, using the existing mode of the file.
23681
23682
23683 .option notify_comsat appendfile boolean false
23684 If this option is true, the &'comsat'& daemon is notified after every
23685 successful delivery to a user mailbox. This is the daemon that notifies logged
23686 on users about incoming mail.
23687
23688
23689 .option quota appendfile string&!! unset
23690 .cindex "quota" "imposed by Exim"
23691 This option imposes a limit on the size of the file to which Exim is appending,
23692 or to the total space used in the directory tree when the &%directory%& option
23693 is set. In the latter case, computation of the space used is expensive, because
23694 all the files in the directory (and any sub-directories) have to be
23695 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23696 &%maildir_use_size_file%& for ways to avoid this in environments where users
23697 have no shell access to their mailboxes).
23698
23699 As there is no interlock against two simultaneous deliveries into a
23700 multi-file mailbox, it is possible for the quota to be overrun in this case.
23701 For single-file mailboxes, of course, an interlock is a necessity.
23702
23703 A file's size is taken as its &'used'& value. Because of blocking effects, this
23704 may be a lot less than the actual amount of disk space allocated to the file.
23705 If the sizes of a number of files are being added up, the rounding effect can
23706 become quite noticeable, especially on systems that have large block sizes.
23707 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23708 the obvious value which users understand most easily.
23709
23710 The value of the option is expanded, and must then be a numerical value
23711 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23712 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23713 and further option modifiers. If Exim is running on a system with
23714 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23715 be handled.
23716
23717 The option modifier &%no_check%& can be used to force delivery even if the over
23718 quota condition is met. The quota gets updated as usual.
23719
23720 &*Note*&: A value of zero is interpreted as &"no quota"&.
23721
23722 The expansion happens while Exim is running as root, before it changes uid for
23723 the delivery. This means that files that are inaccessible to the end user can
23724 be used to hold quota values that are looked up in the expansion. When delivery
23725 fails because this quota is exceeded, the handling of the error is as for
23726 system quota failures.
23727
23728 By default, Exim's quota checking mimics system quotas, and restricts the
23729 mailbox to the specified maximum size, though the value is not accurate to the
23730 last byte, owing to separator lines and additional headers that may get added
23731 during message delivery. When a mailbox is nearly full, large messages may get
23732 refused even though small ones are accepted, because the size of the current
23733 message is added to the quota when the check is made. This behaviour can be
23734 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23735 for exceeding the quota does not include the current message. Thus, deliveries
23736 continue until the quota has been exceeded; thereafter, no further messages are
23737 delivered. See also &%quota_warn_threshold%&.
23738
23739
23740 .option quota_directory appendfile string&!! unset
23741 This option defines the directory to check for quota purposes when delivering
23742 into individual files. The default is the delivery directory, or, if a file
23743 called &_maildirfolder_& exists in a maildir directory, the parent of the
23744 delivery directory.
23745
23746
23747 .option quota_filecount appendfile string&!! 0
23748 This option applies when the &%directory%& option is set. It limits the total
23749 number of files in the directory (compare the inode limit in system quotas). It
23750 can only be used if &%quota%& is also set. The value is expanded; an expansion
23751 failure causes delivery to be deferred. A value of zero is interpreted as
23752 &"no quota"&.
23753
23754 The option modifier &%no_check%& can be used to force delivery even if the over
23755 quota condition is met. The quota gets updated as usual.
23756
23757 .option quota_is_inclusive appendfile boolean true
23758 See &%quota%& above.
23759
23760
23761 .option quota_size_regex appendfile string unset
23762 This option applies when one of the delivery modes that writes a separate file
23763 for each message is being used. When Exim wants to find the size of one of
23764 these files in order to test the quota, it first checks &%quota_size_regex%&.
23765 If this is set to a regular expression that matches the filename, and it
23766 captures one string, that string is interpreted as a representation of the
23767 file's size. The value of &%quota_size_regex%& is not expanded.
23768
23769 This feature is useful only when users have no shell access to their mailboxes
23770 &-- otherwise they could defeat the quota simply by renaming the files. This
23771 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23772 the file length to the filename. For example:
23773 .code
23774 maildir_tag = ,S=$message_size
23775 quota_size_regex = ,S=(\d+)
23776 .endd
23777 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23778 number of lines in the message.
23779
23780 The regular expression should not assume that the length is at the end of the
23781 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23782 sometimes add other information onto the ends of message filenames.
23783
23784 Section &<<SECID136>>& contains further information.
23785
23786 This option should not be used when other message-handling software
23787 may duplicate messages by making hardlinks to the files.  When that is done Exim
23788 will count the message size once for each filename, in contrast with the actual
23789 disk usage.  When the option is not set, calculating total usage requires
23790 a system-call per file to get the size; the number of links is then available also
23791 as is used to adjust the effective size.
23792
23793
23794 .option quota_warn_message appendfile string&!! "see below"
23795 See below for the use of this option. If it is not set when
23796 &%quota_warn_threshold%& is set, it defaults to
23797 .code
23798 quota_warn_message = "\
23799   To: $local_part@$domain\n\
23800   Subject: Your mailbox\n\n\
23801   This message is automatically created \
23802   by mail delivery software.\n\n\
23803   The size of your mailbox has exceeded \
23804   a warning threshold that is\n\
23805   set by the system administrator.\n"
23806 .endd
23807
23808
23809 .option quota_warn_threshold appendfile string&!! 0
23810 .cindex "quota" "warning threshold"
23811 .cindex "mailbox" "size warning"
23812 .cindex "size" "of mailbox"
23813 This option is expanded in the same way as &%quota%& (see above). If the
23814 resulting value is greater than zero, and delivery of the message causes the
23815 size of the file or total space in the directory tree to cross the given
23816 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23817 may be specified as a percentage of it by following the value with a percent
23818 sign. For example:
23819 .code
23820 quota = 10M
23821 quota_warn_threshold = 75%
23822 .endd
23823 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23824 percent sign is ignored.
23825
23826 The warning message itself is specified by the &%quota_warn_message%& option,
23827 and it must start with a &'To:'& header line containing the recipient(s) of the
23828 warning message. These do not necessarily have to include the recipient(s) of
23829 the original message. A &'Subject:'& line should also normally be supplied. You
23830 can include any other header lines that you want. If you do not include a
23831 &'From:'& line, the default is:
23832 .code
23833 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23834 .endd
23835 .oindex &%errors_reply_to%&
23836 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23837 option.
23838
23839 The &%quota%& option does not have to be set in order to use this option; they
23840 are independent of one another except when the threshold is specified as a
23841 percentage.
23842
23843
23844 .option use_bsmtp appendfile boolean false
23845 .cindex "envelope from"
23846 .cindex "envelope sender"
23847 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23848 format, with the envelope sender and recipient(s) included as SMTP commands. If
23849 you want to include a leading HELO command with such messages, you can do
23850 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23851 for details of batch SMTP.
23852
23853
23854 .option use_crlf appendfile boolean false
23855 .cindex "carriage return"
23856 .cindex "linefeed"
23857 This option causes lines to be terminated with the two-character CRLF sequence
23858 (carriage return, linefeed) instead of just a linefeed character. In the case
23859 of batched SMTP, the byte sequence written to the file is then an exact image
23860 of what would be sent down a real SMTP connection.
23861
23862 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23863 (which are used to supply the traditional &"From&~"& and blank line separators
23864 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23865 carriage return characters if these are needed. In cases where these options
23866 have non-empty defaults, the values end with a single linefeed, so they must be
23867 changed to end with &`\r\n`& if &%use_crlf%& is set.
23868
23869
23870 .option use_fcntl_lock appendfile boolean "see below"
23871 This option controls the use of the &[fcntl()]& function to lock a file for
23872 exclusive use when a message is being appended. It is set by default unless
23873 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23874 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23875 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23876
23877
23878 .option use_flock_lock appendfile boolean false
23879 This option is provided to support the use of &[flock()]& for file locking, for
23880 the few situations where it is needed. Most modern operating systems support
23881 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23882 each other. Exim uses &[fcntl()]& locking by default.
23883
23884 This option is required only if you are using an operating system where
23885 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23886 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23887 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23888
23889 .cindex "Solaris" "&[flock()]& support"
23890 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23891 have it (and some, I think, provide a not quite right version built on top of
23892 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23893 the ability to use it, and any attempt to do so will cause a configuration
23894 error.
23895
23896 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23897 is just being mapped onto &[fcntl()]& by the OS).
23898
23899
23900 .option use_lockfile appendfile boolean "see below"
23901 If this option is turned off, Exim does not attempt to create a lock file when
23902 appending to a mailbox file. In this situation, the only locking is by
23903 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23904 sure that every MUA that is ever going to look at your users' mailboxes uses
23905 &[fcntl()]& rather than a lock file, and even then only when you are not
23906 delivering over NFS from more than one host.
23907
23908 .cindex "NFS" "lock file"
23909 In order to append to an NFS file safely from more than one host, it is
23910 necessary to take out a lock &'before'& opening the file, and the lock file
23911 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23912 file corruption.
23913
23914 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23915 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23916 except when &%mbx_format%& is set.
23917
23918
23919 .option use_mbx_lock appendfile boolean "see below"
23920 This option is available only if Exim has been compiled with SUPPORT_MBX
23921 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23922 locking rules be used. It is set by default if &%mbx_format%& is set and none
23923 of the locking options are mentioned in the configuration. The locking rules
23924 are the same as are used by the &'c-client'& library that underlies Pine and
23925 the IMAP4 and POP daemons that come with it (see the discussion below). The
23926 rules allow for shared access to the mailbox. However, this kind of locking
23927 does not work when the mailbox is NFS mounted.
23928
23929 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23930 &%use_flock_lock%& to control what kind of locking is used in implementing the
23931 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23932 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23933
23934
23935
23936
23937 .section "Operational details for appending" "SECTopappend"
23938 .cindex "appending to a file"
23939 .cindex "file" "appending"
23940 Before appending to a file, the following preparations are made:
23941
23942 .ilist
23943 If the name of the file is &_/dev/null_&, no action is taken, and a success
23944 return is given.
23945
23946 .next
23947 .cindex "directory creation"
23948 If any directories on the file's path are missing, Exim creates them if the
23949 &%create_directory%& option is set. A created directory's mode is given by the
23950 &%directory_mode%& option.
23951
23952 .next
23953 If &%file_format%& is set, the format of an existing file is checked. If this
23954 indicates that a different transport should be used, control is passed to that
23955 transport.
23956
23957 .next
23958 .cindex "file" "locking"
23959 .cindex "locking files"
23960 .cindex "NFS" "lock file"
23961 If &%use_lockfile%& is set, a lock file is built in a way that will work
23962 reliably over NFS, as follows:
23963
23964 .olist
23965 Create a &"hitching post"& file whose name is that of the lock file with the
23966 current time, primary host name, and process id added, by opening for writing
23967 as a new file. If this fails with an access error, delivery is deferred.
23968 .next
23969 Close the hitching post file, and hard link it to the lock filename.
23970 .next
23971 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23972 Unlink the hitching post name.
23973 .next
23974 Otherwise, use &[stat()]& to get information about the hitching post file, and
23975 then unlink hitching post name. If the number of links is exactly two, creation
23976 of the lock file succeeded but something (for example, an NFS server crash and
23977 restart) caused this fact not to be communicated to the &[link()]& call.
23978 .next
23979 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23980 up to &%lock_retries%& times. However, since any program that writes to a
23981 mailbox should complete its task very quickly, it is reasonable to time out old
23982 lock files that are normally the result of user agent and system crashes. If an
23983 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23984 it before trying again.
23985 .endlist olist
23986
23987 .next
23988 A call is made to &[lstat()]& to discover whether the main file exists, and if
23989 so, what its characteristics are. If &[lstat()]& fails for any reason other
23990 than non-existence, delivery is deferred.
23991
23992 .next
23993 .cindex "symbolic link" "to mailbox"
23994 .cindex "mailbox" "symbolic link"
23995 If the file does exist and is a symbolic link, delivery is deferred, unless the
23996 &%allow_symlink%& option is set, in which case the ownership of the link is
23997 checked, and then &[stat()]& is called to find out about the real file, which
23998 is then subjected to the checks below. The check on the top-level link
23999 ownership prevents one user creating a link for another's mailbox in a sticky
24000 directory, though allowing symbolic links in this case is definitely not a good
24001 idea. If there is a chain of symbolic links, the intermediate ones are not
24002 checked.
24003
24004 .next
24005 If the file already exists but is not a regular file, or if the file's owner
24006 and group (if the group is being checked &-- see &%check_group%& above) are
24007 different from the user and group under which the delivery is running,
24008 delivery is deferred.
24009
24010 .next
24011 If the file's permissions are more generous than specified, they are reduced.
24012 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
24013 is set false, in which case the delivery is tried using the existing
24014 permissions.
24015
24016 .next
24017 The file's inode number is saved, and the file is then opened for appending.
24018 If this fails because the file has vanished, &(appendfile)& behaves as if it
24019 hadn't existed (see below). For any other failures, delivery is deferred.
24020
24021 .next
24022 If the file is opened successfully, check that the inode number hasn't
24023 changed, that it is still a regular file, and that the owner and permissions
24024 have not changed. If anything is wrong, defer delivery and freeze the message.
24025
24026 .next
24027 If the file did not exist originally, defer delivery if the &%file_must_exist%&
24028 option is set. Otherwise, check that the file is being created in a permitted
24029 directory if the &%create_file%& option is set (deferring on failure), and then
24030 open for writing as a new file, with the O_EXCL and O_CREAT options,
24031 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24032 set). In this case, which can happen if the link points to a non-existent file,
24033 the file is opened for writing using O_CREAT but not O_EXCL, because
24034 that prevents link following.
24035
24036 .next
24037 .cindex "loop" "while file testing"
24038 If opening fails because the file exists, obey the tests given above for
24039 existing files. However, to avoid looping in a situation where the file is
24040 being continuously created and destroyed, the exists/not-exists loop is broken
24041 after 10 repetitions, and the message is then frozen.
24042
24043 .next
24044 If opening fails with any other error, defer delivery.
24045
24046 .next
24047 .cindex "file" "locking"
24048 .cindex "locking files"
24049 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24050 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24051 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24052 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24053 file, and an exclusive lock on the file whose name is
24054 .code
24055 /tmp/.<device-number>.<inode-number>
24056 .endd
24057 using the device and inode numbers of the open mailbox file, in accordance with
24058 the MBX locking rules. This file is created with a mode that is specified by
24059 the &%lockfile_mode%& option.
24060
24061 If Exim fails to lock the file, there are two possible courses of action,
24062 depending on the value of the locking timeout. This is obtained from
24063 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24064
24065 If the timeout value is zero, the file is closed, Exim waits for
24066 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24067 to lock it again. This happens up to &%lock_retries%& times, after which the
24068 delivery is deferred.
24069
24070 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24071 &[flock()]& are used (with the given timeout), so there has already been some
24072 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24073 immediately. It retries up to
24074 .code
24075 (lock_retries * lock_interval) / <timeout>
24076 .endd
24077 times (rounded up).
24078 .endlist
24079
24080 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24081 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24082
24083
24084 .section "Operational details for delivery to a new file" "SECTopdir"
24085 .cindex "delivery" "to single file"
24086 .cindex "&""From""& line"
24087 When the &%directory%& option is set instead of &%file%&, each message is
24088 delivered into a newly-created file or set of files. When &(appendfile)& is
24089 activated directly from a &(redirect)& router, neither &%file%& nor
24090 &%directory%& is normally set, because the path for delivery is supplied by the
24091 router. (See for example, the &(address_file)& transport in the default
24092 configuration.) In this case, delivery is to a new file if either the path name
24093 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24094
24095 No locking is required while writing the message to a new file, so the various
24096 locking options of the transport are ignored. The &"From"& line that by default
24097 separates messages in a single file is not normally needed, nor is the escaping
24098 of message lines that start with &"From"&, and there is no need to ensure a
24099 newline at the end of each message. Consequently, the default values for
24100 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24101 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24102
24103 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24104 the files in the delivery directory by default. However, you can specify a
24105 different directory by setting &%quota_directory%&. Also, for maildir
24106 deliveries (see below) the &_maildirfolder_& convention is honoured.
24107
24108
24109 .cindex "maildir format"
24110 .cindex "mailstore format"
24111 There are three different ways in which delivery to individual files can be
24112 done, controlled by the settings of the &%maildir_format%& and
24113 &%mailstore_format%& options. Note that code to support maildir or mailstore
24114 formats is not included in the binary unless SUPPORT_MAILDIR or
24115 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24116
24117 .cindex "directory creation"
24118 In all three cases an attempt is made to create the directory and any necessary
24119 sub-directories if they do not exist, provided that the &%create_directory%&
24120 option is set (the default). The location of a created directory can be
24121 constrained by setting &%create_file%&. A created directory's mode is given by
24122 the &%directory_mode%& option. If creation fails, or if the
24123 &%create_directory%& option is not set when creation is required, delivery is
24124 deferred.
24125
24126
24127
24128 .section "Maildir delivery" "SECTmaildirdelivery"
24129 .cindex "maildir format" "description of"
24130 If the &%maildir_format%& option is true, Exim delivers each message by writing
24131 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24132 directory that is defined by the &%directory%& option (the &"delivery
24133 directory"&). If the delivery is successful, the file is renamed into the
24134 &_new_& subdirectory.
24135
24136 In the filename, <&'stime'&> is the current time of day in seconds, and
24137 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24138 Exim checks that the time-of-day clock has moved on by at least one microsecond
24139 before terminating the delivery process. This guarantees uniqueness for the
24140 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24141 opening it. If any response other than ENOENT (does not exist) is given,
24142 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24143
24144 Before Exim carries out a maildir delivery, it ensures that subdirectories
24145 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24146 do not exist, Exim tries to create them and any superior directories in their
24147 path, subject to the &%create_directory%& and &%create_file%& options. If the
24148 &%maildirfolder_create_regex%& option is set, and the regular expression it
24149 contains matches the delivery directory, Exim also ensures that a file called
24150 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24151 &_maildirfolder_& file cannot be created, delivery is deferred.
24152
24153 These features make it possible to use Exim to create all the necessary files
24154 and directories in a maildir mailbox, including subdirectories for maildir++
24155 folders. Consider this example:
24156 .code
24157 maildir_format = true
24158 directory = /var/mail/$local_part_data\
24159            ${if eq{$local_part_suffix}{}{}\
24160            {/.${substr_1:$local_part_suffix}}}
24161 maildirfolder_create_regex = /\.[^/]+$
24162 .endd
24163 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24164 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24165 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24166 not match this name, so Exim will not look for or create the file
24167 &_/var/mail/pimbo/maildirfolder_&, though it will create
24168 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24169
24170 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24171 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24172 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24173 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24174 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24175
24176 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24177 not inadvertently match the toplevel maildir directory, because a
24178 &_maildirfolder_& file at top level would completely break quota calculations.
24179
24180 .cindex "quota" "in maildir delivery"
24181 .cindex "maildir++"
24182 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24183 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24184 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24185 Exim assumes the directory is a maildir++ folder directory, which is one level
24186 down from the user's top level mailbox directory. This causes it to start at
24187 the parent directory instead of the current directory when calculating the
24188 amount of space used.
24189
24190 One problem with delivering into a multi-file mailbox is that it is
24191 computationally expensive to compute the size of the mailbox for quota
24192 checking. Various approaches have been taken to reduce the amount of work
24193 needed. The next two sections describe two of them. A third alternative is to
24194 use some external process for maintaining the size data, and use the expansion
24195 of the &%mailbox_size%& option as a way of importing it into Exim.
24196
24197
24198
24199
24200 .section "Using tags to record message sizes" "SECID135"
24201 If &%maildir_tag%& is set, the string is expanded for each delivery.
24202 When the maildir file is renamed into the &_new_& sub-directory, the
24203 tag is added to its name. However, if adding the tag takes the length of the
24204 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24205 the tag is dropped and the maildir file is created with no tag.
24206
24207
24208 .vindex "&$message_size$&"
24209 Tags can be used to encode the size of files in their names; see
24210 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24211 happens after the message has been written. The value of the &$message_size$&
24212 variable is set to the number of bytes actually written. If the expansion is
24213 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24214 be deferred. The expanded tag may contain any printing characters except &"/"&.
24215 Non-printing characters in the string are ignored; if the resulting string is
24216 empty, it is ignored. If it starts with an alphanumeric character, a leading
24217 colon is inserted; this default has not proven to be the path that popular
24218 maildir implementations have chosen (but changing it in Exim would break
24219 backwards compatibility).
24220
24221 For one common implementation, you might set:
24222 .code
24223 maildir_tag = ,S=${message_size}
24224 .endd
24225 but you should check the documentation of the other software to be sure.
24226
24227 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24228 as this allows Exim to extract the size from your tag, instead of having to
24229 &[stat()]& each message file.
24230
24231
24232 .section "Using a maildirsize file" "SECID136"
24233 .cindex "quota" "in maildir delivery"
24234 .cindex "maildir format" "&_maildirsize_& file"
24235 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24236 storing quota and message size information in a file called &_maildirsize_&
24237 within the toplevel maildir directory. If this file does not exist, Exim
24238 creates it, setting the quota from the &%quota%& option of the transport. If
24239 the maildir directory itself does not exist, it is created before any attempt
24240 to write a &_maildirsize_& file.
24241
24242 The &_maildirsize_& file is used to hold information about the sizes of
24243 messages in the maildir, thus speeding up quota calculations. The quota value
24244 in the file is just a cache; if the quota is changed in the transport, the new
24245 value overrides the cached value when the next message is delivered. The cache
24246 is maintained for the benefit of other programs that access the maildir and
24247 need to know the quota.
24248
24249 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24250 file is maintained (with a zero quota setting), but no quota is imposed.
24251
24252 A regular expression is available for controlling which directories in the
24253 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24254 See the description of the &%maildir_quota_directory_regex%& option above for
24255 details.
24256
24257
24258 .section "Mailstore delivery" "SECID137"
24259 .cindex "mailstore format" "description of"
24260 If the &%mailstore_format%& option is true, each message is written as two
24261 files in the given directory. A unique base name is constructed from the
24262 message id and the current delivery process, and the files that are written use
24263 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24264 contains the message's envelope, and the &_.msg_& file contains the message
24265 itself. The base name is placed in the variable &$mailstore_basename$&.
24266
24267 During delivery, the envelope is first written to a file with the suffix
24268 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24269 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24270 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24271 file before accessing either of them. An alternative approach is to wait for
24272 the absence of a &_.tmp_& file.
24273
24274 The envelope file starts with any text defined by the &%mailstore_prefix%&
24275 option, expanded and terminated by a newline if there isn't one. Then follows
24276 the sender address on one line, then all the recipient addresses, one per line.
24277 There can be more than one recipient only if the &%batch_max%& option is set
24278 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24279 appended to the file, followed by a newline if it does not end with one.
24280
24281 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24282 failure, it is ignored. Other expansion errors are treated as serious
24283 configuration errors, and delivery is deferred. The variable
24284 &$mailstore_basename$& is available for use during these expansions.
24285
24286
24287 .section "Non-special new file delivery" "SECID138"
24288 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24289 file is created directly in the named directory. For example, when delivering
24290 messages into files in batched SMTP format for later delivery to some host (see
24291 section &<<SECTbatchSMTP>>&), a setting such as
24292 .code
24293 directory = /var/bsmtp/$host
24294 .endd
24295 might be used. A message is written to a file with a temporary name, which is
24296 then renamed when the delivery is complete. The final name is obtained by
24297 expanding the contents of the &%directory_file%& option.
24298 .ecindex IIDapptra1
24299 .ecindex IIDapptra2
24300
24301
24302
24303
24304
24305
24306 . ////////////////////////////////////////////////////////////////////////////
24307 . ////////////////////////////////////////////////////////////////////////////
24308
24309 .chapter "The autoreply transport" "CHID8"
24310 .scindex IIDauttra1 "transports" "&(autoreply)&"
24311 .scindex IIDauttra2 "&(autoreply)& transport"
24312 The &(autoreply)& transport is not a true transport in that it does not cause
24313 the message to be transmitted. Instead, it generates a new mail message as an
24314 automatic reply to the incoming message. &'References:'& and
24315 &'Auto-Submitted:'& header lines are included. These are constructed according
24316 to the rules in RFCs 2822 and 3834, respectively.
24317
24318 If the router that passes the message to this transport does not have the
24319 &%unseen%& option set, the original message (for the current recipient) is not
24320 delivered anywhere. However, when the &%unseen%& option is set on the router
24321 that passes the message to this transport, routing of the address continues, so
24322 another router can set up a normal message delivery.
24323
24324
24325 The &(autoreply)& transport is usually run as the result of mail filtering, a
24326 &"vacation"& message being the standard example. However, it can also be run
24327 directly from a router like any other transport. To reduce the possibility of
24328 message cascades, messages created by the &(autoreply)& transport always have
24329 empty envelope sender addresses, like bounce messages.
24330
24331 The parameters of the message to be sent can be specified in the configuration
24332 by options described below. However, these are used only when the address
24333 passed to the transport does not contain its own reply information. When the
24334 transport is run as a consequence of a
24335 &%mail%&
24336 or &%vacation%& command in a filter file, the parameters of the message are
24337 supplied by the filter, and passed with the address. The transport's options
24338 that define the message are then ignored (so they are not usually set in this
24339 case). The message is specified entirely by the filter or by the transport; it
24340 is never built from a mixture of options. However, the &%file_optional%&,
24341 &%mode%&, and &%return_message%& options apply in all cases.
24342
24343 &(Autoreply)& is implemented as a local transport. When used as a result of a
24344 command in a user's filter file, &(autoreply)& normally runs under the uid and
24345 gid of the user, and with appropriate current and home directories (see chapter
24346 &<<CHAPenvironment>>&).
24347
24348 There is a subtle difference between routing a message to a &(pipe)& transport
24349 that generates some text to be returned to the sender, and routing it to an
24350 &(autoreply)& transport. This difference is noticeable only if more than one
24351 address from the same message is so handled. In the case of a pipe, the
24352 separate outputs from the different addresses are gathered up and returned to
24353 the sender in a single message, whereas if &(autoreply)& is used, a separate
24354 message is generated for each address that is passed to it.
24355
24356 Non-printing characters are not permitted in the header lines generated for the
24357 message that &(autoreply)& creates, with the exception of newlines that are
24358 immediately followed by white space. If any non-printing characters are found,
24359 the transport defers.
24360 Whether characters with the top bit set count as printing characters or not is
24361 controlled by the &%print_topbitchars%& global option.
24362
24363 If any of the generic options for manipulating headers (for example,
24364 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24365 of the original message that is included in the generated message when
24366 &%return_message%& is set. They do not apply to the generated message itself.
24367
24368 .vindex "&$sender_address$&"
24369 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24370 the message, indicating that there were no recipients, it does not treat this
24371 as an error. This means that autoreplies sent to &$sender_address$& when this
24372 is empty (because the incoming message is a bounce message) do not cause
24373 problems. They are just discarded.
24374
24375
24376
24377 .section "Private options for autoreply" "SECID139"
24378 .cindex "options" "&(autoreply)& transport"
24379
24380 .option bcc autoreply string&!! unset
24381 This specifies the addresses that are to receive &"blind carbon copies"& of the
24382 message when the message is specified by the transport.
24383
24384
24385 .option cc autoreply string&!! unset
24386 This specifies recipients of the message and the contents of the &'Cc:'& header
24387 when the message is specified by the transport.
24388
24389
24390 .option file autoreply string&!! unset
24391 The contents of the file are sent as the body of the message when the message
24392 is specified by the transport. If both &%file%& and &%text%& are set, the text
24393 string comes first.
24394
24395
24396 .option file_expand autoreply boolean false
24397 If this is set, the contents of the file named by the &%file%& option are
24398 subjected to string expansion as they are added to the message.
24399
24400
24401 .option file_optional autoreply boolean false
24402 If this option is true, no error is generated if the file named by the &%file%&
24403 option or passed with the address does not exist or cannot be read.
24404
24405
24406 .option from autoreply string&!! unset
24407 This specifies the contents of the &'From:'& header when the message is
24408 specified by the transport.
24409
24410
24411 .option headers autoreply string&!! unset
24412 This specifies additional RFC 2822 headers that are to be added to the message
24413 when the message is specified by the transport. Several can be given by using
24414 &"\n"& to separate them. There is no check on the format.
24415
24416
24417 .option log autoreply string&!! unset
24418 This option names a file in which a record of every message sent is logged when
24419 the message is specified by the transport.
24420
24421
24422 .option mode autoreply "octal integer" 0600
24423 If either the log file or the &"once"& file has to be created, this mode is
24424 used.
24425
24426
24427 .option never_mail autoreply "address list&!!" unset
24428 If any run of the transport creates a message with a recipient that matches any
24429 item in the list, that recipient is quietly discarded. If all recipients are
24430 discarded, no message is created. This applies both when the recipients are
24431 generated by a filter and when they are specified in the transport.
24432
24433
24434
24435 .option once autoreply string&!! unset
24436 This option names a file or DBM database in which a record of each &'To:'&
24437 recipient is kept when the message is specified by the transport. &*Note*&:
24438 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24439
24440 If &%once%& is unset, or is set to an empty string, the message is always sent.
24441 By default, if &%once%& is set to a non-empty filename, the message
24442 is not sent if a potential recipient is already listed in the database.
24443 However, if the &%once_repeat%& option specifies a time greater than zero, the
24444 message is sent if that much time has elapsed since a message was last sent to
24445 this recipient. A setting of zero time for &%once_repeat%& (the default)
24446 prevents a message from being sent a second time &-- in this case, zero means
24447 infinity.
24448
24449 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24450 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24451 greater than zero, it changes the way Exim implements the &%once%& option.
24452 Instead of using a DBM file to record every recipient it sends to, it uses a
24453 regular file, whose size will never get larger than the given value.
24454
24455 In the file, Exim keeps a linear list of recipient addresses and the times at
24456 which they were sent messages. If the file is full when a new address needs to
24457 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24458 means that a given recipient may receive multiple messages, but at
24459 unpredictable intervals that depend on the rate of turnover of addresses in the
24460 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24461
24462
24463 .option once_file_size autoreply integer 0
24464 See &%once%& above.
24465
24466
24467 .option once_repeat autoreply time&!! 0s
24468 See &%once%& above.
24469 After expansion, the value of this option must be a valid time value.
24470
24471
24472 .option reply_to autoreply string&!! unset
24473 This specifies the contents of the &'Reply-To:'& header when the message is
24474 specified by the transport.
24475
24476
24477 .option return_message autoreply boolean false
24478 If this is set, a copy of the original message is returned with the new
24479 message, subject to the maximum size set in the &%return_size_limit%& global
24480 configuration option.
24481
24482
24483 .option subject autoreply string&!! unset
24484 This specifies the contents of the &'Subject:'& header when the message is
24485 specified by the transport. It is tempting to quote the original subject in
24486 automatic responses. For example:
24487 .code
24488 subject = Re: $h_subject:
24489 .endd
24490 There is a danger in doing this, however. It may allow a third party to
24491 subscribe your users to an opt-in mailing list, provided that the list accepts
24492 bounce messages as subscription confirmations. Well-managed lists require a
24493 non-bounce message to confirm a subscription, so the danger is relatively
24494 small.
24495
24496
24497
24498 .option text autoreply string&!! unset
24499 This specifies a single string to be used as the body of the message when the
24500 message is specified by the transport. If both &%text%& and &%file%& are set,
24501 the text comes first.
24502
24503
24504 .option to autoreply string&!! unset
24505 This specifies recipients of the message and the contents of the &'To:'& header
24506 when the message is specified by the transport.
24507 .ecindex IIDauttra1
24508 .ecindex IIDauttra2
24509
24510
24511
24512
24513 . ////////////////////////////////////////////////////////////////////////////
24514 . ////////////////////////////////////////////////////////////////////////////
24515
24516 .chapter "The lmtp transport" "CHAPLMTP"
24517 .cindex "transports" "&(lmtp)&"
24518 .cindex "&(lmtp)& transport"
24519 .cindex "LMTP" "over a pipe"
24520 .cindex "LMTP" "over a socket"
24521 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24522 specified command
24523 or by interacting with a Unix domain socket.
24524 This transport is something of a cross between the &(pipe)& and &(smtp)&
24525 transports. Exim also has support for using LMTP over TCP/IP; this is
24526 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24527 to be of minority interest, the default build-time configure in &_src/EDITME_&
24528 has it commented out. You need to ensure that
24529 .code
24530 TRANSPORT_LMTP=yes
24531 .endd
24532 .cindex "options" "&(lmtp)& transport"
24533 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24534 included in the Exim binary. The private options of the &(lmtp)& transport are
24535 as follows:
24536
24537 .option batch_id lmtp string&!! unset
24538 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24539
24540
24541 .option batch_max lmtp integer 1
24542 This limits the number of addresses that can be handled in a single delivery.
24543 Most LMTP servers can handle several addresses at once, so it is normally a
24544 good idea to increase this value. See the description of local delivery
24545 batching in chapter &<<CHAPbatching>>&.
24546
24547
24548 .option command lmtp string&!! unset
24549 This option must be set if &%socket%& is not set. The string is a command which
24550 is run in a separate process. It is split up into a command name and list of
24551 arguments, each of which is separately expanded (so expansion cannot change the
24552 number of arguments). The command is run directly, not via a shell. The message
24553 is passed to the new process using the standard input and output to operate the
24554 LMTP protocol.
24555
24556 .option ignore_quota lmtp boolean false
24557 .cindex "LMTP" "ignoring quota errors"
24558 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24559 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24560 in its response to the LHLO command.
24561
24562 .option socket lmtp string&!! unset
24563 This option must be set if &%command%& is not set. The result of expansion must
24564 be the name of a Unix domain socket. The transport connects to the socket and
24565 delivers the message to it using the LMTP protocol.
24566
24567
24568 .option timeout lmtp time 5m
24569 The transport is aborted if the created process or Unix domain socket does not
24570 respond to LMTP commands or message input within this timeout. Delivery
24571 is deferred, and will be tried again later. Here is an example of a typical
24572 LMTP transport:
24573 .code
24574 lmtp:
24575   driver = lmtp
24576   command = /some/local/lmtp/delivery/program
24577   batch_max = 20
24578   user = exim
24579 .endd
24580 This delivers up to 20 addresses at a time, in a mixture of domains if
24581 necessary, running as the user &'exim'&.
24582
24583
24584
24585 . ////////////////////////////////////////////////////////////////////////////
24586 . ////////////////////////////////////////////////////////////////////////////
24587
24588 .chapter "The pipe transport" "CHAPpipetransport"
24589 .scindex IIDpiptra1 "transports" "&(pipe)&"
24590 .scindex IIDpiptra2 "&(pipe)& transport"
24591 The &(pipe)& transport is used to deliver messages via a pipe to a command
24592 running in another process. One example is the use of &(pipe)& as a
24593 pseudo-remote transport for passing messages to some other delivery mechanism
24594 (such as UUCP). Another is the use by individual users to automatically process
24595 their incoming messages. The &(pipe)& transport can be used in one of the
24596 following ways:
24597
24598 .ilist
24599 .vindex "&$local_part$&"
24600 A router routes one address to a transport in the normal way, and the
24601 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24602 contains the local part of the address (as usual), and the command that is run
24603 is specified by the &%command%& option on the transport.
24604 .next
24605 .vindex "&$pipe_addresses$&"
24606 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24607 transport can handle more than one address in a single run. In this case, when
24608 more than one address is routed to the transport, &$local_part$& is not set
24609 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24610 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24611 that are routed to the transport.
24612 .next
24613 .vindex "&$address_pipe$&"
24614 A router redirects an address directly to a pipe command (for example, from an
24615 alias or forward file). In this case, &$address_pipe$& contains the text of the
24616 pipe command, and the &%command%& option on the transport is ignored unless
24617 &%force_command%& is set. If only one address is being transported
24618 (&%batch_max%& is not greater than one, or only one address was redirected to
24619 this pipe command), &$local_part$& contains the local part that was redirected.
24620 .endlist
24621
24622
24623 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24624 deliver messages over pipes using the LMTP interactive protocol. This is
24625 implemented by the &(lmtp)& transport.
24626
24627 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24628 &_.forward_& file, the command runs under the uid and gid of that user. In
24629 other cases, the uid and gid have to be specified explicitly, either on the
24630 transport or on the router that handles the address. Current and &"home"&
24631 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24632 details of the local delivery environment and chapter &<<CHAPbatching>>&
24633 for a discussion of local delivery batching.
24634
24635 .cindex "tainted data" "in pipe command"
24636 .cindex pipe "tainted data"
24637 Tainted data may not be used for the command name.
24638
24639
24640 .section "Concurrent delivery" "SECID140"
24641 If two messages arrive at almost the same time, and both are routed to a pipe
24642 delivery, the two pipe transports may be run concurrently. You must ensure that
24643 any pipe commands you set up are robust against this happening. If the commands
24644 write to a file, the &%exim_lock%& utility might be of use.
24645 Alternatively the &%max_parallel%& option could be used with a value
24646 of "1" to enforce serialization.
24647
24648
24649
24650
24651 .section "Returned status and data" "SECID141"
24652 .cindex "&(pipe)& transport" "returned data"
24653 If the command exits with a non-zero return code, the delivery is deemed to
24654 have failed, unless either the &%ignore_status%& option is set (in which case
24655 the return code is treated as zero), or the return code is one of those listed
24656 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24657 later"&. In this case, delivery is deferred. Details of a permanent failure are
24658 logged, but are not included in the bounce message, which merely contains
24659 &"local delivery failed"&.
24660
24661 If the command exits on a signal and the &%freeze_signal%& option is set then
24662 the message will be frozen in the queue. If that option is not set, a bounce
24663 will be sent as normal.
24664
24665 If the return code is greater than 128 and the command being run is a shell
24666 script, it normally means that the script was terminated by a signal whose
24667 value is the return code minus 128. The &%freeze_signal%& option does not
24668 apply in this case.
24669
24670 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24671 return code is set to 127. This is the value that a shell returns if it is
24672 asked to run a non-existent command. The wording for the log line suggests that
24673 a non-existent command may be the problem.
24674
24675 The &%return_output%& option can affect the result of a pipe delivery. If it is
24676 set and the command produces any output on its standard output or standard
24677 error streams, the command is considered to have failed, even if it gave a zero
24678 return code or if &%ignore_status%& is set. The output from the command is
24679 included as part of the bounce message. The &%return_fail_output%& option is
24680 similar, except that output is returned only when the command exits with a
24681 failure return code, that is, a value other than zero or a code that matches
24682 &%temp_errors%&.
24683
24684
24685
24686 .section "How the command is run" "SECThowcommandrun"
24687 .cindex "&(pipe)& transport" "path for command"
24688 The command line is (by default) broken down into a command name and arguments
24689 by the &(pipe)& transport itself. The &%allow_commands%& and
24690 &%restrict_to_path%& options can be used to restrict the commands that may be
24691 run.
24692
24693 .cindex "quoting" "in pipe command"
24694 Unquoted arguments are delimited by white space. If an argument appears in
24695 double quotes, backslash is interpreted as an escape character in the usual
24696 way. If an argument appears in single quotes, no escaping is done.
24697
24698 String expansion is applied to the command line except when it comes from a
24699 traditional &_.forward_& file (commands from a filter file are expanded). The
24700 expansion is applied to each argument in turn rather than to the whole line.
24701 For this reason, any string expansion item that contains white space must be
24702 quoted so as to be contained within a single argument. A setting such as
24703 .code
24704 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24705 .endd
24706 will not work, because the expansion item gets split between several
24707 arguments. You have to write
24708 .code
24709 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24710 .endd
24711 to ensure that it is all in one argument. The expansion is done in this way,
24712 argument by argument, so that the number of arguments cannot be changed as a
24713 result of expansion, and quotes or backslashes in inserted variables do not
24714 interact with external quoting. However, this leads to problems if you want to
24715 generate multiple arguments (or the command name plus arguments) from a single
24716 expansion. In this situation, the simplest solution is to use a shell. For
24717 example:
24718 .code
24719 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24720 .endd
24721
24722 .cindex "transport" "filter"
24723 .cindex "filter" "transport filter"
24724 .vindex "&$pipe_addresses$&"
24725 Special handling takes place when an argument consists of precisely the text
24726 &`$pipe_addresses`& (no quotes).
24727 This is not a general expansion variable; the only
24728 place this string is recognized is when it appears as an argument for a pipe or
24729 transport filter command. It causes each address that is being handled to be
24730 inserted in the argument list at that point &'as a separate argument'&. This
24731 avoids any problems with spaces or shell metacharacters, and is of use when a
24732 &(pipe)& transport is handling groups of addresses in a batch.
24733
24734 If &%force_command%& is enabled on the transport, special handling takes place
24735 for an argument that consists of precisely the text &`$address_pipe`&.  It
24736 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24737 argument is inserted in the argument list at that point
24738 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24739 the only item in the argument; in fact, if it were then &%force_command%&
24740 should behave as a no-op.  Rather, it should be used to adjust the command
24741 run while preserving the argument vector separation.
24742
24743 After splitting up into arguments and expansion, the resulting command is run
24744 in a subprocess directly from the transport, &'not'& under a shell. The
24745 message that is being delivered is supplied on the standard input, and the
24746 standard output and standard error are both connected to a single pipe that is
24747 read by Exim. The &%max_output%& option controls how much output the command
24748 may produce, and the &%return_output%& and &%return_fail_output%& options
24749 control what is done with it.
24750
24751 Not running the command under a shell (by default) lessens the security risks
24752 in cases when a command from a user's filter file is built out of data that was
24753 taken from an incoming message. If a shell is required, it can of course be
24754 explicitly specified as the command to be run. However, there are circumstances
24755 where existing commands (for example, in &_.forward_& files) expect to be run
24756 under a shell and cannot easily be modified. To allow for these cases, there is
24757 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24758 works. Instead of breaking up the command line as just described, it expands it
24759 as a single string and passes the result to &_/bin/sh_&. The
24760 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24761 with &%use_shell%&, and the whole mechanism is inherently less secure.
24762
24763
24764
24765 .section "Environment variables" "SECTpipeenv"
24766 .cindex "&(pipe)& transport" "environment for command"
24767 .cindex "environment" "&(pipe)& transport"
24768 The environment variables listed below are set up when the command is invoked.
24769 This list is a compromise for maximum compatibility with other MTAs. Note that
24770 the &%environment%& option can be used to add additional variables to this
24771 environment. The environment for the &(pipe)& transport is not subject
24772 to the &%add_environment%& and &%keep_environment%& main config options.
24773 &*Note*&: Using enviroment variables loses track of tainted data.
24774 Writers of &(pipe)& transport commands should be wary of data supplied
24775 by potential attackers.
24776 .display
24777 &`DOMAIN            `&   the domain of the address
24778 &`HOME              `&   the home directory, if set
24779 &`HOST              `&   the host name when called from a router (see below)
24780 &`LOCAL_PART        `&   see below
24781 &`LOCAL_PART_PREFIX `&   see below
24782 &`LOCAL_PART_SUFFIX `&   see below
24783 &`LOGNAME           `&   see below
24784 &`MESSAGE_ID        `&   Exim's local ID for the message
24785 &`PATH              `&   as specified by the &%path%& option below
24786 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24787 &`RECIPIENT         `&   the complete recipient address
24788 &`SENDER            `&   the sender of the message (empty if a bounce)
24789 &`SHELL             `&   &`/bin/sh`&
24790 &`TZ                `&   the value of the &%timezone%& option, if set
24791 &`USER              `&   see below
24792 .endd
24793 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24794 router, LOCAL_PART is set to the local part of the address. When it is
24795 called as a result of a forward or alias expansion, LOCAL_PART is set to
24796 the local part of the address that was expanded. In both cases, any affixes are
24797 removed from the local part, and made available in LOCAL_PART_PREFIX and
24798 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24799 same value as LOCAL_PART for compatibility with other MTAs.
24800
24801 .cindex "HOST"
24802 HOST is set only when a &(pipe)& transport is called from a router that
24803 associates hosts with an address, typically when using &(pipe)& as a
24804 pseudo-remote transport. HOST is set to the first host name specified by
24805 the router.
24806
24807 .cindex "HOME"
24808 If the transport's generic &%home_directory%& option is set, its value is used
24809 for the HOME environment variable. Otherwise, a home directory may be set
24810 by the router's &%transport_home_directory%& option, which defaults to the
24811 user's home directory if &%check_local_user%& is set.
24812
24813
24814 .section "Private options for pipe" "SECID142"
24815 .cindex "options" "&(pipe)& transport"
24816
24817
24818
24819 .option allow_commands pipe "string list&!!" unset
24820 .cindex "&(pipe)& transport" "permitted commands"
24821 The string is expanded, and is then interpreted as a colon-separated list of
24822 permitted commands. If &%restrict_to_path%& is not set, the only commands
24823 permitted are those in the &%allow_commands%& list. They need not be absolute
24824 paths; the &%path%& option is still used for relative paths. If
24825 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24826 in the &%allow_commands%& list, or a name without any slashes that is found on
24827 the path. In other words, if neither &%allow_commands%& nor
24828 &%restrict_to_path%& is set, there is no restriction on the command, but
24829 otherwise only commands that are permitted by one or the other are allowed. For
24830 example, if
24831 .code
24832 allow_commands = /usr/bin/vacation
24833 .endd
24834 and &%restrict_to_path%& is not set, the only permitted command is
24835 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24836 &%use_shell%& is set.
24837
24838
24839 .option batch_id pipe string&!! unset
24840 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24841
24842
24843 .option batch_max pipe integer 1
24844 This limits the number of addresses that can be handled in a single delivery.
24845 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24846
24847
24848 .option check_string pipe string unset
24849 As &(pipe)& writes the message, the start of each line is tested for matching
24850 &%check_string%&, and if it does, the initial matching characters are replaced
24851 by the contents of &%escape_string%&, provided both are set. The value of
24852 &%check_string%& is a literal string, not a regular expression, and the case of
24853 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24854 of &%check_string%& and &%escape_string%& are forced to values that implement
24855 the SMTP escaping protocol. Any settings made in the configuration file are
24856 ignored.
24857
24858
24859 .option command pipe string&!! unset
24860 This option need not be set when &(pipe)& is being used to deliver to pipes
24861 obtained directly from address redirections. In other cases, the option must be
24862 set, to provide a command to be run. It need not yield an absolute path (see
24863 the &%path%& option below). The command is split up into separate arguments by
24864 Exim, and each argument is separately expanded, as described in section
24865 &<<SECThowcommandrun>>& above.
24866
24867 .cindex "tainted data"
24868 No part of the resulting command may be tainted.
24869
24870
24871 .option environment pipe string&!! unset
24872 .cindex "&(pipe)& transport" "environment for command"
24873 .cindex "environment" "&(pipe)& transport"
24874 This option is used to add additional variables to the environment in which the
24875 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24876 a string which is expanded, and then interpreted as a colon-separated list of
24877 environment settings of the form <&'name'&>=<&'value'&>.
24878
24879
24880 .option escape_string pipe string unset
24881 See &%check_string%& above.
24882
24883
24884 .option freeze_exec_fail pipe boolean false
24885 .cindex "exec failure"
24886 .cindex "failure of exec"
24887 .cindex "&(pipe)& transport" "failure of exec"
24888 Failure to exec the command in a pipe transport is by default treated like
24889 any other failure while running the command. However, if &%freeze_exec_fail%&
24890 is set, failure to exec is treated specially, and causes the message to be
24891 frozen, whatever the setting of &%ignore_status%&.
24892
24893
24894 .option freeze_signal pipe boolean false
24895 .cindex "signal exit"
24896 .cindex "&(pipe)& transport", "signal exit"
24897 Normally if the process run by a command in a pipe transport exits on a signal,
24898 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24899 frozen in Exim's queue instead.
24900
24901
24902 .option force_command pipe boolean false
24903 .cindex "force command"
24904 .cindex "&(pipe)& transport", "force command"
24905 Normally when a router redirects an address directly to a pipe command
24906 the &%command%& option on the transport is ignored.  If &%force_command%&
24907 is set, the &%command%& option will used. This is especially
24908 useful for forcing a wrapper or additional argument to be added to the
24909 command. For example:
24910 .code
24911 command = /usr/bin/remote_exec myhost -- $address_pipe
24912 force_command
24913 .endd
24914
24915 Note that &$address_pipe$& is handled specially in &%command%& when
24916 &%force_command%& is set, expanding out to the original argument vector as
24917 separate items, similarly to a Unix shell &`"$@"`& construct.
24918
24919
24920 .option ignore_status pipe boolean false
24921 If this option is true, the status returned by the subprocess that is set up to
24922 run the command is ignored, and Exim behaves as if zero had been returned.
24923 Otherwise, a non-zero status or termination by signal causes an error return
24924 from the transport unless the status value is one of those listed in
24925 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24926
24927 &*Note*&: This option does not apply to timeouts, which do not return a status.
24928 See the &%timeout_defer%& option for how timeouts are handled.
24929
24930
24931 .option log_defer_output pipe boolean false
24932 .cindex "&(pipe)& transport" "logging output"
24933 If this option is set, and the status returned by the command is
24934 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24935 and any output was produced on stdout or stderr, the first line of it is
24936 written to the main log.
24937
24938
24939 .option log_fail_output pipe boolean false
24940 If this option is set, and the command returns any output on stdout or
24941 stderr, and also ends with a return code that is neither zero nor one of
24942 the return codes listed in &%temp_errors%& (that is, the delivery
24943 failed), the first line of output is written to the main log. This
24944 option and &%log_output%& are mutually exclusive.  Only one of them may
24945 be set.
24946
24947
24948 .option log_output pipe boolean false
24949 If this option is set and the command returns any output on stdout or
24950 stderr, the first line of output is written to the main log, whatever
24951 the return code. This option and &%log_fail_output%& are mutually
24952 exclusive. Only one of them may be set.
24953
24954
24955 .option max_output pipe integer 20K
24956 This specifies the maximum amount of output that the command may produce on its
24957 standard output and standard error file combined. If the limit is exceeded, the
24958 process running the command is killed. This is intended as a safety measure to
24959 catch runaway processes. The limit is applied independently of the settings of
24960 the options that control what is done with such output (for example,
24961 &%return_output%&). Because of buffering effects, the amount of output may
24962 exceed the limit by a small amount before Exim notices.
24963
24964
24965 .option message_prefix pipe string&!! "see below"
24966 The string specified here is expanded and output at the start of every message.
24967 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24968 .code
24969 message_prefix = \
24970   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24971   ${tod_bsdinbox}\n
24972 .endd
24973 .cindex "Cyrus"
24974 .cindex "&%tmail%&"
24975 .cindex "&""From""& line"
24976 This is required by the commonly used &_/usr/bin/vacation_& program.
24977 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24978 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24979 setting
24980 .code
24981 message_prefix =
24982 .endd
24983 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24984 &`\n`& to &`\r\n`& in &%message_prefix%&.
24985
24986
24987 .option message_suffix pipe string&!! "see below"
24988 The string specified here is expanded and output at the end of every message.
24989 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24990 The suffix can be suppressed by setting
24991 .code
24992 message_suffix =
24993 .endd
24994 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24995 &`\n`& to &`\r\n`& in &%message_suffix%&.
24996
24997
24998 .option path pipe string&!! "/bin:/usr/bin"
24999 This option is expanded and
25000 specifies the string that is set up in the PATH environment
25001 variable of the subprocess.
25002 If the &%command%& option does not yield an absolute path name, the command is
25003 sought in the PATH directories, in the usual way. &*Warning*&: This does not
25004 apply to a command specified as a transport filter.
25005
25006
25007 .option permit_coredump pipe boolean false
25008 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
25009 a core-dump of a pipe command, enable this command.  This enables core-dumps
25010 during delivery and affects both the Exim binary and the pipe command run.
25011 It is recommended that this option remain off unless and until you have a need
25012 for it and that this only be enabled when needed, as the risk of excessive
25013 resource consumption can be quite high.  Note also that Exim is typically
25014 installed as a setuid binary and most operating systems will inhibit coredumps
25015 of these by default, so further OS-specific action may be required.
25016
25017
25018 .option pipe_as_creator pipe boolean false
25019 .cindex "uid (user id)" "local delivery"
25020 If the generic &%user%& option is not set and this option is true, the delivery
25021 process is run under the uid that was in force when Exim was originally called
25022 to accept the message. If the group id is not otherwise set (via the generic
25023 &%group%& option), the gid that was in force when Exim was originally called to
25024 accept the message is used.
25025
25026
25027 .option restrict_to_path pipe boolean false
25028 When this option is set, any command name not listed in &%allow_commands%& must
25029 contain no slashes. The command is searched for only in the directories listed
25030 in the &%path%& option. This option is intended for use in the case when a pipe
25031 command has been generated from a user's &_.forward_& file. This is usually
25032 handled by a &(pipe)& transport called &%address_pipe%&.
25033
25034
25035 .option return_fail_output pipe boolean false
25036 If this option is true, and the command produced any output and ended with a
25037 return code other than zero or one of the codes listed in &%temp_errors%& (that
25038 is, the delivery failed), the output is returned in the bounce message.
25039 However, if the message has a null sender (that is, it is itself a bounce
25040 message), output from the command is discarded. This option and
25041 &%return_output%& are mutually exclusive. Only one of them may be set.
25042
25043
25044
25045 .option return_output pipe boolean false
25046 If this option is true, and the command produced any output, the delivery is
25047 deemed to have failed whatever the return code from the command, and the output
25048 is returned in the bounce message. Otherwise, the output is just discarded.
25049 However, if the message has a null sender (that is, it is a bounce message),
25050 output from the command is always discarded, whatever the setting of this
25051 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25052 of them may be set.
25053
25054
25055
25056 .option temp_errors pipe "string list" "see below"
25057 .cindex "&(pipe)& transport" "temporary failure"
25058 This option contains either a colon-separated list of numbers, or a single
25059 asterisk. If &%ignore_status%& is false
25060 and &%return_output%& is not set,
25061 and the command exits with a non-zero return code, the failure is treated as
25062 temporary and the delivery is deferred if the return code matches one of the
25063 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25064 codes are treated as permanent errors. The default setting contains the codes
25065 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25066 compiled on a system that does not define these macros, it assumes values of 75
25067 and 73, respectively.
25068
25069
25070 .option timeout pipe time 1h
25071 If the command fails to complete within this time, it is killed. This normally
25072 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25073 specifies no timeout. In order to ensure that any subprocesses created by the
25074 command are also killed, Exim makes the initial process a process group leader,
25075 and kills the whole process group on a timeout. However, this can be defeated
25076 if one of the processes starts a new process group.
25077
25078 .option timeout_defer pipe boolean false
25079 A timeout in a &(pipe)& transport, either in the command that the transport
25080 runs, or in a transport filter that is associated with it, is by default
25081 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25082 is set true, both kinds of timeout become temporary errors, causing the
25083 delivery to be deferred.
25084
25085 .option umask pipe "octal integer" 022
25086 This specifies the umask setting for the subprocess that runs the command.
25087
25088
25089 .option use_bsmtp pipe boolean false
25090 .cindex "envelope sender"
25091 If this option is set true, the &(pipe)& transport writes messages in &"batch
25092 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25093 commands. If you want to include a leading HELO command with such messages,
25094 you can do so by setting the &%message_prefix%& option. See section
25095 &<<SECTbatchSMTP>>& for details of batch SMTP.
25096
25097 .option use_classresources pipe boolean false
25098 .cindex "class resources (BSD)"
25099 This option is available only when Exim is running on FreeBSD, NetBSD, or
25100 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25101 resource limits when a &(pipe)& transport is run to perform a delivery. The
25102 limits for the uid under which the pipe is to run are obtained from the login
25103 class database.
25104
25105
25106 .option use_crlf pipe boolean false
25107 .cindex "carriage return"
25108 .cindex "linefeed"
25109 This option causes lines to be terminated with the two-character CRLF sequence
25110 (carriage return, linefeed) instead of just a linefeed character. In the case
25111 of batched SMTP, the byte sequence written to the pipe is then an exact image
25112 of what would be sent down a real SMTP connection.
25113
25114 The contents of the &%message_prefix%& and &%message_suffix%& options are
25115 written verbatim, so must contain their own carriage return characters if these
25116 are needed. When &%use_bsmtp%& is not set, the default values for both
25117 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25118 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25119
25120
25121 .option use_shell pipe boolean false
25122 .vindex "&$pipe_addresses$&"
25123 If this option is set, it causes the command to be passed to &_/bin/sh_&
25124 instead of being run directly from the transport, as described in section
25125 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25126 where the command is expected to be run under a shell and cannot easily be
25127 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25128 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25129 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25130 its &%-c%& option.
25131
25132
25133
25134 .section "Using an external local delivery agent" "SECID143"
25135 .cindex "local delivery" "using an external agent"
25136 .cindex "&'procmail'&"
25137 .cindex "external local delivery"
25138 .cindex "delivery" "&'procmail'&"
25139 .cindex "delivery" "by external agent"
25140 The &(pipe)& transport can be used to pass all messages that require local
25141 delivery to a separate local delivery agent such as &%procmail%&. When doing
25142 this, care must be taken to ensure that the pipe is run under an appropriate
25143 uid and gid. In some configurations one wants this to be a uid that is trusted
25144 by the delivery agent to supply the correct sender of the message. It may be
25145 necessary to recompile or reconfigure the delivery agent so that it trusts an
25146 appropriate user. The following is an example transport and router
25147 configuration for &%procmail%&:
25148 .code
25149 # transport
25150 procmail_pipe:
25151   driver = pipe
25152   command = /usr/local/bin/procmail -d $local_part_data
25153   return_path_add
25154   delivery_date_add
25155   envelope_to_add
25156   check_string = "From "
25157   escape_string = ">From "
25158   umask = 077
25159   user = $local_part_data
25160   group = mail
25161
25162 # router
25163 procmail:
25164   driver = accept
25165   check_local_user
25166   transport = procmail_pipe
25167 .endd
25168 In this example, the pipe is run as the local user, but with the group set to
25169 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25170 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25171 user to supply a correct sender address. If you do not specify either a
25172 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25173 home directory is the user's home directory by default.
25174
25175 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25176 .code
25177 IFS=" "
25178 .endd
25179 as shown in some &%procmail%& documentation, because Exim does not by default
25180 use a shell to run pipe commands.
25181
25182 .cindex "Cyrus"
25183 The next example shows a transport and a router for a system where local
25184 deliveries are handled by the Cyrus IMAP server.
25185 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25186 . but that suffix is tainted so cannot be used in a command arg
25187 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25188 .code
25189 # transport
25190 local_delivery_cyrus:
25191   driver = pipe
25192   command = /usr/cyrus/bin/deliver \
25193             -- $local_part_data
25194   user = cyrus
25195   group = mail
25196   return_output
25197   log_output
25198   message_prefix =
25199   message_suffix =
25200
25201 # router
25202 local_user_cyrus:
25203   driver = accept
25204   check_local_user
25205   transport = local_delivery_cyrus
25206 .endd
25207 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25208 &%return_output%& to cause any text written by Cyrus to be returned to the
25209 sender.
25210 .ecindex IIDpiptra1
25211 .ecindex IIDpiptra2
25212
25213
25214 . ////////////////////////////////////////////////////////////////////////////
25215 . ////////////////////////////////////////////////////////////////////////////
25216
25217 .chapter "The smtp transport" "CHAPsmtptrans"
25218 .scindex IIDsmttra1 "transports" "&(smtp)&"
25219 .scindex IIDsmttra2 "&(smtp)& transport"
25220 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25221 or LMTP protocol. The list of hosts to try can either be taken from the address
25222 that is being processed (having been set up by the router), or specified
25223 explicitly for the transport. Timeout and retry processing (see chapter
25224 &<<CHAPretry>>&) is applied to each IP address independently.
25225
25226
25227 .section "Multiple messages on a single connection" "SECID144"
25228 The sending of multiple messages over a single TCP/IP connection can arise in
25229 two ways:
25230
25231 .ilist
25232 If a message contains more than &%max_rcpt%& (see below) addresses that are
25233 routed to the same host, more than one copy of the message has to be sent to
25234 that host. In this situation, multiple copies may be sent in a single run of
25235 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25236 does when it has too many addresses to send in one message also depends on the
25237 value of the global &%remote_max_parallel%& option. Details are given in
25238 section &<<SECToutSMTPTCP>>&.)
25239 .next
25240 .cindex "hints database" "remembering routing"
25241 When a message has been successfully delivered over a TCP/IP connection, Exim
25242 looks in its hints database to see if there are any other messages awaiting a
25243 connection to the same host. If there are, a new delivery process is started
25244 for one of them, and the current TCP/IP connection is passed on to it. The new
25245 process may in turn send multiple copies and possibly create yet another
25246 process.
25247 .endlist
25248
25249
25250 For each copy sent over the same TCP/IP connection, a sequence counter is
25251 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25252 no further messages are sent over that connection.
25253
25254
25255
25256 .section "Use of the $host and $host_address variables" "SECID145"
25257 .vindex "&$host$&"
25258 .vindex "&$host_address$&"
25259 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25260 &$host_address$& are the name and IP address of the first host on the host list
25261 passed by the router. However, when the transport is about to connect to a
25262 specific host, and while it is connected to that host, &$host$& and
25263 &$host_address$& are set to the values for that host. These are the values
25264 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25265 &%serialize_hosts%&, and the various TLS options are expanded.
25266
25267
25268 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25269 .vindex &$tls_bits$&
25270 .vindex &$tls_cipher$&
25271 .vindex &$tls_peerdn$&
25272 .vindex &$tls_sni$&
25273 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25274 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25275 are the values that were set when the message was received.
25276 These are the values that are used for options that are expanded before any
25277 SMTP connections are made. Just before each connection is made, these four
25278 variables are emptied. If TLS is subsequently started, they are set to the
25279 appropriate values for the outgoing connection, and these are the values that
25280 are in force when any authenticators are run and when the
25281 &%authenticated_sender%& option is expanded.
25282
25283 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25284 and will be removed in a future release.
25285
25286
25287 .section "Private options for smtp" "SECID146"
25288 .cindex "options" "&(smtp)& transport"
25289 The private options of the &(smtp)& transport are as follows:
25290
25291
25292 .option address_retry_include_sender smtp boolean true
25293 .cindex "4&'xx'& responses" "retrying after"
25294 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25295 is the combination of sender and recipient that is delayed in subsequent queue
25296 runs until the retry time is reached. You can delay the recipient without
25297 reference to the sender (which is what earlier versions of Exim did), by
25298 setting &%address_retry_include_sender%& false. However, this can lead to
25299 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25300
25301 .option allow_localhost smtp boolean false
25302 .cindex "local host" "sending to"
25303 .cindex "fallback" "hosts specified on transport"
25304 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25305 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25306 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25307 the delivery anyway. This should be used only in special cases when the
25308 configuration ensures that no looping will result (for example, a differently
25309 configured Exim is listening on the port to which the message is sent).
25310
25311
25312 .option authenticated_sender smtp string&!! unset
25313 .cindex "Cyrus"
25314 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25315 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25316 overriding any existing authenticated sender value. If the string expansion is
25317 forced to fail, the option is ignored. Other expansion failures cause delivery
25318 to be deferred. If the result of expansion is an empty string, that is also
25319 ignored.
25320
25321 The expansion happens after the outgoing connection has been made and TLS
25322 started, if required. This means that the &$host$&, &$host_address$&,
25323 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25324 particular connection.
25325
25326 If the SMTP session is not authenticated, the expansion of
25327 &%authenticated_sender%& still happens (and can cause the delivery to be
25328 deferred if it fails), but no AUTH= item is added to MAIL commands
25329 unless &%authenticated_sender_force%& is true.
25330
25331 This option allows you to use the &(smtp)& transport in LMTP mode to
25332 deliver mail to Cyrus IMAP and provide the proper local part as the
25333 &"authenticated sender"&, via a setting such as:
25334 .code
25335 authenticated_sender = $local_part
25336 .endd
25337 This removes the need for IMAP subfolders to be assigned special ACLs to
25338 allow direct delivery to those subfolders.
25339
25340 Because of expected uses such as that just described for Cyrus (when no
25341 domain is involved), there is no checking on the syntax of the provided
25342 value.
25343
25344
25345 .option authenticated_sender_force smtp boolean false
25346 If this option is set true, the &%authenticated_sender%& option's value
25347 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25348 authenticated as a client.
25349
25350
25351 .option command_timeout smtp time 5m
25352 .cindex timeout "smtp transport command"
25353 This sets a timeout for receiving a response to an SMTP command that has been
25354 sent out. It is also used when waiting for the initial banner line from the
25355 remote host. Its value must not be zero.
25356
25357
25358 .option connect_timeout smtp time 5m
25359 .cindex timeout "smtp transport connect"
25360 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25361 to a remote host. A setting of zero allows the system timeout (typically
25362 several minutes) to act. To have any effect, the value of this option must be
25363 less than the system timeout. However, it has been observed that on some
25364 systems there is no system timeout, which is why the default value for this
25365 option is 5 minutes, a value recommended by RFC 1123.
25366
25367
25368 .option connection_max_messages smtp integer 500
25369 .cindex "SMTP" "passed connection"
25370 .cindex "SMTP" "multiple deliveries"
25371 .cindex "multiple SMTP deliveries"
25372 This controls the maximum number of separate message deliveries that are sent
25373 over a single TCP/IP connection. If the value is zero, there is no limit.
25374 For testing purposes, this value can be overridden by the &%-oB%& command line
25375 option.
25376
25377
25378 .option dane_require_tls_ciphers smtp string&!! unset
25379 .cindex "TLS" "requiring specific ciphers for DANE"
25380 .cindex "cipher" "requiring specific"
25381 .cindex DANE "TLS ciphers"
25382 This option may be used to override &%tls_require_ciphers%& for connections
25383 where DANE has been determined to be in effect.
25384 If not set, then &%tls_require_ciphers%& will be used.
25385 Normal SMTP delivery is not able to make strong demands of TLS cipher
25386 configuration, because delivery will fall back to plaintext.  Once DANE has
25387 been determined to be in effect, there is no plaintext fallback and making the
25388 TLS cipherlist configuration stronger will increase security, rather than
25389 counter-intuitively decreasing it.
25390 If the option expands to be empty or is forced to fail, then it will
25391 be treated as unset and &%tls_require_ciphers%& will be used instead.
25392
25393
25394 .option data_timeout smtp time 5m
25395 .cindex timeout "for transmitted SMTP data blocks"
25396 This sets a timeout for the transmission of each block in the data portion of
25397 the message. As a result, the overall timeout for a message depends on the size
25398 of the message. Its value must not be zero. See also &%final_timeout%&.
25399
25400
25401 .option dkim_canon smtp string&!! unset
25402 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25403 .option dkim_domain smtp "string list&!!" unset
25404 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25405 .option dkim_hash smtp string&!! sha256
25406 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25407 .option dkim_identity smtp string&!! unset
25408 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25409 .option dkim_private_key smtp string&!! unset
25410 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25411 .option dkim_selector smtp string&!! unset
25412 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25413 .option dkim_strict smtp string&!! unset
25414 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25415 .option dkim_sign_headers smtp string&!! "per RFC"
25416 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25417 .option dkim_timestamps smtp string&!! unset
25418 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25419
25420
25421 .option delay_after_cutoff smtp boolean true
25422 .cindex "final cutoff" "retries, controlling"
25423 .cindex retry "final cutoff"
25424 This option controls what happens when all remote IP addresses for a given
25425 domain have been inaccessible for so long that they have passed their retry
25426 cutoff times.
25427
25428 In the default state, if the next retry time has not been reached for any of
25429 them, the address is bounced without trying any deliveries. In other words,
25430 Exim delays retrying an IP address after the final cutoff time until a new
25431 retry time is reached, and can therefore bounce an address without ever trying
25432 a delivery, when machines have been down for a long time. Some people are
25433 unhappy at this prospect, so...
25434
25435 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25436 addresses are past their final cutoff time, Exim tries to deliver to those
25437 IP addresses that have not been tried since the message arrived. If there are
25438 none, of if they all fail, the address is bounced. In other words, it does not
25439 delay when a new message arrives, but immediately tries those expired IP
25440 addresses that haven't been tried since the message arrived. If there is a
25441 continuous stream of messages for the dead hosts, unsetting
25442 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25443 to them.
25444
25445
25446 .option dns_qualify_single smtp boolean true
25447 If the &%hosts%& or &%fallback_hosts%& option is being used,
25448 and the &%gethostbyname%& option is false,
25449 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25450 in chapter &<<CHAPdnslookup>>& for more details.
25451
25452
25453 .option dns_search_parents smtp boolean false
25454 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25455 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25456 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25457 details.
25458
25459
25460 .option dnssec_request_domains smtp "domain list&!!" *
25461 .cindex "MX record" "security"
25462 .cindex "DNSSEC" "MX lookup"
25463 .cindex "security" "MX lookup"
25464 .cindex "DNS" "DNSSEC"
25465 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25466 the DNSSEC request bit set. Setting this transport option is only useful if the
25467 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25468 router option.
25469
25470
25471
25472 .option dnssec_require_domains smtp "domain list&!!" unset
25473 .cindex "MX record" "security"
25474 .cindex "DNSSEC" "MX lookup"
25475 .cindex "security" "MX lookup"
25476 .cindex "DNS" "DNSSEC"
25477 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25478 the DNSSEC request bit set.  Setting this transport option is only
25479 useful if the transport overrides or sets the host names. See the
25480 &%dnssec_require_domains%& router option.
25481
25482
25483
25484 .option dscp smtp string&!! unset
25485 .cindex "DCSP" "outbound"
25486 This option causes the DSCP value associated with a socket to be set to one
25487 of a number of fixed strings or to numeric value.
25488 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25489 Common values include &`throughput`&, &`mincost`&, and on newer systems
25490 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25491
25492 The outbound packets from Exim will be marked with this value in the header
25493 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25494 that these values will have any effect, not be stripped by networking
25495 equipment, or do much of anything without cooperation with your Network
25496 Engineer and those of all network operators between the source and destination.
25497
25498
25499 .option fallback_hosts smtp "string list" unset
25500 .cindex "fallback" "hosts specified on transport"
25501 String expansion is not applied to this option. The argument must be a
25502 colon-separated list of host names or IP addresses, optionally also including
25503 port numbers, though the separator can be changed, as described in section
25504 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25505 item in a &%route_list%& setting for the &(manualroute)& router, as described
25506 in section &<<SECTformatonehostitem>>&.
25507
25508 Fallback hosts can also be specified on routers, which associate them with the
25509 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25510 &%fallback_hosts%& specified on the transport is used only if the address does
25511 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25512 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25513 However, &%hosts_randomize%& does apply to fallback host lists.
25514
25515 If Exim is unable to deliver to any of the hosts for a particular address, and
25516 the errors are not permanent rejections, the address is put on a separate
25517 transport queue with its host list replaced by the fallback hosts, unless the
25518 address was routed via MX records and the current host was in the original MX
25519 list. In that situation, the fallback host list is not used.
25520
25521 Once normal deliveries are complete, the fallback queue is delivered by
25522 re-running the same transports with the new host lists. If several failing
25523 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25524 copy of the message is sent.
25525
25526 The resolution of the host names on the fallback list is controlled by the
25527 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25528 both to cases when the host list comes with the address and when it is taken
25529 from &%hosts%&. This option provides a &"use a smart host only if delivery
25530 fails"& facility.
25531
25532
25533 .option final_timeout smtp time 10m
25534 .cindex timeout "for transmitted SMTP data accept"
25535 This is the timeout that applies while waiting for the response to the final
25536 line containing just &"."& that terminates a message. Its value must not be
25537 zero.
25538
25539 .option gethostbyname smtp boolean false
25540 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25541 being used, names are looked up using &[gethostbyname()]&
25542 (or &[getipnodebyname()]& when available)
25543 instead of using the DNS. Of course, that function may in fact use the DNS, but
25544 it may also consult other sources of information such as &_/etc/hosts_&.
25545
25546 .option gnutls_compat_mode smtp boolean unset
25547 This option controls whether GnuTLS is used in compatibility mode in an Exim
25548 server. This reduces security slightly, but improves interworking with older
25549 implementations of TLS.
25550
25551 .option helo_data smtp string&!! "see below"
25552 .cindex "HELO" "argument, setting"
25553 .cindex "EHLO" "argument, setting"
25554 .cindex "LHLO argument setting"
25555 The value of this option is expanded after a connection to a another host has
25556 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25557 command that starts the outgoing SMTP or LMTP session. The default value of the
25558 option is:
25559 .code
25560 $primary_hostname
25561 .endd
25562 During the expansion, the variables &$host$& and &$host_address$& are set to
25563 the identity of the remote host, and the variables &$sending_ip_address$& and
25564 &$sending_port$& are set to the local IP address and port number that are being
25565 used. These variables can be used to generate different values for different
25566 servers or different local IP addresses. For example, if you want the string
25567 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25568 interface address, you could use this:
25569 .code
25570 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25571   {${listextract{1}{<\n $value}}} \
25572   {$primary_hostname}}
25573 .endd
25574 The use of &%helo_data%& applies both to sending messages and when doing
25575 callouts.
25576
25577 .option host_name_extract smtp "string list&!!" "see below"
25578 .cindex "load balancer" "hosts behind"
25579 .cindex TLS resumption
25580 Some mail-accepting sites
25581 (notably Microsoft)
25582 operate many servers behind a network load-balancer.  When this is done,
25583 with separated TLS session caches, TLS session resuption becomes problematic.
25584 It will only succeed when the same server happens to be selected by the
25585 load-balancer, matching the session stored in the client's cache.
25586
25587 Exim can pull out a server name, if there is one, from the response to the
25588 client's SMTP EHLO command.
25589 The default value of this option:
25590 .code
25591     ${if and { {match {$host} {.outlook.com\$}} \
25592                {match {$item} {\N^250-([\w.]+)\s\N}} \
25593              } {$1}}
25594 .endd
25595 suffices for one known case.
25596 During the expansion of this option the &$item$& variable will have the
25597 server's EHLO response.
25598 The result of the option expansion is included in the key used to store and
25599 retrieve the TLS session, for session resumption.
25600
25601 Operators of high-load sites may wish to evaluate their logs for indications
25602 of other destination sites operating load-balancers, and develop a suitable
25603 expression for this option.
25604 The smtp:ehlo event and the &$tls_out_resumption$& variable
25605 will be useful for such work.
25606
25607 .option hosts smtp "string list&!!" unset
25608 Hosts are associated with an address by a router such as &(dnslookup)&, which
25609 finds the hosts by looking up the address domain in the DNS, or by
25610 &(manualroute)&, which has lists of hosts in its configuration. However,
25611 email addresses can be passed to the &(smtp)& transport by any router, and not
25612 all of them can provide an associated list of hosts.
25613
25614 The &%hosts%& option specifies a list of hosts to be used if the address being
25615 processed does not have any hosts associated with it. The hosts specified by
25616 &%hosts%& are also used, whether or not the address has its own hosts, if
25617 &%hosts_override%& is set.
25618
25619 The string is first expanded, before being interpreted as a colon-separated
25620 list of host names or IP addresses, possibly including port numbers. The
25621 separator may be changed to something other than colon, as described in section
25622 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25623 item in a &%route_list%& setting for the &(manualroute)& router, as described
25624 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25625 of the &(manualroute)& router is not available here.
25626
25627 If the expansion fails, delivery is deferred. Unless the failure was caused by
25628 the inability to complete a lookup, the error is logged to the panic log as
25629 well as the main log. Host names are looked up either by searching directly for
25630 address records in the DNS or by calling &[gethostbyname()]& (or
25631 &[getipnodebyname()]& when available), depending on the setting of the
25632 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25633 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25634 address are used.
25635
25636 During delivery, the hosts are tried in order, subject to their retry status,
25637 unless &%hosts_randomize%& is set.
25638
25639
25640 .option hosts_avoid_esmtp smtp "host list&!!" unset
25641 .cindex "ESMTP, avoiding use of"
25642 .cindex "HELO" "forcing use of"
25643 .cindex "EHLO" "avoiding use of"
25644 .cindex "PIPELINING" "avoiding the use of"
25645 This option is for use with broken hosts that announce ESMTP facilities (for
25646 example, PIPELINING) and then fail to implement them properly. When a host
25647 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25648 start of the SMTP session. This means that it cannot use any of the ESMTP
25649 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25650
25651
25652 .option hosts_avoid_pipelining smtp "host list&!!" unset
25653 .cindex "PIPELINING" "avoiding the use of"
25654 .cindex "ESMTP extensions" PIPELINING
25655 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25656 that matches this list, even if the server host advertises PIPELINING support.
25657
25658 .option hosts_pipe_connect smtp "host list&!!" unset
25659 .cindex "pipelining" "early connection"
25660 .cindex "pipelining" PIPECONNECT
25661 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25662 this option controls which to hosts the facility watched for
25663 and recorded, and used for subsequent connections.
25664
25665 The retry hints database is used for the record,
25666 and records are subject to the &%retry_data_expire%& option.
25667 When used, the pipelining saves on roundtrip times.
25668 It also turns SMTP into a client-first protocol
25669 so combines well with TCP Fast Open.
25670
25671 See also the &%pipelining_connect_advertise_hosts%& main option.
25672
25673 Note:
25674 When the facility is used, if the transport &%interface%& option is unset
25675 the &%helo_data%& option
25676 will be expanded before the &$sending_ip_address$& variable
25677 is filled in.
25678 A check is made for the use of that variable, without the
25679 presence of a &"def:"& test on it, but suitably complex coding
25680 can avoid the check and produce unexpected results.
25681 You have been warned.
25682
25683
25684 .option hosts_avoid_tls smtp "host list&!!" unset
25685 .cindex "TLS" "avoiding for certain hosts"
25686 Exim will not try to start a TLS session when delivering to any host that
25687 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25688
25689 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25690 .cindex "TLS" "avoiding for certain hosts"
25691 Exim will not try to start a TLS session for a verify callout,
25692 or when delivering in cutthrough mode,
25693 to any host that matches this list.
25694
25695
25696 .option hosts_max_try smtp integer 5
25697 .cindex "host" "maximum number to try"
25698 .cindex "limit" "number of hosts tried"
25699 .cindex "limit" "number of MX tried"
25700 .cindex "MX record" "maximum tried"
25701 This option limits the number of IP addresses that are tried for any one
25702 delivery in cases where there are temporary delivery errors. Section
25703 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25704
25705
25706 .option hosts_max_try_hardlimit smtp integer 50
25707 This is an additional check on the maximum number of IP addresses that Exim
25708 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25709 why it exists.
25710
25711
25712
25713 .option hosts_nopass_tls smtp "host list&!!" unset
25714 .cindex "TLS" "passing connection"
25715 .cindex "multiple SMTP deliveries"
25716 .cindex "TLS" "multiple message deliveries"
25717 For any host that matches this list, a connection on which a TLS session has
25718 been started will not be passed to a new delivery process for sending another
25719 message on the same connection. See section &<<SECTmulmessam>>& for an
25720 explanation of when this might be needed.
25721
25722 .option hosts_noproxy_tls smtp "host list&!!" unset
25723 .cindex "TLS" "passing connection"
25724 .cindex "multiple SMTP deliveries"
25725 .cindex "TLS" "multiple message deliveries"
25726 For any host that matches this list, a TLS session which has
25727 been started will not be passed to a new delivery process for sending another
25728 message on the same session.
25729
25730 The traditional implementation closes down TLS and re-starts it in the new
25731 process, on the same open TCP connection, for each successive message
25732 sent.  If permitted by this option a pipe to to the new process is set up
25733 instead, and the original process maintains the TLS connection and proxies
25734 the SMTP connection from and to the new process and any subsequents.
25735 The new process has no access to TLS information, so cannot include it in
25736 logging.
25737
25738
25739
25740 .option hosts_override smtp boolean false
25741 If this option is set and the &%hosts%& option is also set, any hosts that are
25742 attached to the address are ignored, and instead the hosts specified by the
25743 &%hosts%& option are always used. This option does not apply to
25744 &%fallback_hosts%&.
25745
25746
25747 .option hosts_randomize smtp boolean false
25748 .cindex "randomized host list"
25749 .cindex "host" "list of; randomized"
25750 .cindex "fallback" "randomized hosts"
25751 If this option is set, and either the list of hosts is taken from the
25752 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25753 were not obtained from MX records (this includes fallback hosts from the
25754 router), and were not randomized by the router, the order of trying the hosts
25755 is randomized each time the transport runs. Randomizing the order of a host
25756 list can be used to do crude load sharing.
25757
25758 When &%hosts_randomize%& is true, a host list may be split into groups whose
25759 order is separately randomized. This makes it possible to set up MX-like
25760 behaviour. The boundaries between groups are indicated by an item that is just
25761 &`+`& in the host list. For example:
25762 .code
25763 hosts = host1:host2:host3:+:host4:host5
25764 .endd
25765 The order of the first three hosts and the order of the last two hosts is
25766 randomized for each use, but the first three always end up before the last two.
25767 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25768
25769 .option hosts_require_auth smtp "host list&!!" unset
25770 .cindex "authentication" "required by client"
25771 This option provides a list of servers for which authentication must succeed
25772 before Exim will try to transfer a message. If authentication fails for
25773 servers which are not in this list, Exim tries to send unauthenticated. If
25774 authentication fails for one of these servers, delivery is deferred. This
25775 temporary error is detectable in the retry rules, so it can be turned into a
25776 hard failure if required. See also &%hosts_try_auth%&, and chapter
25777 &<<CHAPSMTPAUTH>>& for details of authentication.
25778
25779
25780 .option hosts_request_ocsp smtp "host list&!!" "see below"
25781 .cindex "TLS" "requiring for certain servers"
25782 Exim will request a Certificate Status on a
25783 TLS session for any host that matches this list.
25784 &%tls_verify_certificates%& should also be set for the transport.
25785
25786 .new
25787 The default is &"**"& if DANE is not in use for the connection,
25788 or if DANE-TA us used.
25789 It is empty if DANE-EE is used.
25790 .wen
25791
25792 .option hosts_require_alpn smtp "host list&!!" unset
25793 .cindex ALPN "require negotiation in client"
25794 .cindex TLS ALPN
25795 .cindex TLS "Application Layer Protocol Names"
25796 If the TLS library supports ALPN
25797 then a successful negotiation of ALPN will be required for any host
25798 matching the list, for TLS to be used.
25799 See also the &%tls_alpn%& option.
25800
25801 &*Note*&: prevention of fallback to in-clear connection is not
25802 managed by this option; see &%hosts_require_tls%&.
25803
25804 .option hosts_require_dane smtp "host list&!!" unset
25805 .cindex DANE "transport options"
25806 .cindex DANE "requiring for certain servers"
25807 If built with DANE support, Exim  will require that a DNSSEC-validated
25808 TLSA record is present for any host matching the list,
25809 and that a DANE-verified TLS connection is made.
25810 There will be no fallback to in-clear communication.
25811 See the &%dnssec_request_domains%& router and transport options.
25812 See section &<<SECDANE>>&.
25813
25814 .option hosts_require_ocsp smtp "host list&!!" unset
25815 .cindex "TLS" "requiring for certain servers"
25816 Exim will request, and check for a valid Certificate Status being given, on a
25817 TLS session for any host that matches this list.
25818 &%tls_verify_certificates%& should also be set for the transport.
25819
25820 .option hosts_require_tls smtp "host list&!!" unset
25821 .cindex "TLS" "requiring for certain servers"
25822 Exim will insist on using a TLS session when delivering to any host that
25823 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25824 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25825 incoming messages, use an appropriate ACL.
25826
25827 .option hosts_try_auth smtp "host list&!!" unset
25828 .cindex "authentication" "optional in client"
25829 This option provides a list of servers to which, provided they announce
25830 authentication support, Exim will attempt to authenticate as a client when it
25831 connects. If authentication fails
25832 and &%hosts_require_auth%& permits,
25833 Exim will try to transfer the message unauthenticated.
25834 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25835
25836 .option hosts_try_chunking smtp "host list&!!" *
25837 .cindex CHUNKING "enabling, in client"
25838 .cindex BDAT "SMTP command"
25839 .cindex "RFC 3030" "CHUNKING"
25840 This option provides a list of servers to which, provided they announce
25841 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25842 Unless DKIM signing is being done,
25843 BDAT will not be used in conjunction with a transport filter.
25844
25845 .option hosts_try_dane smtp "host list&!!" *
25846 .cindex DANE "transport options"
25847 .cindex DANE "attempting for certain servers"
25848 If built with DANE support, Exim  will look up a
25849 TLSA record for any host matching the list,
25850 If one is found and that lookup was DNSSEC-validated,
25851 then Exim requires that a DANE-verified TLS connection is made for that host;
25852 there will be no fallback to in-clear communication.
25853 See the &%dnssec_request_domains%& router and transport options.
25854 See section &<<SECDANE>>&.
25855
25856 .option hosts_try_fastopen smtp "host list&!!" *
25857 .cindex "fast open, TCP" "enabling, in client"
25858 .cindex "TCP Fast Open" "enabling, in client"
25859 .cindex "RFC 7413" "TCP Fast Open"
25860 This option provides a list of servers to which, provided
25861 the facility is supported by this system, Exim will attempt to
25862 perform a TCP Fast Open.
25863 No data is sent on the SYN segment but, if the remote server also
25864 supports the facility, it can send its SMTP banner immediately after
25865 the SYN,ACK segment.  This can save up to one round-trip time.
25866
25867 The facility is only active for previously-contacted servers,
25868 as the initiator must present a cookie in the SYN segment.
25869
25870 On (at least some) current Linux distributions the facility must be enabled
25871 in the kernel by the sysadmin before the support is usable.
25872 There is no option for control of the server side; if the system supports
25873 it it is always enabled.  Note that lengthy operations in the connect ACL,
25874 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25875
25876 .option hosts_try_prdr smtp "host list&!!" *
25877 .cindex "PRDR" "enabling, optional in client"
25878 .cindex "ESMTP extensions" PRDR
25879 This option provides a list of servers to which, provided they announce
25880 PRDR support, Exim will attempt to negotiate PRDR
25881 for multi-recipient messages.
25882 The option can usually be left as default.
25883
25884 .option interface smtp "string list&!!" unset
25885 .cindex "bind IP address"
25886 .cindex "IP address" "binding"
25887 .vindex "&$host$&"
25888 .vindex "&$host_address$&"
25889 This option specifies which interface to bind to when making an outgoing SMTP
25890 call. The value is an IP address, not an interface name such as
25891 &`eth0`&. Do not confuse this with the interface address that was used when a
25892 message was received, which is in &$received_ip_address$&, formerly known as
25893 &$interface_address$&. The name was changed to minimize confusion with the
25894 outgoing interface address. There is no variable that contains an outgoing
25895 interface address because, unless it is set by this option, its value is
25896 unknown.
25897
25898 During the expansion of the &%interface%& option the variables &$host$& and
25899 &$host_address$& refer to the host to which a connection is about to be made
25900 during the expansion of the string. Forced expansion failure, or an empty
25901 string result causes the option to be ignored. Otherwise, after expansion, the
25902 string must be a list of IP addresses, colon-separated by default, but the
25903 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25904 For example:
25905 .code
25906 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25907 .endd
25908 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25909 connection. If none of them are the correct type, the option is ignored. If
25910 &%interface%& is not set, or is ignored, the system's IP functions choose which
25911 interface to use if the host has more than one.
25912
25913
25914 .option keepalive smtp boolean true
25915 .cindex "keepalive" "on outgoing connection"
25916 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25917 connections. When set, it causes the kernel to probe idle connections
25918 periodically, by sending packets with &"old"& sequence numbers. The other end
25919 of the connection should send a acknowledgment if the connection is still okay
25920 or a reset if the connection has been aborted. The reason for doing this is
25921 that it has the beneficial effect of freeing up certain types of connection
25922 that can get stuck when the remote host is disconnected without tidying up the
25923 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25924 unreachable hosts.
25925
25926
25927 .option lmtp_ignore_quota smtp boolean false
25928 .cindex "LMTP" "ignoring quota errors"
25929 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25930 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25931 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25932
25933 .option max_rcpt smtp integer&!! 100
25934 .cindex "RCPT" "maximum number of outgoing"
25935 This option,
25936 .new
25937 after expansion,
25938 .wen
25939 limits the number of RCPT commands that are sent in a single
25940 SMTP message transaction.
25941 A value setting of zero disables the limit.
25942
25943 .new
25944 If a constant is given,
25945 .wen
25946 each set of addresses is treated independently, and
25947 so can cause parallel connections to the same host if &%remote_max_parallel%&
25948 permits this.
25949
25950
25951 .option message_linelength_limit smtp integer 998
25952 .cindex "line length" limit
25953 This option sets the maximum line length, in bytes, that the transport
25954 will send.  Any messages with lines exceeding the given value
25955 will fail and a failure-DSN ("bounce") message will if possible be returned
25956 to the sender.
25957 The default value is that defined by the SMTP standards.
25958
25959 It is generally wise to also check in the data ACL so that messages
25960 received via SMTP can be refused without producing a bounce.
25961
25962
25963 .option multi_domain smtp boolean&!! true
25964 .vindex "&$domain$&"
25965 When this option is set, the &(smtp)& transport can handle a number of
25966 addresses containing a mixture of different domains provided they all resolve
25967 to the same list of hosts. Turning the option off restricts the transport to
25968 handling only one domain at a time. This is useful if you want to use
25969 &$domain$& in an expansion for the transport, because it is set only when there
25970 is a single domain involved in a remote delivery.
25971
25972 It is expanded per-address and can depend on any of
25973 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25974 &$host$&, &$host_address$& and &$host_port$&.
25975
25976 If the connection is DANE-enabled then this option is ignored;
25977 only messages having the domain used for the DANE TLSA lookup are
25978 sent on the connection.
25979
25980 .option port smtp string&!! "see below"
25981 .cindex "port" "sending TCP/IP"
25982 .cindex "TCP/IP" "setting outgoing port"
25983 This option specifies the TCP/IP port on the server to which Exim connects.
25984 &*Note:*& Do not confuse this with the port that was used when a message was
25985 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25986 The name was changed to minimize confusion with the outgoing port. There is no
25987 variable that contains an outgoing port.
25988
25989 If the value of this option begins with a digit it is taken as a port number;
25990 otherwise it is looked up using &[getservbyname()]&. The default value is
25991 normally &"smtp"&,
25992 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25993 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25994 If the expansion fails, or if a port number cannot be found, delivery
25995 is deferred.
25996
25997 Note that at least one Linux distribution has been seen failing
25998 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25999
26000
26001
26002 .option protocol smtp string smtp
26003 .cindex "LMTP" "over TCP/IP"
26004 .cindex "ssmtp protocol" "outbound"
26005 .cindex "TLS" "SSL-on-connect outbound"
26006 .vindex "&$port$&"
26007 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
26008 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
26009 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
26010 deliveries into closed message stores. Exim also has support for running LMTP
26011 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
26012
26013 If this option is set to &"smtps"&, the default value for the &%port%& option
26014 changes to &"smtps"&, and the transport initiates TLS immediately after
26015 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
26016 The Internet standards bodies used to strongly discourage use of this mode,
26017 but as of RFC 8314 it is preferred over STARTTLS for message submission
26018 (as distinct from MTA-MTA communication).
26019
26020
26021 .option retry_include_ip_address smtp boolean&!! true
26022 Exim normally includes both the host name and the IP address in the key it
26023 constructs for indexing retry data after a temporary delivery failure. This
26024 means that when one of several IP addresses for a host is failing, it gets
26025 tried periodically (controlled by the retry rules), but use of the other IP
26026 addresses is not affected.
26027
26028 However, in some dialup environments hosts are assigned a different IP address
26029 each time they connect. In this situation the use of the IP address as part of
26030 the retry key leads to undesirable behaviour. Setting this option false causes
26031 Exim to use only the host name.
26032 Since it is expanded it can be made to depend on the host or domain.
26033
26034
26035 .option serialize_hosts smtp "host list&!!" unset
26036 .cindex "serializing connections"
26037 .cindex "host" "serializing connections"
26038 Because Exim operates in a distributed manner, if several messages for the same
26039 host arrive at around the same time, more than one simultaneous connection to
26040 the remote host can occur. This is not usually a problem except when there is a
26041 slow link between the hosts. In that situation it may be helpful to restrict
26042 Exim to one connection at a time. This can be done by setting
26043 &%serialize_hosts%& to match the relevant hosts.
26044
26045 .cindex "hints database" "serializing deliveries to a host"
26046 Exim implements serialization by means of a hints database in which a record is
26047 written whenever a process connects to one of the restricted hosts. The record
26048 is deleted when the connection is completed. Obviously there is scope for
26049 records to get left lying around if there is a system or program crash. To
26050 guard against this, Exim ignores any records that are more than six hours old.
26051
26052 If you set up this kind of serialization, you should also arrange to delete the
26053 relevant hints database whenever your system reboots. The names of the files
26054 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26055 may be one or two files, depending on the type of DBM in use. The same files
26056 are used for ETRN serialization.
26057
26058 See also the &%max_parallel%& generic transport option.
26059
26060
26061 .option size_addition smtp integer 1024
26062 .cindex "SIZE" "ESMTP extension"
26063 .cindex "message" "size issue for transport filter"
26064 .cindex "size" "of message"
26065 .cindex "transport" "filter"
26066 .cindex "filter" "transport filter"
26067 If a remote SMTP server indicates that it supports the SIZE option of the
26068 MAIL command, Exim uses this to pass over the message size at the start of
26069 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26070 sends, to allow for headers and other text that may be added during delivery by
26071 configuration options or in a transport filter. It may be necessary to increase
26072 this if a lot of text is added to messages.
26073
26074 Alternatively, if the value of &%size_addition%& is set negative, it disables
26075 the use of the SIZE option altogether.
26076
26077
26078 .option socks_proxy smtp string&!! unset
26079 .cindex proxy SOCKS
26080 This option enables use of SOCKS proxies for connections made by the
26081 transport.  For details see section &<<SECTproxySOCKS>>&.
26082
26083
26084 .option tls_alpn smtp string&!! unset
26085 .cindex TLS "Application Layer Protocol Names"
26086 .cindex TLS ALPN
26087 .cindex ALPN "set name in client"
26088 If this option is set
26089 and the TLS library supports ALPN,
26090 the value given is used.
26091
26092 As of writing no value has been standardised for email use.
26093 The authors suggest using &"smtp"&.
26094
26095
26096
26097 .option tls_certificate smtp string&!! unset
26098 .cindex "TLS" "client certificate, location of"
26099 .cindex "certificate" "client, location of"
26100 .vindex "&$host$&"
26101 .vindex "&$host_address$&"
26102 The value of this option must be the absolute path to a file which contains the
26103 client's certificate, for possible use when sending a message over an encrypted
26104 connection. The values of &$host$& and &$host_address$& are set to the name and
26105 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26106 details of TLS.
26107
26108 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26109 certificate when sending messages as a client. The global option of the same
26110 name specifies the certificate for Exim as a server; it is not automatically
26111 assumed that the same certificate should be used when Exim is operating as a
26112 client.
26113
26114
26115 .option tls_crl smtp string&!! unset
26116 .cindex "TLS" "client certificate revocation list"
26117 .cindex "certificate" "revocation list for client"
26118 This option specifies a certificate revocation list. The expanded value must
26119 be the name of a file that contains a CRL in PEM format.
26120
26121
26122 .option tls_dh_min_bits smtp integer 1024
26123 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26124 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26125 key agreement is negotiated, the server will provide a large prime number
26126 for use.  This option establishes the minimum acceptable size of that number.
26127 If the parameter offered by the server is too small, then the TLS handshake
26128 will fail.
26129
26130 Only supported when using GnuTLS.
26131
26132
26133 .option tls_privatekey smtp string&!! unset
26134 .cindex "TLS" "client private key, location of"
26135 .vindex "&$host$&"
26136 .vindex "&$host_address$&"
26137 The value of this option must be the absolute path to a file which contains the
26138 client's private key. This is used when sending a message over an encrypted
26139 connection using a client certificate. The values of &$host$& and
26140 &$host_address$& are set to the name and address of the server during the
26141 expansion. If this option is unset, or the expansion is forced to fail, or the
26142 result is an empty string, the private key is assumed to be in the same file as
26143 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26144
26145
26146 .option tls_require_ciphers smtp string&!! unset
26147 .cindex "TLS" "requiring specific ciphers"
26148 .cindex "cipher" "requiring specific"
26149 .vindex "&$host$&"
26150 .vindex "&$host_address$&"
26151 The value of this option must be a list of permitted cipher suites, for use
26152 when setting up an outgoing encrypted connection. (There is a global option of
26153 the same name for controlling incoming connections.) The values of &$host$& and
26154 &$host_address$& are set to the name and address of the server during the
26155 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26156 is used in different ways by OpenSSL and GnuTLS (see sections
26157 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26158 ciphers is a preference order.
26159
26160
26161 .option tls_resumption_hosts smtp "host list&!!" unset
26162 .cindex TLS resumption
26163 This option controls which connections to use the TLS resumption feature.
26164 See &<<SECTresumption>>& for details.
26165
26166
26167
26168 .option tls_sni smtp string&!! unset
26169 .cindex "TLS" "Server Name Indication"
26170 .cindex "TLS" SNI
26171 .cindex SNI "setting in client"
26172 .vindex "&$tls_sni$&"
26173 If this option is set
26174 and the connection is not DANE-validated
26175 then it sets the $tls_out_sni variable and causes any
26176 TLS session to pass this value as the Server Name Indication extension to
26177 the remote side, which can be used by the remote side to select an appropriate
26178 certificate and private key for the session.
26179
26180 See &<<SECTtlssni>>& for more information.
26181
26182 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26183 TLS extensions.
26184
26185
26186
26187
26188 .option tls_tempfail_tryclear smtp boolean true
26189 .cindex "4&'xx'& responses" "to STARTTLS"
26190 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26191 setting up a TLS session, this option determines whether or not Exim should try
26192 to deliver the message unencrypted. If it is set false, delivery to the
26193 current host is deferred; if there are other hosts, they are tried. If this
26194 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26195 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26196 TLS negotiation fails, Exim closes the current connection (because it is in an
26197 unknown state), opens a new one to the same host, and then tries the delivery
26198 in clear.
26199
26200
26201 .option tls_try_verify_hosts smtp "host list&!!" *
26202 .cindex "TLS" "server certificate verification"
26203 .cindex "certificate" "verification of server"
26204 This option gives a list of hosts for which, on encrypted connections,
26205 certificate verification will be tried but need not succeed.
26206 The &%tls_verify_certificates%& option must also be set.
26207 Note that unless the host is in this list
26208 TLS connections will be denied to hosts using self-signed certificates
26209 when &%tls_verify_certificates%& is matched.
26210 The &$tls_out_certificate_verified$& variable is set when
26211 certificate verification succeeds.
26212
26213
26214 .option tls_verify_cert_hostnames smtp "host list&!!" *
26215 .cindex "TLS" "server certificate hostname verification"
26216 .cindex "certificate" "verification of server"
26217 This option give a list of hosts for which,
26218 while verifying the server certificate,
26219 checks will be included on the host name
26220 (note that this will generally be the result of a DNS MX lookup)
26221 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26222 Wildcard names are permitted,
26223 limited to being the initial component of a 3-or-more component FQDN.
26224
26225 There is no equivalent checking on client certificates.
26226
26227
26228 .option tls_verify_certificates smtp string&!! system
26229 .cindex "TLS" "server certificate verification"
26230 .cindex "certificate" "verification of server"
26231 .vindex "&$host$&"
26232 .vindex "&$host_address$&"
26233 The value of this option must be either the
26234 word "system"
26235 or the absolute path to
26236 a file or directory containing permitted certificates for servers,
26237 for use when setting up an encrypted connection.
26238
26239 The "system" value for the option will use a location compiled into the SSL library.
26240 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26241 is taken as empty and an explicit location
26242 must be specified.
26243
26244 The use of a directory for the option value is not available for GnuTLS versions
26245 preceding 3.3.6 and a single file must be used.
26246
26247 With OpenSSL the certificates specified
26248 explicitly
26249 either by file or directory
26250 are added to those given by the system default location.
26251
26252 The values of &$host$& and
26253 &$host_address$& are set to the name and address of the server during the
26254 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26255
26256 For back-compatibility,
26257 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26258 (a single-colon empty list counts as being set)
26259 and certificate verification fails the TLS connection is closed.
26260
26261
26262 .option tls_verify_hosts smtp "host list&!!" unset
26263 .cindex "TLS" "server certificate verification"
26264 .cindex "certificate" "verification of server"
26265 This option gives a list of hosts for which, on encrypted connections,
26266 certificate verification must succeed.
26267 The &%tls_verify_certificates%& option must also be set.
26268 If both this option and &%tls_try_verify_hosts%& are unset
26269 operation is as if this option selected all hosts.
26270 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26271 that connections use TLS.
26272 Fallback to in-clear communication will be done unless restricted by
26273 the &%hosts_require_tls%& option.
26274
26275 .option utf8_downconvert smtp integer&!! -1
26276 .cindex utf8 "address downconversion"
26277 .cindex i18n "utf8 address downconversion"
26278 If built with internationalization support,
26279 this option controls conversion of UTF-8 in message envelope addresses
26280 to a-label form.
26281 If, after expansion, the value is 1, 0, or -1 then this value overrides
26282 any value previously set for the message.  Otherwise, any previously
26283 set value is used.  To permit use of a previous value,
26284 set this option to an empty string.
26285 For details on the values see section &<<SECTi18nMTA>>&.
26286
26287
26288
26289
26290 .section "How the limits for the number of hosts to try are used" &&&
26291          "SECTvalhosmax"
26292 .cindex "host" "maximum number to try"
26293 .cindex "limit" "hosts; maximum number tried"
26294 There are two options that are concerned with the number of hosts that are
26295 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26296 &%hosts_max_try_hardlimit%&.
26297
26298
26299 The &%hosts_max_try%& option limits the number of hosts that are tried
26300 for a single delivery. However, despite the term &"host"& in its name, the
26301 option actually applies to each IP address independently. In other words, a
26302 multihomed host is treated as several independent hosts, just as it is for
26303 retrying.
26304
26305 Many of the larger ISPs have multiple MX records which often point to
26306 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26307 created as a result of routing one of these domains.
26308
26309 Trying every single IP address on such a long list does not seem sensible; if
26310 several at the top of the list fail, it is reasonable to assume there is some
26311 problem that is likely to affect all of them. Roughly speaking, the value of
26312 &%hosts_max_try%& is the maximum number that are tried before deferring the
26313 delivery. However, the logic cannot be quite that simple.
26314
26315 Firstly, IP addresses that are skipped because their retry times have not
26316 arrived do not count, and in addition, addresses that are past their retry
26317 limits are also not counted, even when they are tried. This means that when
26318 some IP addresses are past their retry limits, more than the value of
26319 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26320 that all IP addresses are considered before timing out an email address (but
26321 see below for an exception).
26322
26323 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26324 list to see if there is a subsequent host with a different (higher valued) MX.
26325 If there is, that host is considered next, and the current IP address is used
26326 but not counted. This behaviour helps in the case of a domain with a retry rule
26327 that hardly ever delays any hosts, as is now explained:
26328
26329 Consider the case of a long list of hosts with one MX value, and a few with a
26330 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26331 hosts at the top of the list are tried at first. With the default retry rule,
26332 which specifies increasing retry times, the higher MX hosts are eventually
26333 tried when those at the top of the list are skipped because they have not
26334 reached their retry times.
26335
26336 However, it is common practice to put a fixed short retry time on domains for
26337 large ISPs, on the grounds that their servers are rarely down for very long.
26338 Unfortunately, these are exactly the domains that tend to resolve to long lists
26339 of hosts. The short retry time means that the lowest MX hosts are tried every
26340 time. The attempts may be in a different order because of random sorting, but
26341 without the special MX check, the higher MX hosts would never be tried until
26342 all the lower MX hosts had timed out (which might be several days), because
26343 there are always some lower MX hosts that have reached their retry times. With
26344 the special check, Exim considers at least one IP address from each MX value at
26345 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26346 reached.
26347
26348 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26349 particular, Exim normally eventually tries all the IP addresses before timing
26350 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26351 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26352 been set up with hundreds of IP addresses for some domains. It can
26353 take a very long time indeed for an address to time out in these cases.
26354
26355 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26356 Exim never tries more than this number of IP addresses; if it hits this limit
26357 and they are all timed out, the email address is bounced, even though not all
26358 possible IP addresses have been tried.
26359 .ecindex IIDsmttra1
26360 .ecindex IIDsmttra2
26361
26362
26363
26364
26365
26366 . ////////////////////////////////////////////////////////////////////////////
26367 . ////////////////////////////////////////////////////////////////////////////
26368
26369 .chapter "Address rewriting" "CHAPrewrite"
26370 .scindex IIDaddrew "rewriting" "addresses"
26371 There are some circumstances in which Exim automatically rewrites domains in
26372 addresses. The two most common are when an address is given without a domain
26373 (referred to as an &"unqualified address"&) or when an address contains an
26374 abbreviated domain that is expanded by DNS lookup.
26375
26376 Unqualified envelope addresses are accepted only for locally submitted
26377 messages, or for messages that are received from hosts matching
26378 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26379 appropriate. Unqualified addresses in header lines are qualified if they are in
26380 locally submitted messages, or messages from hosts that are permitted to send
26381 unqualified envelope addresses. Otherwise, unqualified addresses in header
26382 lines are neither qualified nor rewritten.
26383
26384 One situation in which Exim does &'not'& automatically rewrite a domain is
26385 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26386 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26387 do this. The new RFCs do not contain this suggestion.
26388
26389
26390 .section "Explicitly configured address rewriting" "SECID147"
26391 This chapter describes the rewriting rules that can be used in the
26392 main rewrite section of the configuration file, and also in the generic
26393 &%headers_rewrite%& option that can be set on any transport.
26394
26395 Some people believe that configured address rewriting is a Mortal Sin.
26396 Others believe that life is not possible without it. Exim provides the
26397 facility; you do not have to use it.
26398
26399 The main rewriting rules that appear in the &"rewrite"& section of the
26400 configuration file are applied to addresses in incoming messages, both envelope
26401 addresses and addresses in header lines. Each rule specifies the types of
26402 address to which it applies.
26403
26404 Whether or not addresses in header lines are rewritten depends on the origin of
26405 the headers and the type of rewriting. Global rewriting, that is, rewriting
26406 rules from the rewrite section of the configuration file, is applied only to
26407 those headers that were received with the message. Header lines that are added
26408 by ACLs or by a system filter or by individual routers or transports (which
26409 are specific to individual recipient addresses) are not rewritten by the global
26410 rules.
26411
26412 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26413 applies all headers except those added by routers and transports. That is, as
26414 well as the headers that were received with the message, it also applies to
26415 headers that were added by an ACL or a system filter.
26416
26417
26418 In general, rewriting addresses from your own system or domain has some
26419 legitimacy. Rewriting other addresses should be done only with great care and
26420 in special circumstances. The author of Exim believes that rewriting should be
26421 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26422 Although it can sometimes be used as a routing tool, this is very strongly
26423 discouraged.
26424
26425 There are two commonly encountered circumstances where rewriting is used, as
26426 illustrated by these examples:
26427
26428 .ilist
26429 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26430 exchange mail with each other behind a firewall, but there is only a single
26431 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26432 &'hitch.fict.example'& when sending mail off-site.
26433 .next
26434 A host rewrites the local parts of its own users so that, for example,
26435 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26436 .endlist
26437
26438
26439
26440 .section "When does rewriting happen?" "SECID148"
26441 .cindex "rewriting" "timing of"
26442 .cindex "&ACL;" "rewriting addresses in"
26443 Configured address rewriting can take place at several different stages of a
26444 message's processing.
26445
26446 .vindex "&$sender_address$&"
26447 At the start of an ACL for MAIL, the sender address may have been rewritten
26448 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26449 ordinary rewrite rules have yet been applied. If, however, the sender address
26450 is verified in the ACL, it is rewritten before verification, and remains
26451 rewritten thereafter. The subsequent value of &$sender_address$& is the
26452 rewritten address. This also applies if sender verification happens in a
26453 RCPT ACL. Otherwise, when the sender address is not verified, it is
26454 rewritten as soon as a message's header lines have been received.
26455
26456 .vindex "&$domain$&"
26457 .vindex "&$local_part$&"
26458 Similarly, at the start of an ACL for RCPT, the current recipient's address
26459 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26460 rewrite rules have yet been applied to it. However, the behaviour is different
26461 from the sender address when a recipient is verified. The address is rewritten
26462 for the verification, but the rewriting is not remembered at this stage. The
26463 value of &$local_part$& and &$domain$& after verification are always the same
26464 as they were before (that is, they contain the unrewritten &-- except for
26465 SMTP-time rewriting &-- address).
26466
26467 As soon as a message's header lines have been received, all the envelope
26468 recipient addresses are permanently rewritten, and rewriting is also applied to
26469 the addresses in the header lines (if configured). This happens before adding
26470 any header lines that were specified in MAIL or RCPT ACLs, and
26471 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26472 before the DATA ACL and &[local_scan()]& functions are run.
26473
26474 When an address is being routed, either for delivery or for verification,
26475 rewriting is applied immediately to child addresses that are generated by
26476 redirection, unless &%no_rewrite%& is set on the router.
26477
26478 .cindex "envelope from"
26479 .cindex "envelope sender" "rewriting at transport time"
26480 .cindex "rewriting" "at transport time"
26481 .cindex "header lines" "rewriting at transport time"
26482 At transport time, additional rewriting of addresses in header lines can be
26483 specified by setting the generic &%headers_rewrite%& option on a transport.
26484 This option contains rules that are identical in form to those in the rewrite
26485 section of the configuration file. They are applied to the original message
26486 header lines and any that were added by ACLs or a system filter. They are not
26487 applied to header lines that are added by routers or the transport.
26488
26489 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26490 transport option. However, it is not possible to rewrite envelope recipients at
26491 transport time.
26492
26493
26494
26495
26496 .section "Testing the rewriting rules that apply on input" "SECID149"
26497 .cindex "rewriting" "testing"
26498 .cindex "testing" "rewriting"
26499 Exim's input rewriting configuration appears in a part of the runtime
26500 configuration file headed by &"begin rewrite"&. It can be tested by the
26501 &%-brw%& command line option. This takes an address (which can be a full RFC
26502 2822 address) as its argument. The output is a list of how the address would be
26503 transformed by the rewriting rules for each of the different places it might
26504 appear in an incoming message, that is, for each different header and for the
26505 envelope sender and recipient fields. For example,
26506 .code
26507 exim -brw ph10@exim.workshop.example
26508 .endd
26509 might produce the output
26510 .code
26511 sender: Philip.Hazel@exim.workshop.example
26512 from: Philip.Hazel@exim.workshop.example
26513 to: ph10@exim.workshop.example
26514 cc: ph10@exim.workshop.example
26515 bcc: ph10@exim.workshop.example
26516 reply-to: Philip.Hazel@exim.workshop.example
26517 env-from: Philip.Hazel@exim.workshop.example
26518 env-to: ph10@exim.workshop.example
26519 .endd
26520 which shows that rewriting has been set up for that address when used in any of
26521 the source fields, but not when it appears as a recipient address. At the
26522 present time, there is no equivalent way of testing rewriting rules that are
26523 set for a particular transport.
26524
26525
26526 .section "Rewriting rules" "SECID150"
26527 .cindex "rewriting" "rules"
26528 The rewrite section of the configuration file consists of lines of rewriting
26529 rules in the form
26530 .display
26531 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26532 .endd
26533 Rewriting rules that are specified for the &%headers_rewrite%& generic
26534 transport option are given as a colon-separated list. Each item in the list
26535 takes the same form as a line in the main rewriting configuration (except that
26536 any colons must be doubled, of course).
26537
26538 The formats of source patterns and replacement strings are described below.
26539 Each is terminated by white space, unless enclosed in double quotes, in which
26540 case normal quoting conventions apply inside the quotes. The flags are single
26541 characters which may appear in any order. Spaces and tabs between them are
26542 ignored.
26543
26544 For each address that could potentially be rewritten, the rules are scanned in
26545 order, and replacements for the address from earlier rules can themselves be
26546 replaced by later rules (but see the &"q"& and &"R"& flags).
26547
26548 The order in which addresses are rewritten is undefined, may change between
26549 releases, and must not be relied on, with one exception: when a message is
26550 received, the envelope sender is always rewritten first, before any header
26551 lines are rewritten. For example, the replacement string for a rewrite of an
26552 address in &'To:'& must not assume that the message's address in &'From:'& has
26553 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26554 that the envelope sender has already been rewritten.
26555
26556 .vindex "&$domain$&"
26557 .vindex "&$local_part$&"
26558 The variables &$local_part$& and &$domain$& can be used in the replacement
26559 string to refer to the address that is being rewritten. Note that lookup-driven
26560 rewriting can be done by a rule of the form
26561 .code
26562 *@*   ${lookup ...
26563 .endd
26564 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26565 refer to the address that is being rewritten.
26566
26567
26568 .section "Rewriting patterns" "SECID151"
26569 .cindex "rewriting" "patterns"
26570 .cindex "address list" "in a rewriting pattern"
26571 The source pattern in a rewriting rule is any item which may appear in an
26572 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26573 single-item address list, which means that it is expanded before being tested
26574 against the address. As always, if you use a regular expression as a pattern,
26575 you must take care to escape dollar and backslash characters, or use the &`\N`&
26576 facility to suppress string expansion within the regular expression.
26577
26578 Domains in patterns should be given in lower case. Local parts in patterns are
26579 case-sensitive. If you want to do case-insensitive matching of local parts, you
26580 can use a regular expression that starts with &`^(?i)`&.
26581
26582 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26583 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26584 depending on the type of match which occurred. These can be used in the
26585 replacement string to insert portions of the incoming address. &$0$& always
26586 refers to the complete incoming address. When a regular expression is used, the
26587 numerical variables are set from its capturing subexpressions. For other types
26588 of pattern they are set as follows:
26589
26590 .ilist
26591 If a local part or domain starts with an asterisk, the numerical variables
26592 refer to the character strings matched by asterisks, with &$1$& associated with
26593 the first asterisk, and &$2$& with the second, if present. For example, if the
26594 pattern
26595 .code
26596 *queen@*.fict.example
26597 .endd
26598 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26599 .code
26600 $0 = hearts-queen@wonderland.fict.example
26601 $1 = hearts-
26602 $2 = wonderland
26603 .endd
26604 Note that if the local part does not start with an asterisk, but the domain
26605 does, it is &$1$& that contains the wild part of the domain.
26606
26607 .next
26608 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26609 of the domain are placed in the next available numerical variables. Suppose,
26610 for example, that the address &'foo@bar.baz.example'& is processed by a
26611 rewriting rule of the form
26612 .display
26613 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26614 .endd
26615 and the key in the file that matches the domain is &`*.baz.example`&. Then
26616 .code
26617 $1 = foo
26618 $2 = bar
26619 $3 = baz.example
26620 .endd
26621 If the address &'foo@baz.example'& is looked up, this matches the same
26622 wildcard file entry, and in this case &$2$& is set to the empty string, but
26623 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26624 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26625 whole domain. For non-partial domain lookups, no numerical variables are set.
26626 .endlist
26627
26628
26629 .section "Rewriting replacements" "SECID152"
26630 .cindex "rewriting" "replacements"
26631 If the replacement string for a rule is a single asterisk, addresses that
26632 match the pattern and the flags are &'not'& rewritten, and no subsequent
26633 rewriting rules are scanned. For example,
26634 .code
26635 hatta@lookingglass.fict.example  *  f
26636 .endd
26637 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26638 &'From:'& headers.
26639
26640 .vindex "&$domain$&"
26641 .vindex "&$local_part$&"
26642 If the replacement string is not a single asterisk, it is expanded, and must
26643 yield a fully qualified address. Within the expansion, the variables
26644 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26645 Any letters they contain retain their original case &-- they are not lower
26646 cased. The numerical variables are set up according to the type of pattern that
26647 matched the address, as described above. If the expansion is forced to fail by
26648 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26649 current rule is abandoned, but subsequent rules may take effect. Any other
26650 expansion failure causes the entire rewriting operation to be abandoned, and an
26651 entry written to the panic log.
26652
26653
26654
26655 .subsection "Rewriting flags" "SSECID153"
26656 There are three different kinds of flag that may appear on rewriting rules:
26657
26658 .ilist
26659 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26660 c, f, h, r, s, t.
26661 .next
26662 A flag that specifies rewriting at SMTP time: S.
26663 .next
26664 Flags that control the rewriting process: Q, q, R, w.
26665 .endlist
26666
26667 For rules that are part of the &%headers_rewrite%& generic transport option,
26668 E, F, T, and S are not permitted.
26669
26670
26671
26672 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26673          "SSECID154"
26674 .cindex rewriting flags
26675 If none of the following flag letters, nor the &"S"& flag (see section
26676 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26677 and to both the sender and recipient fields of the envelope, whereas a
26678 transport-time rewriting rule just applies to all headers. Otherwise, the
26679 rewriting rule is skipped unless the relevant addresses are being processed.
26680 .display
26681 &`E`&       rewrite all envelope fields
26682 &`F`&       rewrite the envelope From field
26683 &`T`&       rewrite the envelope To field
26684 &`b`&       rewrite the &'Bcc:'& header
26685 &`c`&       rewrite the &'Cc:'& header
26686 &`f`&       rewrite the &'From:'& header
26687 &`h`&       rewrite all headers
26688 &`r`&       rewrite the &'Reply-To:'& header
26689 &`s`&       rewrite the &'Sender:'& header
26690 &`t`&       rewrite the &'To:'& header
26691 .endd
26692 "All headers" means all of the headers listed above that can be selected
26693 individually, plus their &'Resent-'& versions. It does not include
26694 other headers such as &'Subject:'& etc.
26695
26696 You should be particularly careful about rewriting &'Sender:'& headers, and
26697 restrict this to special known cases in your own domains.
26698
26699
26700 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26701 .cindex SMTP "rewriting malformed addresses"
26702 .cindex RCPT "rewriting argument of"
26703 .cindex MAIL "rewriting argument of"
26704 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26705 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26706 before any other processing; even before syntax checking. The pattern is
26707 required to be a regular expression, and it is matched against the whole of the
26708 data for the command, including any surrounding angle brackets.
26709
26710 .vindex "&$domain$&"
26711 .vindex "&$local_part$&"
26712 This form of rewrite rule allows for the handling of addresses that are not
26713 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26714 input). Because the input is not required to be a syntactically valid address,
26715 the variables &$local_part$& and &$domain$& are not available during the
26716 expansion of the replacement string. The result of rewriting replaces the
26717 original address in the MAIL or RCPT command.
26718
26719
26720 .subsection "Flags controlling the rewriting process" SSECID155
26721 There are four flags which control the way the rewriting process works. These
26722 take effect only when a rule is invoked, that is, when the address is of the
26723 correct type (matches the flags) and matches the pattern:
26724
26725 .ilist
26726 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26727 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26728 absence of &"Q"& the rewritten address must always include a domain.
26729 .next
26730 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26731 even if no rewriting actually takes place because of a &"fail"& in the
26732 expansion. The &"q"& flag is not effective if the address is of the wrong type
26733 (does not match the flags) or does not match the pattern.
26734 .next
26735 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26736 address, up to ten times. It can be combined with the &"q"& flag, to stop
26737 rewriting once it fails to match (after at least one successful rewrite).
26738 .next
26739 .cindex "rewriting" "whole addresses"
26740 When an address in a header is rewritten, the rewriting normally applies only
26741 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26742 left unchanged. For example, rewriting might change
26743 .code
26744 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26745 .endd
26746 into
26747 .code
26748 From: Ford Prefect <prefectf@hitch.fict.example>
26749 .endd
26750 .cindex "RFC 2047"
26751 Sometimes there is a need to replace the whole address item, and this can be
26752 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26753 causes an address in a header line to be rewritten, the entire address is
26754 replaced, not just the working part. The replacement must be a complete RFC
26755 2822 address, including the angle brackets if necessary. If text outside angle
26756 brackets contains a character whose value is greater than 126 or less than 32
26757 (except for tab), the text is encoded according to RFC 2047. The character set
26758 is taken from &%headers_charset%&, which gets its default at build time.
26759
26760 When the &"w"& flag is set on a rule that causes an envelope address to be
26761 rewritten, all but the working part of the replacement address is discarded.
26762 .endlist
26763
26764
26765 .section "Rewriting examples" "SECID156"
26766 Here is an example of the two common rewriting paradigms:
26767 .code
26768 *@*.hitch.fict.example  $1@hitch.fict.example
26769 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26770                      {$value}fail}@hitch.fict.example bctfrF
26771 .endd
26772 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26773 the string expansion to fail if the lookup does not succeed. In this context it
26774 has the effect of leaving the original address unchanged, but Exim goes on to
26775 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26776 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26777 explicitly, which would cause the rewritten address to be the same as before,
26778 at the cost of a small bit of processing. Not supplying either of these is an
26779 error, since the rewritten address would then contain no local part.
26780
26781 The first example above replaces the domain with a superior, more general
26782 domain. This may not be desirable for certain local parts. If the rule
26783 .code
26784 root@*.hitch.fict.example  *
26785 .endd
26786 were inserted before the first rule, rewriting would be suppressed for the
26787 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26788
26789 Rewriting can be made conditional on a number of tests, by making use of
26790 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26791 messages that originate outside the local host:
26792 .code
26793 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26794                          {$1@hitch.fict.example}fail}"
26795 .endd
26796 The replacement string is quoted in this example because it contains white
26797 space.
26798
26799 .cindex "rewriting" "bang paths"
26800 .cindex "bang paths" "rewriting"
26801 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26802 an address it treats it as an unqualified local part which it qualifies with
26803 the local qualification domain (if the source of the message is local or if the
26804 remote host is permitted to send unqualified addresses). Rewriting can
26805 sometimes be used to handle simple bang paths with a fixed number of
26806 components. For example, the rule
26807 .code
26808 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26809 .endd
26810 rewrites a two-component bang path &'host.name!user'& as the domain address
26811 &'user@host.name'&. However, there is a security implication in using this as
26812 a global rewriting rule for envelope addresses. It can provide a backdoor
26813 method for using your system as a relay, because the incoming addresses appear
26814 to be local. If the bang path addresses are received via SMTP, it is safer to
26815 use the &"S"& flag to rewrite them as they are received, so that relay checking
26816 can be done on the rewritten addresses.
26817 .ecindex IIDaddrew
26818
26819
26820
26821
26822
26823 . ////////////////////////////////////////////////////////////////////////////
26824 . ////////////////////////////////////////////////////////////////////////////
26825
26826 .chapter "Retry configuration" "CHAPretry"
26827 .scindex IIDretconf1 "retry" "configuration, description of"
26828 .scindex IIDregconf2 "configuration file" "retry section"
26829 The &"retry"& section of the runtime configuration file contains a list of
26830 retry rules that control how often Exim tries to deliver messages that cannot
26831 be delivered at the first attempt. If there are no retry rules (the section is
26832 empty or not present), there are no retries. In this situation, temporary
26833 errors are treated as permanent. The default configuration contains a single,
26834 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26835 line option can be used to test which retry rule will be used for a given
26836 address, domain and error.
26837
26838 The most common cause of retries is temporary failure to deliver to a remote
26839 host because the host is down, or inaccessible because of a network problem.
26840 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26841 address) basis, not on a per-message basis. Thus, if one message has recently
26842 been delayed, delivery of a new message to the same host is not immediately
26843 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26844 log selector is set, the message
26845 .cindex "retry" "time not reached"
26846 &"retry time not reached"& is written to the main log whenever a delivery is
26847 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26848 the handling of errors during remote deliveries.
26849
26850 Retry processing applies to routing as well as to delivering, except as covered
26851 in the next paragraph. The retry rules do not distinguish between these
26852 actions. It is not possible, for example, to specify different behaviour for
26853 failures to route the domain &'snark.fict.example'& and failures to deliver to
26854 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26855 added complication, so did not implement it. However, although they share the
26856 same retry rule, the actual retry times for routing and transporting a given
26857 domain are maintained independently.
26858
26859 When a delivery is not part of a queue run (typically an immediate delivery on
26860 receipt of a message), the routers are always run, and local deliveries are
26861 always attempted, even if retry times are set for them. This makes for better
26862 behaviour if one particular message is causing problems (for example, causing
26863 quota overflow, or provoking an error in a filter file). If such a delivery
26864 suffers a temporary failure, the retry data is updated as normal, and
26865 subsequent delivery attempts from queue runs occur only when the retry time for
26866 the local address is reached.
26867
26868 .section "Changing retry rules" "SECID157"
26869 If you change the retry rules in your configuration, you should consider
26870 whether or not to delete the retry data that is stored in Exim's spool area in
26871 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26872 always safe; that is why they are called &"hints"&.
26873
26874 The hints retry data contains suggested retry times based on the previous
26875 rules. In the case of a long-running problem with a remote host, it might
26876 record the fact that the host has timed out. If your new rules increase the
26877 timeout time for such a host, you should definitely remove the old retry data
26878 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26879 messages that it should now be retaining.
26880
26881
26882
26883 .section "Format of retry rules" "SECID158"
26884 .cindex "retry" "rules"
26885 Each retry rule occupies one line and consists of three or four parts,
26886 separated by white space: a pattern, an error name, an optional list of sender
26887 addresses, and a list of retry parameters. The pattern and sender lists must be
26888 enclosed in double quotes if they contain white space. The rules are searched
26889 in order until one is found where the pattern, error name, and sender list (if
26890 present) match the failing host or address, the error that occurred, and the
26891 message's sender, respectively.
26892
26893
26894 The pattern is any single item that may appear in an address list (see section
26895 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26896 which means that it is expanded before being tested against the address that
26897 has been delayed. A negated address list item is permitted. Address
26898 list processing treats a plain domain name as if it were preceded by &"*@"&,
26899 which makes it possible for many retry rules to start with just a domain. For
26900 example,
26901 .code
26902 lookingglass.fict.example        *  F,24h,30m;
26903 .endd
26904 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26905 whereas
26906 .code
26907 alice@lookingglass.fict.example  *  F,24h,30m;
26908 .endd
26909 applies only to temporary failures involving the local part &%alice%&.
26910 In practice, almost all rules start with a domain name pattern without a local
26911 part.
26912
26913 .cindex "regular expressions" "in retry rules"
26914 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26915 must match a complete address, not just a domain, because that is how regular
26916 expressions work in address lists.
26917 .display
26918 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26919 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26920 .endd
26921
26922
26923 .section "Choosing which retry rule to use for address errors" "SECID159"
26924 When Exim is looking for a retry rule after a routing attempt has failed (for
26925 example, after a DNS timeout), each line in the retry configuration is tested
26926 against the complete address only if &%retry_use_local_part%& is set for the
26927 router. Otherwise, only the domain is used, except when matching against a
26928 regular expression, when the local part of the address is replaced with &"*"&.
26929 A domain on its own can match a domain pattern, or a pattern that starts with
26930 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26931 &%check_local_user%& is true, and false for other routers.
26932
26933 Similarly, when Exim is looking for a retry rule after a local delivery has
26934 failed (for example, after a mailbox full error), each line in the retry
26935 configuration is tested against the complete address only if
26936 &%retry_use_local_part%& is set for the transport (it defaults true for all
26937 local transports).
26938
26939 .cindex "4&'xx'& responses" "retry rules for"
26940 However, when Exim is looking for a retry rule after a remote delivery attempt
26941 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26942 whole address is always used as the key when searching the retry rules. The
26943 rule that is found is used to create a retry time for the combination of the
26944 failing address and the message's sender. It is the combination of sender and
26945 recipient that is delayed in subsequent queue runs until its retry time is
26946 reached. You can delay the recipient without regard to the sender by setting
26947 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26948 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26949 commands.
26950
26951
26952
26953 .section "Choosing which retry rule to use for host and message errors" &&&
26954          "SECID160"
26955 For a temporary error that is not related to an individual address (for
26956 example, a connection timeout), each line in the retry configuration is checked
26957 twice. First, the name of the remote host is used as a domain name (preceded by
26958 &"*@"& when matching a regular expression). If this does not match the line,
26959 the domain from the email address is tried in a similar fashion. For example,
26960 suppose the MX records for &'a.b.c.example'& are
26961 .code
26962 a.b.c.example  MX  5  x.y.z.example
26963                MX  6  p.q.r.example
26964                MX  7  m.n.o.example
26965 .endd
26966 and the retry rules are
26967 .code
26968 p.q.r.example    *      F,24h,30m;
26969 a.b.c.example    *      F,4d,45m;
26970 .endd
26971 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26972 first rule matches neither the host nor the domain, so Exim looks at the second
26973 rule. This does not match the host, but it does match the domain, so it is used
26974 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26975 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26976 first retry rule is used, because it matches the host.
26977
26978 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26979 first rule to determine retry times, but for all the other hosts for the domain
26980 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26981 routing to &'a.b.c.example'& suffers a temporary failure.
26982
26983 &*Note*&: The host name is used when matching the patterns, not its IP address.
26984 However, if a message is routed directly to an IP address without the use of a
26985 host name, for example, if a &(manualroute)& router contains a setting such as:
26986 .code
26987 route_list = *.a.example  192.168.34.23
26988 .endd
26989 then the &"host name"& that is used when searching for a retry rule is the
26990 textual form of the IP address.
26991
26992 .section "Retry rules for specific errors" "SECID161"
26993 .cindex "retry" "specific errors; specifying"
26994 The second field in a retry rule is the name of a particular error, or an
26995 asterisk, which matches any error. The errors that can be tested for are:
26996
26997 .vlist
26998 .vitem &%auth_failed%&
26999 Authentication failed when trying to send to a host in the
27000 &%hosts_require_auth%& list in an &(smtp)& transport.
27001
27002 .vitem &%data_4xx%&
27003 A 4&'xx'& error was received for an outgoing DATA command, either immediately
27004 after the command, or after sending the message's data.
27005
27006 .vitem &%mail_4xx%&
27007 A 4&'xx'& error was received for an outgoing MAIL command.
27008
27009 .vitem &%rcpt_4xx%&
27010 A 4&'xx'& error was received for an outgoing RCPT command.
27011 .endlist
27012
27013 For the three 4&'xx'& errors, either the first or both of the x's can be given
27014 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
27015 recognize 452 errors given to RCPT commands for addresses in a certain domain,
27016 and have retries every ten minutes with a one-hour timeout, you could set up a
27017 retry rule of this form:
27018 .code
27019 the.domain.name  rcpt_452   F,1h,10m
27020 .endd
27021 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
27022 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
27023
27024 .vlist
27025 .vitem &%lost_connection%&
27026 A server unexpectedly closed the SMTP connection. There may, of course,
27027 legitimate reasons for this (host died, network died), but if it repeats a lot
27028 for the same host, it indicates something odd.
27029
27030 .vitem &%lookup%&
27031 A DNS lookup for a host failed.
27032 Note that a &%dnslookup%& router will need to have matched
27033 its &%fail_defer_domains%& option for this retry type to be usable.
27034 Also note that a &%manualroute%& router will probably need
27035 its &%host_find_failed%& option set to &%defer%&.
27036
27037 .vitem &%refused_MX%&
27038 A connection to a host obtained from an MX record was refused.
27039
27040 .vitem &%refused_A%&
27041 A connection to a host not obtained from an MX record was refused.
27042
27043 .vitem &%refused%&
27044 A connection was refused.
27045
27046 .vitem &%timeout_connect_MX%&
27047 A connection attempt to a host obtained from an MX record timed out.
27048
27049 .vitem &%timeout_connect_A%&
27050 A connection attempt to a host not obtained from an MX record timed out.
27051
27052 .vitem &%timeout_connect%&
27053 A connection attempt timed out.
27054
27055 .vitem &%timeout_MX%&
27056 There was a timeout while connecting or during an SMTP session with a host
27057 obtained from an MX record.
27058
27059 .vitem &%timeout_A%&
27060 There was a timeout while connecting or during an SMTP session with a host not
27061 obtained from an MX record.
27062
27063 .vitem &%timeout%&
27064 There was a timeout while connecting or during an SMTP session.
27065
27066 .vitem &%tls_required%&
27067 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27068 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27069 to STARTTLS, or there was a problem setting up the TLS connection.
27070
27071 .vitem &%quota%&
27072 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27073 transport.
27074
27075 .vitem &%quota_%&<&'time'&>
27076 .cindex "quota" "error testing in retry rule"
27077 .cindex "retry" "quota error testing"
27078 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27079 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27080 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27081 for four days.
27082 .endlist
27083
27084 .cindex "mailbox" "time of last read"
27085 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27086 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27087 it should be based on the last time that the user accessed the mailbox.
27088 However, it is not always possible to determine this. Exim uses the following
27089 heuristic rules:
27090
27091 .ilist
27092 If the mailbox is a single file, the time of last access (the &"atime"&) is
27093 used. As no new messages are being delivered (because the mailbox is over
27094 quota), Exim does not access the file, so this is the time of last user access.
27095 .next
27096 .cindex "maildir format" "time of last read"
27097 For a maildir delivery, the time of last modification of the &_new_&
27098 subdirectory is used. As the mailbox is over quota, no new files are created in
27099 the &_new_& subdirectory, because no new messages are being delivered. Any
27100 change to the &_new_& subdirectory is therefore assumed to be the result of an
27101 MUA moving a new message to the &_cur_& directory when it is first read. The
27102 time that is used is therefore the last time that the user read a new message.
27103 .next
27104 For other kinds of multi-file mailbox, the time of last access cannot be
27105 obtained, so a retry rule that uses this type of error field is never matched.
27106 .endlist
27107
27108 The quota errors apply both to system-enforced quotas and to Exim's own quota
27109 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27110 when a local delivery is deferred because a partition is full (the ENOSPC
27111 error).
27112
27113
27114
27115 .section "Retry rules for specified senders" "SECID162"
27116 .cindex "retry" "rules; sender-specific"
27117 You can specify retry rules that apply only when the failing message has a
27118 specific sender. In particular, this can be used to define retry rules that
27119 apply only to bounce messages. The third item in a retry rule can be of this
27120 form:
27121 .display
27122 &`senders=`&<&'address list'&>
27123 .endd
27124 The retry timings themselves are then the fourth item. For example:
27125 .code
27126 *   rcpt_4xx   senders=:   F,1h,30m
27127 .endd
27128 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27129 host. If the address list contains white space, it must be enclosed in quotes.
27130 For example:
27131 .code
27132 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27133 .endd
27134 &*Warning*&: This facility can be unhelpful if it is used for host errors
27135 (which do not depend on the recipient). The reason is that the sender is used
27136 only to match the retry rule. Once the rule has been found for a host error,
27137 its contents are used to set a retry time for the host, and this will apply to
27138 all messages, not just those with specific senders.
27139
27140 When testing retry rules using &%-brt%&, you can supply a sender using the
27141 &%-f%& command line option, like this:
27142 .code
27143 exim -f "" -brt user@dom.ain
27144 .endd
27145 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27146 list is never matched.
27147
27148
27149
27150
27151
27152 .section "Retry parameters" "SECID163"
27153 .cindex "retry" "parameters in rules"
27154 The third (or fourth, if a senders list is present) field in a retry rule is a
27155 sequence of retry parameter sets, separated by semicolons. Each set consists of
27156 .display
27157 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27158 .endd
27159 The letter identifies the algorithm for computing a new retry time; the cutoff
27160 time is the time beyond which this algorithm no longer applies, and the
27161 arguments vary the algorithm's action. The cutoff time is measured from the
27162 time that the first failure for the domain (combined with the local part if
27163 relevant) was detected, not from the time the message was received.
27164
27165 .cindex "retry" "algorithms"
27166 .cindex "retry" "fixed intervals"
27167 .cindex "retry" "increasing intervals"
27168 .cindex "retry" "random intervals"
27169 The available algorithms are:
27170
27171 .ilist
27172 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27173 the interval.
27174 .next
27175 &'G'&: retry at geometrically increasing intervals. The first argument
27176 specifies a starting value for the interval, and the second a multiplier, which
27177 is used to increase the size of the interval at each retry.
27178 .next
27179 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27180 retry, the previous interval is multiplied by the factor in order to get a
27181 maximum for the next interval. The minimum interval is the first argument of
27182 the parameter, and an actual interval is chosen randomly between them. Such a
27183 rule has been found to be helpful in cluster configurations when all the
27184 members of the cluster restart at once, and may therefore synchronize their
27185 queue processing times.
27186 .endlist
27187
27188 When computing the next retry time, the algorithm definitions are scanned in
27189 order until one whose cutoff time has not yet passed is reached. This is then
27190 used to compute a new retry time that is later than the current time. In the
27191 case of fixed interval retries, this simply means adding the interval to the
27192 current time. For geometrically increasing intervals, retry intervals are
27193 computed from the rule's parameters until one that is greater than the previous
27194 interval is found. The main configuration variable
27195 .cindex "limit" "retry interval"
27196 .cindex "retry" "interval, maximum"
27197 .oindex "&%retry_interval_max%&"
27198 &%retry_interval_max%& limits the maximum interval between retries. It
27199 cannot be set greater than &`24h`&, which is its default value.
27200
27201 A single remote domain may have a number of hosts associated with it, and each
27202 host may have more than one IP address. Retry algorithms are selected on the
27203 basis of the domain name, but are applied to each IP address independently. If,
27204 for example, a host has two IP addresses and one is unusable, Exim will
27205 generate retry times for it and will not try to use it until its next retry
27206 time comes. Thus the good IP address is likely to be tried first most of the
27207 time.
27208
27209 .cindex "hints database" "use for retrying"
27210 Retry times are hints rather than promises. Exim does not make any attempt to
27211 run deliveries exactly at the computed times. Instead, a queue runner process
27212 starts delivery processes for delayed messages periodically, and these attempt
27213 new deliveries only for those addresses that have passed their next retry time.
27214 If a new message arrives for a deferred address, an immediate delivery attempt
27215 occurs only if the address has passed its retry time. In the absence of new
27216 messages, the minimum time between retries is the interval between queue runner
27217 processes. There is not much point in setting retry times of five minutes if
27218 your queue runners happen only once an hour, unless there are a significant
27219 number of incoming messages (which might be the case on a system that is
27220 sending everything to a smart host, for example).
27221
27222 The data in the retry hints database can be inspected by using the
27223 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27224 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27225 &'exinext'& utility script can be used to find out what the next retry times
27226 are for the hosts associated with a particular mail domain, and also for local
27227 deliveries that have been deferred.
27228
27229
27230 .section "Retry rule examples" "SECID164"
27231 Here are some example retry rules:
27232 .code
27233 alice@wonderland.fict.example quota_5d  F,7d,3h
27234 wonderland.fict.example       quota_5d
27235 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27236 lookingglass.fict.example     *         F,24h,30m;
27237 *                 refused_A   F,2h,20m;
27238 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27239 .endd
27240 The first rule sets up special handling for mail to
27241 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27242 mailbox has not been read for at least 5 days. Retries continue every three
27243 hours for 7 days. The second rule handles over-quota errors for all other local
27244 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27245 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27246 fail are bounced immediately if the mailbox has not been read for at least 5
27247 days.
27248
27249 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27250 happen every 15 minutes for an hour, then with geometrically increasing
27251 intervals until two days have passed since a delivery first failed. After the
27252 first hour there is a delay of one hour, then two hours, then four hours, and
27253 so on (this is a rather extreme example).
27254
27255 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27256 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27257 all other domains, with special action for connection refusal from hosts that
27258 were not obtained from an MX record.
27259
27260 The final rule in a retry configuration should always have asterisks in the
27261 first two fields so as to provide a general catch-all for any addresses that do
27262 not have their own special handling. This example tries every 15 minutes for 2
27263 hours, then with intervals starting at one hour and increasing by a factor of
27264 1.5 up to 16 hours, then every 8 hours up to 5 days.
27265
27266
27267
27268 .section "Timeout of retry data" "SECID165"
27269 .cindex "timeout" "of retry data"
27270 .oindex "&%retry_data_expire%&"
27271 .cindex "hints database" "data expiry"
27272 .cindex "retry" "timeout of data"
27273 Exim timestamps the data that it writes to its retry hints database. When it
27274 consults the data during a delivery it ignores any that is older than the value
27275 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27276 been tried for 7 days, Exim will try to deliver to it immediately a message
27277 arrives, and if that fails, it will calculate a retry time as if it were
27278 failing for the first time.
27279
27280 This improves the behaviour for messages routed to rarely-used hosts such as MX
27281 backups. If such a host was down at one time, and happens to be down again when
27282 Exim tries a month later, using the old retry data would imply that it had been
27283 down all the time, which is not a justified assumption.
27284
27285 If a host really is permanently dead, this behaviour causes a burst of retries
27286 every now and again, but only if messages routed to it are rare. If there is a
27287 message at least once every 7 days the retry data never expires.
27288
27289
27290
27291
27292 .section "Long-term failures" "SECID166"
27293 .cindex "delivery failure, long-term"
27294 .cindex "retry" "after long-term failure"
27295 Special processing happens when an email address has been failing for so long
27296 that the cutoff time for the last algorithm is reached. For example, using the
27297 default retry rule:
27298 .code
27299 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27300 .endd
27301 the cutoff time is four days. Reaching the retry cutoff is independent of how
27302 long any specific message has been failing; it is the length of continuous
27303 failure for the recipient address that counts.
27304
27305 When the cutoff time is reached for a local delivery, or for all the IP
27306 addresses associated with a remote delivery, a subsequent delivery failure
27307 causes Exim to give up on the address, and a bounce message is generated.
27308 In order to cater for new messages that use the failing address, a next retry
27309 time is still computed from the final algorithm, and is used as follows:
27310
27311 For local deliveries, one delivery attempt is always made for any subsequent
27312 messages. If this delivery fails, the address fails immediately. The
27313 post-cutoff retry time is not used.
27314
27315 .cindex "final cutoff" "retries, controlling"
27316 .cindex retry "final cutoff"
27317 If the delivery is remote, there are two possibilities, controlled by the
27318 .oindex "&%delay_after_cutoff%&"
27319 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27320 default. Until the post-cutoff retry time for one of the IP addresses,
27321 as set by the &%retry_data_expire%& option, is
27322 reached, the failing email address is bounced immediately, without a delivery
27323 attempt taking place. After that time, one new delivery attempt is made to
27324 those IP addresses that are past their retry times, and if that still fails,
27325 the address is bounced and new retry times are computed.
27326
27327 In other words, when all the hosts for a given email address have been failing
27328 for a long time, Exim bounces rather then defers until one of the hosts' retry
27329 times is reached. Then it tries once, and bounces if that attempt fails. This
27330 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27331 to a broken destination, but if the host does recover, Exim will eventually
27332 notice.
27333
27334 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27335 addresses are past their final cutoff time, Exim tries to deliver to those IP
27336 addresses that have not been tried since the message arrived. If there are
27337 no suitable IP addresses, or if they all fail, the address is bounced. In other
27338 words, it does not delay when a new message arrives, but tries the expired
27339 addresses immediately, unless they have been tried since the message arrived.
27340 If there is a continuous stream of messages for the failing domains, setting
27341 &%delay_after_cutoff%& false means that there will be many more attempts to
27342 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27343 true.
27344
27345 .section "Deliveries that work intermittently" "SECID167"
27346 .cindex "retry" "intermittently working deliveries"
27347 Some additional logic is needed to cope with cases where a host is
27348 intermittently available, or when a message has some attribute that prevents
27349 its delivery when others to the same address get through. In this situation,
27350 because some messages are successfully delivered, the &"retry clock"& for the
27351 host or address keeps getting reset by the successful deliveries, and so
27352 failing messages remain in the queue for ever because the cutoff time is never
27353 reached.
27354
27355 Two exceptional actions are applied to prevent this happening. The first
27356 applies to errors that are related to a message rather than a remote host.
27357 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27358 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27359 commands, and quota failures. For this type of error, if a message's arrival
27360 time is earlier than the &"first failed"& time for the error, the earlier time
27361 is used when scanning the retry rules to decide when to try next and when to
27362 time out the address.
27363
27364 The exceptional second action applies in all cases. If a message has been on
27365 the queue for longer than the cutoff time of any applicable retry rule for a
27366 given address, a delivery is attempted for that address, even if it is not yet
27367 time, and if this delivery fails, the address is timed out. A new retry time is
27368 not computed in this case, so that other messages for the same address are
27369 considered immediately.
27370 .ecindex IIDretconf1
27371 .ecindex IIDregconf2
27372
27373
27374
27375
27376
27377
27378 . ////////////////////////////////////////////////////////////////////////////
27379 . ////////////////////////////////////////////////////////////////////////////
27380
27381 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27382 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27383 .scindex IIDauthconf2 "authentication"
27384 The &"authenticators"& section of Exim's runtime configuration is concerned
27385 with SMTP authentication. This facility is an extension to the SMTP protocol,
27386 described in RFC 2554, which allows a client SMTP host to authenticate itself
27387 to a server. This is a common way for a server to recognize clients that are
27388 permitted to use it as a relay. SMTP authentication is not of relevance to the
27389 transfer of mail between servers that have no managerial connection with each
27390 other.
27391
27392 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27393 prior to Exim 4.95 names would be silently truncated at this length, but now
27394 it is enforced.
27395
27396 .cindex "AUTH" "description of"
27397 .cindex "ESMTP extensions" AUTH
27398 Very briefly, the way SMTP authentication works is as follows:
27399
27400 .olist
27401 The server advertises a number of authentication &'mechanisms'& in response to
27402 the client's EHLO command.
27403 .next
27404 The client issues an AUTH command, naming a specific mechanism. The command
27405 may, optionally, contain some authentication data.
27406 .next
27407 The server may issue one or more &'challenges'&, to which the client must send
27408 appropriate responses. In simple authentication mechanisms, the challenges are
27409 just prompts for user names and passwords. The server does not have to issue
27410 any challenges &-- in some mechanisms the relevant data may all be transmitted
27411 with the AUTH command.
27412 .next
27413 The server either accepts or denies authentication.
27414 .next
27415 If authentication succeeds, the client may optionally make use of the AUTH
27416 option on the MAIL command to pass an authenticated sender in subsequent
27417 mail transactions. Authentication lasts for the remainder of the SMTP
27418 connection.
27419 .next
27420 If authentication fails, the client may give up, or it may try a different
27421 authentication mechanism, or it may try transferring mail over the
27422 unauthenticated connection.
27423 .endlist
27424
27425 If you are setting up a client, and want to know which authentication
27426 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27427 SMTP port) on the server, and issue an EHLO command. The response to this
27428 includes the list of supported mechanisms. For example:
27429 .display
27430 &`$ `&&*&`telnet server.example 25`&*&
27431 &`Trying 192.168.34.25...`&
27432 &`Connected to server.example.`&
27433 &`Escape character is &#x0027;^]&#x0027;.`&
27434 &`220 server.example ESMTP Exim 4.20 ...`&
27435 &*&`ehlo client.example`&*&
27436 &`250-server.example Hello client.example [10.8.4.5]`&
27437 &`250-SIZE 52428800`&
27438 &`250-PIPELINING`&
27439 &`250-AUTH PLAIN`&
27440 &`250 HELP`&
27441 .endd
27442 The second-last line of this example output shows that the server supports
27443 authentication using the PLAIN mechanism. In Exim, the different authentication
27444 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27445 routers and transports, which authenticators are included in the binary is
27446 controlled by build-time definitions. The following are currently available,
27447 included by setting
27448 .code
27449 AUTH_CRAM_MD5=yes
27450 AUTH_CYRUS_SASL=yes
27451 AUTH_DOVECOT=yes
27452 AUTH_EXTERNAL=yes
27453 AUTH_GSASL=yes
27454 AUTH_HEIMDAL_GSSAPI=yes
27455 AUTH_PLAINTEXT=yes
27456 AUTH_SPA=yes
27457 AUTH_TLS=yes
27458 .endd
27459 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27460 authentication mechanism (RFC 2195), and the second provides an interface to
27461 the Cyrus SASL authentication library.
27462 The third is an interface to Dovecot's authentication system, delegating the
27463 work via a socket interface.
27464 The fourth provides for negotiation of authentication done via non-SMTP means,
27465 as defined by RFC 4422 Appendix A.
27466 The fifth provides an interface to the GNU SASL authentication library, which
27467 provides mechanisms but typically not data sources.
27468 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27469 supporting setting a server keytab.
27470 The seventh can be configured to support
27471 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27472 not formally documented, but used by several MUAs.
27473 The eighth authenticator
27474 supports Microsoft's &'Secure Password Authentication'& mechanism.
27475 The last is an Exim authenticator but not an SMTP one;
27476 instead it can use information from a TLS negotiation.
27477
27478 The authenticators are configured using the same syntax as other drivers (see
27479 section &<<SECTfordricon>>&). If no authenticators are required, no
27480 authentication section need be present in the configuration file. Each
27481 authenticator can in principle have both server and client functions. When Exim
27482 is receiving SMTP mail, it is acting as a server; when it is sending out
27483 messages over SMTP, it is acting as a client. Authenticator configuration
27484 options are provided for use in both these circumstances.
27485
27486 To make it clear which options apply to which situation, the prefixes
27487 &%server_%& and &%client_%& are used on option names that are specific to
27488 either the server or the client function, respectively. Server and client
27489 functions are disabled if none of their options are set. If an authenticator is
27490 to be used for both server and client functions, a single definition, using
27491 both sets of options, is required. For example:
27492 .code
27493 cram:
27494   driver = cram_md5
27495   public_name = CRAM-MD5
27496   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27497   client_name = ph10
27498   client_secret = secret2
27499 .endd
27500 The &%server_%& option is used when Exim is acting as a server, and the
27501 &%client_%& options when it is acting as a client.
27502
27503 Descriptions of the individual authenticators are given in subsequent chapters.
27504 The remainder of this chapter covers the generic options for the
27505 authenticators, followed by general discussion of the way authentication works
27506 in Exim.
27507
27508 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27509 per-mechanism basis.  Please read carefully to determine which variables hold
27510 account labels such as usercodes and which hold passwords or other
27511 authenticating data.
27512
27513 Note that some mechanisms support two different identifiers for accounts: the
27514 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27515 and &'authz'& are commonly encountered.  The American spelling is standard here.
27516 Conceptually, authentication data such as passwords are tied to the identifier
27517 used to authenticate; servers may have rules to permit one user to act as a
27518 second user, so that after login the session is treated as though that second
27519 user had logged in.  That second user is the &'authorization id'&.  A robust
27520 configuration might confirm that the &'authz'& field is empty or matches the
27521 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27522 as verified data, the &'authz'& as an unverified request which the server might
27523 choose to honour.
27524
27525 A &'realm'& is a text string, typically a domain name, presented by a server
27526 to a client to help it select an account and credentials to use.  In some
27527 mechanisms, the client and server provably agree on the realm, but clients
27528 typically can not treat the realm as secure data to be blindly trusted.
27529
27530
27531
27532 .section "Generic options for authenticators" "SECID168"
27533 .cindex "authentication" "generic options"
27534 .cindex "options" "generic; for authenticators"
27535
27536 .option client_condition authenticators string&!! unset
27537 When Exim is authenticating as a client, it skips any authenticator whose
27538 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27539 used, for example, to skip plain text authenticators when the connection is not
27540 encrypted by a setting such as:
27541 .code
27542 client_condition = ${if !eq{$tls_out_cipher}{}}
27543 .endd
27544
27545
27546 .option client_set_id authenticators string&!! unset
27547 When client authentication succeeds, this condition is expanded; the
27548 result is used in the log lines for outbound messages.
27549 Typically it will be the user name used for authentication.
27550
27551
27552 .option driver authenticators string unset
27553 This option must always be set. It specifies which of the available
27554 authenticators is to be used.
27555
27556
27557 .option public_name authenticators string unset
27558 This option specifies the name of the authentication mechanism that the driver
27559 implements, and by which it is known to the outside world. These names should
27560 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27561 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27562 defaults to the driver's instance name.
27563
27564
27565 .option server_advertise_condition authenticators string&!! unset
27566 When a server is about to advertise an authentication mechanism, the condition
27567 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27568 mechanism is not advertised.
27569 If the expansion fails, the mechanism is not advertised. If the failure was not
27570 forced, and was not caused by a lookup defer, the incident is logged.
27571 See section &<<SECTauthexiser>>& below for further discussion.
27572
27573
27574 .option server_condition authenticators string&!! unset
27575 This option must be set for a &%plaintext%& server authenticator, where it
27576 is used directly to control authentication. See section &<<SECTplainserver>>&
27577 for details.
27578
27579 For the &(gsasl)& authenticator, this option is required for various
27580 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27581
27582 For the other authenticators, &%server_condition%& can be used as an additional
27583 authentication or authorization mechanism that is applied after the other
27584 authenticator conditions succeed. If it is set, it is expanded when the
27585 authenticator would otherwise return a success code. If the expansion is forced
27586 to fail, authentication fails. Any other expansion failure causes a temporary
27587 error code to be returned. If the result of a successful expansion is an empty
27588 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27589 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27590 other result, a temporary error code is returned, with the expanded string as
27591 the error text.
27592
27593
27594 .option server_debug_print authenticators string&!! unset
27595 If this option is set and authentication debugging is enabled (see the &%-d%&
27596 command line option), the string is expanded and included in the debugging
27597 output when the authenticator is run as a server. This can help with checking
27598 out the values of variables.
27599 If expansion of the string fails, the error message is written to the debugging
27600 output, and Exim carries on processing.
27601
27602
27603 .option server_set_id authenticators string&!! unset
27604 .vindex "&$authenticated_id$&"
27605 .vindex "&$authenticated_fail_id$&"
27606 When an Exim server successfully authenticates a client, this string is
27607 expanded using data from the authentication, and preserved for any incoming
27608 messages in the variable &$authenticated_id$&. It is also included in the log
27609 lines for incoming messages. For example, a user/password authenticator
27610 configuration might preserve the user name that was used to authenticate, and
27611 refer to it subsequently during delivery of the message.
27612 On a failing authentication the expansion result is instead saved in
27613 the &$authenticated_fail_id$& variable.
27614 If expansion fails, the option is ignored.
27615
27616
27617 .option server_mail_auth_condition authenticators string&!! unset
27618 This option allows a server to discard authenticated sender addresses supplied
27619 as part of MAIL commands in SMTP connections that are authenticated by the
27620 driver on which &%server_mail_auth_condition%& is set. The option is not used
27621 as part of the authentication process; instead its (unexpanded) value is
27622 remembered for later use.
27623 How it is used is described in the following section.
27624
27625
27626
27627
27628
27629 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27630 .cindex "authentication" "sender; authenticated"
27631 .cindex "AUTH" "on MAIL command"
27632 When a client supplied an AUTH= item on a MAIL command, Exim applies
27633 the following checks before accepting it as the authenticated sender of the
27634 message:
27635
27636 .ilist
27637 If the connection is not using extended SMTP (that is, HELO was used rather
27638 than EHLO), the use of AUTH= is a syntax error.
27639 .next
27640 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27641 .next
27642 .vindex "&$authenticated_sender$&"
27643 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27644 running, the value of &$authenticated_sender$& is set to the value obtained
27645 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27646 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27647 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27648 given for the MAIL command.
27649 .next
27650 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27651 is accepted and placed in &$authenticated_sender$& only if the client has
27652 authenticated.
27653 .next
27654 If the AUTH= value was accepted by either of the two previous rules, and
27655 the client has authenticated, and the authenticator has a setting for the
27656 &%server_mail_auth_condition%&, the condition is checked at this point. The
27657 valued that was saved from the authenticator is expanded. If the expansion
27658 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27659 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27660 the value of &$authenticated_sender$& is retained and passed on with the
27661 message.
27662 .endlist
27663
27664
27665 When &$authenticated_sender$& is set for a message, it is passed on to other
27666 hosts to which Exim authenticates as a client. Do not confuse this value with
27667 &$authenticated_id$&, which is a string obtained from the authentication
27668 process, and which is not usually a complete email address.
27669
27670 .vindex "&$sender_address$&"
27671 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27672 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27673 therefore make use of &$authenticated_sender$&. The converse is not true: the
27674 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27675 ACL is run.
27676
27677
27678
27679 .section "Authentication on an Exim server" "SECTauthexiser"
27680 .cindex "authentication" "on an Exim server"
27681 When Exim receives an EHLO command, it advertises the public names of those
27682 authenticators that are configured as servers, subject to the following
27683 conditions:
27684
27685 .ilist
27686 The client host must match &%auth_advertise_hosts%& (default *).
27687 .next
27688 If the &%server_advertise_condition%& option is set, its expansion must not
27689 yield the empty string, &"0"&, &"no"&, or &"false"&.
27690 .endlist
27691
27692 The order in which the authenticators are defined controls the order in which
27693 the mechanisms are advertised.
27694
27695 Some mail clients (for example, some versions of Netscape) require the user to
27696 provide a name and password for authentication whenever AUTH is advertised,
27697 even though authentication may not in fact be needed (for example, Exim may be
27698 set up to allow unconditional relaying from the client by an IP address check).
27699 You can make such clients more friendly by not advertising AUTH to them.
27700 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27701 that runs for RCPT) to relay without authentication, you should set
27702 .code
27703 auth_advertise_hosts = ! 10.9.8.0/24
27704 .endd
27705 so that no authentication mechanisms are advertised to them.
27706
27707 The &%server_advertise_condition%& controls the advertisement of individual
27708 authentication mechanisms. For example, it can be used to restrict the
27709 advertisement of a particular mechanism to encrypted connections, by a setting
27710 such as:
27711 .code
27712 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27713 .endd
27714 .vindex "&$tls_in_cipher$&"
27715 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27716 yields &"yes"&, which allows the advertisement to happen.
27717
27718 When an Exim server receives an AUTH command from a client, it rejects it
27719 immediately if AUTH was not advertised in response to an earlier EHLO
27720 command. This is the case if
27721
27722 .ilist
27723 The client host does not match &%auth_advertise_hosts%&; or
27724 .next
27725 No authenticators are configured with server options; or
27726 .next
27727 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27728 server authenticators.
27729 .endlist
27730
27731
27732 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27733 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27734 AUTH is accepted from any client host.
27735
27736 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27737 server authentication mechanism that was advertised in response to EHLO and
27738 that matches the one named in the AUTH command. If it finds one, it runs
27739 the appropriate authentication protocol, and authentication either succeeds or
27740 fails. If there is no matching advertised mechanism, the AUTH command is
27741 rejected with a 504 error.
27742
27743 .vindex "&$received_protocol$&"
27744 .vindex "&$sender_host_authenticated$&"
27745 When a message is received from an authenticated host, the value of
27746 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27747 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27748 public name) of the authenticator driver that successfully authenticated the
27749 client from which the message was received. This variable is empty if there was
27750 no successful authentication.
27751
27752 .cindex authentication "expansion item"
27753 Successful authentication sets up information used by the
27754 &%authresults%& expansion item.
27755
27756 .new
27757 .cindex authentication "failure event, server"
27758 If an authenticator is run and does not succeed,
27759 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27760 While the event is being processed the variables
27761 &$sender_host_authenticated$& (with the authenticator name)
27762 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27763 will be valid.
27764 If the event is serviced and a string is returned then the string will be logged
27765 instead of the default log line.
27766 See <<CHAPevents>> for details on events.
27767 .wen
27768
27769
27770 .section "Testing server authentication" "SECID169"
27771 .cindex "authentication" "testing a server"
27772 .cindex "AUTH" "testing a server"
27773 .cindex "base64 encoding" "creating authentication test data"
27774 Exim's &%-bh%& option can be useful for testing server authentication
27775 configurations. The data for the AUTH command has to be sent using base64
27776 encoding. A quick way to produce such data for testing is the following Perl
27777 script:
27778 .code
27779 use MIME::Base64;
27780 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27781 .endd
27782 .cindex "binary zero" "in authentication data"
27783 This interprets its argument as a Perl string, and then encodes it. The
27784 interpretation as a Perl string allows binary zeros, which are required for
27785 some kinds of authentication, to be included in the data. For example, a
27786 command line to run this script on such data might be
27787 .code
27788 encode '\0user\0password'
27789 .endd
27790 Note the use of single quotes to prevent the shell interpreting the
27791 backslashes, so that they can be interpreted by Perl to specify characters
27792 whose code value is zero.
27793
27794 &*Warning 1*&: If either of the user or password strings starts with an octal
27795 digit, you must use three zeros instead of one after the leading backslash. If
27796 you do not, the octal digit that starts your string will be incorrectly
27797 interpreted as part of the code for the first character.
27798
27799 &*Warning 2*&: If there are characters in the strings that Perl interprets
27800 specially, you must use a Perl escape to prevent them being misinterpreted. For
27801 example, a command such as
27802 .code
27803 encode '\0user@domain.com\0pas$$word'
27804 .endd
27805 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27806
27807 If you have the &%mimencode%& command installed, another way to produce
27808 base64-encoded strings is to run the command
27809 .code
27810 echo -e -n `\0user\0password' | mimencode
27811 .endd
27812 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27813 in the argument, and the &%-n%& option specifies no newline at the end of its
27814 output. However, not all versions of &%echo%& recognize these options, so you
27815 should check your version before relying on this suggestion.
27816
27817
27818
27819 .section "Authentication by an Exim client" "SECID170"
27820 .cindex "authentication" "on an Exim client"
27821 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27822 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27823 announces support for authentication, and the host matches an entry in either
27824 of these options, Exim (as a client) tries to authenticate as follows:
27825
27826 .ilist
27827 For each authenticator that is configured as a client, in the order in which
27828 they are defined in the configuration, it searches the authentication
27829 mechanisms announced by the server for one whose name matches the public name
27830 of the authenticator.
27831 .next
27832 .vindex "&$host$&"
27833 .vindex "&$host_address$&"
27834 When it finds one that matches, it runs the authenticator's client code. The
27835 variables &$host$& and &$host_address$& are available for any string expansions
27836 that the client might do. They are set to the server's name and IP address. If
27837 any expansion is forced to fail, the authentication attempt is abandoned, and
27838 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27839 delivery to be deferred.
27840 .next
27841 If the result of the authentication attempt is a temporary error or a timeout,
27842 Exim abandons trying to send the message to the host for the moment. It will
27843 try again later. If there are any backup hosts available, they are tried in the
27844 usual way.
27845
27846 .new
27847 .next
27848 .cindex authentication "failure event, client"
27849 If the response to authentication is a permanent error (5&'xx'& code),
27850 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27851 While the event is being processed the variable
27852 &$sender_host_authenticated$& (with the authenticator name)
27853 will be valid.
27854 If the event is serviced and a string is returned then the string will be logged.
27855 See <<CHAPevents>> for details on events.
27856 .wen
27857
27858 .next
27859 If the response to authentication is a permanent error (5&'xx'& code), Exim
27860 carries on searching the list of authenticators and tries another one if
27861 possible. If all authentication attempts give permanent errors, or if there are
27862 no attempts because no mechanisms match (or option expansions force failure),
27863 what happens depends on whether the host matches &%hosts_require_auth%& or
27864 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27865 delivery is deferred. The error can be detected in the retry rules, and thereby
27866 turned into a permanent error if you wish. In the second case, Exim tries to
27867 deliver the message unauthenticated.
27868 .endlist
27869
27870 Note that the hostlist test for whether to do authentication can be
27871 confused if name-IP lookups change between the time the peer is decided
27872 upon and the time that the transport runs.  For example, with a manualroute
27873 router given a host name, and with DNS "round-robin" used by that name: if
27874 the local resolver cache times out between the router and the transport
27875 running, the transport may get an IP for the name for its authentication
27876 check which does not match the connection peer IP.
27877 No authentication will then be done, despite the names being identical.
27878
27879 For such cases use a separate transport which always authenticates.
27880
27881 .cindex "AUTH" "on MAIL command"
27882 When Exim has authenticated itself to a remote server, it adds the AUTH
27883 parameter to the MAIL commands it sends, if it has an authenticated sender for
27884 the message. If the message came from a remote host, the authenticated sender
27885 is the one that was receiving on an incoming MAIL command, provided that the
27886 incoming connection was authenticated and the &%server_mail_auth%& condition
27887 allowed the authenticated sender to be retained. If a local process calls Exim
27888 to send a message, the sender address that is built from the login name and
27889 &%qualify_domain%& is treated as authenticated. However, if the
27890 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27891 the authenticated sender that was received with the message.
27892 .ecindex IIDauthconf1
27893 .ecindex IIDauthconf2
27894
27895
27896
27897
27898
27899
27900 . ////////////////////////////////////////////////////////////////////////////
27901 . ////////////////////////////////////////////////////////////////////////////
27902
27903 .chapter "The plaintext authenticator" "CHAPplaintext"
27904 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27905 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27906 The &(plaintext)& authenticator can be configured to support the PLAIN and
27907 LOGIN authentication mechanisms, both of which transfer authentication data as
27908 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27909 security risk; you are strongly advised to insist on the use of SMTP encryption
27910 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27911 use unencrypted plain text, you should not use the same passwords for SMTP
27912 connections as you do for login accounts.
27913
27914 .section "Avoiding cleartext use" "SECTplain_TLS"
27915 The following generic option settings will disable &(plaintext)& authenticators when
27916 TLS is not being used:
27917 .code
27918   server_advertise_condition = ${if def:tls_in_cipher }
27919   client_condition =           ${if def:tls_out_cipher}
27920 .endd
27921
27922 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27923 but is still vulnerable to a Man In The Middle attack unless certificates
27924 (including their names) have been properly verified.
27925
27926 .section "Plaintext server options" "SECID171"
27927 .cindex "options" "&(plaintext)& authenticator (server)"
27928 When configured as a server, &(plaintext)& uses the following options:
27929
27930 .option server_condition authenticators string&!! unset
27931 This is actually a global authentication option, but it must be set in order to
27932 configure the &(plaintext)& driver as a server. Its use is described below.
27933
27934 .option server_prompts plaintext "string list&!!" unset
27935 The contents of this option, after expansion, must be a colon-separated list of
27936 prompt strings. If expansion fails, a temporary authentication rejection is
27937 given.
27938
27939 .section "Using plaintext in a server" "SECTplainserver"
27940 .cindex "AUTH" "in &(plaintext)& authenticator"
27941 .cindex "binary zero" "in &(plaintext)& authenticator"
27942 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27943         "in &(plaintext)& authenticator"
27944 .vindex "&$auth1$&, &$auth2$&, etc"
27945 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27946
27947 When running as a server, &(plaintext)& performs the authentication test by
27948 expanding a string. The data sent by the client with the AUTH command, or in
27949 response to subsequent prompts, is base64 encoded, and so may contain any byte
27950 values when decoded. If any data is supplied with the command, it is treated as
27951 a list of strings, separated by NULs (binary zeros), the first three of which
27952 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27953 (neither LOGIN nor PLAIN uses more than three strings).
27954
27955 For compatibility with previous releases of Exim, the values are also placed in
27956 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27957 variables for this purpose is now deprecated, as it can lead to confusion in
27958 string expansions that also use them for other things.
27959
27960 If there are more strings in &%server_prompts%& than the number of strings
27961 supplied with the AUTH command, the remaining prompts are used to obtain more
27962 data. Each response from the client may be a list of NUL-separated strings.
27963
27964 .vindex "&$authenticated_id$&"
27965 Once a sufficient number of data strings have been received,
27966 &%server_condition%& is expanded. If the expansion is forced to fail,
27967 authentication fails. Any other expansion failure causes a temporary error code
27968 to be returned. If the result of a successful expansion is an empty string,
27969 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27970 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27971 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27972 For any other result, a temporary error code is returned, with the expanded
27973 string as the error text.
27974
27975 &*Warning*&: If you use a lookup in the expansion to find the user's
27976 password, be sure to make the authentication fail if the user is unknown.
27977 There are good and bad examples at the end of the next section.
27978
27979
27980
27981 .section "The PLAIN authentication mechanism" "SECID172"
27982 .cindex "PLAIN authentication mechanism"
27983 .cindex authentication PLAIN
27984 .cindex "binary zero" "in &(plaintext)& authenticator"
27985 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27986 sent as one item of data (that is, one combined string containing two NUL
27987 separators). The data is sent either as part of the AUTH command, or
27988 subsequently in response to an empty prompt from the server.
27989
27990 The second and third strings are a user name and a corresponding password.
27991 Using a single fixed user name and password as an example, this could be
27992 configured as follows:
27993 .code
27994 fixed_plain:
27995   driver = plaintext
27996   public_name = PLAIN
27997   server_prompts = :
27998   server_condition = \
27999     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
28000   server_set_id = $auth2
28001 .endd
28002 Note that the default result strings from &%if%& (&"true"& or an empty string)
28003 are exactly what we want here, so they need not be specified. Obviously, if the
28004 password contains expansion-significant characters such as dollar, backslash,
28005 or closing brace, they have to be escaped.
28006
28007 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
28008 the end of a string list are ignored). If all the data comes as part of the
28009 AUTH command, as is commonly the case, the prompt is not used. This
28010 authenticator is advertised in the response to EHLO as
28011 .code
28012 250-AUTH PLAIN
28013 .endd
28014 and a client host can authenticate itself by sending the command
28015 .code
28016 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
28017 .endd
28018 As this contains three strings (more than the number of prompts), no further
28019 data is required from the client. Alternatively, the client may just send
28020 .code
28021 AUTH PLAIN
28022 .endd
28023 to initiate authentication, in which case the server replies with an empty
28024 prompt. The client must respond with the combined data string.
28025
28026 The data string is base64 encoded, as required by the RFC. This example,
28027 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
28028 represents a zero byte. This is split up into three strings, the first of which
28029 is empty. The &%server_condition%& option in the authenticator checks that the
28030 second two are &`username`& and &`mysecret`& respectively.
28031
28032 Having just one fixed user name and password, as in this example, is not very
28033 realistic, though for a small organization with only a handful of
28034 authenticating clients it could make sense.
28035
28036 A more sophisticated instance of this authenticator could use the user name in
28037 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28038 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28039 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28040 This is an incorrect example:
28041 .code
28042 server_condition = \
28043   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28044 .endd
28045 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28046 which it then compares to the supplied password (&$auth3$&). Why is this example
28047 incorrect? It works fine for existing users, but consider what happens if a
28048 non-existent user name is given. The lookup fails, but as no success/failure
28049 strings are given for the lookup, it yields an empty string. Thus, to defeat
28050 the authentication, all a client has to do is to supply a non-existent user
28051 name and an empty password. The correct way of writing this test is:
28052 .code
28053 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28054   {${if eq{$value}{$auth3}}} {false}}
28055 .endd
28056 In this case, if the lookup succeeds, the result is checked; if the lookup
28057 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28058 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28059 always fails if its second argument is empty. However, the second way of
28060 writing the test makes the logic clearer.
28061
28062
28063 .section "The LOGIN authentication mechanism" "SECID173"
28064 .cindex "LOGIN authentication mechanism"
28065 .cindex authentication LOGIN
28066 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28067 in a number of programs. No data is sent with the AUTH command. Instead, a
28068 user name and password are supplied separately, in response to prompts. The
28069 plaintext authenticator can be configured to support this as in this example:
28070 .code
28071 fixed_login:
28072   driver = plaintext
28073   public_name = LOGIN
28074   server_prompts = User Name : Password
28075   server_condition = \
28076     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28077   server_set_id = $auth1
28078 .endd
28079 Because of the way plaintext operates, this authenticator accepts data supplied
28080 with the AUTH command (in contravention of the specification of LOGIN), but
28081 if the client does not supply it (as is the case for LOGIN clients), the prompt
28082 strings are used to obtain two data items.
28083
28084 Some clients are very particular about the precise text of the prompts. For
28085 example, Outlook Express is reported to recognize only &"Username:"& and
28086 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28087 strings. It uses the &%ldapauth%& expansion condition to check the user
28088 name and password by binding to an LDAP server:
28089 .code
28090 login:
28091   driver = plaintext
28092   public_name = LOGIN
28093   server_prompts = Username:: : Password::
28094   server_condition = ${if and{{ \
28095     !eq{}{$auth1} }{ \
28096     ldapauth{\
28097       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28098       pass=${quote:$auth2} \
28099       ldap://ldap.example.org/} }} }
28100   server_set_id = uid=$auth1,ou=people,o=example.org
28101 .endd
28102 We have to check that the username is not empty before using it, because LDAP
28103 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28104 operator to correctly quote the DN for authentication. However, the basic
28105 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28106 correct one to use for the password, because quoting is needed only to make
28107 the password conform to the Exim syntax. At the LDAP level, the password is an
28108 uninterpreted string.
28109
28110
28111 .section "Support for different kinds of authentication" "SECID174"
28112 A number of string expansion features are provided for the purpose of
28113 interfacing to different ways of user authentication. These include checking
28114 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28115 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28116 &<<SECTexpcond>>&.
28117
28118
28119
28120
28121 .section "Using plaintext in a client" "SECID175"
28122 .cindex "options" "&(plaintext)& authenticator (client)"
28123 The &(plaintext)& authenticator has two client options:
28124
28125 .option client_ignore_invalid_base64 plaintext boolean false
28126 If the client receives a server prompt that is not a valid base64 string,
28127 authentication is abandoned by default. However, if this option is set true,
28128 the error in the challenge is ignored and the client sends the response as
28129 usual.
28130
28131 .option client_send plaintext string&!! unset
28132 The string is a colon-separated list of authentication data strings. Each
28133 string is independently expanded before being sent to the server. The first
28134 string is sent with the AUTH command; any more strings are sent in response
28135 to prompts from the server. Before each string is expanded, the value of the
28136 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28137 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28138 way. Thus, the prompt that is received in response to sending the first string
28139 (with the AUTH command) can be used in the expansion of the second string, and
28140 so on. If an invalid base64 string is received when
28141 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28142 &$auth$&<&'n'&> variable.
28143
28144 &*Note*&: You cannot use expansion to create multiple strings, because
28145 splitting takes priority and happens first.
28146
28147 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28148 the data, further processing is applied to each string before it is sent. If
28149 there are any single circumflex characters in the string, they are converted to
28150 NULs. Should an actual circumflex be required as data, it must be doubled in
28151 the string.
28152
28153 This is an example of a client configuration that implements the PLAIN
28154 authentication mechanism with a fixed user name and password:
28155 .code
28156 fixed_plain:
28157   driver = plaintext
28158   public_name = PLAIN
28159   client_send = ^username^mysecret
28160 .endd
28161 The lack of colons means that the entire text is sent with the AUTH
28162 command, with the circumflex characters converted to NULs.
28163 Note that due to the ambiguity of parsing three consectutive circumflex characters
28164 there is no way to provide a password having a leading circumflex.
28165
28166
28167 A similar example
28168 that uses the LOGIN mechanism is:
28169 .code
28170 fixed_login:
28171   driver = plaintext
28172   public_name = LOGIN
28173   client_send = : username : mysecret
28174 .endd
28175 The initial colon means that the first string is empty, so no data is sent with
28176 the AUTH command itself. The remaining strings are sent in response to
28177 prompts.
28178 .ecindex IIDplaiauth1
28179 .ecindex IIDplaiauth2
28180
28181
28182
28183
28184 . ////////////////////////////////////////////////////////////////////////////
28185 . ////////////////////////////////////////////////////////////////////////////
28186
28187 .chapter "The cram_md5 authenticator" "CHID9"
28188 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28189 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28190 .cindex "CRAM-MD5 authentication mechanism"
28191 .cindex authentication CRAM-MD5
28192 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28193 sends a challenge string to the client, and the response consists of a user
28194 name and the CRAM-MD5 digest of the challenge string combined with a secret
28195 string (password) which is known to both server and client. Thus, the secret
28196 is not sent over the network as plain text, which makes this authenticator more
28197 secure than &(plaintext)&. However, the downside is that the secret has to be
28198 available in plain text at either end.
28199
28200
28201 .section "Using cram_md5 as a server" "SECID176"
28202 .cindex "options" "&(cram_md5)& authenticator (server)"
28203 This authenticator has one server option, which must be set to configure the
28204 authenticator as a server:
28205
28206 .option server_secret cram_md5 string&!! unset
28207 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28208 When the server receives the client's response, the user name is placed in
28209 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28210 obtain the password for that user. The server then computes the CRAM-MD5 digest
28211 that the client should have sent, and checks that it received the correct
28212 string. If the expansion of &%server_secret%& is forced to fail, authentication
28213 fails. If the expansion fails for some other reason, a temporary error code is
28214 returned to the client.
28215
28216 For compatibility with previous releases of Exim, the user name is also placed
28217 in &$1$&. However, the use of this variables for this purpose is now
28218 deprecated, as it can lead to confusion in string expansions that also use
28219 numeric variables for other things.
28220
28221 For example, the following authenticator checks that the user name given by the
28222 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28223 user name, authentication fails.
28224 .code
28225 fixed_cram:
28226   driver = cram_md5
28227   public_name = CRAM-MD5
28228   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28229   server_set_id = $auth1
28230 .endd
28231 .vindex "&$authenticated_id$&"
28232 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28233 name in &$authenticated_id$&. A more typical configuration might look up the
28234 secret string in a file, using the user name as the key. For example:
28235 .code
28236 lookup_cram:
28237   driver = cram_md5
28238   public_name = CRAM-MD5
28239   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28240                   {$value}fail}
28241   server_set_id = $auth1
28242 .endd
28243 Note that this expansion explicitly forces failure if the lookup fails
28244 because &$auth1$& contains an unknown user name.
28245
28246 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28247 using the relevant libraries, you need to know the realm to specify in the
28248 lookup and then ask for the &"userPassword"& attribute for that user in that
28249 realm, with:
28250 .code
28251 cyrusless_crammd5:
28252   driver = cram_md5
28253   public_name = CRAM-MD5
28254   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28255                   dbmjz{/etc/sasldb2}{$value}fail}
28256   server_set_id = $auth1
28257 .endd
28258
28259 .section "Using cram_md5 as a client" "SECID177"
28260 .cindex "options" "&(cram_md5)& authenticator (client)"
28261 When used as a client, the &(cram_md5)& authenticator has two options:
28262
28263
28264
28265 .option client_name cram_md5 string&!! "the primary host name"
28266 This string is expanded, and the result used as the user name data when
28267 computing the response to the server's challenge.
28268
28269
28270 .option client_secret cram_md5 string&!! unset
28271 This option must be set for the authenticator to work as a client. Its value is
28272 expanded and the result used as the secret string when computing the response.
28273
28274
28275 .vindex "&$host$&"
28276 .vindex "&$host_address$&"
28277 Different user names and secrets can be used for different servers by referring
28278 to &$host$& or &$host_address$& in the options. Forced failure of either
28279 expansion string is treated as an indication that this authenticator is not
28280 prepared to handle this case. Exim moves on to the next configured client
28281 authenticator. Any other expansion failure causes Exim to give up trying to
28282 send the message to the current server.
28283
28284 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28285 strings, is:
28286 .code
28287 fixed_cram:
28288   driver = cram_md5
28289   public_name = CRAM-MD5
28290   client_name = ph10
28291   client_secret = secret
28292 .endd
28293 .ecindex IIDcramauth1
28294 .ecindex IIDcramauth2
28295
28296
28297
28298 . ////////////////////////////////////////////////////////////////////////////
28299 . ////////////////////////////////////////////////////////////////////////////
28300
28301 .chapter "The cyrus_sasl authenticator" "CHID10"
28302 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28303 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28304 .cindex "Cyrus" "SASL library"
28305 .cindex "Kerberos"
28306 The code for this authenticator was provided by Matthew Byng-Maddick while
28307 at A L Digital Ltd.
28308
28309 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28310 library implementation of the RFC 2222 (&"Simple Authentication and Security
28311 Layer"&). This library supports a number of authentication mechanisms,
28312 including PLAIN and LOGIN, but also several others that Exim does not support
28313 directly. In particular, there is support for Kerberos authentication.
28314
28315 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28316 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28317 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28318 name of the driver to determine which mechanism to support.
28319
28320 Where access to some kind of secret file is required, for example, in GSSAPI
28321 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28322 user, and that the Cyrus SASL library has no way of escalating privileges
28323 by default. You may also find you need to set environment variables,
28324 depending on the driver you are using.
28325
28326 The application name provided by Exim is &"exim"&, so various SASL options may
28327 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28328 Kerberos, note that because of limitations in the GSSAPI interface,
28329 changing the server keytab might need to be communicated down to the Kerberos
28330 layer independently. The mechanism for doing so is dependent upon the Kerberos
28331 implementation.
28332
28333 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28334 may be set to point to an alternative keytab file. Exim will pass this
28335 variable through from its own inherited environment when started as root or the
28336 Exim user. The keytab file needs to be readable by the Exim user.
28337 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28338 environment variable.  In practice, for those releases, the Cyrus authenticator
28339 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28340 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28341
28342
28343 .section "Using cyrus_sasl as a server" "SECID178"
28344 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28345 (on a successful authentication) into &$auth1$&. For compatibility with
28346 previous releases of Exim, the username is also placed in &$1$&. However, the
28347 use of this variable for this purpose is now deprecated, as it can lead to
28348 confusion in string expansions that also use numeric variables for other
28349 things.
28350
28351
28352 .option server_hostname cyrus_sasl string&!! "see below"
28353 This option selects the hostname that is used when communicating with the
28354 library. The default value is &`$primary_hostname`&. It is up to the underlying
28355 SASL plug-in what it does with this data.
28356
28357
28358 .option server_mech cyrus_sasl string "see below"
28359 This option selects the authentication mechanism this driver should use. The
28360 default is the value of the generic &%public_name%& option. This option allows
28361 you to use a different underlying mechanism from the advertised name. For
28362 example:
28363 .code
28364 sasl:
28365   driver = cyrus_sasl
28366   public_name = X-ANYTHING
28367   server_mech = CRAM-MD5
28368   server_set_id = $auth1
28369 .endd
28370
28371 .option server_realm cyrus_sasl string&!! unset
28372 This specifies the SASL realm that the server claims to be in.
28373
28374
28375 .option server_service cyrus_sasl string &`smtp`&
28376 This is the SASL service that the server claims to implement.
28377
28378
28379 For straightforward cases, you do not need to set any of the authenticator's
28380 private options. All you need to do is to specify an appropriate mechanism as
28381 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28382 PLAIN, you could have two authenticators as follows:
28383 .code
28384 sasl_cram_md5:
28385   driver = cyrus_sasl
28386   public_name = CRAM-MD5
28387   server_set_id = $auth1
28388
28389 sasl_plain:
28390   driver = cyrus_sasl
28391   public_name = PLAIN
28392   server_set_id = $auth2
28393 .endd
28394 Cyrus SASL does implement the LOGIN authentication method, even though it is
28395 not a standard method. It is disabled by default in the source distribution,
28396 but it is present in many binary distributions.
28397 .ecindex IIDcyrauth1
28398 .ecindex IIDcyrauth2
28399
28400
28401
28402
28403 . ////////////////////////////////////////////////////////////////////////////
28404 . ////////////////////////////////////////////////////////////////////////////
28405 .chapter "The dovecot authenticator" "CHAPdovecot"
28406 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28407 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28408 This authenticator is an interface to the authentication facility of the
28409 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28410 Note that Dovecot must be configured to use auth-client not auth-userdb.
28411 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28412 to use the same mechanisms for SMTP authentication. This is a server
28413 authenticator only. There is only one non-generic option:
28414
28415 .option server_socket dovecot string unset
28416
28417 This option must specify the UNIX socket that is the interface to Dovecot
28418 authentication. The &%public_name%& option must specify an authentication
28419 mechanism that Dovecot is configured to support. You can have several
28420 authenticators for different mechanisms. For example:
28421 .code
28422 dovecot_plain:
28423   driver = dovecot
28424   public_name = PLAIN
28425   server_advertise_condition = ${if def:tls_in_cipher}
28426   server_socket = /var/run/dovecot/auth-client
28427   server_set_id = $auth1
28428
28429 dovecot_ntlm:
28430   driver = dovecot
28431   public_name = NTLM
28432   server_socket = /var/run/dovecot/auth-client
28433   server_set_id = $auth1
28434 .endd
28435
28436 .new
28437 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28438 should not be advertised on cleartext SMTP connections.
28439 See the discussion in section &<<SECTplain_TLS>>&.
28440 .wen
28441
28442 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28443 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28444 option is passed in the Dovecot authentication command. If, for a TLS
28445 connection, a client certificate has been verified, the &"valid-client-cert"&
28446 option is passed. When authentication succeeds, the identity of the user
28447 who authenticated is placed in &$auth1$&.
28448
28449 The Dovecot configuration to match the above will look
28450 something like:
28451 .code
28452 conf.d/10-master.conf :-
28453
28454 service auth {
28455 ...
28456 #SASL
28457   unix_listener auth-client {
28458     mode = 0660
28459     user = mail
28460   }
28461 ...
28462 }
28463
28464 conf.d/10-auth.conf :-
28465
28466 auth_mechanisms = plain login ntlm
28467 .endd
28468
28469 .ecindex IIDdcotauth1
28470 .ecindex IIDdcotauth2
28471
28472
28473 . ////////////////////////////////////////////////////////////////////////////
28474 . ////////////////////////////////////////////////////////////////////////////
28475 .chapter "The gsasl authenticator" "CHAPgsasl"
28476 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28477 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28478 .cindex "authentication" "GNU SASL"
28479 .cindex "authentication" "SASL"
28480 .cindex "authentication" "EXTERNAL"
28481 .cindex "authentication" "ANONYMOUS"
28482 .cindex "authentication" "PLAIN"
28483 .cindex "authentication" "LOGIN"
28484 .cindex "authentication" "DIGEST-MD5"
28485 .cindex "authentication" "CRAM-MD5"
28486 .cindex "authentication" "SCRAM family"
28487 The &(gsasl)& authenticator provides integration for the GNU SASL
28488 library and the mechanisms it provides.  This is new as of the 4.80 release
28489 and there are a few areas where the library does not let Exim smoothly
28490 scale to handle future authentication mechanisms, so no guarantee can be
28491 made that any particular new authentication mechanism will be supported
28492 without code changes in Exim.
28493
28494 The library is expected to add support in an upcoming
28495 realease for the SCRAM-SHA-256 method.
28496 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28497 when this happens.
28498
28499 To see the list of mechanisms supported by the library run Exim with "auth" debug
28500 enabled and look for a line containing "GNU SASL supports".
28501 Note however that some may not have been tested from Exim.
28502
28503
28504 .option client_authz gsasl string&!! unset
28505 This option can be used to supply an &'authorization id'&
28506 which is different to the &'authentication_id'& provided
28507 by &%client_username%& option.
28508 If unset or (after expansion) empty it is not used,
28509 which is the common case.
28510
28511 .option client_channelbinding gsasl boolean false
28512 See &%server_channelbinding%& below.
28513
28514 .option client_password gsasl string&!! unset
28515 This option is exapanded before use, and should result in
28516 the password to be used, in clear.
28517
28518 .option client_username gsasl string&!! unset
28519 This option is exapanded before use, and should result in
28520 the account name to be used.
28521
28522
28523 .option client_spassword gsasl string&!! unset
28524 This option is only supported for library versions 1.9.1 and greater.
28525 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28526
28527 If a SCRAM mechanism is being used and this option is set
28528 and correctly sized
28529 it is used in preference to &%client_password%&.
28530 The value after expansion should be
28531 a 40 (for SHA-1) or 64 (for SHA-256) character string
28532 with the PBKDF2-prepared password, hex-encoded.
28533
28534 Note that this value will depend on the salt and iteration-count
28535 supplied by the server.
28536 The option is expanded before use.
28537 During the expansion &$auth1$& is set with the client username,
28538 &$auth2$& with the iteration count, and
28539 &$auth3$& with the salt.
28540
28541 The intent of this option
28542 is to support clients that can cache thes salted password
28543 to save on recalculation costs.
28544 The cache lookup should return an unusable value
28545 (eg. an empty string)
28546 if the salt or iteration count has changed
28547
28548 If the authentication succeeds then the above variables are set,
28549 .vindex "&$auth4$&"
28550 plus the calculated salted password value value in &$auth4$&,
28551 during the expansion of the &%client_set_id%& option.
28552 A side-effect of this expansion can be used to prime the cache.
28553
28554
28555 .option server_channelbinding gsasl boolean false
28556 Some authentication mechanisms are able to use external context at both ends
28557 of the session to bind the authentication to that context, and fail the
28558 authentication process if that context differs.  Specifically, some TLS
28559 ciphersuites can provide identifying information about the cryptographic
28560 context.
28561
28562 This should have meant that certificate identity and verification becomes a
28563 non-issue, as a man-in-the-middle attack will cause the correct client and
28564 server to see different identifiers and authentication will fail.
28565
28566 This is
28567 only usable by mechanisms which support "channel binding"; at time of
28568 writing, that's the SCRAM family.
28569 When using this feature the "-PLUS" variants of the method names need to be used.
28570
28571 This defaults off to ensure smooth upgrade across Exim releases, in case
28572 this option causes some clients to start failing.  Some future release
28573 of Exim might have switched the default to be true.
28574
28575 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28576 . Do not plan to rely upon this feature for security, ever, without consulting
28577 . with a subject matter expert (a cryptographic engineer).
28578
28579 This option was deprecated in previous releases due to doubts over
28580 the "Triple Handshake" vulnerability.
28581 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28582 Session Resumption was used) for safety.
28583
28584
28585 .option server_hostname gsasl string&!! "see below"
28586 This option selects the hostname that is used when communicating with the
28587 library. The default value is &`$primary_hostname`&.
28588 Some mechanisms will use this data.
28589
28590
28591 .option server_mech gsasl string "see below"
28592 This option selects the authentication mechanism this driver should use. The
28593 default is the value of the generic &%public_name%& option. This option allows
28594 you to use a different underlying mechanism from the advertised name. For
28595 example:
28596 .code
28597 sasl:
28598   driver = gsasl
28599   public_name = X-ANYTHING
28600   server_mech = CRAM-MD5
28601   server_set_id = $auth1
28602 .endd
28603
28604
28605 .option server_password gsasl string&!! unset
28606 Various mechanisms need access to the cleartext password on the server, so
28607 that proof-of-possession can be demonstrated on the wire, without sending
28608 the password itself.
28609
28610 The data available for lookup varies per mechanism.
28611 In all cases, &$auth1$& is set to the &'authentication id'&.
28612 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28613 if available, else the empty string.
28614 The &$auth3$& variable will always be the &'realm'& if available,
28615 else the empty string.
28616
28617 A forced failure will cause authentication to defer.
28618
28619 If using this option, it may make sense to set the &%server_condition%&
28620 option to be simply "true".
28621
28622
28623 .option server_realm gsasl string&!! unset
28624 This specifies the SASL realm that the server claims to be in.
28625 Some mechanisms will use this data.
28626
28627
28628 .option server_scram_iter gsasl string&!! 4096
28629 This option provides data for the SCRAM family of mechanisms.
28630 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28631 when this option is expanded.
28632
28633 The result of expansion should be a decimal number,
28634 and represents both a lower-bound on the security, and
28635 a compute cost factor imposed on the client
28636 (if it does not cache results, or the server changes
28637 either the iteration count or the salt).
28638 A minimum value of 4096 is required by the standards
28639 for all current SCRAM mechanism variants.
28640
28641 .option server_scram_salt gsasl string&!! unset
28642 This option provides data for the SCRAM family of mechanisms.
28643 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28644 when this option is expanded.
28645 The value should be a base64-encoded string,
28646 of random data typically 4-to-16 bytes long.
28647 If unset or empty after expansion the library will provides a value for the
28648 protocol conversation.
28649
28650
28651 .option server_key gsasl string&!! unset
28652 .option server_skey gsasl string&!! unset
28653 These options can be used for the SCRAM family of mechanisms
28654 to provide stored information related to a password,
28655 the storage of which is preferable to plaintext.
28656
28657 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28658 &%server_skey%& is StoredKey.
28659
28660 They are only available for version 1.9.0 (or later) of the gsasl library.
28661 When this is so, the macros
28662 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28663 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28664 will be defined.
28665
28666 The &$authN$& variables are available when these options are expanded.
28667
28668 If set, the results of expansion should for each
28669 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28670 of base64-coded data, and will be used in preference to the
28671 &%server_password%& option.
28672 If unset or not of the right length, &%server_password%& will be used.
28673
28674 The libgsasl library release includes a utility &'gsasl'& which can be used
28675 to generate these values.
28676
28677
28678 .option server_service gsasl string &`smtp`&
28679 This is the SASL service that the server claims to implement.
28680 Some mechanisms will use this data.
28681
28682
28683 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28684 .vindex "&$auth1$&, &$auth2$&, etc"
28685 These may be set when evaluating specific options, as detailed above.
28686 They will also be set when evaluating &%server_condition%&.
28687
28688 Unless otherwise stated below, the &(gsasl)& integration will use the following
28689 meanings for these variables:
28690
28691 .ilist
28692 .vindex "&$auth1$&"
28693 &$auth1$&: the &'authentication id'&
28694 .next
28695 .vindex "&$auth2$&"
28696 &$auth2$&: the &'authorization id'&
28697 .next
28698 .vindex "&$auth3$&"
28699 &$auth3$&: the &'realm'&
28700 .endlist
28701
28702 On a per-mechanism basis:
28703
28704 .ilist
28705 .cindex "authentication" "EXTERNAL"
28706 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28707 the &%server_condition%& option must be present.
28708 .next
28709 .cindex "authentication" "ANONYMOUS"
28710 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28711 the &%server_condition%& option must be present.
28712 .next
28713 .cindex "authentication" "GSSAPI"
28714 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28715 &$auth2$& will be set to the &'authorization id'&,
28716 the &%server_condition%& option must be present.
28717 .endlist
28718
28719 An &'anonymous token'& is something passed along as an unauthenticated
28720 identifier; this is analogous to FTP anonymous authentication passing an
28721 email address, or software-identifier@, as the "password".
28722
28723
28724 An example showing the password having the realm specified in the callback
28725 and demonstrating a Cyrus SASL to GSASL migration approach is:
28726 .code
28727 gsasl_cyrusless_crammd5:
28728   driver = gsasl
28729   public_name = CRAM-MD5
28730   server_realm = imap.example.org
28731   server_password = ${lookup{$auth1:$auth3:userPassword}\
28732                     dbmjz{/etc/sasldb2}{$value}fail}
28733   server_set_id = ${quote:$auth1}
28734   server_condition = yes
28735 .endd
28736
28737
28738 . ////////////////////////////////////////////////////////////////////////////
28739 . ////////////////////////////////////////////////////////////////////////////
28740
28741 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28742 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28743 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28744 .cindex "authentication" "GSSAPI"
28745 .cindex "authentication" "Kerberos"
28746 The &(heimdal_gssapi)& authenticator provides server integration for the
28747 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28748 reliably.
28749
28750 .option server_hostname heimdal_gssapi string&!! "see below"
28751 This option selects the hostname that is used, with &%server_service%&,
28752 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28753 identifier.  The default value is &`$primary_hostname`&.
28754
28755 .option server_keytab heimdal_gssapi string&!! unset
28756 If set, then Heimdal will not use the system default keytab (typically
28757 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28758 The value should be a pathname, with no &"file:"& prefix.
28759
28760 .option server_service heimdal_gssapi string&!! "smtp"
28761 This option specifies the service identifier used, in conjunction with
28762 &%server_hostname%&, for building the identifier for finding credentials
28763 from the keytab.
28764
28765
28766 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28767 Beware that these variables will typically include a realm, thus will appear
28768 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28769 not verified, so a malicious client can set it to anything.
28770
28771 The &$auth1$& field should be safely trustable as a value from the Key
28772 Distribution Center.  Note that these are not quite email addresses.
28773 Each identifier is for a role, and so the left-hand-side may include a
28774 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28775
28776 .vindex "&$auth1$&, &$auth2$&, etc"
28777 .ilist
28778 .vindex "&$auth1$&"
28779 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28780 .next
28781 .vindex "&$auth2$&"
28782 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28783 authentication.  If that was empty, this will also be set to the
28784 GSS Display Name.
28785 .endlist
28786
28787
28788 . ////////////////////////////////////////////////////////////////////////////
28789 . ////////////////////////////////////////////////////////////////////////////
28790
28791 .chapter "The spa authenticator" "CHAPspa"
28792 .scindex IIDspaauth1 "&(spa)& authenticator"
28793 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28794 .cindex "authentication" "Microsoft Secure Password"
28795 .cindex "authentication" "NTLM"
28796 .cindex "Microsoft Secure Password Authentication"
28797 .cindex "NTLM authentication"
28798 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28799 Password Authentication'& mechanism,
28800 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28801 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28802 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28803 server side was subsequently contributed by Tom Kistner. The mechanism works as
28804 follows:
28805
28806 .ilist
28807 After the AUTH command has been accepted, the client sends an SPA
28808 authentication request based on the user name and optional domain.
28809 .next
28810 The server sends back a challenge.
28811 .next
28812 The client builds a challenge response which makes use of the user's password
28813 and sends it to the server, which then accepts or rejects it.
28814 .endlist
28815
28816 Encryption is used to protect the password in transit.
28817
28818
28819
28820 .section "Using spa as a server" "SECID179"
28821 .cindex "options" "&(spa)& authenticator (server)"
28822 The &(spa)& authenticator has just one server option:
28823
28824 .option server_password spa string&!! unset
28825 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28826 This option is expanded, and the result must be the cleartext password for the
28827 authenticating user, whose name is at this point in &$auth1$&. For
28828 compatibility with previous releases of Exim, the user name is also placed in
28829 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28830 it can lead to confusion in string expansions that also use numeric variables
28831 for other things. For example:
28832 .code
28833 spa:
28834   driver = spa
28835   public_name = NTLM
28836   server_password = \
28837     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28838 .endd
28839 If the expansion is forced to fail, authentication fails. Any other expansion
28840 failure causes a temporary error code to be returned.
28841
28842
28843
28844
28845
28846 .section "Using spa as a client" "SECID180"
28847 .cindex "options" "&(spa)& authenticator (client)"
28848 The &(spa)& authenticator has the following client options:
28849
28850
28851
28852 .option client_domain spa string&!! unset
28853 This option specifies an optional domain for the authentication.
28854
28855
28856 .option client_password spa string&!! unset
28857 This option specifies the user's password, and must be set.
28858
28859
28860 .option client_username spa string&!! unset
28861 This option specifies the user name, and must be set. Here is an example of a
28862 configuration of this authenticator for use with the mail servers at
28863 &'msn.com'&:
28864 .code
28865 msn:
28866   driver = spa
28867   public_name = MSN
28868   client_username = msn/msn_username
28869   client_password = msn_plaintext_password
28870   client_domain = DOMAIN_OR_UNSET
28871 .endd
28872 .ecindex IIDspaauth1
28873 .ecindex IIDspaauth2
28874
28875
28876
28877
28878
28879 . ////////////////////////////////////////////////////////////////////////////
28880 . ////////////////////////////////////////////////////////////////////////////
28881
28882 .chapter "The external authenticator" "CHAPexternauth"
28883 .scindex IIDexternauth1 "&(external)& authenticator"
28884 .scindex IIDexternauth2 "authenticators" "&(external)&"
28885 .cindex "authentication" "Client Certificate"
28886 .cindex "authentication" "X509"
28887 .cindex "Certificate-based authentication"
28888 The &(external)& authenticator provides support for
28889 authentication based on non-SMTP information.
28890 The specification is in RFC 4422 Appendix A
28891 (&url(https://tools.ietf.org/html/rfc4422)).
28892 It is only a transport and negotiation mechanism;
28893 the process of authentication is entirely controlled
28894 by the server configuration.
28895
28896 The client presents an identity in-clear.
28897 It is probably wise for a server to only advertise,
28898 and for clients to only attempt,
28899 this authentication method on a secure (eg. under TLS) connection.
28900
28901 One possible use, compatible with the
28902 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28903 is for using X509 client certificates.
28904
28905 It thus overlaps in function with the TLS authenticator
28906 (see &<<CHAPtlsauth>>&)
28907 but is a full SMTP SASL authenticator
28908 rather than being implicit for TLS-connection carried
28909 client certificates only.
28910
28911 The examples and discussion in this chapter assume that
28912 client-certificate authentication is being done.
28913
28914 The client must present a certificate,
28915 for which it must have been requested via the
28916 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28917 (see &<<CHAPTLS>>&).
28918 For authentication to be effective the certificate should be
28919 verifiable against a trust-anchor certificate known to the server.
28920
28921 .section "External options" "SECTexternsoptions"
28922 .cindex "options" "&(external)& authenticator (server)"
28923 The &(external)& authenticator has two server options:
28924
28925 .option server_param2 external string&!! unset
28926 .option server_param3 external string&!! unset
28927 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28928 These options are expanded before the &%server_condition%& option
28929 and the result are placed in &$auth2$& and &$auth3$& resectively.
28930 If the expansion is forced to fail, authentication fails. Any other expansion
28931 failure causes a temporary error code to be returned.
28932
28933 They can be used to clarify the coding of a complex &%server_condition%&.
28934
28935 .section "Using external in a server" "SECTexternserver"
28936 .cindex "AUTH" "in &(external)& authenticator"
28937 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28938         "in &(external)& authenticator"
28939 .vindex "&$auth1$&, &$auth2$&, etc"
28940 .cindex "base64 encoding" "in &(external)& authenticator"
28941
28942 When running as a server, &(external)& performs the authentication test by
28943 expanding a string. The data sent by the client with the AUTH command, or in
28944 response to subsequent prompts, is base64 encoded, and so may contain any byte
28945 values when decoded. The decoded value is treated as
28946 an identity for authentication and
28947 placed in the expansion variable &$auth1$&.
28948
28949 For compatibility with previous releases of Exim, the value is also placed in
28950 the expansion variable &$1$&. However, the use of this
28951 variable for this purpose is now deprecated, as it can lead to confusion in
28952 string expansions that also use them for other things.
28953
28954 .vindex "&$authenticated_id$&"
28955 Once an identity has been received,
28956 &%server_condition%& is expanded. If the expansion is forced to fail,
28957 authentication fails. Any other expansion failure causes a temporary error code
28958 to be returned. If the result of a successful expansion is an empty string,
28959 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28960 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28961 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28962 For any other result, a temporary error code is returned, with the expanded
28963 string as the error text.
28964
28965 Example:
28966 .code
28967 ext_ccert_san_mail:
28968   driver =            external
28969   public_name =       EXTERNAL
28970
28971   server_advertise_condition = $tls_in_certificate_verified
28972   server_param2 =     ${certextract {subj_altname,mail,>:} \
28973                                     {$tls_in_peercert}}
28974   server_condition =  ${if forany {$auth2} \
28975                             {eq {$item}{$auth1}}}
28976   server_set_id =     $auth1
28977 .endd
28978 This accepts a client certificate that is verifiable against any
28979 of your configured trust-anchors
28980 (which usually means the full set of public CAs)
28981 and which has a mail-SAN matching the claimed identity sent by the client.
28982
28983 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28984 The account name is therefore guessable by an opponent.
28985 TLS 1.3 protects both server and client certificates, and is not vulnerable
28986 in this way.
28987
28988
28989 .section "Using external in a client" "SECTexternclient"
28990 .cindex "options" "&(external)& authenticator (client)"
28991 The &(external)& authenticator has one client option:
28992
28993 .option client_send external string&!! unset
28994 This option is expanded and sent with the AUTH command as the
28995 identity being asserted.
28996
28997 Example:
28998 .code
28999 ext_ccert:
29000   driver =      external
29001   public_name = EXTERNAL
29002
29003   client_condition = ${if !eq{$tls_out_cipher}{}}
29004   client_send = myaccount@smarthost.example.net
29005 .endd
29006
29007
29008 .ecindex IIDexternauth1
29009 .ecindex IIDexternauth2
29010
29011
29012
29013
29014
29015 . ////////////////////////////////////////////////////////////////////////////
29016 . ////////////////////////////////////////////////////////////////////////////
29017
29018 .chapter "The tls authenticator" "CHAPtlsauth"
29019 .scindex IIDtlsauth1 "&(tls)& authenticator"
29020 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
29021 .cindex "authentication" "Client Certificate"
29022 .cindex "authentication" "X509"
29023 .cindex "Certificate-based authentication"
29024 The &(tls)& authenticator provides server support for
29025 authentication based on client certificates.
29026
29027 It is not an SMTP authentication mechanism and is not
29028 advertised by the server as part of the SMTP EHLO response.
29029 It is an Exim authenticator in the sense that it affects
29030 the protocol element of the log line, can be tested for
29031 by the &%authenticated%& ACL condition, and can set
29032 the &$authenticated_id$& variable.
29033
29034 The client must present a verifiable certificate,
29035 for which it must have been requested via the
29036 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29037 (see &<<CHAPTLS>>&).
29038
29039 If an authenticator of this type is configured it is
29040 run immediately after a TLS connection being negotiated
29041 (due to either STARTTLS or TLS-on-connect)
29042 and can authenticate the connection.
29043 If it does, SMTP authentication is not subsequently offered.
29044
29045 A maximum of one authenticator of this type may be present.
29046
29047
29048 .cindex "options" "&(tls)& authenticator (server)"
29049 The &(tls)& authenticator has three server options:
29050
29051 .option server_param1 tls string&!! unset
29052 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29053 This option is expanded after the TLS negotiation and
29054 the result is placed in &$auth1$&.
29055 If the expansion is forced to fail, authentication fails. Any other expansion
29056 failure causes a temporary error code to be returned.
29057
29058 .option server_param2 tls string&!! unset
29059 .option server_param3 tls string&!! unset
29060 As above, for &$auth2$& and &$auth3$&.
29061
29062 &%server_param1%& may also be spelled &%server_param%&.
29063
29064
29065 Example:
29066 .code
29067 tls:
29068   driver = tls
29069   server_param1 =     ${certextract {subj_altname,mail,>:} \
29070                                     {$tls_in_peercert}}
29071   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29072                                  {forany {$auth1} \
29073                             {!= {0} \
29074                                 {${lookup ldap{ldap:///\
29075                          mailname=${quote_ldap_dn:${lc:$item}},\
29076                          ou=users,LDAP_DC?mailid} {$value}{0} \
29077                        }    }  } }}}
29078   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29079 .endd
29080 This accepts a client certificate that is verifiable against any
29081 of your configured trust-anchors
29082 (which usually means the full set of public CAs)
29083 and which has a SAN with a good account name.
29084
29085 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29086 The account name is therefore guessable by an opponent.
29087 TLS 1.3 protects both server and client certificates, and is not vulnerable
29088 in this way.
29089 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29090
29091 . An alternative might use
29092 . .code
29093 .   server_param1 = ${sha256:$tls_in_peercert}
29094 . .endd
29095 . to require one of a set of specific certs that define a given account
29096 . (the verification is still required, but mostly irrelevant).
29097 . This would help for per-device use.
29098 .
29099 . However, for the future we really need support for checking a
29100 . user cert in LDAP - which probably wants a base-64 DER.
29101
29102 .ecindex IIDtlsauth1
29103 .ecindex IIDtlsauth2
29104
29105
29106 Note that because authentication is traditionally an SMTP operation,
29107 the &%authenticated%& ACL condition cannot be used in
29108 a connect- or helo-ACL.
29109
29110
29111
29112 . ////////////////////////////////////////////////////////////////////////////
29113 . ////////////////////////////////////////////////////////////////////////////
29114
29115 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29116          "Encrypted SMTP connections"
29117 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29118 .scindex IIDencsmtp2 "SMTP" "encryption"
29119 .cindex "TLS" "on SMTP connection"
29120 .cindex "OpenSSL"
29121 .cindex "GnuTLS"
29122 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29123 Sockets Layer), is implemented by making use of the OpenSSL library or the
29124 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29125 cryptographic code in the Exim distribution itself for implementing TLS. In
29126 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29127 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29128 You also need to understand the basic concepts of encryption at a managerial
29129 level, and in particular, the way that public keys, private keys, and
29130 certificates are used.
29131
29132 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29133 connection is established, the client issues a STARTTLS command. If the
29134 server accepts this, the client and the server negotiate an encryption
29135 mechanism. If the negotiation succeeds, the data that subsequently passes
29136 between them is encrypted.
29137
29138 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29139 and if so, what cipher suite is in use, whether the client supplied a
29140 certificate, and whether or not that certificate was verified. This makes it
29141 possible for an Exim server to deny or accept certain commands based on the
29142 encryption state.
29143
29144 &*Warning*&: Certain types of firewall and certain anti-virus products can
29145 disrupt TLS connections. You need to turn off SMTP scanning for these products
29146 in order to get TLS to work.
29147
29148
29149
29150 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29151          "SECID284"
29152 .cindex "submissions protocol"
29153 .cindex "ssmtp protocol"
29154 .cindex "smtps protocol"
29155 .cindex "SMTP" "submissions protocol"
29156 .cindex "SMTP" "ssmtp protocol"
29157 .cindex "SMTP" "smtps protocol"
29158 The history of port numbers for TLS in SMTP is a little messy and has been
29159 contentious.  As of RFC 8314, the common practice of using the historically
29160 allocated port 465 for "email submission but with TLS immediately upon connect
29161 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29162 by them in preference to STARTTLS.
29163
29164 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29165 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29166 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29167
29168 This approach was, for a while, officially abandoned when encrypted SMTP was
29169 standardized, but many clients kept using it, even as the TCP port number was
29170 reassigned for other use.
29171 Thus you may encounter guidance claiming that you shouldn't enable use of
29172 this port.
29173 In practice, a number of mail-clients have only ever supported submissions,
29174 not submission with STARTTLS upgrade.
29175 Ideally, offer both submission (587) and submissions (465) service.
29176
29177 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29178 global option. Its value must be a list of port numbers;
29179 the most common use is expected to be:
29180 .code
29181 tls_on_connect_ports = 465
29182 .endd
29183 The port numbers specified by this option apply to all SMTP connections, both
29184 via the daemon and via &'inetd'&. You still need to specify all the ports that
29185 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29186 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29187 an extra port &-- rather, it specifies different behaviour on a port that is
29188 defined elsewhere.
29189
29190 There is also a &%-tls-on-connect%& command line option. This overrides
29191 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29192
29193
29194
29195
29196
29197
29198 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29199 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29200 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29201 To build Exim to use OpenSSL you need to set
29202 .code
29203 USE_OPENSSL=yes
29204 .endd
29205 in Local/Makefile.
29206
29207 To build Exim to use GnuTLS, you need to set
29208 .code
29209 USE_GNUTLS=yes
29210 .endd
29211 in Local/Makefile.
29212
29213 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29214 include files and libraries for GnuTLS can be found.
29215
29216 There are some differences in usage when using GnuTLS instead of OpenSSL:
29217
29218 .ilist
29219 The &%tls_verify_certificates%& option
29220 cannot be the path of a directory
29221 for GnuTLS versions before 3.3.6
29222 (for later versions, or OpenSSL, it can be either).
29223 .next
29224 The default value for &%tls_dhparam%& differs for historical reasons.
29225 .next
29226 .vindex "&$tls_in_peerdn$&"
29227 .vindex "&$tls_out_peerdn$&"
29228 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29229 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29230 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29231 .next
29232 OpenSSL identifies cipher suites using hyphens as separators, for example:
29233 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29234 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29235 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29236 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29237 to handle its own older variants) when processing lists of cipher suites in the
29238 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29239 option).
29240 .next
29241 The &%tls_require_ciphers%& options operate differently, as described in the
29242 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29243 .next
29244 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29245 When using OpenSSL, this option is ignored.
29246 (If an API is found to let OpenSSL be configured in this way,
29247 let the Exim Maintainers know and we'll likely use it).
29248 .next
29249 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option, it must be ordered to match the &%tls_certificate%& list.
29250 .next
29251 Some other recently added features may only be available in one or the other.
29252 This should be documented with the feature.  If the documentation does not
29253 explicitly state that the feature is infeasible in the other TLS
29254 implementation, then patches are welcome.
29255 .next
29256 The output from "exim -bV" will show which (if any) support was included
29257 in the build.
29258 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29259 .endlist
29260
29261
29262 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29263 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29264 an explicit path; if the latter, then the text about generation still applies,
29265 but not the chosen filename.
29266 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29267 See the documentation of &%tls_dhparam%& for more information.
29268
29269 GnuTLS uses D-H parameters that may take a substantial amount of time
29270 to compute. It is unreasonable to re-compute them for every TLS session.
29271 Therefore, Exim keeps this data in a file in its spool directory, called
29272 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29273 of bits requested.
29274 The file is owned by the Exim user and is readable only by
29275 its owner. Every Exim process that start up GnuTLS reads the D-H
29276 parameters from this file. If the file does not exist, the first Exim process
29277 that needs it computes the data and writes it to a temporary file which is
29278 renamed once it is complete. It does not matter if several Exim processes do
29279 this simultaneously (apart from wasting a few resources). Once a file is in
29280 place, new Exim processes immediately start using it.
29281
29282 For maximum security, the parameters that are stored in this file should be
29283 recalculated periodically, the frequency depending on your paranoia level.
29284 If you are avoiding using the fixed D-H primes published in RFCs, then you
29285 are concerned about some advanced attacks and will wish to do this; if you do
29286 not regenerate then you might as well stick to the standard primes.
29287
29288 Arranging this is easy in principle; just delete the file when you want new
29289 values to be computed. However, there may be a problem. The calculation of new
29290 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29291 If the system is not very active, &_/dev/random_& may delay returning data
29292 until enough randomness (entropy) is available. This may cause Exim to hang for
29293 a substantial amount of time, causing timeouts on incoming connections.
29294
29295 The solution is to generate the parameters externally to Exim. They are stored
29296 in &_gnutls-params-N_& in PEM format, which means that they can be
29297 generated externally using the &(certtool)& command that is part of GnuTLS.
29298
29299 To replace the parameters with new ones, instead of deleting the file
29300 and letting Exim re-create it, you can generate new parameters using
29301 &(certtool)& and, when this has been done, replace Exim's cache file by
29302 renaming. The relevant commands are something like this:
29303 .code
29304 # ls
29305 [ look for file; assume gnutls-params-2236 is the most recent ]
29306 # rm -f new-params
29307 # touch new-params
29308 # chown exim:exim new-params
29309 # chmod 0600 new-params
29310 # certtool --generate-dh-params --bits 2236 >>new-params
29311 # openssl dhparam -noout -text -in new-params | head
29312 [ check the first line, make sure it's not more than 2236;
29313   if it is, then go back to the start ("rm") and repeat
29314   until the size generated is at most the size requested ]
29315 # chmod 0400 new-params
29316 # mv new-params gnutls-params-2236
29317 .endd
29318 If Exim never has to generate the parameters itself, the possibility of
29319 stalling is removed.
29320
29321 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29322 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29323 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29324 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29325 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29326 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29327 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29328 which applies to all D-H usage, client or server.  If the value returned by
29329 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29330 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29331 limit, which is still much higher than Exim historically used.
29332
29333 The filename and bits used will change as the GnuTLS maintainers change the
29334 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29335 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29336 2432 bits, while NSS is limited to 2236 bits.
29337
29338 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29339 increase the chance of the generated prime actually being within acceptable
29340 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29341 procedure above.  There is no sane procedure available to Exim to double-check
29342 the size of the generated prime, so it might still be too large.
29343
29344
29345 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29346 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29347 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29348 There is a function in the OpenSSL library that can be passed a list of cipher
29349 suites before the cipher negotiation takes place. This specifies which ciphers
29350 are acceptable for TLS versions prior to 1.3.
29351 The list is colon separated and may contain names like
29352 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29353 directly to this function call.
29354 Many systems will install the OpenSSL manual-pages, so you may have
29355 &'ciphers(1)'& available to you.
29356 The following quotation from the OpenSSL
29357 documentation specifies what forms of item are allowed in the cipher string:
29358
29359 .ilist
29360 It can consist of a single cipher suite such as RC4-SHA.
29361 .next
29362 It can represent a list of cipher suites containing a certain algorithm,
29363 or cipher suites of a certain type. For example SHA1 represents all
29364 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29365 SSL v3 algorithms.
29366 .next
29367 Lists of cipher suites can be combined in a single cipher string using
29368 the + character. This is used as a logical and operation. For example
29369 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29370 algorithms.
29371 .endlist
29372
29373 Each cipher string can be optionally preceded by one of the characters &`!`&,
29374 &`-`& or &`+`&.
29375 .ilist
29376 If &`!`& is used, the ciphers are permanently deleted from the list. The
29377 ciphers deleted can never reappear in the list even if they are explicitly
29378 stated.
29379 .next
29380 If &`-`& is used, the ciphers are deleted from the list, but some or all
29381 of the ciphers can be added again by later options.
29382 .next
29383 If &`+`& is used, the ciphers are moved to the end of the list. This
29384 option does not add any new ciphers; it just moves matching existing ones.
29385 .endlist
29386
29387 If none of these characters is present, the string is interpreted as
29388 a list of ciphers to be appended to the current preference list. If the list
29389 includes any ciphers already present they will be ignored: that is, they will
29390 not be moved to the end of the list.
29391 .endlist
29392
29393 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29394 string:
29395 .code
29396 # note single-quotes to get ! past any shell history expansion
29397 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29398 .endd
29399
29400 This example will let the library defaults be permitted on the MX port, where
29401 there's probably no identity verification anyway, but ups the ante on the
29402 submission ports where the administrator might have some influence on the
29403 choice of clients used:
29404 .code
29405 # OpenSSL variant; see man ciphers(1)
29406 tls_require_ciphers = ${if =={$received_port}{25}\
29407                            {DEFAULT}\
29408                            {HIGH:!MD5:!SHA1}}
29409 .endd
29410
29411 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29412 .code
29413 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29414 .endd
29415
29416 For TLS version 1.3 the control available is less fine-grained
29417 and Exim does not provide access to it at present.
29418 The value of the &%tls_require_ciphers%& option is ignored when
29419 TLS version 1.3 is negotiated.
29420
29421 As of writing the library default cipher suite list for TLSv1.3 is
29422 .code
29423 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29424 .endd
29425
29426
29427 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29428          "SECTreqciphgnu"
29429 .cindex "GnuTLS" "specifying parameters for"
29430 .cindex "TLS" "specifying ciphers (GnuTLS)"
29431 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29432 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29433 .cindex "TLS" "specifying protocols (GnuTLS)"
29434 .cindex "TLS" "specifying priority string (GnuTLS)"
29435 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29436 The GnuTLS library allows the caller to provide a "priority string", documented
29437 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29438 ciphersuite specification in OpenSSL.
29439
29440 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29441 and controls both protocols and ciphers.
29442
29443 The &%tls_require_ciphers%& option is available both as an global option,
29444 controlling how Exim behaves as a server, and also as an option of the
29445 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29446 the value is string expanded.  The resulting string is not an Exim list and
29447 the string is given to the GnuTLS library, so that Exim does not need to be
29448 aware of future feature enhancements of GnuTLS.
29449
29450 Documentation of the strings accepted may be found in the GnuTLS manual, under
29451 "Priority strings".  This is online as
29452 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29453 but beware that this relates to GnuTLS 3, which may be newer than the version
29454 installed on your system.  If you are using GnuTLS 3,
29455 then the example code
29456 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29457 on that site can be used to test a given string.
29458
29459 For example:
29460 .code
29461 # Disable older versions of protocols
29462 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29463 .endd
29464
29465 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29466 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29467 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29468
29469 This example will let the library defaults be permitted on the MX port, where
29470 there's probably no identity verification anyway, and lowers security further
29471 by increasing compatibility; but this ups the ante on the submission ports
29472 where the administrator might have some influence on the choice of clients
29473 used:
29474 .code
29475 # GnuTLS variant
29476 tls_require_ciphers = ${if =={$received_port}{25}\
29477                            {NORMAL:%COMPAT}\
29478                            {SECURE128}}
29479 .endd
29480
29481
29482 .section "Configuring an Exim server to use TLS" "SECID182"
29483 .cindex "TLS" "configuring an Exim server"
29484 .cindex "ESMTP extensions" STARTTLS
29485 When Exim has been built with TLS support, it advertises the availability of
29486 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29487 but not to any others. The default value of this option is *, which means
29488 that STARTTLS is always advertised.  Set it to blank to never advertise;
29489 this is reasonable for systems that want to use TLS only as a client.
29490
29491 If STARTTLS is to be used you
29492 need to set some other options in order to make TLS available.
29493
29494 If a client issues a STARTTLS command and there is some configuration
29495 problem in the server, the command is rejected with a 454 error. If the client
29496 persists in trying to issue SMTP commands, all except QUIT are rejected
29497 with the error
29498 .code
29499 554 Security failure
29500 .endd
29501 If a STARTTLS command is issued within an existing TLS session, it is
29502 rejected with a 554 error code.
29503
29504 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29505 must be set to match some hosts. The default is * which matches all hosts.
29506
29507 If this is all you do, TLS encryption will be enabled but not authentication -
29508 meaning that the peer has no assurance it is actually you he is talking to.
29509 You gain protection from a passive sniffer listening on the wire but not
29510 from someone able to intercept the communication.
29511
29512 Further protection requires some further configuration at the server end.
29513
29514 To make TLS work you need to set, in the server,
29515 .code
29516 tls_certificate = /some/file/name
29517 tls_privatekey = /some/file/name
29518 .endd
29519 These options are, in fact, expanded strings, so you can make them depend on
29520 the identity of the client that is connected if you wish. The first file
29521 contains the server's X509 certificate, and the second contains the private key
29522 that goes with it. These files need to be
29523 PEM format and readable by the Exim user, and must
29524 always be given as full path names.
29525 The key must not be password-protected.
29526 They can be the same file if both the
29527 certificate and the key are contained within it. If &%tls_privatekey%& is not
29528 set, or if its expansion is forced to fail or results in an empty string, this
29529 is assumed to be the case. The certificate file may also contain intermediate
29530 certificates that need to be sent to the client to enable it to authenticate
29531 the server's certificate.
29532
29533 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29534 colon-separated lists of file paths.  Ciphers using given authentication
29535 algorithms require the presence of a suitable certificate to supply the
29536 public-key.  The server selects among the certificates to present to the
29537 client depending on the selected cipher, hence the priority ordering for
29538 ciphers will affect which certificate is used.
29539
29540 If you do not understand about certificates and keys, please try to find a
29541 source of this background information, which is not Exim-specific. (There are a
29542 few comments below in section &<<SECTcerandall>>&.)
29543
29544 &*Note*&: These options do not apply when Exim is operating as a client &--
29545 they apply only in the case of a server. If you need to use a certificate in an
29546 Exim client, you must set the options of the same names in an &(smtp)&
29547 transport.
29548
29549 With just these options, an Exim server will be able to use TLS. It does not
29550 require the client to have a certificate (but see below for how to insist on
29551 this). There is one other option that may be needed in other situations. If
29552 .code
29553 tls_dhparam = /some/file/name
29554 .endd
29555 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29556 with the parameters contained in the file.
29557 Set this to &`none`& to disable use of DH entirely, by making no prime
29558 available:
29559 .code
29560 tls_dhparam = none
29561 .endd
29562 This may also be set to a string identifying a standard prime to be used for
29563 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29564 used is &`ike23`&.  There are a few standard primes available, see the
29565 documentation for &%tls_dhparam%& for the complete list.
29566
29567 See the command
29568 .code
29569 openssl dhparam
29570 .endd
29571 for a way of generating file data.
29572
29573 The strings supplied for these three options are expanded every time a client
29574 host connects. It is therefore possible to use different certificates and keys
29575 for different hosts, if you so wish, by making use of the client's IP address
29576 in &$sender_host_address$& to control the expansion. If a string expansion is
29577 forced to fail, Exim behaves as if the option is not set.
29578
29579 .cindex "cipher" "logging"
29580 .cindex "log" "TLS cipher"
29581 .vindex "&$tls_in_cipher$&"
29582 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29583 an incoming TLS connection. It is included in the &'Received:'& header of an
29584 incoming message (by default &-- you can, of course, change this), and it is
29585 also included in the log line that records a message's arrival, keyed by
29586 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29587 condition can be used to test for specific cipher suites in ACLs.
29588
29589 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29590 can check the name of the cipher suite and vary their actions accordingly. The
29591 cipher suite names vary, depending on which TLS library is being used. For
29592 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29593 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29594 documentation for more details.
29595
29596 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29597 (again depending on the &%tls_cipher%& log selector).
29598
29599
29600 .subsection "Requesting and verifying client certificates"
29601 .cindex "certificate" "verification of client"
29602 .cindex "TLS" "client certificate verification"
29603 If you want an Exim server to request a certificate when negotiating a TLS
29604 session with a client, you must set either &%tls_verify_hosts%& or
29605 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29606 apply to all TLS connections. For any host that matches one of these options,
29607 Exim requests a certificate as part of the setup of the TLS session. The
29608 contents of the certificate are verified by comparing it with a list of
29609 expected trust-anchors or certificates.
29610 These may be the system default set (depending on library version),
29611 an explicit file or,
29612 depending on library version, a directory, identified by
29613 &%tls_verify_certificates%&.
29614
29615 A file can contain multiple certificates, concatenated end to end. If a
29616 directory is used
29617 (OpenSSL only),
29618 each certificate must be in a separate file, with a name (or a symbolic link)
29619 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29620 certificate. You can compute the relevant hash by running the command
29621 .code
29622 openssl x509 -hash -noout -in /cert/file
29623 .endd
29624 where &_/cert/file_& contains a single certificate.
29625
29626 There is no checking of names of the client against the certificate
29627 Subject Name or Subject Alternate Names.
29628
29629 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29630 what happens if the client does not supply a certificate, or if the certificate
29631 does not match any of the certificates in the collection named by
29632 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29633 attempt to set up a TLS session is aborted, and the incoming connection is
29634 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29635 session continues. ACLs that run for subsequent SMTP commands can detect the
29636 fact that no certificate was verified, and vary their actions accordingly. For
29637 example, you can insist on a certificate before accepting a message for
29638 relaying, but not when the message is destined for local delivery.
29639
29640 .vindex "&$tls_in_peerdn$&"
29641 When a client supplies a certificate (whether it verifies or not), the value of
29642 the Distinguished Name of the certificate is made available in the variable
29643 &$tls_in_peerdn$& during subsequent processing of the message.
29644
29645 .cindex "log" "distinguished name"
29646 Because it is often a long text string, it is not included in the log line or
29647 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29648 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29649 &%received_header_text%& to change the &'Received:'& header. When no
29650 certificate is supplied, &$tls_in_peerdn$& is empty.
29651
29652
29653 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29654 .cindex certificate caching
29655 .cindex privatekey caching
29656 .cindex crl caching
29657 .cindex ocsp caching
29658 .cindex ciphers caching
29659 .cindex "CA bundle" caching
29660 .cindex "certificate authorities" caching
29661 .cindex tls_certificate caching
29662 .cindex tls_privatekey caching
29663 .cindex tls_crl caching
29664 .cindex tls_ocsp_file caching
29665 .cindex tls_require_ciphers caching
29666 .cindex tls_verify_certificate caching
29667 .cindex caching certificate
29668 .cindex caching privatekey
29669 .cindex caching crl
29670 .cindex caching ocsp
29671 .cindex caching ciphers
29672 .cindex caching "certificate authorities
29673 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29674 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29675 expandable elements,
29676 then the associated information is loaded at daemon startup.
29677 It is made available
29678 to child processes forked for handling received SMTP connections.
29679
29680 This caching is currently only supported under Linux and FreeBSD.
29681
29682 If caching is not possible, for example if an item has to be dependent
29683 on the peer host so contains a &$sender_host_name$& expansion, the load
29684 of the associated information is done at the startup of the TLS connection.
29685
29686 The cache is invalidated and reloaded after any changes to the directories
29687 containing files specified by these options.
29688
29689 The information specified by the main option &%tls_verify_certificates%&
29690 is similarly cached so long as it specifies files explicitly
29691 or (under GnuTLS) is the string &"system,cache"&.
29692 The latter case is not automatically invalidated;
29693 it is the operator's responsibility to arrange for a daemon restart
29694 any time the system certificate authority bundle is updated.
29695 A HUP signal is sufficient for this.
29696 The value &"system"& results in no caching under GnuTLS.
29697
29698 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29699 is acceptable in configurations for the Exim executable.
29700
29701 Caching of the system Certificate Authorities bundle can
29702 save significant time and processing on every TLS connection
29703 accepted by Exim.
29704
29705
29706
29707
29708 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29709 .cindex "cipher" "logging"
29710 .cindex "log" "TLS cipher"
29711 .cindex "log" "distinguished name"
29712 .cindex "TLS" "configuring an Exim client"
29713 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29714 deliveries as well as to incoming, the latter one causing logging of the
29715 server certificate's DN. The remaining client configuration for TLS is all
29716 within the &(smtp)& transport.
29717
29718 .cindex "ESMTP extensions" STARTTLS
29719 It is not necessary to set any options to have TLS work in the &(smtp)&
29720 transport. If Exim is built with TLS support, and TLS is advertised by a
29721 server, the &(smtp)& transport always tries to start a TLS session. However,
29722 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29723 transport) to a list of server hosts for which TLS should not be used.
29724
29725 If you do not want Exim to attempt to send messages unencrypted when an attempt
29726 to set up an encrypted connection fails in any way, you can set
29727 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29728 those hosts, delivery is always deferred if an encrypted connection cannot be
29729 set up. If there are any other hosts for the address, they are tried in the
29730 usual way.
29731
29732 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29733 the message unencrypted. It always does this if the response to STARTTLS is
29734 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29735 session after a success response code, what happens is controlled by the
29736 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29737 delivery to this host is deferred, and other hosts (if available) are tried. If
29738 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29739 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29740 negotiation fails, Exim closes the current connection (because it is in an
29741 unknown state), opens a new one to the same host, and then tries the delivery
29742 unencrypted.
29743
29744 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29745 transport provide the client with a certificate, which is passed to the server
29746 if it requests it.
29747 This is an optional thing for TLS connections, although either end
29748 may insist on it.
29749 If the server is Exim, it will request a certificate only if
29750 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29751
29752 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29753 for client use (they are usable for server use).
29754 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29755 in failed connections.
29756
29757 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29758 specifies a collection of expected server certificates.
29759 These may be
29760 the system default set (depending on library version),
29761 a file,
29762 or (depending on library version) a directory.
29763 The client verifies the server's certificate
29764 against this collection, taking into account any revoked certificates that are
29765 in the list defined by &%tls_crl%&.
29766 Failure to verify fails the TLS connection unless either of the
29767 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29768
29769 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29770 certificate verification to the listed servers.  Verification either must
29771 or need not succeed respectively.
29772
29773 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29774 name checks are made on the server certificate.
29775 The match against this list is, as per other Exim usage, the
29776 IP for the host.  That is most closely associated with the
29777 name on the DNS A (or AAAA) record for the host.
29778 However, the name that needs to be in the certificate
29779 is the one at the head of any CNAME chain leading to the A record.
29780 The option defaults to always checking.
29781
29782 The &(smtp)& transport has two OCSP-related options:
29783 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29784 is requested and required for the connection to proceed.  The default
29785 value is empty.
29786 &%hosts_request_ocsp%&; a host-list for which (additionally)
29787 a Certificate Status is requested (but not necessarily verified).  The default
29788 value is "*" meaning that requests are made unless configured
29789 otherwise.
29790
29791 The host(s) should also be in &%hosts_require_tls%&, and
29792 &%tls_verify_certificates%& configured for the transport,
29793 for OCSP to be relevant.
29794
29795 If
29796 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29797 list of permitted cipher suites. If either of these checks fails, delivery to
29798 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29799 alternative hosts, if any.
29800
29801  &*Note*&:
29802 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29803 is operating as a client. Exim does not assume that a server certificate (set
29804 by the global options of the same name) should also be used when operating as a
29805 client.
29806
29807 .vindex "&$host$&"
29808 .vindex "&$host_address$&"
29809 All the TLS options in the &(smtp)& transport are expanded before use, with
29810 &$host$& and &$host_address$& containing the name and address of the server to
29811 which the client is connected. Forced failure of an expansion causes Exim to
29812 behave as if the relevant option were unset.
29813
29814 .vindex &$tls_out_bits$&
29815 .vindex &$tls_out_cipher$&
29816 .vindex &$tls_out_peerdn$&
29817 .vindex &$tls_out_sni$&
29818 Before an SMTP connection is established, the
29819 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29820 variables are emptied. (Until the first connection, they contain the values
29821 that were set when the message was received.) If STARTTLS is subsequently
29822 successfully obeyed, these variables are set to the relevant values for the
29823 outgoing connection.
29824
29825
29826
29827 .subsection "Caching of static client configuration items" SECTclientTLScache
29828 .cindex certificate caching
29829 .cindex privatekey caching
29830 .cindex crl caching
29831 .cindex ciphers caching
29832 .cindex "CA bundle" caching
29833 .cindex "certificate authorities" caching
29834 .cindex tls_certificate caching
29835 .cindex tls_privatekey caching
29836 .cindex tls_crl caching
29837 .cindex tls_require_ciphers caching
29838 .cindex tls_verify_certificate caching
29839 .cindex caching certificate
29840 .cindex caching privatekey
29841 .cindex caching crl
29842 .cindex caching ciphers
29843 .cindex caching "certificate authorities
29844 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29845 and &%tls_crl%& have values with no
29846 expandable elements,
29847 then the associated information is loaded per smtp transport
29848 at daemon startup, at the start of a queue run, or on a
29849 command-line specified message delivery.
29850 It is made available
29851 to child processes forked for handling making SMTP connections.
29852
29853 This caching is currently only supported under Linux.
29854
29855 If caching is not possible, the load
29856 of the associated information is done at the startup of the TLS connection.
29857
29858 The cache is invalidated in the daemon
29859 and reloaded after any changes to the directories
29860 containing files specified by these options.
29861
29862 The information specified by the main option &%tls_verify_certificates%&
29863 is similarly cached so long as it specifies files explicitly
29864 or (under GnuTLS) is the string &"system,cache"&.
29865 The latter case is not automatically invaludated;
29866 it is the operator's responsibility to arrange for a daemon restart
29867 any time the system certificate authority bundle is updated.
29868 A HUP signal is sufficient for this.
29869 The value &"system"& results in no caching under GnuTLS.
29870
29871 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29872 is acceptable in configurations for the Exim executable.
29873
29874 Caching of the system Certificate Authorities bundle can
29875 save significant time and processing on every TLS connection
29876 initiated by Exim.
29877
29878
29879
29880
29881 .section "Use of TLS Server Name Indication" "SECTtlssni"
29882 .cindex "TLS" "Server Name Indication"
29883 .cindex "TLS" SNI
29884 .cindex SNI
29885 .vindex "&$tls_in_sni$&"
29886 .oindex "&%tls_in_sni%&"
29887 With TLS1.0 or above, there is an extension mechanism by which extra
29888 information can be included at various points in the protocol.  One of these
29889 extensions, documented in RFC 6066 (and before that RFC 4366) is
29890 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29891 client in the initial handshake, so that the server can examine the servername
29892 within and possibly choose to use different certificates and keys (and more)
29893 for this session.
29894
29895 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29896 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29897 address.
29898
29899 With SMTP to MX, there are the same problems here as in choosing the identity
29900 against which to validate a certificate: you can't rely on insecure DNS to
29901 provide the identity which you then cryptographically verify.  So this will
29902 be of limited use in that environment.
29903
29904 With SMTP to Submission, there is a well-defined hostname which clients are
29905 connecting to and can validate certificates against.  Thus clients &*can*&
29906 choose to include this information in the TLS negotiation.  If this becomes
29907 wide-spread, then hosters can choose to present different certificates to
29908 different clients.  Or even negotiate different cipher suites.
29909
29910 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29911 if not empty, will be sent on a TLS session as part of the handshake.  There's
29912 nothing more to it.  Choosing a sensible value not derived insecurely is the
29913 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29914 for the lifetime of the client connection (including during authentication).
29915
29916 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29917 is forced to the name of the destination host, after any MX- or CNAME-following.
29918
29919 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29920 received from a client.
29921 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29922
29923 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29924 option (prior to expansion) then the following options will be re-expanded
29925 during TLS session handshake, to permit alternative values to be chosen:
29926
29927 .ilist
29928 &%tls_certificate%&
29929 .next
29930 &%tls_crl%&
29931 .next
29932 &%tls_privatekey%&
29933 .next
29934 &%tls_verify_certificates%&
29935 .next
29936 &%tls_ocsp_file%&
29937 .endlist
29938
29939 Great care should be taken to deal with matters of case, various injection
29940 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29941 can always be referenced; it is important to remember that &$tls_in_sni$& is
29942 arbitrary unverified data provided prior to authentication.
29943 Further, the initial certificate is loaded before SNI has arrived, so
29944 an expansion for &%tls_certificate%& must have a default which is used
29945 when &$tls_in_sni$& is empty.
29946
29947 The Exim developers are proceeding cautiously and so far no other TLS options
29948 are re-expanded.
29949
29950 When Exim is built against OpenSSL, OpenSSL must have been built with support
29951 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29952 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29953 see &`-servername`& in the output, then OpenSSL has support.
29954
29955 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29956 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29957 built, then you have SNI support).
29958
29959 .subsection ALPN
29960 .cindex TLS ALPN
29961 .cindex ALPN "general information"
29962 .cindex TLS "Application Layer Protocol Names"
29963 There is a TLS feature related to SNI
29964 called Application Layer Protocol Name (ALPN).
29965 This is intended to declare, or select, what protocol layer will be using a TLS
29966 connection.
29967 The client for the connection proposes a set of protocol names, and
29968 the server responds with a selected one.
29969 It is not, as of 2021, commonly used for SMTP connections.
29970 However, to guard against misdirected or malicious use of web clients
29971 (which often do use ALPN) against MTA ports, Exim by default check that
29972 there is no incompatible ALPN specified by a client for a TLS connection.
29973 If there is, the connection is rejected.
29974
29975 As a client Exim does not supply ALPN by default.
29976 The behaviour of both client and server can be configured using the options
29977 &%tls_alpn%& and &%hosts_require_alpn%&.
29978 There are no variables providing observability.
29979 Some feature-specific logging may appear on denied connections, but this
29980 depends on the behaviour of the peer
29981 (not all peers can send a feature-specific TLS Alert).
29982
29983 This feature is available when Exim is built with
29984 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29985 the macro _HAVE_TLS_ALPN will be defined when this is so.
29986
29987
29988
29989 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29990          "SECTmulmessam"
29991 .cindex "multiple SMTP deliveries with TLS"
29992 .cindex "TLS" "multiple message deliveries"
29993 Exim sends multiple messages down the same TCP/IP connection by starting up
29994 an entirely new delivery process for each message, passing the socket from
29995 one process to the next. This implementation does not fit well with the use
29996 of TLS, because there is quite a lot of state information associated with a TLS
29997 connection, not just a socket identification. Passing all the state information
29998 to a new process is not feasible. Consequently, for sending using TLS Exim
29999 starts an additional proxy process for handling the encryption, piping the
30000 unencrypted data stream from and to the delivery processes.
30001
30002 An older mode of operation can be enabled on a per-host basis by the
30003 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
30004 this list the proxy process described above is not used; instead Exim
30005 shuts down an existing TLS session being run by the delivery process
30006 before passing the socket to a new process. The new process may then
30007 try to start a new TLS session, and if successful, may try to re-authenticate
30008 if AUTH is in use, before sending the next message.
30009
30010 The RFC is not clear as to whether or not an SMTP session continues in clear
30011 after TLS has been shut down, or whether TLS may be restarted again later, as
30012 just described. However, if the server is Exim, this shutdown and
30013 reinitialization works. It is not known which (if any) other servers operate
30014 successfully if the client closes a TLS session and continues with unencrypted
30015 SMTP, but there are certainly some that do not work. For such servers, Exim
30016 should not pass the socket to another process, because the failure of the
30017 subsequent attempt to use it would cause Exim to record a temporary host error,
30018 and delay other deliveries to that host.
30019
30020 To test for this case, Exim sends an EHLO command to the server after
30021 closing down the TLS session. If this fails in any way, the connection is
30022 closed instead of being passed to a new delivery process, but no retry
30023 information is recorded.
30024
30025 There is also a manual override; you can set &%hosts_nopass_tls%& on the
30026 &(smtp)& transport to match those hosts for which Exim should not pass
30027 connections to new processes if TLS has been used.
30028
30029
30030
30031
30032 .section "Certificates and all that" "SECTcerandall"
30033 .cindex "certificate" "references to discussion"
30034 In order to understand fully how TLS works, you need to know about
30035 certificates, certificate signing, and certificate authorities.
30036 This is a large topic and an introductory guide is unsuitable for the Exim
30037 reference manual, so instead we provide pointers to existing documentation.
30038
30039 The Apache web-server was for a long time the canonical guide, so their
30040 documentation is a good place to start; their SSL module's Introduction
30041 document is currently at
30042 .display
30043 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30044 .endd
30045 and their FAQ is at
30046 .display
30047 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30048 .endd
30049
30050 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30051 0-201-61598-3) in 2001, contains both introductory and more in-depth
30052 descriptions.
30053 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30054 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30055 Ivan is the author of the popular TLS testing tools at
30056 &url(https://www.ssllabs.com/).
30057
30058
30059 .subsection "Certificate chains" SECID186
30060 A file named by &%tls_certificate%& may contain more than one
30061 certificate. This is useful in the case where the certificate that is being
30062 sent is validated by an intermediate certificate which the other end does
30063 not have. Multiple certificates must be in the correct order in the file.
30064 First the host's certificate itself, then the first intermediate
30065 certificate to validate the issuer of the host certificate, then the next
30066 intermediate certificate to validate the issuer of the first intermediate
30067 certificate, and so on, until finally (optionally) the root certificate.
30068 The root certificate must already be trusted by the recipient for
30069 validation to succeed, of course, but if it's not preinstalled, sending the
30070 root certificate along with the rest makes it available for the user to
30071 install if the receiving end is a client MUA that can interact with a user.
30072
30073 Note that certificates using MD5 are unlikely to work on today's Internet;
30074 even if your libraries allow loading them for use in Exim when acting as a
30075 server, increasingly clients will not accept such certificates.  The error
30076 diagnostics in such a case can be frustratingly vague.
30077
30078
30079
30080 .subsection "Self-signed certificates" SECID187
30081 .cindex "certificate" "self-signed"
30082 You can create a self-signed certificate using the &'req'& command provided
30083 with OpenSSL, like this:
30084 . ==== Do not shorten the duration here without reading and considering
30085 . ==== the text below.  Please leave it at 9999 days.
30086 .code
30087 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30088             -days 9999 -nodes
30089 .endd
30090 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30091 delimited and so can be identified independently. The &%-days%& option
30092 specifies a period for which the certificate is valid. The &%-nodes%& option is
30093 important: if you do not set it, the key is encrypted with a passphrase
30094 that you are prompted for, and any use that is made of the key causes more
30095 prompting for the passphrase. This is not helpful if you are going to use
30096 this certificate and key in an MTA, where prompting is not possible.
30097
30098 . ==== I expect to still be working 26 years from now.  The less technical
30099 . ==== debt I create, in terms of storing up trouble for my later years, the
30100 . ==== happier I will be then.  We really have reached the point where we
30101 . ==== should start, at the very least, provoking thought and making folks
30102 . ==== pause before proceeding, instead of leaving all the fixes until two
30103 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30104 . ==== -pdp, 2012
30105 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30106 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30107 the above command might produce a date in the past.  Think carefully about
30108 the lifetime of the systems you're deploying, and either reduce the duration
30109 of the certificate or reconsider your platform deployment.  (At time of
30110 writing, reducing the duration is the most likely choice, but the inexorable
30111 progression of time takes us steadily towards an era where this will not
30112 be a sensible resolution).
30113
30114 A self-signed certificate made in this way is sufficient for testing, and
30115 may be adequate for all your requirements if you are mainly interested in
30116 encrypting transfers, and not in secure identification.
30117
30118 However, many clients require that the certificate presented by the server be a
30119 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30120 certificate. In this situation, the self-signed certificate described above
30121 must be installed on the client host as a trusted root &'certification
30122 authority'& (CA), and the certificate used by Exim must be a user certificate
30123 signed with that self-signed certificate.
30124
30125 For information on creating self-signed CA certificates and using them to sign
30126 user certificates, see the &'General implementation overview'& chapter of the
30127 Open-source PKI book, available online at
30128 &url(https://sourceforge.net/projects/ospkibook/).
30129
30130
30131 .subsection "Revoked certificates"
30132 .cindex "TLS" "revoked certificates"
30133 .cindex "revocation list"
30134 .cindex "certificate" "revocation list"
30135 .cindex "OCSP" "stapling"
30136 There are three ways for a certificate to be made unusable
30137 before its expiry.
30138
30139 .ilist
30140 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30141 certificates are revoked. If you have such a list, you can pass it to an Exim
30142 server using the global option called &%tls_crl%& and to an Exim client using
30143 an identically named option for the &(smtp)& transport. In each case, the value
30144 of the option is expanded and must then be the name of a file that contains a
30145 CRL in PEM format.
30146 The downside is that clients have to periodically re-download a potentially huge
30147 file from every certificate authority they know of.
30148
30149 .next
30150 The way with most moving parts at query time is Online Certificate
30151 Status Protocol (OCSP), where the client verifies the certificate
30152 against an OCSP server run by the CA.  This lets the CA track all
30153 usage of the certs.  It requires running software with access to the
30154 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30155 is based on HTTP and can be proxied accordingly.
30156
30157 The only widespread OCSP server implementation (known to this writer)
30158 comes as part of OpenSSL and aborts on an invalid request, such as
30159 connecting to the port and then disconnecting.  This requires
30160 re-entering the passphrase each time some random client does this.
30161
30162 .next
30163 The third way is OCSP Stapling; in this, the server using a certificate
30164 issued by the CA periodically requests an OCSP proof of validity from
30165 the OCSP server, then serves it up inline as part of the TLS
30166 negotiation.   This approach adds no extra round trips, does not let the
30167 CA track users, scales well with number of certs issued by the CA and is
30168 resilient to temporary OCSP server failures, as long as the server
30169 starts retrying to fetch an OCSP proof some time before its current
30170 proof expires.  The downside is that it requires server support.
30171
30172 Unless Exim is built with the support disabled,
30173 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30174 support for OCSP stapling is included.
30175
30176 There is a global option called &%tls_ocsp_file%&.
30177 The file specified therein is expected to be in DER format, and contain
30178 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30179 option will be re-expanded for SNI, if the &%tls_certificate%& option
30180 contains &`tls_in_sni`&, as per other TLS options.
30181
30182 Exim does not at this time implement any support for fetching a new OCSP
30183 proof.  The burden is on the administrator to handle this, outside of
30184 Exim.  The file specified should be replaced atomically, so that the
30185 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30186 on each connection, so a new file will be handled transparently on the
30187 next connection.
30188
30189 When built with OpenSSL Exim will check for a valid next update timestamp
30190 in the OCSP proof; if not present, or if the proof has expired, it will be
30191 ignored.
30192
30193 For the client to be able to verify the stapled OCSP the server must
30194 also supply, in its stapled information, any intermediate
30195 certificates for the chain leading to the OCSP proof from the signer
30196 of the server certificate.  There may be zero or one such. These
30197 intermediate certificates should be added to the server OCSP stapling
30198 file named by &%tls_ocsp_file%&.
30199
30200 Note that the proof only covers the terminal server certificate,
30201 not any of the chain from CA to it.
30202
30203 There is no current way to staple a proof for a client certificate.
30204
30205 .code
30206   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30207   OCSP server is supplied.  The server URL may be included in the
30208   server certificate, if the CA is helpful.
30209
30210   One failure mode seen was the OCSP Signer cert expiring before the end
30211   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30212   noted this as invalid overall, but the re-fetch script did not.
30213 .endd
30214 .endlist
30215
30216
30217 .ecindex IIDencsmtp1
30218 .ecindex IIDencsmtp2
30219
30220
30221 .section "TLS Resumption" "SECTresumption"
30222 .cindex TLS resumption
30223 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30224 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30225 (or later).
30226
30227 Session resumption (this is the "stateless" variant) involves the server sending
30228 a "session ticket" to the client on one connection, which can be stored by the
30229 client and used for a later session.  The ticket contains sufficient state for
30230 the server to reconstruct the TLS session, avoiding some expensive crypto
30231 calculation and (on TLS1.2) one full packet roundtrip time.
30232
30233 .ilist
30234 Operational cost/benefit:
30235
30236  The extra data being transmitted costs a minor amount, and the client has
30237  extra costs in storing and retrieving the data.
30238
30239  In the Exim/Gnutls implementation the extra cost on an initial connection
30240  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30241  The saved cost on a subsequent connection is about 4ms; three or more
30242  connections become a net win.  On longer network paths, two or more
30243  connections will have an average lower startup time thanks to the one
30244  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30245  packet roundtrips.
30246
30247 .cindex "hints database" tls
30248  Since a new hints DB is used on the TLS client,
30249  the hints DB maintenance should be updated to additionally handle "tls".
30250
30251 .next
30252 Security aspects:
30253
30254  The session ticket is encrypted, but is obviously an additional security
30255  vulnarability surface.  An attacker able to decrypt it would have access
30256  all connections using the resumed session.
30257  The session ticket encryption key is not committed to storage by the server
30258  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30259  overlap; GnuTLS 6hr but does not specify any overlap).
30260  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30261  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30262
30263  There is a question-mark over the security of the Diffie-Helman parameters
30264  used for session negotiation.
30265
30266 .next
30267 Observability:
30268
30269  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30270  element.
30271
30272  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30273  have bits 0-4 indicating respectively
30274  support built, client requested ticket, client offered session,
30275  server issued ticket, resume used.  A suitable decode list is provided
30276  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30277
30278 .next
30279 Control:
30280
30281 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30282 exim, operating as a server, will offer resumption to clients.
30283 Current best practice is to not offer the feature to MUA connection.
30284 Commonly this can be done like this:
30285 .code
30286 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30287 .endd
30288 If the peer host matches the list after expansion then resumption
30289 is offered and/or accepted.
30290
30291 The &%tls_resumption_hosts%& smtp transport option performs the
30292 equivalent function for operation as a client.
30293 If the peer host matches the list after expansion then resumption
30294 is attempted (if a stored session is available) or the information
30295 stored (if supplied by the peer).
30296
30297
30298 .next
30299 Issues:
30300
30301  In a resumed session:
30302 .ilist
30303   The variables &$tls_{in,out}_cipher$& will have values different
30304  to the original (under GnuTLS).
30305 .next
30306   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30307  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30308 . XXX need to do something with that hosts_require_ocsp
30309 .endlist
30310
30311 .endlist
30312
30313
30314 .section DANE "SECDANE"
30315 .cindex DANE
30316 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30317 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30318 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30319 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30320 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30321 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30322
30323 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30324 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30325 by (a) is thought to be smaller than that of the set of root CAs.
30326
30327 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30328 fail to pass on a server's STARTTLS.
30329
30330 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30331 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30332 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30333
30334 DANE requires a server operator to do three things:
30335 .olist
30336 Run DNSSEC.  This provides assurance to clients
30337 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30338 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30339 DNSSEC.
30340 .next
30341 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30342 .next
30343 Offer a server certificate, or certificate chain, in TLS connections which is anchored by one of the TLSA records.
30344 .endlist
30345
30346 There are no changes to Exim specific to server-side operation of DANE.
30347 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30348 in &_Local/Makefile_&.
30349 If it has been included, the macro "_HAVE_DANE" will be defined.
30350
30351 .subsection "DNS records"
30352 A TLSA record consist of 4 fields, the "Certificate Usage", the
30353 "Selector", the "Matching type", and the "Certificate Association Data".
30354 For a detailed description of the TLSA record see
30355 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30356
30357 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30358 These are the "Trust Anchor" and "End Entity" variants.
30359 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30360 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30361 this is appropriate for a single system, using a self-signed certificate.
30362 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30363 well-known one.
30364 A private CA at simplest is just a self-signed certificate (with certain
30365 attributes) which is used to sign server certificates, but running one securely
30366 does require careful arrangement.
30367 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30368 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30369 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30370 all of which point to a single TLSA record.
30371 DANE-TA and DANE-EE can both be used together.
30372
30373 Our recommendation is to use DANE with a certificate from a public CA,
30374 because this enables a variety of strategies for remote clients to verify
30375 your certificate.
30376 You can then publish information both via DANE and another technology,
30377 "MTA-STS", described below.
30378
30379 When you use DANE-TA to publish trust anchor information, you ask entities
30380 outside your administrative control to trust the Certificate Authority for
30381 connections to you.
30382 If using a private CA then you should expect others to still apply the
30383 technical criteria they'd use for a public CA to your certificates.
30384 In particular, you should probably try to follow current best practices for CA
30385 operation around hash algorithms and key sizes.
30386 Do not expect other organizations to lower their security expectations just
30387 because a particular profile might be reasonable for your own internal use.
30388
30389 When this text was last updated, this in practice means to avoid use of SHA-1
30390 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30391 than 4096, for interoperability); to use keyUsage fields correctly; to use
30392 random serial numbers.
30393 The list of requirements is subject to change as best practices evolve.
30394 If you're not already using a private CA, or it doesn't meet these
30395 requirements, then we encourage you to avoid all these issues and use a public
30396 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30397
30398 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30399 a "Matching Type" (3rd) field of SHA2-512(2).
30400
30401 For the "Certificate Authority Data" (4th) field, commands like
30402
30403 .code
30404   openssl x509 -pubkey -noout <certificate.pem \
30405   | openssl rsa -outform der -pubin 2>/dev/null \
30406   | openssl sha512 \
30407   | awk '{print $2}'
30408 .endd
30409
30410 are workable to create a hash of the certificate's public key.
30411
30412 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30413
30414 .code
30415   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30416 .endd
30417
30418 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30419 is useful for quickly generating TLSA records.
30420
30421
30422 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30423
30424 The Certificate issued by the CA published in the DANE-TA model should be
30425 issued using a strong hash algorithm.
30426 Exim, and importantly various other MTAs sending to you, will not
30427 re-enable hash algorithms which have been disabled by default in TLS
30428 libraries.
30429 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30430 interoperability (and probably the maximum too, in 2018).
30431
30432 .subsection "Interaction with OCSP"
30433 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30434 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30435 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30436
30437 .code
30438   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30439                                  {= {4}{$tls_out_tlsa_usage}} } \
30440                          {*}{}}
30441 .endd
30442
30443 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30444 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30445 found. If the definition of &%hosts_request_ocsp%& includes the
30446 string "tls_out_tlsa_usage", they are re-expanded in time to
30447 control the OCSP request.
30448
30449 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30450 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30451
30452
30453 .subsection "Client configuration"
30454 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30455 and &%dane_require_tls_ciphers%&.
30456 The &"require"& variant will result in failure if the target host is not
30457 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30458 the &%dnssec_request_domains%& router or transport option.
30459
30460 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30461
30462 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30463 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30464 will be required for the host.  If it does not, the host will not
30465 be used; there is no fallback to non-DANE or non-TLS.
30466
30467 If DANE is requested and usable, then the TLS cipher list configuration
30468 prefers to use the option &%dane_require_tls_ciphers%& and falls
30469 back to &%tls_require_ciphers%& only if that is unset.
30470 This lets you configure "decent crypto" for DANE and "better than nothing
30471 crypto" as the default.  Note though that while GnuTLS lets the string control
30472 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30473 limited to ciphersuite constraints.
30474
30475 If DANE is requested and useable (see above) the following transport options are ignored:
30476 .code
30477   hosts_require_tls
30478   tls_verify_hosts
30479   tls_try_verify_hosts
30480   tls_verify_certificates
30481   tls_crl
30482   tls_verify_cert_hostnames
30483   tls_sni
30484 .endd
30485
30486 If DANE is not usable, whether requested or not, and CA-anchored
30487 verification evaluation is wanted, the above variables should be set appropriately.
30488
30489 The router and transport option &%dnssec_request_domains%& must not be
30490 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30491
30492 .subsection Observability
30493 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30494
30495 There is a new variable &$tls_out_dane$& which will have "yes" if
30496 verification succeeded using DANE and "no" otherwise (only useful
30497 in combination with events; see &<<CHAPevents>>&),
30498 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30499
30500 .cindex DANE reporting
30501 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30502 to achieve DANE-verified connection, if one was either requested and offered, or
30503 required.  This is intended to support TLS-reporting as defined in
30504 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30505 The &$event_data$& will be one of the Result Types defined in
30506 Section 4.3 of that document.
30507
30508 .subsection General
30509 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30510
30511 DANE is specified in published RFCs and decouples certificate authority trust
30512 selection from a "race to the bottom" of "you must trust everything for mail
30513 to get through".
30514 There is an alternative technology called MTA-STS, which
30515 instead publishes MX trust anchor information on an HTTPS website.  At the
30516 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30517 Exim has no support for MTA-STS as a client, but Exim mail server operators
30518 can choose to publish information describing their TLS configuration using
30519 MTA-STS to let those clients who do use that protocol derive trust
30520 information.
30521
30522 The MTA-STS design requires a certificate from a public Certificate Authority
30523 which is recognized by clients sending to you.
30524 That selection of which CAs are trusted by others is outside your control.
30525
30526 The most interoperable course of action is probably to use
30527 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30528 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30529 records for DANE clients (such as Exim and Postfix) and to publish anchor
30530 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30531 domain itself (with caveats around occasionally broken MTA-STS because of
30532 incompatible specification changes prior to reaching RFC status).
30533
30534
30535
30536 . ////////////////////////////////////////////////////////////////////////////
30537 . ////////////////////////////////////////////////////////////////////////////
30538
30539 .chapter "Access control lists" "CHAPACL"
30540 .scindex IIDacl "&ACL;" "description"
30541 .cindex "control of incoming mail"
30542 .cindex "message" "controlling incoming"
30543 .cindex "policy control" "access control lists"
30544 Access Control Lists (ACLs) are defined in a separate section of the runtime
30545 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30546 name, terminated by a colon. Here is a complete ACL section that contains just
30547 one very small ACL:
30548 .code
30549 begin acl
30550 small_acl:
30551   accept   hosts = one.host.only
30552 .endd
30553 You can have as many lists as you like in the ACL section, and the order in
30554 which they appear does not matter. The lists are self-terminating.
30555
30556 The majority of ACLs are used to control Exim's behaviour when it receives
30557 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30558 when a local process submits a message using SMTP by specifying the &%-bs%&
30559 option. The most common use is for controlling which recipients are accepted
30560 in incoming messages. In addition, you can define an ACL that is used to check
30561 local non-SMTP messages. The default configuration file contains an example of
30562 a realistic ACL for checking RCPT commands. This is discussed in chapter
30563 &<<CHAPdefconfil>>&.
30564
30565
30566 .section "Testing ACLs" "SECID188"
30567 The &%-bh%& command line option provides a way of testing your ACL
30568 configuration locally by running a fake SMTP session with which you interact.
30569
30570
30571 .section "Specifying when ACLs are used" "SECID189"
30572 .cindex "&ACL;" "options for specifying"
30573 In order to cause an ACL to be used, you have to name it in one of the relevant
30574 options in the main part of the configuration. These options are:
30575 .cindex "AUTH" "ACL for"
30576 .cindex "DATA" "ACLs for"
30577 .cindex "ETRN" "ACL for"
30578 .cindex "EXPN" "ACL for"
30579 .cindex "HELO" "ACL for"
30580 .cindex "EHLO" "ACL for"
30581 .cindex "DKIM" "ACL for"
30582 .cindex "MAIL" "ACL for"
30583 .cindex "QUIT, ACL for"
30584 .cindex "RCPT" "ACL for"
30585 .cindex "STARTTLS, ACL for"
30586 .cindex "VRFY" "ACL for"
30587 .cindex "SMTP" "connection, ACL for"
30588 .cindex "non-SMTP messages" "ACLs for"
30589 .cindex "MIME content scanning" "ACL for"
30590 .cindex "PRDR" "ACL for"
30591
30592 .table2 140pt
30593 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30594 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30595 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30596 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30597 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30598 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30599 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30600 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30601 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30602 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30603 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30604 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30605 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30606 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30607 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30608 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30609 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30610 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30611 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30612 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30613 .endtable
30614
30615 For example, if you set
30616 .code
30617 acl_smtp_rcpt = small_acl
30618 .endd
30619 the little ACL defined above is used whenever Exim receives a RCPT command
30620 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30621 done when RCPT commands arrive. A rejection of RCPT should cause the
30622 sending MTA to give up on the recipient address contained in the RCPT
30623 command, whereas rejection at other times may cause the client MTA to keep on
30624 trying to deliver the message. It is therefore recommended that you do as much
30625 testing as possible at RCPT time.
30626
30627
30628 .subsection "The non-SMTP ACLs" SECID190
30629 .cindex "non-SMTP messages" "ACLs for"
30630 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30631 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30632 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30633 the state of the SMTP connection such as encryption and authentication) are not
30634 relevant and are forbidden in these ACLs. However, the sender and recipients
30635 are known, so the &%senders%& and &%sender_domains%& conditions and the
30636 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30637 &$authenticated_sender$& are also available. You can specify added header lines
30638 in any of these ACLs.
30639
30640 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30641 non-SMTP message, before any of the message has been read. (This is the
30642 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30643 batched SMTP input, it runs after the DATA command has been reached. The
30644 result of this ACL is ignored; it cannot be used to reject a message. If you
30645 really need to, you could set a value in an ACL variable here and reject based
30646 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30647 controls, and in particular, it can be used to set
30648 .code
30649 control = suppress_local_fixups
30650 .endd
30651 This cannot be used in the other non-SMTP ACLs because by the time they are
30652 run, it is too late.
30653
30654 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30655 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30656
30657 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30658 kind of rejection is treated as permanent, because there is no way of sending a
30659 temporary error for these kinds of message.
30660
30661
30662 .subsection "The SMTP connect ACL" SECID191
30663 .cindex "SMTP" "connection, ACL for"
30664 .oindex &%smtp_banner%&
30665 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30666 session, after the test specified by &%host_reject_connection%& (which is now
30667 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30668 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30669 the message override the banner message that is otherwise specified by the
30670 &%smtp_banner%& option.
30671
30672 .new
30673 For tls-on-connect connections, the ACL is run before the TLS connection
30674 is accepted; if the ACL does not accept then the TCP connection is dropped without
30675 any TLS startup attempt and without any SMTP response being transmitted.
30676 .wen
30677
30678
30679 .subsection "The EHLO/HELO ACL" SECID192
30680 .cindex "EHLO" "ACL for"
30681 .cindex "HELO" "ACL for"
30682 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30683 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30684 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30685 Note that a client may issue more than one EHLO or HELO command in an SMTP
30686 session, and indeed is required to issue a new EHLO or HELO after successfully
30687 setting up encryption following a STARTTLS command.
30688
30689 Note also that a deny neither forces the client to go away nor means that
30690 mail will be refused on the connection.  Consider checking for
30691 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30692
30693 If the command is accepted by an &%accept%& verb that has a &%message%&
30694 modifier, the message may not contain more than one line (it will be truncated
30695 at the first newline and a panic logged if it does). Such a message cannot
30696 affect the EHLO options that are listed on the second and subsequent lines of
30697 an EHLO response.
30698
30699
30700 .subsection "The DATA ACLs" SECID193
30701 .cindex "DATA" "ACLs for"
30702 Two ACLs are associated with the DATA command, because it is two-stage
30703 command, with two responses being sent to the client.
30704 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30705 is obeyed. This gives you control after all the RCPT commands, but before
30706 the message itself is received. It offers the opportunity to give a negative
30707 response to the DATA command before the data is transmitted. Header lines
30708 added by MAIL or RCPT ACLs are not visible at this time, but any that
30709 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30710
30711 You cannot test the contents of the message, for example, to verify addresses
30712 in the headers, at RCPT time or when the DATA command is received. Such
30713 tests have to appear in the ACL that is run after the message itself has been
30714 received, before the final response to the DATA command is sent. This is
30715 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30716 associated with the DATA command.
30717
30718 .cindex CHUNKING "BDAT command"
30719 .cindex BDAT "SMTP command"
30720 .cindex "RFC 3030" CHUNKING
30721 If CHUNKING was advertised and a BDAT command sequence is received,
30722 the &%acl_smtp_predata%& ACL is not run.
30723 . XXX why not?  It should be possible, for the first BDAT.
30724 The &%acl_smtp_data%& is run after the last BDAT command and all of
30725 the data specified is received.
30726
30727 For both of these ACLs, it is not possible to reject individual recipients. An
30728 error response rejects the entire message. Unfortunately, it is known that some
30729 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30730 before or after the data) correctly &-- they keep the message on their queues
30731 and try again later, but that is their problem, though it does waste some of
30732 your resources.
30733
30734 The &%acl_smtp_data%& ACL is run after
30735 the &%acl_smtp_data_prdr%&,
30736 the &%acl_smtp_dkim%&
30737 and the &%acl_smtp_mime%& ACLs.
30738
30739 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30740 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30741 enabled (which is the default).
30742
30743 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30744 received, and is executed for each DKIM signature found in a message.  If not
30745 otherwise specified, the default action is to accept.
30746
30747 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30748
30749 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30750
30751
30752 .subsection "The SMTP MIME ACL" SECID194
30753 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30754 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30755
30756 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30757
30758
30759 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30760 .cindex "PRDR" "ACL for"
30761 .oindex "&%prdr_enable%&"
30762 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30763 with PRDR support enabled (which is the default).
30764 It becomes active only when the PRDR feature is negotiated between
30765 client and server for a message, and more than one recipient
30766 has been accepted.
30767
30768 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30769 has been received, and is executed once for each recipient of the message
30770 with &$local_part$& and &$domain$& valid.
30771 The test may accept, defer or deny for individual recipients.
30772 The &%acl_smtp_data%& will still be called after this ACL and
30773 can reject the message overall, even if this ACL has accepted it
30774 for some or all recipients.
30775
30776 PRDR may be used to support per-user content filtering.  Without it
30777 one must defer any recipient after the first that has a different
30778 content-filter configuration.  With PRDR, the RCPT-time check
30779 .cindex "PRDR" "variable for"
30780 for this can be disabled when the variable &$prdr_requested$&
30781 is &"yes"&.
30782 Any required difference in behaviour of the main DATA-time
30783 ACL should however depend on the PRDR-time ACL having run, as Exim
30784 will avoid doing so in some situations (e.g. single-recipient mails).
30785
30786 See also the &%prdr_enable%& global option
30787 and the &%hosts_try_prdr%& smtp transport option.
30788
30789 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30790 If the ACL is not defined, processing completes as if
30791 the feature was not requested by the client.
30792
30793 .subsection "The QUIT ACL" SECTQUITACL
30794 .cindex "QUIT, ACL for"
30795 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30796 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30797 does not in fact control any access.
30798 For this reason, it may only accept
30799 or warn as its final result.
30800
30801 This ACL can be used for tasks such as custom logging at the end of an SMTP
30802 session. For example, you can use ACL variables in other ACLs to count
30803 messages, recipients, etc., and log the totals at QUIT time using one or
30804 more &%logwrite%& modifiers on a &%warn%& verb.
30805
30806 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30807 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30808
30809 You do not need to have a final &%accept%&, but if you do, you can use a
30810 &%message%& modifier to specify custom text that is sent as part of the 221
30811 response to QUIT.
30812
30813 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30814 failure (for example, failure to open a log file, or when Exim is bombing out
30815 because it has detected an unrecoverable error), all SMTP commands from the
30816 client are given temporary error responses until QUIT is received or the
30817 connection is closed. In these special cases, the QUIT ACL does not run.
30818
30819
30820 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30821 .vindex &$acl_smtp_notquit$&
30822 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30823 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30824 trouble, such as being unable to write to its log files, this ACL is not run,
30825 because it might try to do things (such as write to log files) that make the
30826 situation even worse.
30827
30828 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30829 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30830 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30831 and &%warn%&.
30832
30833 .vindex &$smtp_notquit_reason$&
30834 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30835 to a string that indicates the reason for the termination of the SMTP
30836 connection. The possible values are:
30837 .table2
30838 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30839 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30840 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30841 .irow &`connection-lost`&          "The SMTP connection has been lost"
30842 .irow &`data-timeout`&             "Timeout while reading message data"
30843 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30844 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30845 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30846 .irow &`synchronization-error`&    "SMTP synchronization error"
30847 .irow &`tls-failed`&               "TLS failed to start"
30848 .endtable
30849 In most cases when an SMTP connection is closed without having received QUIT,
30850 Exim sends an SMTP response message before actually closing the connection.
30851 With the exception of the &`acl-drop`& case, the default message can be
30852 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30853 &%drop%& verb in another ACL, it is the message from the other ACL that is
30854 used.
30855
30856
30857 .section "Finding an ACL to use" "SECID195"
30858 .cindex "&ACL;" "finding which to use"
30859 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30860 you can use different ACLs in different circumstances. For example,
30861 .code
30862 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30863                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30864 .endd
30865 In the default configuration file there are some example settings for
30866 providing an RFC 4409 message &"submission"& service on port 587 and
30867 an RFC 8314 &"submissions"& service on port 465. You can use a string
30868 expansion like this to choose an ACL for MUAs on these ports which is
30869 more appropriate for this purpose than the default ACL on port 25.
30870
30871 The expanded string does not have to be the name of an ACL in the
30872 configuration file; there are other possibilities. Having expanded the
30873 string, Exim searches for an ACL as follows:
30874
30875 .ilist
30876 If the string begins with a slash, Exim uses it as a filename, and reads its
30877 contents as an ACL. The lines are processed in the same way as lines in the
30878 Exim configuration file. In particular, continuation lines are supported, blank
30879 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30880 If the file does not exist or cannot be read, an error occurs (typically
30881 causing a temporary failure of whatever caused the ACL to be run). For example:
30882 .code
30883 acl_smtp_data = /etc/acls/\
30884   ${lookup{$sender_host_address}lsearch\
30885   {/etc/acllist}{$value}{default}}
30886 .endd
30887 This looks up an ACL file to use on the basis of the host's IP address, falling
30888 back to a default if the lookup fails. If an ACL is successfully read from a
30889 file, it is retained in memory for the duration of the Exim process, so that it
30890 can be re-used without having to re-read the file.
30891 .next
30892 If the string does not start with a slash, and does not contain any spaces,
30893 Exim searches the ACL section of the configuration for an ACL whose name
30894 matches the string.
30895 .next
30896 If no named ACL is found, or if the string contains spaces, Exim parses
30897 the string as an inline ACL. This can save typing in cases where you just
30898 want to have something like
30899 .code
30900 acl_smtp_vrfy = accept
30901 .endd
30902 in order to allow free use of the VRFY command. Such a string may contain
30903 newlines; it is processed in the same way as an ACL that is read from a file.
30904 .endlist
30905
30906
30907
30908
30909 .section "ACL return codes" "SECID196"
30910 .cindex "&ACL;" "return codes"
30911 Except for the QUIT ACL, which does not affect the SMTP return code (see
30912 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30913 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30914 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30915 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30916 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30917 This also causes a 4&'xx'& return code.
30918
30919 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30920 &"deny"&, because there is no mechanism for passing temporary errors to the
30921 submitters of non-SMTP messages.
30922
30923
30924 ACLs that are relevant to message reception may also return &"discard"&. This
30925 has the effect of &"accept"&, but causes either the entire message or an
30926 individual recipient address to be discarded. In other words, it is a
30927 blackholing facility. Use it with care.
30928
30929 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30930 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30931 RCPT ACL is to discard just the one recipient address. If there are no
30932 recipients left when the message's data is received, the DATA ACL is not
30933 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30934 remaining recipients. The &"discard"& return is not permitted for the
30935 &%acl_smtp_predata%& ACL.
30936
30937 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30938 is done on the address and the result determines the SMTP response.
30939
30940
30941 .cindex "&[local_scan()]& function" "when all recipients discarded"
30942 The &[local_scan()]& function is always run, even if there are no remaining
30943 recipients; it may create new recipients.
30944
30945
30946
30947 .section "Unset ACL options" "SECID197"
30948 .cindex "&ACL;" "unset options"
30949 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30950 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30951 not defined at all. For any defined ACL, the default action when control
30952 reaches the end of the ACL statements is &"deny"&.
30953
30954 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30955 these two are ACLs that are used only for their side effects. They cannot be
30956 used to accept or reject anything.
30957
30958 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30959 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30960 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30961 when the ACL is not defined is &"accept"&.
30962
30963 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30964 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30965 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30966 messages over an SMTP connection. For an example, see the ACL in the default
30967 configuration file.
30968
30969
30970
30971
30972 .section "Data for message ACLs" "SECID198"
30973 .cindex "&ACL;" "data for message ACL"
30974 .vindex &$domain$&
30975 .vindex &$local_part$&
30976 .vindex &$sender_address$&
30977 .vindex &$sender_host_address$&
30978 .vindex &$smtp_command$&
30979 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30980 that contain information about the host and the message's sender (for example,
30981 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30982 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30983 &$local_part$& are set from the argument address. The entire SMTP command
30984 is available in &$smtp_command$&.
30985
30986 When an ACL for the AUTH parameter of MAIL is running, the variables that
30987 contain information about the host are set, but &$sender_address$& is not yet
30988 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30989 how it is used.
30990
30991 .vindex "&$message_size$&"
30992 The &$message_size$& variable is set to the value of the SIZE parameter on
30993 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30994 that parameter is not given. The value is updated to the true message size by
30995 the time the final DATA ACL is run (after the message data has been
30996 received).
30997
30998 .vindex "&$rcpt_count$&"
30999 .vindex "&$recipients_count$&"
31000 The &$rcpt_count$& variable increases by one for each RCPT command received.
31001 The &$recipients_count$& variable increases by one each time a RCPT command is
31002 accepted, so while an ACL for RCPT is being processed, it contains the number
31003 of previously accepted recipients. At DATA time (for both the DATA ACLs),
31004 &$rcpt_count$& contains the total number of RCPT commands, and
31005 &$recipients_count$& contains the total number of accepted recipients.
31006
31007
31008
31009
31010
31011 .section "Data for non-message ACLs" "SECTdatfornon"
31012 .cindex "&ACL;" "data for non-message ACL"
31013 .vindex &$smtp_command_argument$&
31014 .vindex &$smtp_command$&
31015 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
31016 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
31017 and the entire SMTP command is available in &$smtp_command$&.
31018 These variables can be tested using a &%condition%& condition. For example,
31019 here is an ACL for use with AUTH, which insists that either the session is
31020 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
31021 does not permit authentication methods that use cleartext passwords on
31022 unencrypted connections.
31023 .code
31024 acl_check_auth:
31025   accept encrypted = *
31026   accept condition = ${if eq{${uc:$smtp_command_argument}}\
31027                      {CRAM-MD5}}
31028   deny   message   = TLS encryption or CRAM-MD5 required
31029 .endd
31030 (Another way of applying this restriction is to arrange for the authenticators
31031 that use cleartext passwords not to be advertised when the connection is not
31032 encrypted. You can use the generic &%server_advertise_condition%& authenticator
31033 option to do this.)
31034
31035
31036
31037 .section "Format of an ACL" "SECID199"
31038 .cindex "&ACL;" "format of"
31039 .cindex "&ACL;" "verbs, definition of"
31040 An individual ACL consists of a number of statements. Each statement starts
31041 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31042 Modifiers can change the way the verb operates, define error and log messages,
31043 set variables, insert delays, and vary the processing of accepted messages.
31044
31045 If all the conditions are met, the verb is obeyed. The same condition may be
31046 used (with different arguments) more than once in the same statement. This
31047 provides a means of specifying an &"and"& conjunction between conditions. For
31048 example:
31049 .code
31050 deny  dnslists = list1.example
31051       dnslists = list2.example
31052 .endd
31053 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31054 the conditions and modifiers when it reaches a condition that fails. What
31055 happens then depends on the verb (and in one case, on a special modifier). Not
31056 all the conditions make sense at every testing point. For example, you cannot
31057 test a sender address in the ACL that is run for a VRFY command.
31058
31059
31060 .section "ACL verbs" "SECID200"
31061 The ACL verbs are as follows:
31062
31063 .ilist
31064 .cindex "&%accept%& ACL verb"
31065 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31066 of the conditions are not met, what happens depends on whether &%endpass%&
31067 appears among the conditions (for syntax see below). If the failing condition
31068 is before &%endpass%&, control is passed to the next ACL statement; if it is
31069 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31070 check a RCPT command:
31071 .code
31072 accept domains = +local_domains
31073        endpass
31074        verify = recipient
31075 .endd
31076 If the recipient domain does not match the &%domains%& condition, control
31077 passes to the next statement. If it does match, the recipient is verified, and
31078 the command is accepted if verification succeeds. However, if verification
31079 fails, the ACL yields &"deny"&, because the failing condition is after
31080 &%endpass%&.
31081
31082 The &%endpass%& feature has turned out to be confusing to many people, so its
31083 use is not recommended nowadays. It is always possible to rewrite an ACL so
31084 that &%endpass%& is not needed, and it is no longer used in the default
31085 configuration.
31086
31087 .cindex "&%message%& ACL modifier" "with &%accept%&"
31088 If a &%message%& modifier appears on an &%accept%& statement, its action
31089 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31090 (when an &%accept%& verb either accepts or passes control to the next
31091 statement), &%message%& can be used to vary the message that is sent when an
31092 SMTP command is accepted. For example, in a RCPT ACL you could have:
31093 .display
31094 &`accept  `&<&'some conditions'&>
31095 &`        message = OK, I will allow you through today`&
31096 .endd
31097 You can specify an SMTP response code, optionally followed by an &"extended
31098 response code"& at the start of the message, but the first digit must be the
31099 same as would be sent by default, which is 2 for an &%accept%& verb.
31100
31101 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31102 an error message that is used when access is denied. This behaviour is retained
31103 for backward compatibility, but current &"best practice"& is to avoid the use
31104 of &%endpass%&.
31105
31106
31107 .next
31108 .cindex "&%defer%& ACL verb"
31109 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31110 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31111 &%defer%& is the same as &%deny%&, because there is no way of sending a
31112 temporary error. For a RCPT command, &%defer%& is much the same as using a
31113 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31114 be used in any ACL, and even for a recipient it might be a simpler approach.
31115
31116
31117 .next
31118 .cindex "&%deny%& ACL verb"
31119 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31120 the conditions are not met, control is passed to the next ACL statement. For
31121 example,
31122 .code
31123 deny dnslists = blackholes.mail-abuse.org
31124 .endd
31125 rejects commands from hosts that are on a DNS black list.
31126
31127
31128 .next
31129 .cindex "&%discard%& ACL verb"
31130 &%discard%&: This verb behaves like &%accept%&, except that it returns
31131 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31132 that are concerned with receiving messages. When all the conditions are true,
31133 the sending entity receives a &"success"& response. However, &%discard%& causes
31134 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31135 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31136 message's recipients are discarded. Recipients that are discarded before DATA
31137 do not appear in the log line when the &%received_recipients%& log selector is set.
31138
31139 If the &%log_message%& modifier is set when &%discard%& operates,
31140 its contents are added to the line that is automatically written to the log.
31141 The &%message%& modifier operates exactly as it does for &%accept%&.
31142
31143
31144 .next
31145 .cindex "&%drop%& ACL verb"
31146 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31147 forcibly closed after the 5&'xx'& error message has been sent. For example:
31148 .code
31149 drop   condition = ${if > {$rcpt_count}{20}}
31150        message   = I don't take more than 20 RCPTs
31151 .endd
31152 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31153 The connection is always dropped after sending a 550 response.
31154
31155 .next
31156 .cindex "&%require%& ACL verb"
31157 &%require%&: If all the conditions are met, control is passed to the next ACL
31158 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31159 example, when checking a RCPT command,
31160 .code
31161 require message = Sender did not verify
31162         verify  = sender
31163 .endd
31164 passes control to subsequent statements only if the message's sender can be
31165 verified. Otherwise, it rejects the command. Note the positioning of the
31166 &%message%& modifier, before the &%verify%& condition. The reason for this is
31167 discussed in section &<<SECTcondmodproc>>&.
31168
31169 .next
31170 .cindex "&%warn%& ACL verb"
31171 &%warn%&: If all the conditions are true, a line specified by the
31172 &%log_message%& modifier is written to Exim's main log. Control always passes
31173 to the next ACL statement. If any condition is false, the log line is not
31174 written. If an identical log line is requested several times in the same
31175 message, only one copy is actually written to the log. If you want to force
31176 duplicates to be written, use the &%logwrite%& modifier instead.
31177
31178 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31179 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31180 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31181 first failing condition. There is more about adding header lines in section
31182 &<<SECTaddheadacl>>&.
31183
31184 If any condition on a &%warn%& statement cannot be completed (that is, there is
31185 some sort of defer), the log line specified by &%log_message%& is not written.
31186 This does not include the case of a forced failure from a lookup, which
31187 is considered to be a successful completion. After a defer, no further
31188 conditions or modifiers in the &%warn%& statement are processed. The incident
31189 is logged, and the ACL continues to be processed, from the next statement
31190 onwards.
31191
31192
31193 .vindex "&$acl_verify_message$&"
31194 When one of the &%warn%& conditions is an address verification that fails, the
31195 text of the verification failure message is in &$acl_verify_message$&. If you
31196 want this logged, you must set it up explicitly. For example:
31197 .code
31198 warn   !verify = sender
31199        log_message = sender verify failed: $acl_verify_message
31200 .endd
31201 .endlist
31202
31203 At the end of each ACL there is an implicit unconditional &%deny%&.
31204
31205 As you can see from the examples above, the conditions and modifiers are
31206 written one to a line, with the first one on the same line as the verb, and
31207 subsequent ones on following lines. If you have a very long condition, you can
31208 continue it onto several physical lines by the usual backslash continuation
31209 mechanism. It is conventional to align the conditions vertically.
31210
31211
31212
31213 .section "ACL variables" "SECTaclvariables"
31214 .cindex "&ACL;" "variables"
31215 There are some special variables that can be set during ACL processing. They
31216 can be used to pass information between different ACLs, different invocations
31217 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31218 transports, and filters that are used to deliver a message. The names of these
31219 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31220 an underscore, but the remainder of the name can be any sequence of
31221 alphanumeric characters and underscores that you choose. There is no limit on
31222 the number of ACL variables. The two sets act as follows:
31223 .ilist
31224 The values of those variables whose names begin with &$acl_c$& persist
31225 throughout an SMTP connection. They are never reset. Thus, a value that is set
31226 while receiving one message is still available when receiving the next message
31227 on the same SMTP connection.
31228 .next
31229 The values of those variables whose names begin with &$acl_m$& persist only
31230 while a message is being received. They are reset afterwards. They are also
31231 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31232 .endlist
31233
31234 When a message is accepted, the current values of all the ACL variables are
31235 preserved with the message and are subsequently made available at delivery
31236 time. The ACL variables are set by a modifier called &%set%&. For example:
31237 .code
31238 accept hosts = whatever
31239        set acl_m4 = some value
31240 accept authenticated = *
31241        set acl_c_auth = yes
31242 .endd
31243 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31244 be set. If you want to set a variable without taking any action, you can use a
31245 &%warn%& verb without any other modifiers or conditions.
31246
31247 .oindex &%strict_acl_vars%&
31248 What happens if a syntactically valid but undefined ACL variable is
31249 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31250 false (the default), an empty string is substituted; if it is true, an
31251 error is generated.
31252
31253 Versions of Exim before 4.64 have a limited set of numbered variables, but
31254 their names are compatible, so there is no problem with upgrading.
31255
31256
31257 .section "Condition and modifier processing" "SECTcondmodproc"
31258 .cindex "&ACL;" "conditions; processing"
31259 .cindex "&ACL;" "modifiers; processing"
31260 An exclamation mark preceding a condition negates its result. For example:
31261 .code
31262 deny   domains = *.dom.example
31263       !verify  = recipient
31264 .endd
31265 causes the ACL to return &"deny"& if the recipient domain ends in
31266 &'dom.example'& and the recipient address cannot be verified. Sometimes
31267 negation can be used on the right-hand side of a condition. For example, these
31268 two statements are equivalent:
31269 .code
31270 deny  hosts = !192.168.3.4
31271 deny !hosts =  192.168.3.4
31272 .endd
31273 However, for many conditions (&%verify%& being a good example), only left-hand
31274 side negation of the whole condition is possible.
31275
31276 The arguments of conditions and modifiers are expanded. A forced failure
31277 of an expansion causes a condition to be ignored, that is, it behaves as if the
31278 condition is true. Consider these two statements:
31279 .code
31280 accept  senders = ${lookup{$host_name}lsearch\
31281                   {/some/file}{$value}fail}
31282 accept  senders = ${lookup{$host_name}lsearch\
31283                   {/some/file}{$value}{}}
31284 .endd
31285 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31286 the returned list is searched, but if the lookup fails the behaviour is
31287 different in the two cases. The &%fail%& in the first statement causes the
31288 condition to be ignored, leaving no further conditions. The &%accept%& verb
31289 therefore succeeds. The second statement, however, generates an empty list when
31290 the lookup fails. No sender can match an empty list, so the condition fails,
31291 and therefore the &%accept%& also fails.
31292
31293 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31294 specify actions that are taken as the conditions for a statement are checked;
31295 others specify text for messages that are used when access is denied or a
31296 warning is generated. The &%control%& modifier affects the way an incoming
31297 message is handled.
31298
31299 The positioning of the modifiers in an ACL statement is important, because the
31300 processing of a verb ceases as soon as its outcome is known. Only those
31301 modifiers that have already been encountered will take effect. For example,
31302 consider this use of the &%message%& modifier:
31303 .code
31304 require message = Can't verify sender
31305         verify  = sender
31306         message = Can't verify recipient
31307         verify  = recipient
31308         message = This message cannot be used
31309 .endd
31310 If sender verification fails, Exim knows that the result of the statement is
31311 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31312 so its text is used as the error message. If sender verification succeeds, but
31313 recipient verification fails, the second message is used. If recipient
31314 verification succeeds, the third message becomes &"current"&, but is never used
31315 because there are no more conditions to cause failure.
31316
31317 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31318 modifier that is used, because all the conditions must be true for rejection to
31319 happen. Specifying more than one &%message%& modifier does not make sense, and
31320 the message can even be specified after all the conditions. For example:
31321 .code
31322 deny   hosts = ...
31323       !senders = *@my.domain.example
31324        message = Invalid sender from client host
31325 .endd
31326 The &"deny"& result does not happen until the end of the statement is reached,
31327 by which time Exim has set up the message.
31328
31329
31330
31331 .section "ACL modifiers" "SECTACLmodi"
31332 .cindex "&ACL;" "modifiers; list of"
31333 The ACL modifiers are as follows:
31334
31335 .vlist
31336 .vitem &*add_header*&&~=&~<&'text'&>
31337 This modifier specifies one or more header lines that are to be added to an
31338 incoming message, assuming, of course, that the message is ultimately
31339 accepted. For details, see section &<<SECTaddheadacl>>&.
31340
31341 .vitem &*continue*&&~=&~<&'text'&>
31342 .cindex "&%continue%& ACL modifier"
31343 .cindex "database" "updating in ACL"
31344 This modifier does nothing of itself, and processing of the ACL always
31345 continues with the next condition or modifier. The value of &%continue%& is in
31346 the side effects of expanding its argument. Typically this could be used to
31347 update a database. It is really just a syntactic tidiness, to avoid having to
31348 write rather ugly lines like this:
31349 .display
31350 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31351 .endd
31352 Instead, all you need is
31353 .display
31354 &`continue = `&<&'some expansion'&>
31355 .endd
31356
31357 .vitem &*control*&&~=&~<&'text'&>
31358 .cindex "&%control%& ACL modifier"
31359 This modifier affects the subsequent processing of the SMTP connection or of an
31360 incoming message that is accepted. The effect of the first type of control
31361 lasts for the duration of the connection, whereas the effect of the second type
31362 lasts only until the current message has been received. The message-specific
31363 controls always apply to the whole message, not to individual recipients,
31364 even if the &%control%& modifier appears in a RCPT ACL.
31365
31366 As there are now quite a few controls that can be applied, they are described
31367 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31368 in several different ways. For example:
31369
31370 . ==== As this is a nested list, any displays it contains must be indented
31371 . ==== as otherwise they are too far to the left. That comment applies only
31372 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31373 . ==== way.
31374
31375 .ilist
31376 It can be at the end of an &%accept%& statement:
31377 .code
31378     accept  ...some conditions
31379             control = queue
31380 .endd
31381 In this case, the control is applied when this statement yields &"accept"&, in
31382 other words, when the conditions are all true.
31383
31384 .next
31385 It can be in the middle of an &%accept%& statement:
31386 .code
31387     accept  ...some conditions...
31388             control = queue
31389             ...some more conditions...
31390 .endd
31391 If the first set of conditions are true, the control is applied, even if the
31392 statement does not accept because one of the second set of conditions is false.
31393 In this case, some subsequent statement must yield &"accept"& for the control
31394 to be relevant.
31395
31396 .next
31397 It can be used with &%warn%& to apply the control, leaving the
31398 decision about accepting or denying to a subsequent verb. For
31399 example:
31400 .code
31401     warn    ...some conditions...
31402             control = freeze
31403     accept  ...
31404 .endd
31405 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31406 &%logwrite%&, so it does not add anything to the message and does not write a
31407 log entry.
31408
31409 .next
31410 If you want to apply a control unconditionally, you can use it with a
31411 &%require%& verb. For example:
31412 .code
31413     require  control = no_multiline_responses
31414 .endd
31415 .endlist
31416
31417 .vitem &*delay*&&~=&~<&'time'&>
31418 .cindex "&%delay%& ACL modifier"
31419 .oindex "&%-bh%&"
31420 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31421 the time interval before proceeding. However, when testing Exim using the
31422 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31423 output instead). The time is given in the usual Exim notation, and the delay
31424 happens as soon as the modifier is processed. In an SMTP session, pending
31425 output is flushed before the delay is imposed.
31426
31427 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31428 example:
31429 .code
31430 deny    ...some conditions...
31431         delay = 30s
31432 .endd
31433 The delay happens if all the conditions are true, before the statement returns
31434 &"deny"&. Compare this with:
31435 .code
31436 deny    delay = 30s
31437         ...some conditions...
31438 .endd
31439 which waits for 30s before processing the conditions. The &%delay%& modifier
31440 can also be used with &%warn%& and together with &%control%&:
31441 .code
31442 warn    ...some conditions...
31443         delay = 2m
31444         control = freeze
31445 accept  ...
31446 .endd
31447
31448 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31449 responses to several commands are no longer buffered and sent in one packet (as
31450 they would normally be) because all output is flushed before imposing the
31451 delay. This optimization is disabled so that a number of small delays do not
31452 appear to the client as one large aggregated delay that might provoke an
31453 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31454 using a &%control%& modifier to set &%no_delay_flush%&.
31455
31456
31457 .vitem &*endpass*&
31458 .cindex "&%endpass%& ACL modifier"
31459 This modifier, which has no argument, is recognized only in &%accept%& and
31460 &%discard%& statements. It marks the boundary between the conditions whose
31461 failure causes control to pass to the next statement, and the conditions whose
31462 failure causes the ACL to return &"deny"&. This concept has proved to be
31463 confusing to some people, so the use of &%endpass%& is no longer recommended as
31464 &"best practice"&. See the description of &%accept%& above for more details.
31465
31466
31467 .vitem &*log_message*&&~=&~<&'text'&>
31468 .cindex "&%log_message%& ACL modifier"
31469 This modifier sets up a message that is used as part of the log message if the
31470 ACL denies access or a &%warn%& statement's conditions are true. For example:
31471 .code
31472 require log_message = wrong cipher suite $tls_in_cipher
31473         encrypted   = DES-CBC3-SHA
31474 .endd
31475 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31476 example:
31477 .display
31478 &`discard `&<&'some conditions'&>
31479 &`        log_message = Discarded $local_part@$domain because...`&
31480 .endd
31481 When access is denied, &%log_message%& adds to any underlying error message
31482 that may exist because of a condition failure. For example, while verifying a
31483 recipient address, a &':fail:'& redirection might have already set up a
31484 message.
31485
31486 The message may be defined before the conditions to which it applies, because
31487 the string expansion does not happen until Exim decides that access is to be
31488 denied. This means that any variables that are set by the condition are
31489 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31490 variables are set after a DNS black list lookup succeeds. If the expansion of
31491 &%log_message%& fails, or if the result is an empty string, the modifier is
31492 ignored.
31493
31494 .vindex "&$acl_verify_message$&"
31495 If you want to use a &%warn%& statement to log the result of an address
31496 verification, you can use &$acl_verify_message$& to include the verification
31497 error message.
31498
31499 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31500 the start of the logged message. If the same warning log message is requested
31501 more than once while receiving  a single email message, only one copy is
31502 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31503 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31504 is logged for a successful &%warn%& statement.
31505
31506 If &%log_message%& is not present and there is no underlying error message (for
31507 example, from the failure of address verification), but &%message%& is present,
31508 the &%message%& text is used for logging rejections. However, if any text for
31509 logging contains newlines, only the first line is logged. In the absence of
31510 both &%log_message%& and &%message%&, a default built-in message is used for
31511 logging rejections.
31512
31513
31514 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31515 .cindex "&%log_reject_target%& ACL modifier"
31516 .cindex "logging in ACL" "specifying which log"
31517 This modifier makes it possible to specify which logs are used for messages
31518 about ACL rejections. Its argument is a colon-separated list of words that can
31519 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31520 may be empty, in which case a rejection is not logged at all. For example, this
31521 ACL fragment writes no logging information when access is denied:
31522 .display
31523 &`deny `&<&'some conditions'&>
31524 &`     log_reject_target =`&
31525 .endd
31526 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31527 permanent and temporary rejections. Its effect lasts for the rest of the
31528 current ACL.
31529
31530
31531 .vitem &*logwrite*&&~=&~<&'text'&>
31532 .cindex "&%logwrite%& ACL modifier"
31533 .cindex "logging in ACL" "immediate"
31534 This modifier writes a message to a log file as soon as it is encountered when
31535 processing an ACL. (Compare &%log_message%&, which, except in the case of
31536 &%warn%& and &%discard%&, is used only if the ACL statement denies
31537 access.) The &%logwrite%& modifier can be used to log special incidents in
31538 ACLs. For example:
31539 .display
31540 &`accept `&<&'some special conditions'&>
31541 &`       control  = freeze`&
31542 &`       logwrite = froze message because ...`&
31543 .endd
31544 By default, the message is written to the main log. However, it may begin
31545 with a colon, followed by a comma-separated list of log names, and then
31546 another colon, to specify exactly which logs are to be written. For
31547 example:
31548 .code
31549 logwrite = :main,reject: text for main and reject logs
31550 logwrite = :panic: text for panic log only
31551 .endd
31552
31553
31554 .vitem &*message*&&~=&~<&'text'&>
31555 .cindex "&%message%& ACL modifier"
31556 This modifier sets up a text string that is expanded and used as a response
31557 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31558 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31559 there is some complication if &%endpass%& is involved; see the description of
31560 &%accept%& for details.)
31561
31562 The expansion of the message happens at the time Exim decides that the ACL is
31563 to end, not at the time it processes &%message%&. If the expansion fails, or
31564 generates an empty string, the modifier is ignored. Here is an example where
31565 &%message%& must be specified first, because the ACL ends with a rejection if
31566 the &%hosts%& condition fails:
31567 .code
31568 require  message = Host not recognized
31569          hosts = 10.0.0.0/8
31570 .endd
31571 (Once a condition has failed, no further conditions or modifiers are
31572 processed.)
31573
31574 .cindex "SMTP" "error codes"
31575 .oindex "&%smtp_banner%&
31576 For ACLs that are triggered by SMTP commands, the message is returned as part
31577 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31578 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31579 is accepted. In the case of the connect ACL, accepting with a message modifier
31580 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31581 accept message may not contain more than one line (otherwise it will be
31582 truncated at the first newline and a panic logged), and it cannot affect the
31583 EHLO options.
31584
31585 When SMTP is involved, the message may begin with an overriding response code,
31586 consisting of three digits optionally followed by an &"extended response code"&
31587 of the form &'n.n.n'&, each code being followed by a space. For example:
31588 .code
31589 deny  message = 599 1.2.3 Host not welcome
31590       hosts = 192.168.34.0/24
31591 .endd
31592 The first digit of the supplied response code must be the same as would be sent
31593 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31594 access, but for the predata ACL, note that the default success code is 354, not
31595 2&'xx'&.
31596
31597 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31598 the message modifier cannot override the 221 response code.
31599
31600 The text in a &%message%& modifier is literal; any quotes are taken as
31601 literals, but because the string is expanded, backslash escapes are processed
31602 anyway.
31603 If the message contains newlines, this gives rise to a multi-line SMTP
31604 response.
31605 A long message line will also be split into multi-line SMTP responses,
31606 on word boundaries if possible.
31607
31608 .vindex "&$acl_verify_message$&"
31609 While the text is being expanded, the &$acl_verify_message$& variable
31610 contains any message previously set.
31611 Afterwards, &$acl_verify_message$& is cleared.
31612
31613 If &%message%& is used on a statement that verifies an address, the message
31614 specified overrides any message that is generated by the verification process.
31615 However, the original message is available in the variable
31616 &$acl_verify_message$&, so you can incorporate it into your message if you
31617 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31618 routers to be passed back as part of the SMTP response, you should either not
31619 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31620
31621 For compatibility with previous releases of Exim, a &%message%& modifier that
31622 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31623 modifier, but this usage is now deprecated. However, &%message%& acts only when
31624 all the conditions are true, wherever it appears in an ACL command, whereas
31625 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31626 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31627 effect.
31628
31629
31630 .vitem &*queue*&&~=&~<&'text'&>
31631 .cindex "&%queue%& ACL modifier"
31632 .cindex "named queues" "selecting in ACL"
31633 This modifier specifies the use of a named queue for spool files
31634 for the message.
31635 It can only be used before the message is received (i.e. not in
31636 the DATA ACL).
31637 This could be used, for example, for known high-volume burst sources
31638 of traffic, or for quarantine of messages.
31639 Separate queue-runner processes will be needed for named queues.
31640 If the text after expansion is empty, the default queue is used.
31641
31642
31643 .vitem &*remove_header*&&~=&~<&'text'&>
31644 This modifier specifies one or more header names in a colon-separated list
31645  that are to be removed from an incoming message, assuming, of course, that
31646 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31647
31648
31649 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31650 .cindex "&%set%& ACL modifier"
31651 This modifier puts a value into one of the ACL variables (see section
31652 &<<SECTaclvariables>>&).
31653
31654
31655 .vitem &*udpsend*&&~=&~<&'parameters'&>
31656 .cindex "UDP communications"
31657 This modifier sends a UDP packet, for purposes such as statistics
31658 collection or behaviour monitoring. The parameters are expanded, and
31659 the result of the expansion must be a colon-separated list consisting
31660 of a destination server, port number, and the packet contents. The
31661 server can be specified as a host name or IPv4 or IPv6 address. The
31662 separator can be changed with the usual angle bracket syntax. For
31663 example, you might want to collect information on which hosts connect
31664 when:
31665 .code
31666 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31667              $tod_zulu $sender_host_address
31668 .endd
31669 .endlist
31670
31671
31672
31673
31674 .section "Use of the control modifier" "SECTcontrols"
31675 .cindex "&%control%& ACL modifier"
31676 The &%control%& modifier supports the following settings:
31677
31678 .vlist
31679 .vitem &*control&~=&~allow_auth_unadvertised*&
31680 This modifier allows a client host to use the SMTP AUTH command even when it
31681 has not been advertised in response to EHLO. Furthermore, because there are
31682 apparently some really broken clients that do this, Exim will accept AUTH after
31683 HELO (rather than EHLO) when this control is set. It should be used only if you
31684 really need it, and you should limit its use to those broken clients that do
31685 not work without it. For example:
31686 .code
31687 warn hosts   = 192.168.34.25
31688      control = allow_auth_unadvertised
31689 .endd
31690 Normally, when an Exim server receives an AUTH command, it checks the name of
31691 the authentication mechanism that is given in the command to ensure that it
31692 matches an advertised mechanism. When this control is set, the check that a
31693 mechanism has been advertised is bypassed. Any configured mechanism can be used
31694 by the client. This control is permitted only in the connection and HELO ACLs.
31695
31696
31697 .vitem &*control&~=&~caseful_local_part*& &&&
31698        &*control&~=&~caselower_local_part*&
31699 .cindex "&ACL;" "case of local part in"
31700 .cindex "case of local parts"
31701 .vindex "&$local_part$&"
31702 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31703 (that is, during RCPT processing). By default, the contents of &$local_part$&
31704 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31705 any uppercase letters in the original local part are restored in &$local_part$&
31706 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31707 is encountered.
31708
31709 These controls affect only the current recipient. Moreover, they apply only to
31710 local part handling that takes place directly in the ACL (for example, as a key
31711 in lookups). If a test to verify the recipient is obeyed, the case-related
31712 handling of the local part during the verification is controlled by the router
31713 configuration (see the &%caseful_local_part%& generic router option).
31714
31715 This facility could be used, for example, to add a spam score to local parts
31716 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31717 spam score:
31718 .code
31719 warn  control = caseful_local_part
31720       set acl_m4 = ${eval:\
31721                      $acl_m4 + \
31722                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31723                     }
31724       control = caselower_local_part
31725 .endd
31726 Notice that we put back the lower cased version afterwards, assuming that
31727 is what is wanted for subsequent tests.
31728
31729
31730 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31731 .cindex "&ACL;" "cutthrough routing"
31732 .cindex "cutthrough" "requesting"
31733 This option requests delivery be attempted while the item is being received.
31734
31735 The option is usable in the RCPT ACL.
31736 If enabled for a message received via smtp and routed to an smtp transport,
31737 and only one transport, interface, destination host and port combination
31738 is used for all recipients of the message,
31739 then the delivery connection is made while the receiving connection is open
31740 and data is copied from one to the other.
31741
31742 An attempt to set this option for any recipient but the first
31743 for a mail will be quietly ignored.
31744 If a recipient-verify callout
31745 (with use_sender)
31746 connection is subsequently
31747 requested in the same ACL it is held open and used for
31748 any subsequent recipients and the data,
31749 otherwise one is made after the initial RCPT ACL completes.
31750
31751 Note that routers are used in verify mode,
31752 and cannot depend on content of received headers.
31753 Note also that headers cannot be
31754 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31755 Headers may be modified by routers (subject to the above) and transports.
31756 The &'Received-By:'& header is generated as soon as the body reception starts,
31757 rather than the traditional time after the full message is received;
31758 this will affect the timestamp.
31759
31760 All the usual ACLs are called; if one results in the message being
31761 rejected, all effort spent in delivery (including the costs on
31762 the ultimate destination) will be wasted.
31763 Note that in the case of data-time ACLs this includes the entire
31764 message body.
31765
31766 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31767 of outgoing messages is done, because it sends data to the ultimate destination
31768 before the entire message has been received from the source.
31769 It is not supported for messages received with the SMTP PRDR
31770 or CHUNKING
31771 options in use.
31772
31773 Should the ultimate destination system positively accept or reject the mail,
31774 a corresponding indication is given to the source system and nothing is queued.
31775 If the item is successfully delivered in cutthrough mode
31776 the delivery log lines are tagged with ">>" rather than "=>" and appear
31777 before the acceptance "<=" line.
31778
31779 If there is a temporary error the item is queued for later delivery in the
31780 usual fashion.
31781 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31782 to the control; the default value is &"spool"& and the alternate value
31783 &"pass"& copies an SMTP defer response from the target back to the initiator
31784 and does not queue the message.
31785 Note that this is independent of any recipient verify conditions in the ACL.
31786
31787 Delivery in this mode avoids the generation of a bounce mail to a
31788 (possibly faked)
31789 sender when the destination system is doing content-scan based rejection.
31790
31791
31792 .vitem &*control&~=&~debug/*&<&'options'&>
31793 .cindex "&ACL;" "enabling debug logging"
31794 .cindex "debugging" "enabling from an ACL"
31795 This control turns on debug logging, almost as though Exim had been invoked
31796 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31797 by default called &'debuglog'&.
31798
31799 Logging set up by the control will be maintained across spool residency.
31800
31801 Options are a slash-separated list.
31802 If an option takes an argument, the option name and argument are separated by
31803 an equals character.
31804 Several options are supported:
31805 .display
31806 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31807                      The argument, which may access any variables already defined,
31808                      is appended to the default name.
31809
31810 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31811                      using the same values as the &`-d`& command-line option.
31812
31813 stop                 Logging started with this control may be
31814                      stopped by using this option.
31815
31816 kill                 Logging started with this control may be
31817                      stopped by using this option.
31818                      Additionally the debug file will be removed,
31819                      providing one means for speculative debug tracing.
31820
31821 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31822                      for pre-trigger debug capture.
31823                      Debug lines are recorded in the buffer until
31824                      and if) a trigger occurs; at which time they are
31825                      dumped to the debug file.  Newer lines displace the
31826                      oldest if the buffer is full.  After a trigger,
31827                      immediate writes to file are done as normal.
31828
31829 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31830                      see above) to be copied to file.  A reason of &*now*&
31831                      take effect immediately; one of &*paniclog*& triggers
31832                      on a write to the panic log.
31833 .endd
31834
31835 Some examples (which depend on variables that don't exist in all
31836 contexts):
31837 .code
31838       control = debug
31839       control = debug/tag=.$sender_host_address
31840       control = debug/opts=+expand+acl
31841       control = debug/tag=.$message_exim_id/opts=+expand
31842       control = debug/kill
31843       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31844       control = debug/trigger=now
31845 .endd
31846
31847
31848 .vitem &*control&~=&~dkim_disable_verify*&
31849 .cindex "disable DKIM verify"
31850 .cindex "DKIM" "disable verify"
31851 This control turns off DKIM verification processing entirely.  For details on
31852 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31853
31854
31855 .vitem &*control&~=&~dmarc_disable_verify*&
31856 .cindex "disable DMARC verify"
31857 .cindex "DMARC" "disable verify"
31858 This control turns off DMARC verification processing entirely.  For details on
31859 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31860
31861
31862 .vitem &*control&~=&~dscp/*&<&'value'&>
31863 .cindex "&ACL;" "setting DSCP value"
31864 .cindex "DSCP" "inbound"
31865 This option causes the DSCP value associated with the socket for the inbound
31866 connection to be adjusted to a given value, given as one of a number of fixed
31867 strings or to numeric value.
31868 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31869 Common values include &`throughput`&, &`mincost`&, and on newer systems
31870 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31871
31872 The outbound packets from Exim will be marked with this value in the header
31873 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31874 that these values will have any effect, not be stripped by networking
31875 equipment, or do much of anything without cooperation with your Network
31876 Engineer and those of all network operators between the source and destination.
31877
31878
31879 .vitem &*control&~=&~enforce_sync*& &&&
31880        &*control&~=&~no_enforce_sync*&
31881 .cindex "SMTP" "synchronization checking"
31882 .cindex "synchronization checking in SMTP"
31883 These controls make it possible to be selective about when SMTP synchronization
31884 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31885 state of the switch (it is true by default). See the description of this option
31886 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31887
31888 The effect of these two controls lasts for the remainder of the SMTP
31889 connection. They can appear in any ACL except the one for the non-SMTP
31890 messages. The most straightforward place to put them is in the ACL defined by
31891 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31892 before the first synchronization check. The expected use is to turn off the
31893 synchronization checks for badly-behaved hosts that you nevertheless need to
31894 work with.
31895
31896
31897 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31898 .cindex "fake defer"
31899 .cindex "defer, fake"
31900 .cindex fakedefer
31901 This control works in exactly the same way as &%fakereject%& (described below)
31902 except that it causes an SMTP 450 response after the message data instead of a
31903 550 response. You must take care when using &%fakedefer%& because it causes the
31904 messages to be duplicated when the sender retries. Therefore, you should not
31905 use &%fakedefer%& if the message is to be delivered normally.
31906
31907 .vitem &*control&~=&~fakereject/*&<&'message'&>
31908 .cindex "fake rejection"
31909 .cindex "rejection, fake"
31910 .cindex fakereject
31911 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31912 words, only when an SMTP message is being received. If Exim accepts the
31913 message, instead the final 250 response, a 550 rejection message is sent.
31914 However, Exim proceeds to deliver the message as normal. The control applies
31915 only to the current message, not to any subsequent ones that may be received in
31916 the same SMTP connection.
31917
31918 The text for the 550 response is taken from the &%control%& modifier. If no
31919 message is supplied, the following is used:
31920 .code
31921 550-Your message has been rejected but is being
31922 550-kept for evaluation.
31923 550-If it was a legitimate message, it may still be
31924 550 delivered to the target recipient(s).
31925 .endd
31926 This facility should be used with extreme caution.
31927
31928 .vitem &*control&~=&~freeze*&
31929 .cindex "frozen messages" "forcing in ACL"
31930 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31931 other words, only when a message is being received. If the message is accepted,
31932 it is placed on Exim's queue and frozen. The control applies only to the
31933 current message, not to any subsequent ones that may be received in the same
31934 SMTP connection.
31935
31936 This modifier can optionally be followed by &`/no_tell`&. If the global option
31937 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31938 is told about the freezing), provided all the &*control=freeze*& modifiers that
31939 are obeyed for the current message have the &`/no_tell`& option.
31940
31941 .vitem &*control&~=&~no_delay_flush*&
31942 .cindex "SMTP" "output flushing, disabling for delay"
31943 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31944 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31945 use. This control, as long as it is encountered before the &%delay%& modifier,
31946 disables such output flushing.
31947
31948 .vitem &*control&~=&~no_callout_flush*&
31949 .cindex "SMTP" "output flushing, disabling for callout"
31950 Exim normally flushes SMTP output before performing a callout in an ACL, to
31951 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31952 use. This control, as long as it is encountered before the &%verify%& condition
31953 that causes the callout, disables such output flushing.
31954
31955 .vitem &*control&~=&~no_mbox_unspool*&
31956 This control is available when Exim is compiled with the content scanning
31957 extension. Content scanning may require a copy of the current message, or parts
31958 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31959 or spam scanner. Normally, such copies are deleted when they are no longer
31960 needed. If this control is set, the copies are not deleted. The control applies
31961 only to the current message, not to any subsequent ones that may be received in
31962 the same SMTP connection. It is provided for debugging purposes and is unlikely
31963 to be useful in production.
31964
31965 .vitem &*control&~=&~no_multiline_responses*&
31966 .cindex "multiline responses, suppressing"
31967 This control is permitted for any ACL except the one for non-SMTP messages.
31968 It seems that there are broken clients in use that cannot handle multiline
31969 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31970
31971 If this control is set, multiline SMTP responses from ACL rejections are
31972 suppressed. One way of doing this would have been to put out these responses as
31973 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31974 (&"use multiline responses for more"& it says &-- ha!), and some of the
31975 responses might get close to that. So this facility, which is after all only a
31976 sop to broken clients, is implemented by doing two very easy things:
31977
31978 .ilist
31979 Extra information that is normally output as part of a rejection caused by
31980 sender verification failure is omitted. Only the final line (typically &"sender
31981 verification failed"&) is sent.
31982 .next
31983 If a &%message%& modifier supplies a multiline response, only the first
31984 line is output.
31985 .endlist
31986
31987 The setting of the switch can, of course, be made conditional on the
31988 calling host. Its effect lasts until the end of the SMTP connection.
31989
31990 .vitem &*control&~=&~no_pipelining*&
31991 .cindex "PIPELINING" "suppressing advertising"
31992 .cindex "ESMTP extensions" PIPELINING
31993 This control turns off the advertising of the PIPELINING extension to SMTP in
31994 the current session. To be useful, it must be obeyed before Exim sends its
31995 response to an EHLO command. Therefore, it should normally appear in an ACL
31996 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31997 &%pipelining_advertise_hosts%&.
31998
31999 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
32000        &*control&~=&~queue_only*&
32001 .oindex "&%queue%&"
32002 .oindex "&%queue_only%&"
32003 .cindex "queueing incoming messages"
32004 .cindex queueing "forcing in ACL"
32005 .cindex "first pass routing"
32006 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
32007 other words, only when a message is being received. If the message is accepted,
32008 it is placed on Exim's queue and left there for delivery by a subsequent queue
32009 runner.
32010 If used with no options set,
32011 no immediate delivery process is started. In other words, it has the
32012 effect as the &%queue_only%& global option or &'-odq'& command-line option.
32013
32014 If the &'first_pass_route'& option is given then
32015 the behaviour is like the command-line &'-oqds'& option;
32016 a delivery process is started which stops short of making
32017 any SMTP delivery.  The benefit is that the hints database will be updated for
32018 the message being waiting for a specific host, and a later queue run will be
32019 able to send all such messages on a single connection.
32020
32021 The control only applies to the current message, not to any subsequent ones that
32022  may be received in the same SMTP connection.
32023
32024 .vitem &*control&~=&~submission/*&<&'options'&>
32025 .cindex "message" "submission"
32026 .cindex "submission mode"
32027 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
32028 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
32029 the current message is a submission from a local MUA. In this case, Exim
32030 operates in &"submission mode"&, and applies certain fixups to the message if
32031 necessary. For example, it adds a &'Date:'& header line if one is not present.
32032 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
32033 late (the message has already been created).
32034
32035 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32036 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32037 submission mode; the available options for this control are described there.
32038 The control applies only to the current message, not to any subsequent ones
32039 that may be received in the same SMTP connection.
32040
32041 .vitem &*control&~=&~suppress_local_fixups*&
32042 .cindex "submission fixups, suppressing"
32043 This control applies to locally submitted (non TCP/IP) messages, and is the
32044 complement of &`control = submission`&. It disables the fixups that are
32045 normally applied to locally-submitted messages. Specifically:
32046
32047 .ilist
32048 Any &'Sender:'& header line is left alone (in this respect, it is a
32049 dynamic version of &%local_sender_retain%&).
32050 .next
32051 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32052 .next
32053 There is no check that &'From:'& corresponds to the actual sender.
32054 .endlist ilist
32055
32056 This control may be useful when a remotely-originated message is accepted,
32057 passed to some scanning program, and then re-submitted for delivery. It can be
32058 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32059 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32060 data is read.
32061
32062 &*Note:*& This control applies only to the current message, not to any others
32063 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32064
32065 .vitem &*control&~=&~utf8_downconvert*&
32066 This control enables conversion of UTF-8 in message envelope addresses
32067 to a-label form.
32068 For details see section &<<SECTi18nMTA>>&.
32069 .endlist vlist
32070
32071
32072 .section "Summary of message fixup control" "SECTsummesfix"
32073 All four possibilities for message fixups can be specified:
32074
32075 .ilist
32076 Locally submitted, fixups applied: the default.
32077 .next
32078 Locally submitted, no fixups applied: use
32079 &`control = suppress_local_fixups`&.
32080 .next
32081 Remotely submitted, no fixups applied: the default.
32082 .next
32083 Remotely submitted, fixups applied: use &`control = submission`&.
32084 .endlist
32085
32086
32087
32088 .section "Adding header lines in ACLs" "SECTaddheadacl"
32089 .cindex "header lines" "adding in an ACL"
32090 .cindex "header lines" "position of added lines"
32091 .cindex "&%add_header%& ACL modifier"
32092 The &%add_header%& modifier can be used to add one or more extra header lines
32093 to an incoming message, as in this example:
32094 .code
32095 warn dnslists = sbl.spamhaus.org : \
32096                 dialup.mail-abuse.org
32097      add_header = X-blacklisted-at: $dnslist_domain
32098 .endd
32099 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32100 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32101 receiving a message). The message must ultimately be accepted for
32102 &%add_header%& to have any significant effect. You can use &%add_header%& with
32103 any ACL verb, including &%deny%& (though this is potentially useful only in a
32104 RCPT ACL).
32105
32106 Headers will not be added to the message if the modifier is used in
32107 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32108
32109 Leading and trailing newlines are removed from
32110 the data for the &%add_header%& modifier; if it then
32111 contains one or more newlines that
32112 are not followed by a space or a tab, it is assumed to contain multiple header
32113 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32114 front of any line that is not a valid header line.
32115
32116 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32117 They are added to the message before processing the DATA and MIME ACLs.
32118 However, if an identical header line is requested more than once, only one copy
32119 is actually added to the message. Further header lines may be accumulated
32120 during the DATA and MIME ACLs, after which they are added to the message, again
32121 with duplicates suppressed. Thus, it is possible to add two identical header
32122 lines to an SMTP message, but only if one is added before DATA and one after.
32123 In the case of non-SMTP messages, new headers are accumulated during the
32124 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32125 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32126 are included in the entry that is written to the reject log.
32127
32128 .cindex "header lines" "added; visibility of"
32129 Header lines are not visible in string expansions
32130 of message headers
32131 until they are added to the
32132 message. It follows that header lines defined in the MAIL, RCPT, and predata
32133 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32134 header lines that are added by the DATA or MIME ACLs are not visible in those
32135 ACLs. Because of this restriction, you cannot use header lines as a way of
32136 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32137 this, you can use ACL variables, as described in section
32138 &<<SECTaclvariables>>&.
32139
32140 The list of headers yet to be added is given by the &%$headers_added%& variable.
32141
32142 The &%add_header%& modifier acts immediately as it is encountered during the
32143 processing of an ACL. Notice the difference between these two cases:
32144 .display
32145 &`accept add_header = ADDED: some text`&
32146 &`       `&<&'some condition'&>
32147
32148 &`accept `&<&'some condition'&>
32149 &`       add_header = ADDED: some text`&
32150 .endd
32151 In the first case, the header line is always added, whether or not the
32152 condition is true. In the second case, the header line is added only if the
32153 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32154 ACL statement. All those that are encountered before a condition fails are
32155 honoured.
32156
32157 .cindex "&%warn%& ACL verb"
32158 For compatibility with previous versions of Exim, a &%message%& modifier for a
32159 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32160 effect only if all the conditions are true, even if it appears before some of
32161 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32162 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32163 are present on a &%warn%& verb, both are processed according to their
32164 specifications.
32165
32166 By default, new header lines are added to a message at the end of the existing
32167 header lines. However, you can specify that any particular header line should
32168 be added right at the start (before all the &'Received:'& lines), immediately
32169 after the first block of &'Received:'& lines, or immediately before any line
32170 that is not a &'Received:'& or &'Resent-something:'& header.
32171
32172 This is done by specifying &":at_start:"&, &":after_received:"&, or
32173 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32174 header line, respectively. (Header text cannot start with a colon, as there has
32175 to be a header name first.) For example:
32176 .code
32177 warn add_header = \
32178        :after_received:X-My-Header: something or other...
32179 .endd
32180 If more than one header line is supplied in a single &%add_header%& modifier,
32181 each one is treated independently and can therefore be placed differently. If
32182 you add more than one line at the start, or after the Received: block, they end
32183 up in reverse order.
32184
32185 &*Warning*&: This facility currently applies only to header lines that are
32186 added in an ACL. It does NOT work for header lines that are added in a
32187 system filter or in a router or transport.
32188
32189
32190
32191 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32192 .cindex "header lines" "removing in an ACL"
32193 .cindex "header lines" "position of removed lines"
32194 .cindex "&%remove_header%& ACL modifier"
32195 The &%remove_header%& modifier can be used to remove one or more header lines
32196 from an incoming message, as in this example:
32197 .code
32198 warn   message        = Remove internal headers
32199        remove_header  = x-route-mail1 : x-route-mail2
32200 .endd
32201 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32202 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32203 receiving a message). The message must ultimately be accepted for
32204 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32205 with any ACL verb, including &%deny%&, though this is really not useful for
32206 any verb that doesn't result in a delivered message.
32207
32208 Headers will not be removed from the message if the modifier is used in
32209 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32210
32211 More than one header can be removed at the same time by using a colon separated
32212 list of header specifiers.
32213 .new
32214 If a specifier does not start with a circumflex (^)
32215 then it is treated as a header name.
32216 The header name matching is case insensitive.
32217 If it does, then it is treated as a (front-anchored)
32218 regular expression applied to the whole header.
32219
32220 &*Note*&: The colon terminating a header name will need to be doubled
32221 if used in an RE, and there can legitimately be whitepace before it.
32222
32223 Example:
32224 .code
32225 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32226 .endd
32227 .wen
32228
32229 List expansion is not performed, so you cannot use hostlists to
32230 create a list of headers, however both connection and message variable expansion
32231 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32232 .code
32233 warn   hosts           = +internal_hosts
32234        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32235 warn   message         = Remove internal headers
32236        remove_header   = $acl_c_ihdrs
32237 .endd
32238 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32239 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32240 If multiple header lines match, all are removed.
32241 There is no harm in attempting to remove the same header twice nor in removing
32242 a non-existent header. Further header specifiers for removal may be accumulated
32243 during the DATA and MIME ACLs, after which matching headers are removed
32244 if present. In the case of non-SMTP messages, remove specifiers are
32245 accumulated during the non-SMTP ACLs, and are acted on after
32246 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32247 ACL, there really is no effect because there is no logging of what headers
32248 would have been removed.
32249
32250 .cindex "header lines" "removed; visibility of"
32251 Header lines are not visible in string expansions until the DATA phase when it
32252 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32253 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32254 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32255 this restriction, you cannot use header lines as a way of controlling data
32256 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32257 you should instead use ACL variables, as described in section
32258 &<<SECTaclvariables>>&.
32259
32260 The &%remove_header%& modifier acts immediately as it is encountered during the
32261 processing of an ACL. Notice the difference between these two cases:
32262 .display
32263 &`accept remove_header = X-Internal`&
32264 &`       `&<&'some condition'&>
32265
32266 &`accept `&<&'some condition'&>
32267 &`       remove_header = X-Internal`&
32268 .endd
32269 In the first case, the header line is always removed, whether or not the
32270 condition is true. In the second case, the header line is removed only if the
32271 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32272 same ACL statement. All those that are encountered before a condition fails
32273 are honoured.
32274
32275 &*Warning*&: This facility currently applies only to header lines that are
32276 present during ACL processing. It does NOT remove header lines that are added
32277 in a system filter or in a router or transport.
32278
32279
32280
32281
32282 .section "ACL conditions" "SECTaclconditions"
32283 .cindex "&ACL;" "conditions; list of"
32284 Some of the conditions listed in this section are available only when Exim is
32285 compiled with the content-scanning extension. They are included here briefly
32286 for completeness. More detailed descriptions can be found in the discussion on
32287 content scanning in chapter &<<CHAPexiscan>>&.
32288
32289 Not all conditions are relevant in all circumstances. For example, testing
32290 senders and recipients does not make sense in an ACL that is being run as the
32291 result of the arrival of an ETRN command, and checks on message headers can be
32292 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32293 can use the same condition (with different parameters) more than once in the
32294 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32295 The conditions are as follows:
32296
32297
32298 .vlist
32299 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32300 .cindex "&ACL;" "nested"
32301 .cindex "&ACL;" "indirect"
32302 .cindex "&ACL;" "arguments"
32303 .cindex "&%acl%& ACL condition"
32304 The possible values of the argument are the same as for the
32305 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32306 &"accept"& the condition is true; if it returns &"deny"& the condition is
32307 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32308 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32309 condition false. This means that further processing of the &%warn%& verb
32310 ceases, but processing of the ACL continues.
32311
32312 If the argument is a named ACL, up to nine space-separated optional values
32313 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32314 and $acl_narg is set to the count of values.
32315 Previous values of these variables are restored after the call returns.
32316 The name and values are expanded separately.
32317 Note that spaces in complex expansions which are used as arguments
32318 will act as argument separators.
32319
32320 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32321 the connection is dropped. If it returns &"discard"&, the verb must be
32322 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32323 conditions are tested.
32324
32325 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32326 loops. This condition allows you to use different ACLs in different
32327 circumstances. For example, different ACLs can be used to handle RCPT commands
32328 for different local users or different local domains.
32329
32330 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32331 .cindex "&%authenticated%& ACL condition"
32332 .cindex "authentication" "ACL checking"
32333 .cindex "&ACL;" "testing for authentication"
32334 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32335 the name of the authenticator is tested against the list. To test for
32336 authentication by any authenticator, you can set
32337 .code
32338 authenticated = *
32339 .endd
32340
32341 .vitem &*condition&~=&~*&<&'string'&>
32342 .cindex "&%condition%& ACL condition"
32343 .cindex "customizing" "ACL condition"
32344 .cindex "&ACL;" "customized test"
32345 .cindex "&ACL;" "testing, customized"
32346 This feature allows you to make up custom conditions. If the result of
32347 expanding the string is an empty string, the number zero, or one of the strings
32348 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32349 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32350 any other value, some error is assumed to have occurred, and the ACL returns
32351 &"defer"&. However, if the expansion is forced to fail, the condition is
32352 ignored. The effect is to treat it as true, whether it is positive or
32353 negative.
32354
32355 .vitem &*decode&~=&~*&<&'location'&>
32356 .cindex "&%decode%& ACL condition"
32357 This condition is available only when Exim is compiled with the
32358 content-scanning extension, and it is allowed only in the ACL defined by
32359 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32360 If all goes well, the condition is true. It is false only if there are
32361 problems such as a syntax error or a memory shortage. For more details, see
32362 chapter &<<CHAPexiscan>>&.
32363
32364 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32365 .cindex "&%dnslists%& ACL condition"
32366 .cindex "DNS list" "in ACL"
32367 .cindex "black list (DNS)"
32368 .cindex "&ACL;" "testing a DNS list"
32369 This condition checks for entries in DNS black lists. These are also known as
32370 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32371 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32372 different variants of this condition to describe briefly here. See sections
32373 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32374
32375 .vitem &*domains&~=&~*&<&'domain&~list'&>
32376 .cindex "&%domains%& ACL condition"
32377 .cindex "domain" "ACL checking"
32378 .cindex "&ACL;" "testing a recipient domain"
32379 .vindex "&$domain_data$&"
32380 This condition is relevant only in a RCPT ACL. It checks that the domain
32381 of the recipient address is in the domain list. If percent-hack processing is
32382 enabled, it is done before this test is done. If the check succeeds with a
32383 lookup, the result of the lookup is placed in &$domain_data$& until the next
32384 &%domains%& test.
32385
32386 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32387 use &%domains%& in a DATA ACL.
32388
32389
32390 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32391 .cindex "&%encrypted%& ACL condition"
32392 .cindex "encryption" "checking in an ACL"
32393 .cindex "&ACL;" "testing for encryption"
32394 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32395 name of the cipher suite in use is tested against the list. To test for
32396 encryption without testing for any specific cipher suite(s), set
32397 .code
32398 encrypted = *
32399 .endd
32400
32401
32402 .vitem &*hosts&~=&~*&<&'host&~list'&>
32403 .cindex "&%hosts%& ACL condition"
32404 .cindex "host" "ACL checking"
32405 .cindex "&ACL;" "testing the client host"
32406 This condition tests that the calling host matches the host list. If you have
32407 name lookups or wildcarded host names and IP addresses in the same host list,
32408 you should normally put the IP addresses first. For example, you could have:
32409 .code
32410 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32411 .endd
32412 The lookup in this example uses the host name for its key. This is implied by
32413 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32414 and it wouldn't matter which way round you had these two items.)
32415
32416 The reason for the problem with host names lies in the left-to-right way that
32417 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32418 but when it reaches an item that requires a host name, it fails if it cannot
32419 find a host name to compare with the pattern. If the above list is given in the
32420 opposite order, the &%accept%& statement fails for a host whose name cannot be
32421 found, even if its IP address is 10.9.8.7.
32422
32423 If you really do want to do the name check first, and still recognize the IP
32424 address even if the name lookup fails, you can rewrite the ACL like this:
32425 .code
32426 accept hosts = dbm;/etc/friendly/hosts
32427 accept hosts = 10.9.8.7
32428 .endd
32429 The default action on failing to find the host name is to assume that the host
32430 is not in the list, so the first &%accept%& statement fails. The second
32431 statement can then check the IP address.
32432
32433 .vindex "&$host_data$&"
32434 If a &%hosts%& condition is satisfied by means of a lookup, the result
32435 of the lookup is made available in the &$host_data$& variable. This
32436 allows you, for example, to set up a statement like this:
32437 .code
32438 deny  hosts = net-lsearch;/some/file
32439       message = $host_data
32440 .endd
32441 which gives a custom error message for each denied host.
32442
32443 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32444 .cindex "&%local_parts%& ACL condition"
32445 .cindex "local part" "ACL checking"
32446 .cindex "&ACL;" "testing a local part"
32447 .vindex "&$local_part_data$&"
32448 This condition is relevant only in a RCPT ACL. It checks that the local
32449 part of the recipient address is in the list. If percent-hack processing is
32450 enabled, it is done before this test. If the check succeeds with a lookup, the
32451 result of the lookup is placed in &$local_part_data$&, which remains set until
32452 the next &%local_parts%& test.
32453
32454 .vitem &*malware&~=&~*&<&'option'&>
32455 .cindex "&%malware%& ACL condition"
32456 .cindex "&ACL;" "virus scanning"
32457 .cindex "&ACL;" "scanning for viruses"
32458 This condition is available only when Exim is compiled with the
32459 content-scanning extension
32460 and only after a DATA command.
32461 It causes the incoming message to be scanned for
32462 viruses. For details, see chapter &<<CHAPexiscan>>&.
32463
32464 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32465 .cindex "&%mime_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 it is allowed only in the ACL defined by
32469 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32470 with any of the regular expressions. For details, see chapter
32471 &<<CHAPexiscan>>&.
32472
32473 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32474 .cindex "rate limiting"
32475 This condition can be used to limit the rate at which a user or host submits
32476 messages. Details are given in section &<<SECTratelimiting>>&.
32477
32478 .vitem &*recipients&~=&~*&<&'address&~list'&>
32479 .cindex "&%recipients%& ACL condition"
32480 .cindex "recipient" "ACL checking"
32481 .cindex "&ACL;" "testing a recipient"
32482 This condition is relevant only in a RCPT ACL. It checks the entire
32483 recipient address against a list of recipients.
32484
32485 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32486 .cindex "&%regex%& ACL condition"
32487 .cindex "&ACL;" "testing by regex matching"
32488 This condition is available only when Exim is compiled with the
32489 content-scanning extension, and is available only in the DATA, MIME, and
32490 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32491 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32492
32493 .vitem &*seen&~=&~*&<&'parameters'&>
32494 .cindex "&%seen%& ACL condition"
32495 This condition can be used to test if a situation has been previously met,
32496 for example for greylisting.
32497 Details are given in section &<<SECTseen>>&.
32498
32499 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32500 .cindex "&%sender_domains%& ACL condition"
32501 .cindex "sender" "ACL checking"
32502 .cindex "&ACL;" "testing a sender domain"
32503 .vindex "&$domain$&"
32504 .vindex "&$sender_address_domain$&"
32505 This condition tests the domain of the sender of the message against the given
32506 domain list. &*Note*&: The domain of the sender address is in
32507 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32508 of this condition. This is an exception to the general rule for testing domain
32509 lists. It is done this way so that, if this condition is used in an ACL for a
32510 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32511 influence the sender checking.
32512
32513 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32514 relaying, because sender addresses are easily, and commonly, forged.
32515
32516 .vitem &*senders&~=&~*&<&'address&~list'&>
32517 .cindex "&%senders%& ACL condition"
32518 .cindex "sender" "ACL checking"
32519 .cindex "&ACL;" "testing a sender"
32520 This condition tests the sender of the message against the given list. To test
32521 for a bounce message, which has an empty sender, set
32522 .code
32523 senders = :
32524 .endd
32525 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32526 relaying, because sender addresses are easily, and commonly, forged.
32527
32528 .vitem &*spam&~=&~*&<&'username'&>
32529 .cindex "&%spam%& ACL condition"
32530 .cindex "&ACL;" "scanning for spam"
32531 This condition is available only when Exim is compiled with the
32532 content-scanning extension. It causes the incoming message to be scanned by
32533 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32534
32535 .vitem &*verify&~=&~certificate*&
32536 .cindex "&%verify%& ACL condition"
32537 .cindex "TLS" "client certificate verification"
32538 .cindex "certificate" "verification of client"
32539 .cindex "&ACL;" "certificate verification"
32540 .cindex "&ACL;" "testing a TLS certificate"
32541 This condition is true in an SMTP session if the session is encrypted, and a
32542 certificate was received from the client, and the certificate was verified. The
32543 server requests a certificate only if the client matches &%tls_verify_hosts%&
32544 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32545
32546 .vitem &*verify&~=&~csa*&
32547 .cindex "CSA verification"
32548 This condition checks whether the sending host (the client) is authorized to
32549 send email. Details of how this works are given in section
32550 &<<SECTverifyCSA>>&.
32551
32552 .vitem &*verify&~=&~header_names_ascii*&
32553 .cindex "&%verify%& ACL condition"
32554 .cindex "&ACL;" "verifying header names only ASCII"
32555 .cindex "header lines" "verifying header names only ASCII"
32556 .cindex "verifying" "header names only ASCII"
32557 This condition is relevant only in an ACL that is run after a message has been
32558 received.
32559 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32560 It checks all header names (not the content) to make sure
32561 there are no non-ASCII characters, also excluding control characters.  The
32562 allowable characters are decimal ASCII values 33 through 126.
32563
32564 Exim itself will handle headers with non-ASCII characters, but it can cause
32565 problems for downstream applications, so this option will allow their
32566 detection and rejection in the DATA ACL's.
32567
32568 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32569 .cindex "&%verify%& ACL condition"
32570 .cindex "&ACL;" "verifying sender in the header"
32571 .cindex "header lines" "verifying the sender in"
32572 .cindex "sender" "verifying in header"
32573 .cindex "verifying" "sender in header"
32574 This condition is relevant only in an ACL that is run after a message has been
32575 received, that is, in an ACL specified by &%acl_smtp_data%& or
32576 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32577 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32578 is loosely thought of as a &"sender"& address (hence the name of the test).
32579 However, an address that appears in one of these headers need not be an address
32580 that accepts bounce messages; only sender addresses in envelopes are required
32581 to accept bounces. Therefore, if you use the callout option on this check, you
32582 might want to arrange for a non-empty address in the MAIL command.
32583
32584 Details of address verification and the options are given later, starting at
32585 section &<<SECTaddressverification>>& (callouts are described in section
32586 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32587 condition to restrict it to bounce messages only:
32588 .code
32589 deny    senders = :
32590        !verify  = header_sender
32591         message = A valid sender header is required for bounces
32592 .endd
32593
32594 .vitem &*verify&~=&~header_syntax*&
32595 .cindex "&%verify%& ACL condition"
32596 .cindex "&ACL;" "verifying header syntax"
32597 .cindex "header lines" "verifying syntax"
32598 .cindex "verifying" "header syntax"
32599 This condition is relevant only in an ACL that is run after a message has been
32600 received, that is, in an ACL specified by &%acl_smtp_data%& or
32601 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32602 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32603 and &'Bcc:'&), returning true if there are no problems.
32604 Unqualified addresses (local parts without domains) are
32605 permitted only in locally generated messages and from hosts that match
32606 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32607 appropriate.
32608
32609 Note that this condition is a syntax check only. However, a common spamming
32610 ploy used to be to send syntactically invalid headers such as
32611 .code
32612 To: @
32613 .endd
32614 and this condition can be used to reject such messages, though they are not as
32615 common as they used to be.
32616
32617 .vitem &*verify&~=&~helo*&
32618 .cindex "&%verify%& ACL condition"
32619 .cindex "&ACL;" "verifying HELO/EHLO"
32620 .cindex "HELO" "verifying"
32621 .cindex "EHLO" "verifying"
32622 .cindex "verifying" "EHLO"
32623 .cindex "verifying" "HELO"
32624 This condition is true if a HELO or EHLO command has been received from the
32625 client host, and its contents have been verified. If there has been no previous
32626 attempt to verify the HELO/EHLO contents, it is carried out when this
32627 condition is encountered. See the description of the &%helo_verify_hosts%& and
32628 &%helo_try_verify_hosts%& options for details of how to request verification
32629 independently of this condition, and for detail of the verification.
32630
32631 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32632 option), this condition is always true.
32633
32634
32635 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32636 .cindex "verifying" "not blind"
32637 .cindex "bcc recipients, verifying none"
32638 This condition checks that there are no blind (bcc) recipients in the message.
32639 Every envelope recipient must appear either in a &'To:'& header line or in a
32640 &'Cc:'& header line for this condition to be true. Local parts are checked
32641 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32642 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32643 used only in a DATA or non-SMTP ACL.
32644
32645 There is one possible option, &`case_insensitive`&.  If this is present then
32646 local parts are checked case-insensitively.
32647
32648 There are, of course, many legitimate messages that make use of blind (bcc)
32649 recipients. This check should not be used on its own for blocking messages.
32650
32651
32652 .vitem &*verify&~=&~recipient/*&<&'options'&>
32653 .cindex "&%verify%& ACL condition"
32654 .cindex "&ACL;" "verifying recipient"
32655 .cindex "recipient" "verifying"
32656 .cindex "verifying" "recipient"
32657 .vindex "&$address_data$&"
32658 This condition is relevant only after a RCPT command. It verifies the current
32659 recipient. Details of address verification are given later, starting at section
32660 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32661 of &$address_data$& is the last value that was set while routing the address.
32662 This applies even if the verification fails. When an address that is being
32663 verified is redirected to a single address, verification continues with the new
32664 address, and in that case, the subsequent value of &$address_data$& is the
32665 value for the child address.
32666
32667 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32668 .cindex "&%verify%& ACL condition"
32669 .cindex "&ACL;" "verifying host reverse lookup"
32670 .cindex "host" "verifying reverse lookup"
32671 This condition ensures that a verified host name has been looked up from the IP
32672 address of the client host. (This may have happened already if the host name
32673 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32674 Verification ensures that the host name obtained from a reverse DNS lookup, or
32675 one of its aliases, does, when it is itself looked up in the DNS, yield the
32676 original IP address.
32677
32678 There is one possible option, &`defer_ok`&.  If this is present and a
32679 DNS operation returns a temporary error, the verify condition succeeds.
32680
32681 If this condition is used for a locally generated message (that is, when there
32682 is no client host involved), it always succeeds.
32683
32684 .vitem &*verify&~=&~sender/*&<&'options'&>
32685 .cindex "&%verify%& ACL condition"
32686 .cindex "&ACL;" "verifying sender"
32687 .cindex "sender" "verifying"
32688 .cindex "verifying" "sender"
32689 This condition is relevant only after a MAIL or RCPT command, or after a
32690 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32691 the message's sender is empty (that is, this is a bounce message), the
32692 condition is true. Otherwise, the sender address is verified.
32693
32694 .vindex "&$address_data$&"
32695 .vindex "&$sender_address_data$&"
32696 If there is data in the &$address_data$& variable at the end of routing, its
32697 value is placed in &$sender_address_data$& at the end of verification. This
32698 value can be used in subsequent conditions and modifiers in the same ACL
32699 statement. It does not persist after the end of the current statement. If you
32700 want to preserve the value for longer, you can save it in an ACL variable.
32701
32702 Details of verification are given later, starting at section
32703 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32704 to avoid doing it more than once per message.
32705
32706 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32707 .cindex "&%verify%& ACL condition"
32708 This is a variation of the previous option, in which a modified address is
32709 verified as a sender.
32710
32711 Note that '/' is legal in local-parts; if the address may have such
32712 (eg. is generated from the received message)
32713 they must be protected from the options parsing by doubling:
32714 .code
32715 verify = sender=${listquote{/}{${address:$h_sender:}}}
32716 .endd
32717 .endlist
32718
32719
32720
32721 .section "Using DNS lists" "SECTmorednslists"
32722 .cindex "DNS list" "in ACL"
32723 .cindex "black list (DNS)"
32724 .cindex "&ACL;" "testing a DNS list"
32725 In its simplest form, the &%dnslists%& condition tests whether the calling host
32726 is on at least one of a number of DNS lists by looking up the inverted IP
32727 address in one or more DNS domains. (Note that DNS list domains are not mail
32728 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32729 special options instead.) For example, if the calling host's IP
32730 address is 192.168.62.43, and the ACL statement is
32731 .code
32732 deny dnslists = blackholes.mail-abuse.org : \
32733                 dialups.mail-abuse.org
32734 .endd
32735 the following records are looked up:
32736 .code
32737 43.62.168.192.blackholes.mail-abuse.org
32738 43.62.168.192.dialups.mail-abuse.org
32739 .endd
32740 As soon as Exim finds an existing DNS record, processing of the list stops.
32741 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32742 to test that a host is on more than one list (an &"and"& conjunction), you can
32743 use two separate conditions:
32744 .code
32745 deny dnslists = blackholes.mail-abuse.org
32746      dnslists = dialups.mail-abuse.org
32747 .endd
32748 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32749 behaves as if the host does not match the list item, that is, as if the DNS
32750 record does not exist. If there are further items in the DNS list, they are
32751 processed.
32752
32753 This is usually the required action when &%dnslists%& is used with &%deny%&
32754 (which is the most common usage), because it prevents a DNS failure from
32755 blocking mail. However, you can change this behaviour by putting one of the
32756 following special items in the list:
32757 .itable none 0 0 2 25* left 75* left
32758 .irow "+include_unknown"   "behave as if the item is on the list"
32759 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32760 .irow "+defer_unknown  "   "give a temporary error"
32761 .endtable
32762 .cindex "&`+include_unknown`&"
32763 .cindex "&`+exclude_unknown`&"
32764 .cindex "&`+defer_unknown`&"
32765 Each of these applies to any subsequent items on the list. For example:
32766 .code
32767 deny dnslists = +defer_unknown : foo.bar.example
32768 .endd
32769 Testing the list of domains stops as soon as a match is found. If you want to
32770 warn for one list and block for another, you can use two different statements:
32771 .code
32772 deny  dnslists = blackholes.mail-abuse.org
32773 warn  dnslists = dialups.mail-abuse.org
32774       message  = X-Warn: sending host is on dialups list
32775 .endd
32776 .cindex caching "of dns lookup"
32777 .cindex DNS TTL
32778 DNS list lookups are cached by Exim for the duration of the SMTP session
32779 (but limited by the DNS return TTL value),
32780 so a lookup based on the IP address is done at most once for any incoming
32781 connection (assuming long-enough TTL).
32782 Exim does not share information between multiple incoming
32783 connections (but your local name server cache should be active).
32784
32785 There are a number of DNS lists to choose from, some commercial, some free,
32786 or free for small deployments.  An overview can be found at
32787 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32788
32789
32790
32791 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32792 .cindex "DNS list" "keyed by explicit IP address"
32793 By default, the IP address that is used in a DNS list lookup is the IP address
32794 of the calling host. However, you can specify another IP address by listing it
32795 after the domain name, introduced by a slash. For example:
32796 .code
32797 deny dnslists = black.list.tld/192.168.1.2
32798 .endd
32799 This feature is not very helpful with explicit IP addresses; it is intended for
32800 use with IP addresses that are looked up, for example, the IP addresses of the
32801 MX hosts or nameservers of an email sender address. For an example, see section
32802 &<<SECTmulkeyfor>>& below.
32803
32804
32805
32806
32807 .subsection "DNS lists keyed on domain names" SECID202
32808 .cindex "DNS list" "keyed by domain name"
32809 There are some lists that are keyed on domain names rather than inverted IP
32810 addresses (see, e.g., the &'domain based zones'& link at
32811 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32812 with these lists. You can change the name that is looked up in a DNS list by
32813 listing it after the domain name, introduced by a slash. For example,
32814 .code
32815 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32816       message  = Sender's domain is listed at $dnslist_domain
32817 .endd
32818 This particular example is useful only in ACLs that are obeyed after the
32819 RCPT or DATA commands, when a sender address is available. If (for
32820 example) the message's sender is &'user@tld.example'& the name that is looked
32821 up by this example is
32822 .code
32823 tld.example.dsn.rfc-ignorant.org
32824 .endd
32825 A single &%dnslists%& condition can contain entries for both names and IP
32826 addresses. For example:
32827 .code
32828 deny dnslists = sbl.spamhaus.org : \
32829                 dsn.rfc-ignorant.org/$sender_address_domain
32830 .endd
32831 The first item checks the sending host's IP address; the second checks a domain
32832 name. The whole condition is true if either of the DNS lookups succeeds.
32833
32834
32835
32836
32837 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32838 .cindex "DNS list" "multiple keys for"
32839 The syntax described above for looking up explicitly-defined values (either
32840 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32841 name for the DNS list, what follows the slash can in fact be a list of items.
32842 As with all lists in Exim, the default separator is a colon. However, because
32843 this is a sublist within the list of DNS blacklist domains, it is necessary
32844 either to double the separators like this:
32845 .code
32846 dnslists = black.list.tld/name.1::name.2
32847 .endd
32848 or to change the separator character, like this:
32849 .code
32850 dnslists = black.list.tld/<;name.1;name.2
32851 .endd
32852 If an item in the list is an IP address, it is inverted before the DNS
32853 blacklist domain is appended. If it is not an IP address, no inversion
32854 occurs. Consider this condition:
32855 .code
32856 dnslists = black.list.tld/<;192.168.1.2;a.domain
32857 .endd
32858 The DNS lookups that occur are:
32859 .code
32860 2.1.168.192.black.list.tld
32861 a.domain.black.list.tld
32862 .endd
32863 Once a DNS record has been found (that matches a specific IP return
32864 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32865 are done. If there is a temporary DNS error, the rest of the sublist of domains
32866 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32867 only if no other DNS lookup in this sublist succeeds. In other words, a
32868 successful lookup for any of the items in the sublist overrides a temporary
32869 error for a previous item.
32870
32871 The ability to supply a list of items after the slash is in some sense just a
32872 syntactic convenience. These two examples have the same effect:
32873 .code
32874 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32875 dnslists = black.list.tld/a.domain::b.domain
32876 .endd
32877 However, when the data for the list is obtained from a lookup, the second form
32878 is usually much more convenient. Consider this example:
32879 .code
32880 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32881                                    ${lookup dnsdb {>|mxh=\
32882                                    $sender_address_domain} }} }
32883      message  = The mail servers for the domain \
32884                 $sender_address_domain \
32885                 are listed at $dnslist_domain ($dnslist_value); \
32886                 see $dnslist_text.
32887 .endd
32888 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32889 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32890 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32891 of expanding the condition might be something like this:
32892 .code
32893 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32894 .endd
32895 Thus, this example checks whether or not the IP addresses of the sender
32896 domain's mail servers are on the Spamhaus black list.
32897
32898 The key that was used for a successful DNS list lookup is put into the variable
32899 &$dnslist_matched$& (see section &<<SECID204>>&).
32900
32901
32902
32903
32904 .subsection "Data returned by DNS lists" SECID203
32905 .cindex "DNS list" "data returned from"
32906 DNS lists are constructed using address records in the DNS. The original RBL
32907 just used the address 127.0.0.1 on the right hand side of each record, but the
32908 RBL+ list and some other lists use a number of values with different meanings.
32909 The values used on the RBL+ list are:
32910 .itable none 0 0 2 20* left 80* left
32911 .irow 127.1.0.1  "RBL"
32912 .irow 127.1.0.2  "DUL"
32913 .irow 127.1.0.3  "DUL and RBL"
32914 .irow 127.1.0.4  "RSS"
32915 .irow 127.1.0.5  "RSS and RBL"
32916 .irow 127.1.0.6  "RSS and DUL"
32917 .irow 127.1.0.7  "RSS and DUL and RBL"
32918 .endtable
32919 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32920 different values. Some DNS lists may return more than one address record;
32921 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32922
32923 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32924 range. If a DNSBL operator loses control of the domain, lookups on it
32925 may start returning other addresses.  Because of this, Exim now ignores
32926 returned values outside the 127/8 region.
32927
32928
32929 .subsection "Variables set from DNS lists" SECID204
32930 .cindex "expansion" "variables, set from DNS list"
32931 .cindex "DNS list" "variables set from"
32932 .vindex "&$dnslist_domain$&"
32933 .vindex "&$dnslist_matched$&"
32934 .vindex "&$dnslist_text$&"
32935 .vindex "&$dnslist_value$&"
32936 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32937 the name of the overall domain that matched (for example,
32938 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32939 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32940 the DNS record. When the key is an IP address, it is not reversed in
32941 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32942 cases, for example:
32943 .code
32944 deny dnslists = spamhaus.example
32945 .endd
32946 the key is also available in another variable (in this case,
32947 &$sender_host_address$&). In more complicated cases, however, this is not true.
32948 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32949 might generate a dnslists lookup like this:
32950 .code
32951 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32952 .endd
32953 If this condition succeeds, the value in &$dnslist_matched$& might be
32954 &`192.168.6.7`& (for example).
32955
32956 If more than one address record is returned by the DNS lookup, all the IP
32957 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32958 The variable &$dnslist_text$& contains the contents of any associated TXT
32959 record. For lists such as RBL+ the TXT record for a merged entry is often not
32960 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32961 information.
32962
32963 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32964 &-- even if these appear before the condition in the ACL, they are not
32965 expanded until after it has failed. For example:
32966 .code
32967 deny    hosts = !+local_networks
32968         message = $sender_host_address is listed \
32969                   at $dnslist_domain
32970         dnslists = rbl-plus.mail-abuse.example
32971 .endd
32972
32973
32974
32975 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32976 .cindex "DNS list" "matching specific returned data"
32977 You can add an equals sign and an IP address after a &%dnslists%& domain name
32978 in order to restrict its action to DNS records with a matching right hand side.
32979 For example,
32980 .code
32981 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32982 .endd
32983 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32984 any address record is considered to be a match. For the moment, we assume
32985 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32986 describes how multiple records are handled.
32987
32988 More than one IP address may be given for checking, using a comma as a
32989 separator. These are alternatives &-- if any one of them matches, the
32990 &%dnslists%& condition is true. For example:
32991 .code
32992 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32993 .endd
32994 If you want to specify a constraining address list and also specify names or IP
32995 addresses to be looked up, the constraining address list must be specified
32996 first. For example:
32997 .code
32998 deny dnslists = dsn.rfc-ignorant.org\
32999                 =127.0.0.2/$sender_address_domain
33000 .endd
33001
33002 If the character &`&&`& is used instead of &`=`&, the comparison for each
33003 listed IP address is done by a bitwise &"and"& instead of by an equality test.
33004 In other words, the listed addresses are used as bit masks. The comparison is
33005 true if all the bits in the mask are present in the address that is being
33006 tested. For example:
33007 .code
33008 dnslists = a.b.c&0.0.0.3
33009 .endd
33010 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
33011 want to test whether one bit or another bit is present (as opposed to both
33012 being present), you must use multiple values. For example:
33013 .code
33014 dnslists = a.b.c&0.0.0.1,0.0.0.2
33015 .endd
33016 matches if the final component of the address is an odd number or two times
33017 an odd number.
33018
33019
33020
33021 .subsection "Negated DNS matching conditions" SECID205
33022 You can supply a negative list of IP addresses as part of a &%dnslists%&
33023 condition. Whereas
33024 .code
33025 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33026 .endd
33027 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33028 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
33029 .code
33030 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
33031 .endd
33032 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33033 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
33034 words, the result of the test is inverted if an exclamation mark appears before
33035 the &`=`& (or the &`&&`&) sign.
33036
33037 &*Note*&: This kind of negation is not the same as negation in a domain,
33038 host, or address list (which is why the syntax is different).
33039
33040 If you are using just one list, the negation syntax does not gain you much. The
33041 previous example is precisely equivalent to
33042 .code
33043 deny  dnslists = a.b.c
33044      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33045 .endd
33046 However, if you are using multiple lists, the negation syntax is clearer.
33047 Consider this example:
33048 .code
33049 deny  dnslists = sbl.spamhaus.org : \
33050                  list.dsbl.org : \
33051                  dnsbl.njabl.org!=127.0.0.3 : \
33052                  relays.ordb.org
33053 .endd
33054 Using only positive lists, this would have to be:
33055 .code
33056 deny  dnslists = sbl.spamhaus.org : \
33057                  list.dsbl.org
33058 deny  dnslists = dnsbl.njabl.org
33059      !dnslists = dnsbl.njabl.org=127.0.0.3
33060 deny  dnslists = relays.ordb.org
33061 .endd
33062 which is less clear, and harder to maintain.
33063
33064 Negation can also be used with a bitwise-and restriction.
33065 The dnslists condition with only be trus if a result is returned
33066 by the lookup which, anded with the restriction, is all zeroes.
33067 For example:
33068 .code
33069 deny dnslists = zen.spamhaus.org!&0.255.255.0
33070 .endd
33071
33072
33073
33074
33075 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33076 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33077 thereby providing more than one IP address. When an item in a &%dnslists%& list
33078 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33079 the match to specific results from the DNS lookup, there are two ways in which
33080 the checking can be handled. For example, consider the condition:
33081 .code
33082 dnslists = a.b.c=127.0.0.1
33083 .endd
33084 What happens if the DNS lookup for the incoming IP address yields both
33085 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33086 condition true because at least one given value was found, or is it false
33087 because at least one of the found values was not listed? And how does this
33088 affect negated conditions? Both possibilities are provided for with the help of
33089 additional separators &`==`& and &`=&&`&.
33090
33091 .ilist
33092 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33093 IP addresses matches one of the listed addresses. For the example above, the
33094 condition is true because 127.0.0.1 matches.
33095 .next
33096 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33097 looked up IP addresses matches one of the listed addresses. If the condition is
33098 changed to:
33099 .code
33100 dnslists = a.b.c==127.0.0.1
33101 .endd
33102 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33103 false because 127.0.0.2 is not listed. You would need to have:
33104 .code
33105 dnslists = a.b.c==127.0.0.1,127.0.0.2
33106 .endd
33107 for the condition to be true.
33108 .endlist
33109
33110 When &`!`& is used to negate IP address matching, it inverts the result, giving
33111 the precise opposite of the behaviour above. Thus:
33112 .ilist
33113 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33114 addresses matches one of the listed addresses. Consider:
33115 .code
33116 dnslists = a.b.c!&0.0.0.1
33117 .endd
33118 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33119 false because 127.0.0.1 matches.
33120 .next
33121 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33122 looked up IP address that does not match. Consider:
33123 .code
33124 dnslists = a.b.c!=&0.0.0.1
33125 .endd
33126 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33127 true, because 127.0.0.2 does not match. You would need to have:
33128 .code
33129 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33130 .endd
33131 for the condition to be false.
33132 .endlist
33133 When the DNS lookup yields only a single IP address, there is no difference
33134 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33135
33136
33137
33138
33139 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33140 .cindex "DNS list" "information from merged"
33141 When the facility for restricting the matching IP values in a DNS list is used,
33142 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33143 the true reason for rejection. This happens when lists are merged and the IP
33144 address in the A record is used to distinguish them; unfortunately there is
33145 only one TXT record. One way round this is not to use merged lists, but that
33146 can be inefficient because it requires multiple DNS lookups where one would do
33147 in the vast majority of cases when the host of interest is not on any of the
33148 lists.
33149
33150 A less inefficient way of solving this problem is available. If
33151 two domain names, comma-separated, are given, the second is used first to
33152 do an initial check, making use of any IP value restrictions that are set.
33153 If there is a match, the first domain is used, without any IP value
33154 restrictions, to get the TXT record. As a byproduct of this, there is also
33155 a check that the IP being tested is indeed on the first list. The first
33156 domain is the one that is put in &$dnslist_domain$&. For example:
33157 .code
33158 deny   dnslists = \
33159          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33160          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33161        message  = \
33162          rejected because $sender_host_address is blacklisted \
33163          at $dnslist_domain\n$dnslist_text
33164 .endd
33165 For the first blacklist item, this starts by doing a lookup in
33166 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33167 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33168 value, and as long as something is found, it looks for the corresponding TXT
33169 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33170 The second blacklist item is processed similarly.
33171
33172 If you are interested in more than one merged list, the same list must be
33173 given several times, but because the results of the DNS lookups are cached,
33174 the DNS calls themselves are not repeated. For example:
33175 .code
33176 deny dnslists = \
33177          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33178          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33179          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33180          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33181 .endd
33182 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33183 values matches (or if no record is found), this is the only lookup that is
33184 done. Only if there is a match is one of the more specific lists consulted.
33185
33186
33187
33188 .subsection "DNS lists and IPv6" SECTmorednslistslast
33189 .cindex "IPv6" "DNS black lists"
33190 .cindex "DNS list" "IPv6 usage"
33191 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33192 nibble by nibble. For example, if the calling host's IP address is
33193 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33194 .code
33195 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33196   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33197 .endd
33198 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33199 lists contain wildcard records, intended for IPv4, that interact badly with
33200 IPv6. For example, the DNS entry
33201 .code
33202 *.3.some.list.example.    A    127.0.0.1
33203 .endd
33204 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33205 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33206
33207 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33208 &%condition%& condition, as in this example:
33209 .code
33210 deny   condition = ${if isip4{$sender_host_address}}
33211        dnslists  = some.list.example
33212 .endd
33213
33214 If an explicit key is being used for a DNS lookup and it may be an IPv6
33215 address you should specify alternate list separators for both the outer
33216 (DNS list name) list and inner (lookup keys) list:
33217 .code
33218        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33219 .endd
33220
33221
33222 .section "Previously seen user and hosts" "SECTseen"
33223 .cindex "&%seen%& ACL condition"
33224 .cindex greylisting
33225 The &%seen%& ACL condition can be used to test whether a
33226 situation has been previously met.
33227 It uses a hints database to record a timestamp against a key.
33228 The syntax of the condition is:
33229 .display
33230 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33231 .endd
33232
33233 For example,
33234 .code
33235 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33236 .endd
33237 in a RCPT ACL will implement simple greylisting.
33238
33239 The parameters for the condition are
33240 a possible minus sign,
33241 then an interval,
33242 then, slash-separated, a list of options.
33243 The interval is taken as an offset before the current time,
33244 and used for the test.
33245 If the interval is preceded by a minus sign then the condition returns
33246 whether a record is found which is before the test time.
33247 Otherwise, the condition returns whether one is found which is since the
33248 test time.
33249
33250 Options are read in order with later ones overriding earlier ones.
33251
33252 The default key is &$sender_host_address$&.
33253 An explicit key can be set using a &%key=value%& option.
33254
33255 If a &%readonly%& option is given then
33256 no record create or update is done.
33257 If a &%write%& option is given then
33258 a record create or update is always done.
33259 An update is done if the test is for &"since"&.
33260 If none of those hold and there was no existing record,
33261 a record is created.
33262
33263 Creates and updates are marked with the current time.
33264
33265 Finally, a &"before"& test which succeeds, and for which the record
33266 is old enough, will be refreshed with a timestamp of the test time.
33267 This can prevent tidying of the database from removing the entry.
33268 The interval for this is, by default, 10 days.
33269 An explicit interval can be set using a
33270 &%refresh=value%& option.
33271
33272 Note that &"seen"& should be added to the list of hints databases
33273 for maintenance if this ACL condition is used.
33274
33275
33276 .section "Rate limiting incoming messages" "SECTratelimiting"
33277 .cindex "rate limiting" "client sending"
33278 .cindex "limiting client sending rates"
33279 .oindex "&%smtp_ratelimit_*%&"
33280 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33281 which clients can send email. This is more powerful than the
33282 &%smtp_ratelimit_*%& options, because those options control the rate of
33283 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33284 works across all connections (concurrent and sequential) from the same client
33285 host. The syntax of the &%ratelimit%& condition is:
33286 .display
33287 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33288 .endd
33289 If the average client sending rate is less than &'m'& messages per time
33290 period &'p'& then the condition is false; otherwise it is true.
33291
33292 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33293 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33294 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33295 of &'p'&.
33296
33297 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33298 time interval, for example, &`8h`& for eight hours. A larger time constant
33299 means that it takes Exim longer to forget a client's past behaviour. The
33300 parameter &'m'& is the maximum number of messages that a client is permitted to
33301 send in each time interval. It also specifies the number of messages permitted
33302 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33303 constant, you can allow a client to send more messages in a burst without
33304 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33305 both small, messages must be sent at an even rate.
33306
33307 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33308 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33309 when deploying the &%ratelimit%& ACL condition. The script prints usage
33310 instructions when it is run with no arguments.
33311
33312 The key is used to look up the data for calculating the client's average
33313 sending rate. This data is stored in Exim's spool directory, alongside the
33314 retry and other hints databases. The default key is &$sender_host_address$&,
33315 which means Exim computes the sending rate of each client host IP address.
33316 By changing the key you can change how Exim identifies clients for the purpose
33317 of ratelimiting. For example, to limit the sending rate of each authenticated
33318 user, independent of the computer they are sending from, set the key to
33319 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33320 example, &$authenticated_id$& is only meaningful if the client has
33321 authenticated (which you can check with the &%authenticated%& ACL condition).
33322
33323 The lookup key does not have to identify clients: If you want to limit the
33324 rate at which a recipient receives messages, you can use the key
33325 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33326 ACL.
33327
33328 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33329 specifies what Exim measures the rate of, for example, messages or recipients
33330 or bytes. You can adjust the measurement using the &%unique=%& and/or
33331 &%count=%& options. You can also control when Exim updates the recorded rate
33332 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33333 separated by a slash, like the other parameters. They may appear in any order.
33334
33335 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33336 any options that alter the meaning of the stored data. The limit &'m'& is not
33337 stored, so you can alter the configured maximum rate and Exim will still
33338 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33339 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33340 behaviour. The lookup key is not affected by changes to the update mode and
33341 the &%count=%& option.
33342
33343
33344 .subsection "Ratelimit options for what is being measured" ratoptmea
33345 .cindex "rate limiting" "per_* options"
33346 .vlist
33347 .vitem per_conn
33348 .cindex "rate limiting" per_conn
33349 This option limits the client's connection rate. It is not
33350 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33351 &%acl_not_smtp_start%& ACLs.
33352
33353 .vitem per_mail
33354 .cindex "rate limiting" per_conn
33355 This option limits the client's rate of sending messages. This is
33356 the default if none of the &%per_*%& options is specified. It can be used in
33357 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33358 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33359
33360 .vitem per_byte
33361 .cindex "rate limiting" per_conn
33362 This option limits the sender's email bandwidth. It can be used in
33363 the same ACLs as the &%per_mail%& option, though it is best to use this option
33364 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33365 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33366 in its MAIL command, which may be inaccurate or completely missing. You can
33367 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33368 in kilobytes, megabytes, or gigabytes, respectively.
33369
33370 .vitem per_rcpt
33371 .cindex "rate limiting" per_rcpt
33372 This option causes Exim to limit the rate at which recipients are
33373 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33374 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33375 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33376 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33377 in either case the rate limiting engine will see a message with many
33378 recipients as a large high-speed burst.
33379
33380 .vitem per_addr
33381 .cindex "rate limiting" per_addr
33382 This option is like the &%per_rcpt%& option, except it counts the
33383 number of different recipients that the client has sent messages to in the
33384 last time period. That is, if the client repeatedly sends messages to the same
33385 recipient, its measured rate is not increased. This option can only be used in
33386 &%acl_smtp_rcpt%&.
33387
33388 .vitem per_cmd
33389 .cindex "rate limiting" per_cmd
33390 This option causes Exim to recompute the rate every time the
33391 condition is processed. This can be used to limit the rate of any SMTP
33392 command. If it is used in multiple ACLs it can limit the aggregate rate of
33393 multiple different commands.
33394
33395 .vitem count
33396 .cindex "rate limiting" count
33397 This option can be used to alter how much Exim adds to the client's
33398 measured rate.
33399 A value is required, after an equals sign.
33400 For example, the &%per_byte%& option is equivalent to
33401 &`per_mail/count=$message_size`&.
33402 If there is no &%count=%& option, Exim
33403 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33404 other than &%acl_smtp_rcpt%&).
33405 The count does not have to be an integer.
33406
33407 .vitem unique
33408 .cindex "rate limiting" unique
33409 This option is described in section &<<ratoptuniq>>& below.
33410 .endlist
33411
33412
33413 .subsection "Ratelimit update modes" ratoptupd
33414 .cindex "rate limiting" "reading data without updating"
33415 You can specify one of three options with the &%ratelimit%& condition to
33416 control when its database is updated. This section describes the &%readonly%&
33417 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33418
33419 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33420 previously-computed rate to check against the limit.
33421
33422 For example, you can test the client's sending rate and deny it access (when
33423 it is too fast) in the connect ACL. If the client passes this check then it
33424 can go on to send a message, in which case its recorded rate will be updated
33425 in the MAIL ACL. Subsequent connections from the same client will check this
33426 new rate.
33427 .code
33428 acl_check_connect:
33429  deny ratelimit = 100 / 5m / readonly
33430       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33431                   (max $sender_rate_limit)
33432 # ...
33433 acl_check_mail:
33434  warn ratelimit = 100 / 5m / strict
33435       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33436                   (max $sender_rate_limit)
33437 .endd
33438
33439 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33440 processing a message then it may increase the client's measured rate more than
33441 it should. For example, this will happen if you check the &%per_rcpt%& option
33442 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33443 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33444 multiple update problems by using the &%readonly%& option on later ratelimit
33445 checks.
33446
33447 The &%per_*%& options described above do not make sense in some ACLs. If you
33448 use a &%per_*%& option in an ACL where it is not normally permitted then the
33449 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33450 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33451 next section) so you must specify the &%readonly%& option explicitly.
33452
33453
33454 .subsection "Ratelimit options for handling fast clients" ratoptfast
33455 .cindex "rate limiting" "strict and leaky modes"
33456 If a client's average rate is greater than the maximum, the rate limiting
33457 engine can react in two possible ways, depending on the presence of the
33458 &%strict%& or &%leaky%& update modes. This is independent of the other
33459 counter-measures (such as rejecting the message) that may be specified by the
33460 rest of the ACL.
33461
33462 The &%leaky%& (default) option means that the client's recorded rate is not
33463 updated if it is above the limit. The effect of this is that Exim measures the
33464 client's average rate of successfully sent email,
33465 up to the given limit.
33466 This is appropriate if the countermeasure when the condition is true
33467 consists of refusing the message, and
33468 is generally the better choice if you have clients that retry automatically.
33469 If the action when true is anything more complex then this option is
33470 likely not what is wanted.
33471
33472 The &%strict%& option means that the client's recorded rate is always
33473 updated. The effect of this is that Exim measures the client's average rate
33474 of attempts to send email, which can be much higher than the maximum it is
33475 actually allowed. If the client is over the limit it may be subjected to
33476 counter-measures by the ACL. It must slow down and allow sufficient time to
33477 pass that its computed rate falls below the maximum before it can send email
33478 again. The time (the number of smoothing periods) it must wait and not
33479 attempt to send mail can be calculated with this formula:
33480 .code
33481         ln(peakrate/maxrate)
33482 .endd
33483
33484
33485 .subsection "Limiting the rate of different events" ratoptuniq
33486 .cindex "rate limiting" "counting unique events"
33487 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33488 rate of different events. For example, the &%per_addr%& option uses this
33489 mechanism to count the number of different recipients that the client has
33490 sent messages to in the last time period; it is equivalent to
33491 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33492 measure the rate that a client uses different sender addresses with the
33493 options &`per_mail/unique=$sender_address`&.
33494
33495 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33496 has seen for that key. The whole set is thrown away when it is older than the
33497 rate smoothing period &'p'&, so each different event is counted at most once
33498 per period. In the &%leaky%& update mode, an event that causes the client to
33499 go over the limit is not added to the set, in the same way that the client's
33500 recorded rate is not updated in the same situation.
33501
33502 When you combine the &%unique=%& and &%readonly%& options, the specific
33503 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33504 rate.
33505
33506 The &%unique=%& mechanism needs more space in the ratelimit database than the
33507 other &%ratelimit%& options in order to store the event set. The number of
33508 unique values is potentially as large as the rate limit, so the extra space
33509 required increases with larger limits.
33510
33511 The uniqueification is not perfect: there is a small probability that Exim
33512 will think a new event has happened before. If the sender's rate is less than
33513 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33514 the measured rate can go above the limit, in which case Exim may under-count
33515 events by a significant margin. Fortunately, if the rate is high enough (2.7
33516 times the limit) that the false positive rate goes above 9%, then Exim will
33517 throw away the over-full event set before the measured rate falls below the
33518 limit. Therefore the only harm should be that exceptionally high sending rates
33519 are logged incorrectly; any countermeasures you configure will be as effective
33520 as intended.
33521
33522
33523 .subsection "Using rate limiting" useratlim
33524 Exim's other ACL facilities are used to define what counter-measures are taken
33525 when the rate limit is exceeded. This might be anything from logging a warning
33526 (for example, while measuring existing sending rates in order to define
33527 policy), through time delays to slow down fast senders, up to rejecting the
33528 message. For example:
33529 .code
33530 # Log all senders' rates
33531 warn ratelimit = 0 / 1h / strict
33532      log_message = Sender rate $sender_rate / $sender_rate_period
33533
33534 # Slow down fast senders; note the need to truncate $sender_rate
33535 # at the decimal point.
33536 warn ratelimit = 100 / 1h / per_rcpt / strict
33537      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33538                    $sender_rate_limit }s
33539
33540 # Keep authenticated users under control
33541 deny authenticated = *
33542      ratelimit = 100 / 1d / strict / $authenticated_id
33543
33544 # System-wide rate limit
33545 defer ratelimit = 10 / 1s / $primary_hostname
33546       message = Sorry, too busy. Try again later.
33547
33548 # Restrict incoming rate from each host, with a default
33549 # set using a macro and special cases looked up in a table.
33550 defer ratelimit = ${lookup {$sender_host_address} \
33551                    cdb {DB/ratelimits.cdb} \
33552                    {$value} {RATELIMIT} }
33553       message = Sender rate exceeds $sender_rate_limit \
33554                messages per $sender_rate_period
33555 .endd
33556 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33557 especially with the &%per_rcpt%& option, you may suffer from a performance
33558 bottleneck caused by locking on the ratelimit hints database. Apart from
33559 making your ACLs less complicated, you can reduce the problem by using a
33560 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33561 this means that Exim will lose its hints data after a reboot (including retry
33562 hints, the callout cache, and ratelimit data).
33563
33564
33565
33566 .section "Address verification" "SECTaddressverification"
33567 .cindex "verifying address" "options for"
33568 .cindex "policy control" "address verification"
33569 Several of the &%verify%& conditions described in section
33570 &<<SECTaclconditions>>& cause addresses to be verified. Section
33571 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33572 The verification conditions can be followed by options that modify the
33573 verification process. The options are separated from the keyword and from each
33574 other by slashes, and some of them contain parameters. For example:
33575 .code
33576 verify = sender/callout
33577 verify = recipient/defer_ok/callout=10s,defer_ok
33578 .endd
33579 The first stage of address verification, which always happens, is to run the
33580 address through the routers, in &"verify mode"&. Routers can detect the
33581 difference between verification and routing for delivery, and their actions can
33582 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33583 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33584 The available options are as follows:
33585
33586 .ilist
33587 If the &%callout%& option is specified, successful routing to one or more
33588 remote hosts is followed by a &"callout"& to those hosts as an additional
33589 check. Callouts and their sub-options are discussed in the next section.
33590 .next
33591 If there is a defer error while doing verification routing, the ACL
33592 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33593 options, the condition is forced to be true instead. Note that this is a main
33594 verification option as well as a suboption for callouts.
33595 .next
33596 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33597 discusses the reporting of sender address verification failures.
33598 .next
33599 The &%success_on_redirect%& option causes verification always to succeed
33600 immediately after a successful redirection. By default, if a redirection
33601 generates just one address, that address is also verified. See further
33602 discussion in section &<<SECTredirwhilveri>>&.
33603 .next
33604 If the &%quota%& option is specified for recipient verify,
33605 successful routing to an appendfile transport is followed by a call into
33606 the transport to evaluate the quota status for the recipient.
33607 No actual delivery is done, but verification will succeed if the quota
33608 is sufficient for the message (if the sender gave a message size) or
33609 not already exceeded (otherwise).
33610 .endlist
33611
33612 .cindex "verifying address" "differentiating failures"
33613 .vindex "&$recipient_verify_failure$&"
33614 .vindex "&$sender_verify_failure$&"
33615 .vindex "&$acl_verify_message$&"
33616 After an address verification failure, &$acl_verify_message$& contains the
33617 error message that is associated with the failure. It can be preserved by
33618 coding like this:
33619 .code
33620 warn  !verify = sender
33621        set acl_m0 = $acl_verify_message
33622 .endd
33623 If you are writing your own custom rejection message or log message when
33624 denying access, you can use this variable to include information about the
33625 verification failure.
33626 This variable is cleared at the end of processing the ACL verb.
33627
33628 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33629 appropriate) contains one of the following words:
33630
33631 .ilist
33632 &%qualify%&: The address was unqualified (no domain), and the message
33633 was neither local nor came from an exempted host.
33634 .next
33635 &%route%&: Routing failed.
33636 .next
33637 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33638 occurred at or before the MAIL command (that is, on initial
33639 connection, HELO, or MAIL).
33640 .next
33641 &%recipient%&: The RCPT command in a callout was rejected.
33642 .next
33643 &%postmaster%&: The postmaster check in a callout was rejected.
33644 .next
33645 &%quota%&: The quota check for a local recipient did non pass.
33646 .endlist
33647
33648 The main use of these variables is expected to be to distinguish between
33649 rejections of MAIL and rejections of RCPT in callouts.
33650
33651 The above variables may also be set after a &*successful*&
33652 address verification to:
33653
33654 .ilist
33655 &%random%&: A random local-part callout succeeded
33656 .endlist
33657
33658
33659
33660
33661 .section "Callout verification" "SECTcallver"
33662 .cindex "verifying address" "by callout"
33663 .cindex "callout" "verification"
33664 .cindex "SMTP" "callout verification"
33665 For non-local addresses, routing verifies the domain, but is unable to do any
33666 checking of the local part. There are situations where some means of verifying
33667 the local part is desirable. One way this can be done is to make an SMTP
33668 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33669 a subsequent host for a recipient address, to see if the host accepts the
33670 address. We use the term &'callout'& to cover both cases. Note that for a
33671 sender address, the callback is not to the client host that is trying to
33672 deliver the message, but to one of the hosts that accepts incoming mail for the
33673 sender's domain.
33674
33675 Exim does not do callouts by default. If you want them to happen, you must
33676 request them by setting appropriate options on the &%verify%& condition, as
33677 described below. This facility should be used with care, because it can add a
33678 lot of resource usage to the cost of verifying an address. However, Exim does
33679 cache the results of callouts, which helps to reduce the cost. Details of
33680 caching are in section &<<SECTcallvercache>>&.
33681
33682 Recipient callouts are usually used only between hosts that are controlled by
33683 the same administration. For example, a corporate gateway host could use
33684 callouts to check for valid recipients on an internal mailserver. A successful
33685 callout does not guarantee that a real delivery to the address would succeed;
33686 on the other hand, a failing callout does guarantee that a delivery would fail.
33687
33688 If the &%callout%& option is present on a condition that verifies an address, a
33689 second stage of verification occurs if the address is successfully routed to
33690 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33691 &(manualroute)& router, where the router specifies the hosts. However, if a
33692 router that does not set up hosts routes to an &(smtp)& transport with a
33693 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33694 &%hosts_override%& set, its hosts are always used, whether or not the router
33695 supplies a host list.
33696 Callouts are only supported on &(smtp)& transports.
33697
33698 The port that is used is taken from the transport, if it is specified and is a
33699 remote transport. (For routers that do verification only, no transport need be
33700 specified.) Otherwise, the default SMTP port is used. If a remote transport
33701 specifies an outgoing interface, this is used; otherwise the interface is not
33702 specified. Likewise, the text that is used for the HELO command is taken from
33703 the transport's &%helo_data%& option; if there is no transport, the value of
33704 &$smtp_active_hostname$& is used.
33705
33706 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33707 test whether a bounce message could be delivered to the sender address. The
33708 following SMTP commands are sent:
33709 .display
33710 &`HELO `&<&'local host name'&>
33711 &`MAIL FROM:<>`&
33712 &`RCPT TO:`&<&'the address to be tested'&>
33713 &`QUIT`&
33714 .endd
33715 LHLO is used instead of HELO if the transport's &%protocol%& option is
33716 set to &"lmtp"&.
33717
33718 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33719 settings.
33720
33721 A recipient callout check is similar. By default, it also uses an empty address
33722 for the sender. This default is chosen because most hosts do not make use of
33723 the sender address when verifying a recipient. Using the same address means
33724 that a single cache entry can be used for each recipient. Some sites, however,
33725 do make use of the sender address when verifying. These are catered for by the
33726 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33727
33728 If the response to the RCPT command is a 2&'xx'& code, the verification
33729 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33730 Exim tries the next host, if any. If there is a problem with all the remote
33731 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33732 &%callout%& option is given, in which case the condition is forced to succeed.
33733
33734 .cindex "SMTP" "output flushing, disabling for callout"
33735 A callout may take a little time. For this reason, Exim normally flushes SMTP
33736 output before performing a callout in an ACL, to avoid unexpected timeouts in
33737 clients when the SMTP PIPELINING extension is in use. The flushing can be
33738 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33739
33740 .cindex "tainted data" "de-tainting"
33741 .cindex "de-tainting" "using recipient verify"
33742 A recipient callout which gets a 2&'xx'& code
33743 will assign untainted values to the
33744 &$domain_data$& and &$local_part_data$& variables,
33745 corresponding to the domain and local parts of the recipient address.
33746
33747
33748
33749
33750 .subsection "Additional parameters for callouts" CALLaddparcall
33751 .cindex "callout" "additional parameters for"
33752 The &%callout%& option can be followed by an equals sign and a number of
33753 optional parameters, separated by commas. For example:
33754 .code
33755 verify = recipient/callout=10s,defer_ok
33756 .endd
33757 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33758 separate verify options, is retained for backwards compatibility, but is now
33759 deprecated. The additional parameters for &%callout%& are as follows:
33760
33761
33762 .vlist
33763 .vitem <&'a&~time&~interval'&>
33764 .cindex "callout" "timeout, specifying"
33765 This specifies the timeout that applies for the callout attempt to each host.
33766 For example:
33767 .code
33768 verify = sender/callout=5s
33769 .endd
33770 The default is 30 seconds. The timeout is used for each response from the
33771 remote host. It is also used for the initial connection, unless overridden by
33772 the &%connect%& parameter.
33773
33774
33775 .vitem &*connect&~=&~*&<&'time&~interval'&>
33776 .cindex "callout" "connection timeout, specifying"
33777 This parameter makes it possible to set a different (usually smaller) timeout
33778 for making the SMTP connection. For example:
33779 .code
33780 verify = sender/callout=5s,connect=1s
33781 .endd
33782 If not specified, this timeout defaults to the general timeout value.
33783
33784 .vitem &*defer_ok*&
33785 .cindex "callout" "defer, action on"
33786 When this parameter is present, failure to contact any host, or any other kind
33787 of temporary error, is treated as success by the ACL. However, the cache is not
33788 updated in this circumstance.
33789
33790 .vitem &*fullpostmaster*&
33791 .cindex "callout" "full postmaster check"
33792 This operates like the &%postmaster%& option (see below), but if the check for
33793 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33794 accordance with the specification in RFC 2821. The RFC states that the
33795 unqualified address &'postmaster'& should be accepted.
33796
33797
33798 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33799 .cindex "callout" "sender when verifying header"
33800 When verifying addresses in header lines using the &%header_sender%&
33801 verification option, Exim behaves by default as if the addresses are envelope
33802 sender addresses from a message. Callout verification therefore tests to see
33803 whether a bounce message could be delivered, by using an empty address in the
33804 MAIL command. However, it is arguable that these addresses might never be used
33805 as envelope senders, and could therefore justifiably reject bounce messages
33806 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33807 address to use in the MAIL command. For example:
33808 .code
33809 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33810 .endd
33811 This parameter is available only for the &%header_sender%& verification option.
33812
33813
33814 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33815 .cindex "callout" "overall timeout, specifying"
33816 This parameter sets an overall timeout for performing a callout verification.
33817 For example:
33818 .code
33819 verify = sender/callout=5s,maxwait=30s
33820 .endd
33821 This timeout defaults to four times the callout timeout for individual SMTP
33822 commands. The overall timeout applies when there is more than one host that can
33823 be tried. The timeout is checked before trying the next host. This prevents
33824 very long delays if there are a large number of hosts and all are timing out
33825 (for example, when network connections are timing out).
33826
33827
33828 .vitem &*no_cache*&
33829 .cindex "callout" "cache, suppressing"
33830 .cindex "caching callout, suppressing"
33831 When this parameter is given, the callout cache is neither read nor updated.
33832
33833 .vitem &*postmaster*&
33834 .cindex "callout" "postmaster; checking"
33835 When this parameter is set, a successful callout check is followed by a similar
33836 check for the local part &'postmaster'& at the same domain. If this address is
33837 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33838 the postmaster check is recorded in a cache record; if it is a failure, this is
33839 used to fail subsequent callouts for the domain without a connection being
33840 made, until the cache record expires.
33841
33842 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33843 The postmaster check uses an empty sender in the MAIL command by default.
33844 You can use this parameter to do a postmaster check using a different address.
33845 For example:
33846 .code
33847 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33848 .endd
33849 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33850 one overrides. The &%postmaster%& parameter is equivalent to this example:
33851 .code
33852 require  verify = sender/callout=postmaster_mailfrom=
33853 .endd
33854 &*Warning*&: The caching arrangements for postmaster checking do not take
33855 account of the sender address. It is assumed that either the empty address or
33856 a fixed non-empty address will be used. All that Exim remembers is that the
33857 postmaster check for the domain succeeded or failed.
33858
33859
33860 .vitem &*random*&
33861 .cindex "callout" "&""random""& check"
33862 When this parameter is set, before doing the normal callout check, Exim does a
33863 check for a &"random"& local part at the same domain. The local part is not
33864 really random &-- it is defined by the expansion of the option
33865 &%callout_random_local_part%&, which defaults to
33866 .code
33867 $primary_hostname-$tod_epoch-testing
33868 .endd
33869 The idea here is to try to determine whether the remote host accepts all local
33870 parts without checking. If it does, there is no point in doing callouts for
33871 specific local parts. If the &"random"& check succeeds, the result is saved in
33872 a cache record, and used to force the current and subsequent callout checks to
33873 succeed without a connection being made, until the cache record expires.
33874
33875 .vitem &*use_postmaster*&
33876 .cindex "callout" "sender for recipient check"
33877 This parameter applies to recipient callouts only. For example:
33878 .code
33879 deny  !verify = recipient/callout=use_postmaster
33880 .endd
33881 .vindex "&$qualify_domain$&"
33882 It causes a non-empty postmaster address to be used in the MAIL command when
33883 performing the callout for the recipient, and also for a &"random"& check if
33884 that is configured. The local part of the address is &`postmaster`& and the
33885 domain is the contents of &$qualify_domain$&.
33886
33887 .vitem &*use_sender*&
33888 This option applies to recipient callouts only. For example:
33889 .code
33890 require  verify = recipient/callout=use_sender
33891 .endd
33892 It causes the message's actual sender address to be used in the MAIL
33893 command when performing the callout, instead of an empty address. There is no
33894 need to use this option unless you know that the called hosts make use of the
33895 sender when checking recipients. If used indiscriminately, it reduces the
33896 usefulness of callout caching.
33897
33898 .vitem &*hold*&
33899 This option applies to recipient callouts only. For example:
33900 .code
33901 require  verify = recipient/callout=use_sender,hold
33902 .endd
33903 It causes the connection to be held open and used for any further recipients
33904 and for eventual delivery (should that be done quickly).
33905 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33906 when that is used for the connections.
33907 The advantage is only gained if there are no callout cache hits
33908 (which could be enforced by the no_cache option),
33909 if the use_sender option is used,
33910 if neither the random nor the use_postmaster option is used,
33911 and if no other callouts intervene.
33912 .endlist
33913
33914 If you use any of the parameters that set a non-empty sender for the MAIL
33915 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33916 &%use_sender%&), you should think about possible loops. Recipient checking is
33917 usually done between two hosts that are under the same management, and the host
33918 that receives the callouts is not normally configured to do callouts itself.
33919 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33920 these circumstances.
33921
33922 However, if you use a non-empty sender address for a callout to an arbitrary
33923 host, there is the likelihood that the remote host will itself initiate a
33924 callout check back to your host. As it is checking what appears to be a message
33925 sender, it is likely to use an empty address in MAIL, thus avoiding a
33926 callout loop. However, to be on the safe side it would be best to set up your
33927 own ACLs so that they do not do sender verification checks when the recipient
33928 is the address you use for header sender or postmaster callout checking.
33929
33930 Another issue to think about when using non-empty senders for callouts is
33931 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33932 by the sender/recipient combination; thus, for any given recipient, many more
33933 actual callouts are performed than when an empty sender or postmaster is used.
33934
33935
33936
33937
33938 .subsection "Callout caching" SECTcallvercache
33939 .cindex "hints database" "callout cache"
33940 .cindex "callout" "cache, description of"
33941 .cindex "caching" "callout"
33942 Exim caches the results of callouts in order to reduce the amount of resources
33943 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33944 option. A hints database called &"callout"& is used for the cache. Two
33945 different record types are used: one records the result of a callout check for
33946 a specific address, and the other records information that applies to the
33947 entire domain (for example, that it accepts the local part &'postmaster'&).
33948
33949 When an original callout fails, a detailed SMTP error message is given about
33950 the failure. However, for subsequent failures that use the cache data, this message
33951 is not available.
33952
33953 The expiry times for negative and positive address cache records are
33954 independent, and can be set by the global options &%callout_negative_expire%&
33955 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33956
33957 If a host gives a negative response to an SMTP connection, or rejects any
33958 commands up to and including
33959 .code
33960 MAIL FROM:<>
33961 .endd
33962 (but not including the MAIL command with a non-empty address),
33963 any callout attempt is bound to fail. Exim remembers such failures in a
33964 domain cache record, which it uses to fail callouts for the domain without
33965 making new connections, until the domain record times out. There are two
33966 separate expiry times for domain cache records:
33967 &%callout_domain_negative_expire%& (default 3h) and
33968 &%callout_domain_positive_expire%& (default 7d).
33969
33970 Domain records expire when the negative expiry time is reached if callouts
33971 cannot be made for the domain, or if the postmaster check failed.
33972 Otherwise, they expire when the positive expiry time is reached. This
33973 ensures that, for example, a host that stops accepting &"random"& local parts
33974 will eventually be noticed.
33975
33976 The callout caching mechanism is based on the domain of the address that is
33977 being tested. If the domain routes to several hosts, it is assumed that their
33978 behaviour will be the same.
33979
33980
33981
33982 .section "Quota caching" "SECTquotacache"
33983 .cindex "hints database" "quota cache"
33984 .cindex "quota" "cache, description of"
33985 .cindex "caching" "quota"
33986 Exim caches the results of quota verification
33987 in order to reduce the amount of resources used.
33988 The &"callout"& hints database is used.
33989
33990 The default cache periods are five minutes for a positive (good) result
33991 and one hour for a negative result.
33992 To change the periods the &%quota%& option can be followed by an equals sign
33993 and a number of optional paramemters, separated by commas.
33994 For example:
33995 .code
33996 verify = recipient/quota=cachepos=1h,cacheneg=1d
33997 .endd
33998 Possible parameters are:
33999 .vlist
34000 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
34001 .cindex "quota cache" "positive entry expiry, specifying"
34002 Set the lifetime for a positive cache entry.
34003 A value of zero seconds is legitimate.
34004
34005 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
34006 .cindex "quota cache" "negative entry expiry, specifying"
34007 As above, for a negative entry.
34008
34009 .vitem &*no_cache*&
34010 Set both positive and negative lifetimes to zero.
34011
34012 .section "Sender address verification reporting" "SECTsenaddver"
34013 .cindex "verifying" "suppressing error details"
34014 See section &<<SECTaddressverification>>& for a general discussion of
34015 verification. When sender verification fails in an ACL, the details of the
34016 failure are given as additional output lines before the 550 response to the
34017 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
34018 you might see:
34019 .code
34020 MAIL FROM:<xyz@abc.example>
34021 250 OK
34022 RCPT TO:<pqr@def.example>
34023 550-Verification failed for <xyz@abc.example>
34024 550-Called:   192.168.34.43
34025 550-Sent:     RCPT TO:<xyz@abc.example>
34026 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
34027 550 Sender verification failed
34028 .endd
34029 If more than one RCPT command fails in the same way, the details are given
34030 only for the first of them. However, some administrators do not want to send
34031 out this much information. You can suppress the details by adding
34032 &`/no_details`& to the ACL statement that requests sender verification. For
34033 example:
34034 .code
34035 verify = sender/no_details
34036 .endd
34037
34038 .section "Redirection while verifying" "SECTredirwhilveri"
34039 .cindex "verifying" "redirection while"
34040 .cindex "address redirection" "while verifying"
34041 A dilemma arises when a local address is redirected by aliasing or forwarding
34042 during verification: should the generated addresses themselves be verified,
34043 or should the successful expansion of the original address be enough to verify
34044 it? By default, Exim takes the following pragmatic approach:
34045
34046 .ilist
34047 When an incoming address is redirected to just one child address, verification
34048 continues with the child address, and if that fails to verify, the original
34049 verification also fails.
34050 .next
34051 When an incoming address is redirected to more than one child address,
34052 verification does not continue. A success result is returned.
34053 .endlist
34054
34055 This seems the most reasonable behaviour for the common use of aliasing as a
34056 way of redirecting different local parts to the same mailbox. It means, for
34057 example, that a pair of alias entries of the form
34058 .code
34059 A.Wol:   aw123
34060 aw123:   :fail: Gone away, no forwarding address
34061 .endd
34062 work as expected, with both local parts causing verification failure. When a
34063 redirection generates more than one address, the behaviour is more like a
34064 mailing list, where the existence of the alias itself is sufficient for
34065 verification to succeed.
34066
34067 It is possible, however, to change the default behaviour so that all successful
34068 redirections count as successful verifications, however many new addresses are
34069 generated. This is specified by the &%success_on_redirect%& verification
34070 option. For example:
34071 .code
34072 require verify = recipient/success_on_redirect/callout=10s
34073 .endd
34074 In this example, verification succeeds if a router generates a new address, and
34075 the callout does not occur, because no address was routed to a remote host.
34076
34077 When verification is being tested via the &%-bv%& option, the treatment of
34078 redirections is as just described, unless the &%-v%& or any debugging option is
34079 also specified. In that case, full verification is done for every generated
34080 address and a report is output for each of them.
34081
34082
34083
34084 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34085 .cindex "CSA" "verifying"
34086 Client SMTP Authorization is a system that allows a site to advertise
34087 which machines are and are not permitted to send email. This is done by placing
34088 special SRV records in the DNS; these are looked up using the client's HELO
34089 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34090 Authorization checks in Exim are performed by the ACL condition:
34091 .code
34092 verify = csa
34093 .endd
34094 This fails if the client is not authorized. If there is a DNS problem, or if no
34095 valid CSA SRV record is found, or if the client is authorized, the condition
34096 succeeds. These three cases can be distinguished using the expansion variable
34097 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34098 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34099 be likely to cause problems for legitimate email.
34100
34101 The error messages produced by the CSA code include slightly more
34102 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34103 looking up the CSA SRV record, or problems looking up the CSA target
34104 address record. There are four reasons for &$csa_status$& being &"fail"&:
34105
34106 .ilist
34107 The client's host name is explicitly not authorized.
34108 .next
34109 The client's IP address does not match any of the CSA target IP addresses.
34110 .next
34111 The client's host name is authorized but it has no valid target IP addresses
34112 (for example, the target's addresses are IPv6 and the client is using IPv4).
34113 .next
34114 The client's host name has no CSA SRV record but a parent domain has asserted
34115 that all subdomains must be explicitly authorized.
34116 .endlist
34117
34118 The &%csa%& verification condition can take an argument which is the domain to
34119 use for the DNS query. The default is:
34120 .code
34121 verify = csa/$sender_helo_name
34122 .endd
34123 This implementation includes an extension to CSA. If the query domain
34124 is an address literal such as [192.0.2.95], or if it is a bare IP
34125 address, Exim searches for CSA SRV records in the reverse DNS as if
34126 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34127 meaningful to say:
34128 .code
34129 verify = csa/$sender_host_address
34130 .endd
34131 In fact, this is the check that Exim performs if the client does not say HELO.
34132 This extension can be turned off by setting the main configuration option
34133 &%dns_csa_use_reverse%& to be false.
34134
34135 If a CSA SRV record is not found for the domain itself, a search
34136 is performed through its parent domains for a record which might be
34137 making assertions about subdomains. The maximum depth of this search is limited
34138 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34139 default. Exim does not look for CSA SRV records in a top level domain, so the
34140 default settings handle HELO domains as long as seven
34141 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34142 of legitimate HELO domains.
34143
34144 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34145 direct SRV lookups, this is not sufficient because of the extra parent domain
34146 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34147 addresses into lookups in the reverse DNS space. The result of a successful
34148 lookup such as:
34149 .code
34150 ${lookup dnsdb {csa=$sender_helo_name}}
34151 .endd
34152 has two space-separated fields: an authorization code and a target host name.
34153 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34154 authorization required but absent, or &"?"& for unknown.
34155
34156
34157
34158
34159 .section "Bounce address tag validation" "SECTverifyPRVS"
34160 .cindex "BATV, verifying"
34161 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34162 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34163 Genuine incoming bounce messages should therefore always be addressed to
34164 recipients that have a valid tag. This scheme is a way of detecting unwanted
34165 bounce messages caused by sender address forgeries (often called &"collateral
34166 spam"&), because the recipients of such messages do not include valid tags.
34167
34168 There are two expansion items to help with the implementation of the BATV
34169 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34170 the original envelope sender address by using a simple key to add a hash of the
34171 address and some time-based randomizing information. The &%prvs%& expansion
34172 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34173 The syntax of these expansion items is described in section
34174 &<<SECTexpansionitems>>&.
34175 The validity period on signed addresses is seven days.
34176
34177 As an example, suppose the secret per-address keys are stored in an MySQL
34178 database. A query to look up the key for an address could be defined as a macro
34179 like this:
34180 .code
34181 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34182                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34183                 }{$value}}
34184 .endd
34185 Suppose also that the senders who make use of BATV are defined by an address
34186 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34187 use this:
34188 .code
34189 # Bounces: drop unsigned addresses for BATV senders
34190 deny senders = :
34191      recipients = +batv_senders
34192      message = This address does not send an unsigned reverse path
34193
34194 # Bounces: In case of prvs-signed address, check signature.
34195 deny senders = :
34196      condition  = ${prvscheck {$local_part@$domain}\
34197                   {PRVSCHECK_SQL}{1}}
34198      !condition = $prvscheck_result
34199      message = Invalid reverse path signature.
34200 .endd
34201 The first statement rejects recipients for bounce messages that are addressed
34202 to plain BATV sender addresses, because it is known that BATV senders do not
34203 send out messages with plain sender addresses. The second statement rejects
34204 recipients that are prvs-signed, but with invalid signatures (either because
34205 the key is wrong, or the signature has timed out).
34206
34207 A non-prvs-signed address is not rejected by the second statement, because the
34208 &%prvscheck%& expansion yields an empty string if its first argument is not a
34209 prvs-signed address, thus causing the &%condition%& condition to be false. If
34210 the first argument is a syntactically valid prvs-signed address, the yield is
34211 the third string (in this case &"1"&), whether or not the cryptographic and
34212 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34213 of the checks (empty for failure, &"1"& for success).
34214
34215 There is one more issue you must consider when implementing prvs-signing:
34216 you have to ensure that the routers accept prvs-signed addresses and
34217 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34218 router to remove the signature with a configuration along these lines:
34219 .code
34220 batv_redirect:
34221   driver = redirect
34222   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34223 .endd
34224 This works because, if the third argument of &%prvscheck%& is empty, the result
34225 of the expansion of a prvs-signed address is the decoded value of the original
34226 address. This router should probably be the first of your routers that handles
34227 local addresses.
34228
34229 To create BATV-signed addresses in the first place, a transport of this form
34230 can be used:
34231 .code
34232 external_smtp_batv:
34233   driver = smtp
34234   return_path = ${prvs {$return_path} \
34235                        {${lookup mysql{SELECT \
34236                        secret FROM batv_prvs WHERE \
34237                        sender='${quote_mysql:$sender_address}'} \
34238                        {$value}fail}}}
34239 .endd
34240 If no key can be found for the existing return path, no signing takes place.
34241
34242
34243
34244 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34245 .cindex "&ACL;" "relay control"
34246 .cindex "relaying" "control by ACL"
34247 .cindex "policy control" "relay control"
34248 An MTA is said to &'relay'& a message if it receives it from some host and
34249 delivers it directly to another host as a result of a remote address contained
34250 within it. Redirecting a local address via an alias or forward file and then
34251 passing the message on to another host is not relaying,
34252 .cindex "&""percent hack""&"
34253 but a redirection as a result of the &"percent hack"& is.
34254
34255 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34256 A host which is acting as a gateway or an MX backup is concerned with incoming
34257 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34258 a host which is acting as a smart host for a number of clients is concerned
34259 with outgoing relaying from those clients to the Internet at large. Often the
34260 same host is fulfilling both functions,
34261 . ///
34262 . as illustrated in the diagram below,
34263 . ///
34264 but in principle these two kinds of relaying are entirely independent. What is
34265 not wanted is the transmission of mail from arbitrary remote hosts through your
34266 system to arbitrary domains.
34267
34268
34269 You can implement relay control by means of suitable statements in the ACL that
34270 runs for each RCPT command. For convenience, it is often easiest to use
34271 Exim's named list facility to define the domains and hosts involved. For
34272 example, suppose you want to do the following:
34273
34274 .ilist
34275 Deliver a number of domains to mailboxes on the local host (or process them
34276 locally in some other way). Let's say these are &'my.dom1.example'& and
34277 &'my.dom2.example'&.
34278 .next
34279 Relay mail for a number of other domains for which you are the secondary MX.
34280 These might be &'friend1.example'& and &'friend2.example'&.
34281 .next
34282 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34283 Suppose your LAN is 192.168.45.0/24.
34284 .endlist
34285
34286
34287 In the main part of the configuration, you put the following definitions:
34288 .code
34289 domainlist local_domains    = my.dom1.example : my.dom2.example
34290 domainlist relay_to_domains = friend1.example : friend2.example
34291 hostlist   relay_from_hosts = 192.168.45.0/24
34292 .endd
34293 Now you can use these definitions in the ACL that is run for every RCPT
34294 command:
34295 .code
34296 acl_check_rcpt:
34297   accept domains = +local_domains : +relay_to_domains
34298   accept hosts   = +relay_from_hosts
34299 .endd
34300 The first statement accepts any RCPT command that contains an address in
34301 the local or relay domains. For any other domain, control passes to the second
34302 statement, which accepts the command only if it comes from one of the relay
34303 hosts. In practice, you will probably want to make your ACL more sophisticated
34304 than this, for example, by including sender and recipient verification. The
34305 default configuration includes a more comprehensive example, which is described
34306 in chapter &<<CHAPdefconfil>>&.
34307
34308
34309
34310 .section "Checking a relay configuration" "SECTcheralcon"
34311 .cindex "relaying" "checking control of"
34312 You can check the relay characteristics of your configuration in the same way
34313 that you can test any ACL behaviour for an incoming SMTP connection, by using
34314 the &%-bh%& option to run a fake SMTP session with which you interact.
34315 .ecindex IIDacl
34316
34317
34318
34319 . ////////////////////////////////////////////////////////////////////////////
34320 . ////////////////////////////////////////////////////////////////////////////
34321
34322 .chapter "Content scanning at ACL time" "CHAPexiscan"
34323 .scindex IIDcosca "content scanning" "at ACL time"
34324 The extension of Exim to include content scanning at ACL time, formerly known
34325 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34326 was integrated into the main source for Exim release 4.50, and Tom continues to
34327 maintain it. Most of the wording of this chapter is taken from Tom's
34328 specification.
34329
34330 It is also possible to scan the content of messages at other times. The
34331 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34332 scanning after all the ACLs have run. A transport filter can be used to scan
34333 messages at delivery time (see the &%transport_filter%& option, described in
34334 chapter &<<CHAPtransportgeneric>>&).
34335
34336 If you want to include the ACL-time content-scanning features when you compile
34337 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34338 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34339
34340 .ilist
34341 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34342 for all MIME parts for SMTP and non-SMTP messages, respectively.
34343 .next
34344 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34345 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34346 run at the end of message reception (the &%acl_smtp_data%& ACL).
34347 .next
34348 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34349 of messages, or parts of messages, for debugging purposes.
34350 .next
34351 Additional expansion variables that are set in the new ACL and by the new
34352 conditions.
34353 .next
34354 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34355 .endlist
34356
34357 Content-scanning is continually evolving, and new features are still being
34358 added. While such features are still unstable and liable to incompatible
34359 changes, they are made available in Exim by setting options whose names begin
34360 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34361 this manual. You can find out about them by reading the file called
34362 &_doc/experimental.txt_&.
34363
34364 All the content-scanning facilities work on a MBOX copy of the message that is
34365 temporarily created in a file called:
34366 .display
34367 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34368 .endd
34369 The &_.eml_& extension is a friendly hint to virus scanners that they can
34370 expect an MBOX-like structure inside that file. The file is created when the
34371 first content scanning facility is called. Subsequent calls to content
34372 scanning conditions open the same file again. The directory is recursively
34373 removed when the &%acl_smtp_data%& ACL has finished running, unless
34374 .code
34375 control = no_mbox_unspool
34376 .endd
34377 has been encountered. When the MIME ACL decodes files, they are put into the
34378 same directory by default.
34379
34380
34381
34382 .section "Scanning for viruses" "SECTscanvirus"
34383 .cindex "virus scanning"
34384 .cindex "content scanning" "for viruses"
34385 .cindex "content scanning" "the &%malware%& condition"
34386 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34387 It supports a &"generic"& interface to scanners called via the shell, and
34388 specialized interfaces for &"daemon"& type virus scanners, which are resident
34389 in memory and thus are much faster.
34390
34391 Since message data needs to have arrived,
34392 the condition may be only called in ACL defined by
34393 &%acl_smtp_data%&,
34394 &%acl_smtp_data_prdr%&,
34395 &%acl_smtp_mime%& or
34396 &%acl_smtp_dkim%&
34397
34398 A timeout of 2 minutes is applied to a scanner call (by default);
34399 if it expires then a defer action is taken.
34400
34401 .oindex "&%av_scanner%&"
34402 You can set the &%av_scanner%& option in the main part of the configuration
34403 to specify which scanner to use, together with any additional options that
34404 are needed. The basic syntax is as follows:
34405 .display
34406 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34407 .endd
34408 If you do not set &%av_scanner%&, it defaults to
34409 .code
34410 av_scanner = sophie:/var/run/sophie
34411 .endd
34412 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34413 before use.
34414 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34415 The following scanner types are supported in this release,
34416 though individual ones can be included or not at build time:
34417
34418 .vlist
34419 .vitem &%avast%&
34420 .cindex "virus scanners" "avast"
34421 This is the scanner daemon of Avast. It has been tested with Avast Core
34422 Security (currently at version 2.2.0).
34423 You can get a trial version at &url(https://www.avast.com) or for Linux
34424 at &url(https://www.avast.com/linux-server-antivirus).
34425 This scanner type takes one option,
34426 which can be either a full path to a UNIX socket,
34427 or host and port specifiers separated by white space.
34428 The host may be a name or an IP address; the port is either a
34429 single number or a pair of numbers with a dash between.
34430 A list of options may follow. These options are interpreted on the
34431 Exim's side of the malware scanner, or are given on separate lines to
34432 the daemon as options before the main scan command.
34433
34434 .cindex &`pass_unscanned`& "avast"
34435 If &`pass_unscanned`&
34436 is set, any files the Avast scanner can't scan (e.g.
34437 decompression bombs, or invalid archives) are considered clean. Use with
34438 care.
34439
34440 For example:
34441 .code
34442 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34443 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34444 av_scanner = avast:192.168.2.22 5036
34445 .endd
34446 If you omit the argument, the default path
34447 &_/var/run/avast/scan.sock_&
34448 is used.
34449 If you use a remote host,
34450 you need to make Exim's spool directory available to it,
34451 as the scanner is passed a file path, not file contents.
34452 For information about available commands and their options you may use
34453 .code
34454 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34455     FLAGS
34456     SENSITIVITY
34457     PACK
34458 .endd
34459
34460 If the scanner returns a temporary failure (e.g. license issues, or
34461 permission problems), the message is deferred and a paniclog entry is
34462 written.  The usual &`defer_ok`& option is available.
34463
34464 .vitem &%aveserver%&
34465 .cindex "virus scanners" "Kaspersky"
34466 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34467 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34468 which is the path to the daemon's UNIX socket. The default is shown in this
34469 example:
34470 .code
34471 av_scanner = aveserver:/var/run/aveserver
34472 .endd
34473
34474
34475 .vitem &%clamd%&
34476 .cindex "virus scanners" "clamd"
34477 This daemon-type scanner is GPL and free. You can get it at
34478 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34479 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34480 in the MIME ACL. This is no longer believed to be necessary.
34481
34482 The options are a list of server specifiers, which may be
34483 a UNIX socket specification,
34484 a TCP socket specification,
34485 or a (global) option.
34486
34487 A socket specification consists of a space-separated list.
34488 For a Unix socket the first element is a full path for the socket,
34489 for a TCP socket the first element is the IP address
34490 and the second a port number,
34491 Any further elements are per-server (non-global) options.
34492 These per-server options are supported:
34493 .code
34494 retry=<timespec>        Retry on connect fail
34495 .endd
34496
34497 The &`retry`& option specifies a time after which a single retry for
34498 a failed connect is made.  The default is to not retry.
34499
34500 If a Unix socket file is specified, only one server is supported.
34501
34502 Examples:
34503 .code
34504 av_scanner = clamd:/opt/clamd/socket
34505 av_scanner = clamd:192.0.2.3 1234
34506 av_scanner = clamd:192.0.2.3 1234:local
34507 av_scanner = clamd:192.0.2.3 1234 retry=10s
34508 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34509 .endd
34510 If the value of av_scanner points to a UNIX socket file or contains the
34511 &`local`&
34512 option, then the ClamAV interface will pass a filename containing the data
34513 to be scanned, which should normally result in less I/O happening and be
34514 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34515 Exim does not assume that there is a common filesystem with the remote host.
34516
34517 The final example shows that multiple TCP targets can be specified.  Exim will
34518 randomly use one for each incoming email (i.e. it load balances them).  Note
34519 that only TCP targets may be used if specifying a list of scanners; a UNIX
34520 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34521 unavailable, Exim will try the remaining one(s) until it finds one that works.
34522 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34523 not keep track of scanner state between multiple messages, and the scanner
34524 selection is random, so the message will get logged in the mainlog for each
34525 email that the down scanner gets chosen first (message wrapped to be readable):
34526 .code
34527 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34528    clamd: connection to localhost, port 3310 failed
34529    (Connection refused)
34530 .endd
34531
34532 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34533 contributing the code for this scanner.
34534
34535 .vitem &%cmdline%&
34536 .cindex "virus scanners" "command line interface"
34537 This is the keyword for the generic command line scanner interface. It can be
34538 used to attach virus scanners that are invoked from the shell. This scanner
34539 type takes 3 mandatory options:
34540
34541 .olist
34542 The full path and name of the scanner binary, with all command line options,
34543 and a placeholder (&`%s`&) for the directory to scan.
34544
34545 .next
34546 A regular expression to match against the STDOUT and STDERR output of the
34547 virus scanner. If the expression matches, a virus was found. You must make
34548 absolutely sure that this expression matches on &"virus found"&. This is called
34549 the &"trigger"& expression.
34550
34551 .next
34552 Another regular expression, containing exactly one pair of parentheses, to
34553 match the name of the virus found in the scanners output. This is called the
34554 &"name"& expression.
34555 .endlist olist
34556
34557 For example, Sophos Sweep reports a virus on a line like this:
34558 .code
34559 Virus 'W32/Magistr-B' found in file ./those.bat
34560 .endd
34561 For the trigger expression, we can match the phrase &"found in file"&. For the
34562 name expression, we want to extract the W32/Magistr-B string, so we can match
34563 for the single quotes left and right of it. Altogether, this makes the
34564 configuration setting:
34565 .code
34566 av_scanner = cmdline:\
34567              /path/to/sweep -ss -all -rec -archive %s:\
34568              found in file:'(.+)'
34569 .endd
34570 .vitem &%drweb%&
34571 .cindex "virus scanners" "DrWeb"
34572 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34573 takes one option,
34574 either a full path to a UNIX socket,
34575 or host and port specifiers separated by white space.
34576 The host may be a name or an IP address; the port is either a
34577 single number or a pair of numbers with a dash between.
34578 For example:
34579 .code
34580 av_scanner = drweb:/var/run/drwebd.sock
34581 av_scanner = drweb:192.168.2.20 31337
34582 .endd
34583 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34584 is used. Thanks to Alex Miller for contributing the code for this scanner.
34585
34586 .vitem &%f-protd%&
34587 .cindex "virus scanners" "f-protd"
34588 The f-protd scanner is accessed via HTTP over TCP.
34589 One argument is taken, being a space-separated hostname and port number
34590 (or port-range).
34591 For example:
34592 .code
34593 av_scanner = f-protd:localhost 10200-10204
34594 .endd
34595 If you omit the argument, the default values shown above are used.
34596
34597 .vitem &%f-prot6d%&
34598 .cindex "virus scanners" "f-prot6d"
34599 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34600 One argument is taken, being a space-separated hostname and port number.
34601 For example:
34602 .code
34603 av_scanner = f-prot6d:localhost 10200
34604 .endd
34605 If you omit the argument, the default values show above are used.
34606
34607 .vitem &%fsecure%&
34608 .cindex "virus scanners" "F-Secure"
34609 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34610 argument which is the path to a UNIX socket. For example:
34611 .code
34612 av_scanner = fsecure:/path/to/.fsav
34613 .endd
34614 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34615 Thelmen for contributing the code for this scanner.
34616
34617 .vitem &%kavdaemon%&
34618 .cindex "virus scanners" "Kaspersky"
34619 This is the scanner daemon of Kaspersky Version 4. This version of the
34620 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34621 scanner type takes one option, which is the path to the daemon's UNIX socket.
34622 For example:
34623 .code
34624 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34625 .endd
34626 The default path is &_/var/run/AvpCtl_&.
34627
34628 .vitem &%mksd%&
34629 .cindex "virus scanners" "mksd"
34630 This was a daemon type scanner that is aimed mainly at Polish users,
34631 though some documentation was available in English.
34632 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34633 and this appears to be a candidate for removal from Exim, unless
34634 we are informed of other virus scanners which use the same protocol
34635 to integrate.
34636 The only option for this scanner type is
34637 the maximum number of processes used simultaneously to scan the attachments,
34638 provided that mksd has
34639 been run with at least the same number of child processes. For example:
34640 .code
34641 av_scanner = mksd:2
34642 .endd
34643 You can safely omit this option (the default value is 1).
34644
34645 .vitem &%sock%&
34646 .cindex "virus scanners" "simple socket-connected"
34647 This is a general-purpose way of talking to simple scanner daemons
34648 running on the local machine.
34649 There are four options:
34650 an address (which may be an IP address and port, or the path of a Unix socket),
34651 a commandline to send (may include a single %s which will be replaced with
34652 the path to the mail file to be scanned),
34653 an RE to trigger on from the returned data,
34654 and an RE to extract malware_name from the returned data.
34655 For example:
34656 .code
34657 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34658 .endd
34659 Note that surrounding whitespace is stripped from each option, meaning
34660 there is no way to specify a trailing newline.
34661 The socket specifier and both regular-expressions are required.
34662 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34663 specify an empty element to get this.
34664
34665 .vitem &%sophie%&
34666 .cindex "virus scanners" "Sophos and Sophie"
34667 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34668 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34669 for this scanner type is the path to the UNIX socket that Sophie uses for
34670 client communication. For example:
34671 .code
34672 av_scanner = sophie:/tmp/sophie
34673 .endd
34674 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34675 the option.
34676 .endlist
34677
34678 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34679 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34680 ACL.
34681
34682 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34683 makes it possible to use different scanners. See further below for an example.
34684 The &%malware%& condition caches its results, so when you use it multiple times
34685 for the same message, the actual scanning process is only carried out once.
34686 However, using expandable items in &%av_scanner%& disables this caching, in
34687 which case each use of the &%malware%& condition causes a new scan of the
34688 message.
34689
34690 The &%malware%& condition takes a right-hand argument that is expanded before
34691 use and taken as a list, slash-separated by default.
34692 The first element can then be one of
34693
34694 .ilist
34695 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34696 The condition succeeds if a virus was found, and fail otherwise. This is the
34697 recommended usage.
34698 .next
34699 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34700 the condition fails immediately.
34701 .next
34702 A regular expression, in which case the message is scanned for viruses. The
34703 condition succeeds if a virus is found and its name matches the regular
34704 expression. This allows you to take special actions on certain types of virus.
34705 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34706 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34707 .endlist
34708
34709 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34710 messages even if there is a problem with the virus scanner.
34711 Otherwise, such a problem causes the ACL to defer.
34712
34713 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34714 specify a non-default timeout.  The default is two minutes.
34715 For example:
34716 .code
34717 malware = * / defer_ok / tmo=10s
34718 .endd
34719 A timeout causes the ACL to defer.
34720
34721 .vindex "&$callout_address$&"
34722 When a connection is made to the scanner the expansion variable &$callout_address$&
34723 is set to record the actual address used.
34724
34725 .vindex "&$malware_name$&"
34726 When a virus is found, the condition sets up an expansion variable called
34727 &$malware_name$& that contains the name of the virus. You can use it in a
34728 &%message%& modifier that specifies the error returned to the sender, and/or in
34729 logging data.
34730
34731 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34732 imposed by your anti-virus scanner.
34733
34734 Here is a very simple scanning example:
34735 .code
34736 deny malware = *
34737      message = This message contains malware ($malware_name)
34738 .endd
34739 The next example accepts messages when there is a problem with the scanner:
34740 .code
34741 deny malware = */defer_ok
34742      message = This message contains malware ($malware_name)
34743 .endd
34744 The next example shows how to use an ACL variable to scan with both sophie and
34745 aveserver. It assumes you have set:
34746 .code
34747 av_scanner = $acl_m0
34748 .endd
34749 in the main Exim configuration.
34750 .code
34751 deny set acl_m0 = sophie
34752      malware = *
34753      message = This message contains malware ($malware_name)
34754
34755 deny set acl_m0 = aveserver
34756      malware = *
34757      message = This message contains malware ($malware_name)
34758 .endd
34759
34760
34761 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34762 .cindex "content scanning" "for spam"
34763 .cindex "spam scanning"
34764 .cindex "SpamAssassin"
34765 .cindex "Rspamd"
34766 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34767 score and a report for the message.
34768 Support is also provided for Rspamd.
34769
34770 For more information about installation and configuration of SpamAssassin or
34771 Rspamd refer to their respective websites at
34772 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34773
34774 SpamAssassin can be installed with CPAN by running:
34775 .code
34776 perl -MCPAN -e 'install Mail::SpamAssassin'
34777 .endd
34778 SpamAssassin has its own set of configuration files. Please review its
34779 documentation to see how you can tweak it. The default installation should work
34780 nicely, however.
34781
34782 .oindex "&%spamd_address%&"
34783 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34784 intend to use an instance running on the local host you do not need to set
34785 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34786 you must set the &%spamd_address%& option in the global part of the Exim
34787 configuration as follows (example):
34788 .code
34789 spamd_address = 192.168.99.45 783
34790 .endd
34791 The SpamAssassin protocol relies on a TCP half-close from the client.
34792 If your SpamAssassin client side is running a Linux system with an
34793 iptables firewall, consider setting
34794 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34795 timeout, Exim uses when waiting for a response from the SpamAssassin
34796 server (currently defaulting to 120s).  With a lower value the Linux
34797 connection tracking may consider your half-closed connection as dead too
34798 soon.
34799
34800
34801 To use Rspamd (which by default listens on all local addresses
34802 on TCP port 11333)
34803 you should add &%variant=rspamd%& after the address/port pair, for example:
34804 .code
34805 spamd_address = 127.0.0.1 11333 variant=rspamd
34806 .endd
34807
34808 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34809 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34810 filename instead of an address/port pair:
34811 .code
34812 spamd_address = /var/run/spamd_socket
34813 .endd
34814 You can have multiple &%spamd%& servers to improve scalability. These can
34815 reside on other hardware reachable over the network. To specify multiple
34816 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34817 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34818 .code
34819 spamd_address = 192.168.2.10 783 : \
34820                 192.168.2.11 783 : \
34821                 192.168.2.12 783
34822 .endd
34823 Up to 32 &%spamd%& servers are supported.
34824 When a server fails to respond to the connection attempt, all other
34825 servers are tried until one succeeds. If no server responds, the &%spam%&
34826 condition defers.
34827
34828 Unix and TCP socket specifications may be mixed in any order.
34829 Each element of the list is a list itself, space-separated by default
34830 and changeable in the usual way (&<<SECTlistsepchange>>&);
34831 take care to not double the separator.
34832
34833 For TCP socket specifications a host name or IP (v4 or v6, but
34834 subject to list-separator quoting rules) address can be used,
34835 and the port can be one or a dash-separated pair.
34836 In the latter case, the range is tried in strict order.
34837
34838 Elements after the first for Unix sockets, or second for TCP socket,
34839 are options.
34840 The supported options are:
34841 .code
34842 pri=<priority>      Selection priority
34843 weight=<value>      Selection bias
34844 time=<start>-<end>  Use only between these times of day
34845 retry=<timespec>    Retry on connect fail
34846 tmo=<timespec>      Connection time limit
34847 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34848 .endd
34849
34850 The &`pri`& option specifies a priority for the server within the list,
34851 higher values being tried first.
34852 The default priority is 1.
34853
34854 The &`weight`& option specifies a selection bias.
34855 Within a priority set
34856 servers are queried in a random fashion, weighted by this value.
34857 The default value for selection bias is 1.
34858
34859 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34860 in the local time zone; each element being one or more digits.
34861 Either the seconds or both minutes and seconds, plus the leading &`.`&
34862 characters, may be omitted and will be taken as zero.
34863
34864 Timeout specifications for the &`retry`& and &`tmo`& options
34865 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34866
34867 The &`tmo`& option specifies an overall timeout for communication.
34868 The default value is two minutes.
34869
34870 The &`retry`& option specifies a time after which a single retry for
34871 a failed connect is made.
34872 The default is to not retry.
34873
34874 The &%spamd_address%& variable is expanded before use if it starts with
34875 a dollar sign. In this case, the expansion may return a string that is
34876 used as the list so that multiple spamd servers can be the result of an
34877 expansion.
34878
34879 .vindex "&$callout_address$&"
34880 When a connection is made to the server the expansion variable &$callout_address$&
34881 is set to record the actual address used.
34882
34883 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34884 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34885 .code
34886 deny spam = joe
34887      message = This message was classified as SPAM
34888 .endd
34889 The right-hand side of the &%spam%& condition specifies a name. This is
34890 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34891 to scan using a specific profile, but rather use the SpamAssassin system-wide
34892 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34893 Rspamd does not use this setting. However, you must put something on the
34894 right-hand side.
34895
34896 The name allows you to use per-domain or per-user antispam profiles in
34897 principle, but this is not straightforward in practice, because a message may
34898 have multiple recipients, not necessarily all in the same domain. Because the
34899 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34900 read the contents of the message, the variables &$local_part$& and &$domain$&
34901 are not set.
34902 Careful enforcement of single-recipient messages
34903 (e.g. by responding with defer in the recipient ACL for all recipients
34904 after the first),
34905 or the use of PRDR,
34906 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34907 are needed to use this feature.
34908
34909 The right-hand side of the &%spam%& condition is expanded before being used, so
34910 you can put lookups or conditions there. When the right-hand side evaluates to
34911 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34912
34913
34914 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34915 large ones may cause significant performance degradation. As most spam messages
34916 are quite small, it is recommended that you do not scan the big ones. For
34917 example:
34918 .code
34919 deny condition = ${if < {$message_size}{10K}}
34920      spam = nobody
34921      message = This message was classified as SPAM
34922 .endd
34923
34924 The &%spam%& condition returns true if the threshold specified in the user's
34925 SpamAssassin profile has been matched or exceeded. If you want to use the
34926 &%spam%& condition for its side effects (see the variables below), you can make
34927 it always return &"true"& by appending &`:true`& to the username.
34928
34929 .cindex "spam scanning" "returned variables"
34930 When the &%spam%& condition is run, it sets up a number of expansion
34931 variables.
34932 Except for &$spam_report$&,
34933 these variables are saved with the received message so are
34934 available for use at delivery time.
34935
34936 .vlist
34937 .vitem &$spam_score$&
34938 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34939 for inclusion in log or reject messages.
34940
34941 .vitem &$spam_score_int$&
34942 The spam score of the message, multiplied by ten, as an integer value. For
34943 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34944 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34945 The integer value is useful for numeric comparisons in conditions.
34946
34947 .vitem &$spam_bar$&
34948 A string consisting of a number of &"+"& or &"-"& characters, representing the
34949 integer part of the spam score value. A spam score of 4.4 would have a
34950 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34951 headers, since MUAs can match on such strings. The maximum length of the
34952 spam bar is 50 characters.
34953
34954 .vitem &$spam_report$&
34955 A multiline text table, containing the full SpamAssassin report for the
34956 message. Useful for inclusion in headers or reject messages.
34957 This variable is only usable in a DATA-time ACL.
34958 Beware that SpamAssassin may return non-ASCII characters, especially
34959 when running in country-specific locales, which are not legal
34960 unencoded in headers.
34961
34962 .vitem &$spam_action$&
34963 For SpamAssassin either 'reject' or 'no action' depending on the
34964 spam score versus threshold.
34965 For Rspamd, the recommended action.
34966
34967 .endlist
34968
34969 The &%spam%& condition caches its results unless expansion in
34970 spamd_address was used. If you call it again with the same user name, it
34971 does not scan again, but rather returns the same values as before.
34972
34973 The &%spam%& condition returns DEFER if there is any error while running
34974 the message through SpamAssassin or if the expansion of spamd_address
34975 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34976 statement block), append &`/defer_ok`& to the right-hand side of the
34977 spam condition, like this:
34978 .code
34979 deny spam    = joe/defer_ok
34980      message = This message was classified as SPAM
34981 .endd
34982 This causes messages to be accepted even if there is a problem with &%spamd%&.
34983
34984 Here is a longer, commented example of the use of the &%spam%&
34985 condition:
34986 .code
34987 # put headers in all messages (no matter if spam or not)
34988 warn  spam = nobody:true
34989       add_header = X-Spam-Score: $spam_score ($spam_bar)
34990       add_header = X-Spam-Report: $spam_report
34991
34992 # add second subject line with *SPAM* marker when message
34993 # is over threshold
34994 warn  spam = nobody
34995       add_header = Subject: *SPAM* $h_Subject:
34996
34997 # reject spam at high scores (> 12)
34998 deny  spam = nobody:true
34999       condition = ${if >{$spam_score_int}{120}{1}{0}}
35000       message = This message scored $spam_score spam points.
35001 .endd
35002
35003
35004
35005 .section "Scanning MIME parts" "SECTscanmimepart"
35006 .cindex "content scanning" "MIME parts"
35007 .cindex "MIME content scanning"
35008 .oindex "&%acl_smtp_mime%&"
35009 .oindex "&%acl_not_smtp_mime%&"
35010 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
35011 each MIME part of an SMTP message, including multipart types, in the sequence
35012 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
35013 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
35014 options may both refer to the same ACL if you want the same processing in both
35015 cases.
35016
35017 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
35018 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
35019 the case of a non-SMTP message. However, a MIME ACL is called only if the
35020 message contains a &'Content-Type:'& header line. When a call to a MIME
35021 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
35022 result code is sent to the client. In the case of an SMTP message, the
35023 &%acl_smtp_data%& ACL is not called when this happens.
35024
35025 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
35026 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
35027 condition to match against the raw MIME part. You can also use the
35028 &%mime_regex%& condition to match against the decoded MIME part (see section
35029 &<<SECTscanregex>>&).
35030
35031 At the start of a MIME ACL, a number of variables are set from the header
35032 information for the relevant MIME part. These are described below. The contents
35033 of the MIME part are not by default decoded into a disk file except for MIME
35034 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
35035 part into a disk file, you can use the &%decode%& condition. The general
35036 syntax is:
35037 .display
35038 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35039 .endd
35040 The right hand side is expanded before use. After expansion,
35041 the value can be:
35042
35043 .olist
35044 &"0"& or &"false"&, in which case no decoding is done.
35045 .next
35046 The string &"default"&. In that case, the file is put in the temporary
35047 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35048 a sequential filename consisting of the message id and a sequence number. The
35049 full path and name is available in &$mime_decoded_filename$& after decoding.
35050 .next
35051 A full path name starting with a slash. If the full name is an existing
35052 directory, it is used as a replacement for the default directory. The filename
35053 is then sequentially assigned. If the path does not exist, it is used as
35054 the full path and filename.
35055 .next
35056 If the string does not start with a slash, it is used as the
35057 filename, and the default path is then used.
35058 .endlist
35059 The &%decode%& condition normally succeeds. It is only false for syntax
35060 errors or unusual circumstances such as memory shortages. You can easily decode
35061 a file with its original, proposed filename using
35062 .code
35063 decode = $mime_filename
35064 .endd
35065 However, you should keep in mind that &$mime_filename$& might contain
35066 anything. If you place files outside of the default path, they are not
35067 automatically unlinked.
35068
35069 For RFC822 attachments (these are messages attached to messages, with a
35070 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35071 as for the primary message, only that the &$mime_is_rfc822$& expansion
35072 variable is set (see below). Attached messages are always decoded to disk
35073 before being checked, and the files are unlinked once the check is done.
35074
35075 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35076 used to match regular expressions against raw and decoded MIME parts,
35077 respectively. They are described in section &<<SECTscanregex>>&.
35078
35079 .cindex "MIME content scanning" "returned variables"
35080 The following list describes all expansion variables that are
35081 available in the MIME ACL:
35082
35083 .vlist
35084 .vitem &$mime_anomaly_level$& &&&
35085        &$mime_anomaly_text$&
35086 .vindex &$mime_anomaly_level$&
35087 .vindex &$mime_anomaly_text$&
35088 If there are problems decoding, these variables contain information on
35089 the detected issue.
35090
35091 .vitem &$mime_boundary$&
35092 .vindex &$mime_boundary$&
35093 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35094 have a boundary string, which is stored in this variable. If the current part
35095 has no boundary parameter in the &'Content-Type:'& header, this variable
35096 contains the empty string.
35097
35098 .vitem &$mime_charset$&
35099 .vindex &$mime_charset$&
35100 This variable contains the character set identifier, if one was found in the
35101 &'Content-Type:'& header. Examples for charset identifiers are:
35102 .code
35103 us-ascii
35104 gb2312 (Chinese)
35105 iso-8859-1
35106 .endd
35107 Please note that this value is not normalized, so you should do matches
35108 case-insensitively.
35109
35110 .vitem &$mime_content_description$&
35111 .vindex &$mime_content_description$&
35112 This variable contains the normalized content of the &'Content-Description:'&
35113 header. It can contain a human-readable description of the parts content. Some
35114 implementations repeat the filename for attachments here, but they are usually
35115 only used for display purposes.
35116
35117 .vitem &$mime_content_disposition$&
35118 .vindex &$mime_content_disposition$&
35119 This variable contains the normalized content of the &'Content-Disposition:'&
35120 header. You can expect strings like &"attachment"& or &"inline"& here.
35121
35122 .vitem &$mime_content_id$&
35123 .vindex &$mime_content_id$&
35124 This variable contains the normalized content of the &'Content-ID:'& header.
35125 This is a unique ID that can be used to reference a part from another part.
35126
35127 .vitem &$mime_content_size$&
35128 .vindex &$mime_content_size$&
35129 This variable is set only after the &%decode%& modifier (see above) has been
35130 successfully run. It contains the size of the decoded part in kilobytes. The
35131 size is always rounded up to full kilobytes, so only a completely empty part
35132 has a &$mime_content_size$& of zero.
35133
35134 .vitem &$mime_content_transfer_encoding$&
35135 .vindex &$mime_content_transfer_encoding$&
35136 This variable contains the normalized content of the
35137 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35138 type. Typical values are &"base64"& and &"quoted-printable"&.
35139
35140 .vitem &$mime_content_type$&
35141 .vindex &$mime_content_type$&
35142 If the MIME part has a &'Content-Type:'& header, this variable contains its
35143 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35144 are some examples of popular MIME types, as they may appear in this variable:
35145 .code
35146 text/plain
35147 text/html
35148 application/octet-stream
35149 image/jpeg
35150 audio/midi
35151 .endd
35152 If the MIME part has no &'Content-Type:'& header, this variable contains the
35153 empty string.
35154
35155 .vitem &$mime_decoded_filename$&
35156 .vindex &$mime_decoded_filename$&
35157 This variable is set only after the &%decode%& modifier (see above) has been
35158 successfully run. It contains the full path and filename of the file
35159 containing the decoded data.
35160 .endlist
35161
35162 .cindex "RFC 2047"
35163 .vlist
35164 .vitem &$mime_filename$&
35165 .vindex &$mime_filename$&
35166 This is perhaps the most important of the MIME variables. It contains a
35167 proposed filename for an attachment, if one was found in either the
35168 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35169 RFC2047
35170 or RFC2231
35171 decoded, but no additional sanity checks are done.
35172  If no filename was
35173 found, this variable contains the empty string.
35174
35175 .vitem &$mime_is_coverletter$&
35176 .vindex &$mime_is_coverletter$&
35177 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35178 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35179 content in the cover letter, while not restricting attachments at all.
35180
35181 The variable contains 1 (true) for a MIME part believed to be part of the
35182 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35183 follows:
35184
35185 .olist
35186 The outermost MIME part of a message is always a cover letter.
35187
35188 .next
35189 If a multipart/alternative or multipart/related MIME part is a cover letter,
35190 so are all MIME subparts within that multipart.
35191
35192 .next
35193 If any other multipart is a cover letter, the first subpart is a cover letter,
35194 and the rest are attachments.
35195
35196 .next
35197 All parts contained within an attachment multipart are attachments.
35198 .endlist olist
35199
35200 As an example, the following will ban &"HTML mail"& (including that sent with
35201 alternative plain text), while allowing HTML files to be attached. HTML
35202 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35203 .code
35204 deny !condition = $mime_is_rfc822
35205      condition = $mime_is_coverletter
35206      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35207      message = HTML mail is not accepted here
35208 .endd
35209
35210 .vitem &$mime_is_multipart$&
35211 .vindex &$mime_is_multipart$&
35212 This variable has the value 1 (true) when the current part has the main type
35213 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35214 Since multipart entities only serve as containers for other parts, you may not
35215 want to carry out specific actions on them.
35216
35217 .vitem &$mime_is_rfc822$&
35218 .vindex &$mime_is_rfc822$&
35219 This variable has the value 1 (true) if the current part is not a part of the
35220 checked message itself, but part of an attached message. Attached message
35221 decoding is fully recursive.
35222
35223 .vitem &$mime_part_count$&
35224 .vindex &$mime_part_count$&
35225 This variable is a counter that is raised for each processed MIME part. It
35226 starts at zero for the very first part (which is usually a multipart). The
35227 counter is per-message, so it is reset when processing RFC822 attachments (see
35228 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35229 complete, so you can use it in the DATA ACL to determine the number of MIME
35230 parts of a message. For non-MIME messages, this variable contains the value -1.
35231 .endlist
35232
35233
35234
35235 .section "Scanning with regular expressions" "SECTscanregex"
35236 .cindex "content scanning" "with regular expressions"
35237 .cindex "regular expressions" "content scanning with"
35238 You can specify your own custom regular expression matches on the full body of
35239 the message, or on individual MIME parts.
35240
35241 The &%regex%& condition takes one or more regular expressions as arguments and
35242 matches them against the full message (when called in the DATA ACL) or a raw
35243 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35244 linewise, with a maximum line length of 32K characters. That means you cannot
35245 have multiline matches with the &%regex%& condition.
35246
35247 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35248 to 32K of decoded content (the whole content at once, not linewise). If the
35249 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35250 is decoded automatically when &%mime_regex%& is executed (using default path
35251 and filename values). If the decoded data is larger than  32K, only the first
35252 32K characters are checked.
35253
35254 The regular expressions are passed as a colon-separated list. To include a
35255 literal colon, you must double it. Since the whole right-hand side string is
35256 expanded before being used, you must also escape dollar signs and backslashes
35257 with more backslashes, or use the &`\N`& facility to disable expansion.
35258 Here is a simple example that contains two regular expressions:
35259 .code
35260 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35261      message = contains blacklisted regex ($regex_match_string)
35262 .endd
35263 The conditions returns true if any one of the regular expressions matches. The
35264 &$regex_match_string$& expansion variable is then set up and contains the
35265 matching regular expression.
35266 The expansion variables &$regex1$& &$regex2$& etc
35267 are set to any substrings captured by the regular expression.
35268
35269 &*Warning*&: With large messages, these conditions can be fairly
35270 CPU-intensive.
35271
35272 .ecindex IIDcosca
35273
35274
35275
35276
35277 . ////////////////////////////////////////////////////////////////////////////
35278 . ////////////////////////////////////////////////////////////////////////////
35279
35280 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35281          "Local scan function"
35282 .scindex IIDlosca "&[local_scan()]& function" "description of"
35283 .cindex "customizing" "input scan using C function"
35284 .cindex "policy control" "by local scan function"
35285 In these days of email worms, viruses, and ever-increasing spam, some sites
35286 want to apply a lot of checking to messages before accepting them.
35287
35288 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35289 passing messages to external virus and spam scanning software. You can also do
35290 a certain amount in Exim itself through string expansions and the &%condition%&
35291 condition in the ACL that runs after the SMTP DATA command or the ACL for
35292 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35293
35294 To allow for further customization to a site's own requirements, there is the
35295 possibility of linking Exim with a private message scanning function, written
35296 in C. If you want to run code that is written in something other than C, you
35297 can of course use a little C stub to call it.
35298
35299 The local scan function is run once for every incoming message, at the point
35300 when Exim is just about to accept the message.
35301 It can therefore be used to control non-SMTP messages from local processes as
35302 well as messages arriving via SMTP.
35303
35304 Exim applies a timeout to calls of the local scan function, and there is an
35305 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35306 Zero means &"no timeout"&.
35307 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35308 before calling the local scan function, so that the most common types of crash
35309 are caught. If the timeout is exceeded or one of those signals is caught, the
35310 incoming message is rejected with a temporary error if it is an SMTP message.
35311 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35312 code. The incident is logged on the main and reject logs.
35313
35314
35315
35316 .section "Building Exim to use a local scan function" "SECID207"
35317 .cindex "&[local_scan()]& function" "building Exim to use"
35318 To make use of the local scan function feature, you must tell Exim where your
35319 function is before building Exim, by setting
35320 both HAVE_LOCAL_SCAN and
35321 LOCAL_SCAN_SOURCE in your
35322 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35323 directory, so you might set
35324 .code
35325 HAVE_LOCAL_SCAN=yes
35326 LOCAL_SCAN_SOURCE=Local/local_scan.c
35327 .endd
35328 for example. The function must be called &[local_scan()]&;
35329 the source file(s) for it should first #define LOCAL_SCAN
35330 and then #include "local_scan.h".
35331 It is called by
35332 Exim after it has received a message, when the success return code is about to
35333 be sent. This is after all the ACLs have been run. The return code from your
35334 function controls whether the message is actually accepted or not. There is a
35335 commented template function (that just accepts the message) in the file
35336 _src/local_scan.c_.
35337
35338 If you want to make use of Exim's runtime configuration file to set options
35339 for your &[local_scan()]& function, you must also set
35340 .code
35341 LOCAL_SCAN_HAS_OPTIONS=yes
35342 .endd
35343 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35344
35345
35346
35347
35348 .section "API for local_scan()" "SECTapiforloc"
35349 .cindex "&[local_scan()]& function" "API description"
35350 .cindex &%dlfunc%& "API description"
35351 You must include this line near the start of your code:
35352 .code
35353 #define LOCAL_SCAN
35354 #include "local_scan.h"
35355 .endd
35356 This header file defines a number of variables and other values, and the
35357 prototype for the function itself. Exim is coded to use unsigned char values
35358 almost exclusively, and one of the things this header defines is a shorthand
35359 for &`unsigned char`& called &`uschar`&.
35360 It also makes available the following macro definitions, to simplify casting character
35361 strings and pointers to character strings:
35362 .code
35363 #define CS   (char *)
35364 #define CCS  (const char *)
35365 #define CSS  (char **)
35366 #define US   (unsigned char *)
35367 #define CUS  (const unsigned char *)
35368 #define USS  (unsigned char **)
35369 .endd
35370 The function prototype for &[local_scan()]& is:
35371 .code
35372 extern int local_scan(int fd, uschar **return_text);
35373 .endd
35374 The arguments are as follows:
35375
35376 .ilist
35377 &%fd%& is a file descriptor for the file that contains the body of the message
35378 (the -D file). The file is open for reading and writing, but updating it is not
35379 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35380
35381 The descriptor is positioned at character 19 of the file, which is the first
35382 character of the body itself, because the first 19 characters are the message
35383 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35384 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35385 case this changes in some future version.
35386 .next
35387 &%return_text%& is an address which you can use to return a pointer to a text
35388 string at the end of the function. The value it points to on entry is NULL.
35389 .endlist
35390
35391 The function must return an &%int%& value which is one of the following macros:
35392
35393 .vlist
35394 .vitem &`LOCAL_SCAN_ACCEPT`&
35395 .vindex "&$local_scan_data$&"
35396 The message is accepted. If you pass back a string of text, it is saved with
35397 the message, and made available in the variable &$local_scan_data$&. No
35398 newlines are permitted (if there are any, they are turned into spaces) and the
35399 maximum length of text is 1000 characters.
35400
35401 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35402 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35403 queued without immediate delivery, and is frozen.
35404
35405 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35406 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35407 queued without immediate delivery.
35408
35409 .vitem &`LOCAL_SCAN_REJECT`&
35410 The message is rejected; the returned text is used as an error message which is
35411 passed back to the sender and which is also logged. Newlines are permitted &--
35412 they cause a multiline response for SMTP rejections, but are converted to
35413 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35414 used.
35415
35416 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35417 The message is temporarily rejected; the returned text is used as an error
35418 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35419 problem"& is used.
35420
35421 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35422 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35423 message is not written to the reject log. It has the effect of unsetting the
35424 &%rejected_header%& log selector for just this rejection. If
35425 &%rejected_header%& is already unset (see the discussion of the
35426 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35427 same as LOCAL_SCAN_REJECT.
35428
35429 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35430 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35431 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35432 .endlist
35433
35434 If the message is not being received by interactive SMTP, rejections are
35435 reported by writing to &%stderr%& or by sending an email, as configured by the
35436 &%-oe%& command line options.
35437
35438
35439
35440 .section "Configuration options for local_scan()" "SECTconoptloc"
35441 .cindex "&[local_scan()]& function" "configuration options"
35442 It is possible to have option settings in the main configuration file
35443 that set values in static variables in the &[local_scan()]& module. If you
35444 want to do this, you must have the line
35445 .code
35446 LOCAL_SCAN_HAS_OPTIONS=yes
35447 .endd
35448 in your &_Local/Makefile_& when you build Exim. (This line is in
35449 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35450 file, you must define static variables to hold the option values, and a table
35451 to define them.
35452
35453 The table must be a vector called &%local_scan_options%&, of type
35454 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35455 and a pointer to the variable that holds the value. The entries must appear in
35456 alphabetical order. Following &%local_scan_options%& you must also define a
35457 variable called &%local_scan_options_count%& that contains the number of
35458 entries in the table. Here is a short example, showing two kinds of option:
35459 .code
35460 static int my_integer_option = 42;
35461 static uschar *my_string_option = US"a default string";
35462
35463 optionlist local_scan_options[] = {
35464   { "my_integer", opt_int,       &my_integer_option },
35465   { "my_string",  opt_stringptr, &my_string_option }
35466 };
35467
35468 int local_scan_options_count =
35469   sizeof(local_scan_options)/sizeof(optionlist);
35470 .endd
35471 The values of the variables can now be changed from Exim's runtime
35472 configuration file by including a local scan section as in this example:
35473 .code
35474 begin local_scan
35475 my_integer = 99
35476 my_string = some string of text...
35477 .endd
35478 The available types of option data are as follows:
35479
35480 .vlist
35481 .vitem &*opt_bool*&
35482 This specifies a boolean (true/false) option. The address should point to a
35483 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35484 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35485 whether such a variable has been set at all, you can initialize it to
35486 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35487 values.)
35488
35489 .vitem &*opt_fixed*&
35490 This specifies a fixed point number, such as is used for load averages.
35491 The address should point to a variable of type &`int`&. The value is stored
35492 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35493
35494 .vitem &*opt_int*&
35495 This specifies an integer; the address should point to a variable of type
35496 &`int`&. The value may be specified in any of the integer formats accepted by
35497 Exim.
35498
35499 .vitem &*opt_mkint*&
35500 This is the same as &%opt_int%&, except that when such a value is output in a
35501 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35502 printed with the suffix K or M.
35503
35504 .vitem &*opt_octint*&
35505 This also specifies an integer, but the value is always interpreted as an
35506 octal integer, whether or not it starts with the digit zero, and it is
35507 always output in octal.
35508
35509 .vitem &*opt_stringptr*&
35510 This specifies a string value; the address must be a pointer to a
35511 variable that points to a string (for example, of type &`uschar *`&).
35512
35513 .vitem &*opt_time*&
35514 This specifies a time interval value. The address must point to a variable of
35515 type &`int`&. The value that is placed there is a number of seconds.
35516 .endlist
35517
35518 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35519 out the values of all the &[local_scan()]& options.
35520
35521
35522
35523 .section "Available Exim variables" "SECID208"
35524 .cindex "&[local_scan()]& function" "available Exim variables"
35525 The header &_local_scan.h_& gives you access to a number of C variables. These
35526 are the only ones that are guaranteed to be maintained from release to release.
35527 Note, however, that you can obtain the value of any Exim expansion variable,
35528 including &$recipients$&, by calling &'expand_string()'&. The exported
35529 C variables are as follows:
35530
35531 .vlist
35532 .vitem &*int&~body_linecount*&
35533 This variable contains the number of lines in the message's body.
35534 It is not valid if the &%spool_wireformat%& option is used.
35535
35536 .vitem &*int&~body_zerocount*&
35537 This variable contains the number of binary zero bytes in the message's body.
35538 It is not valid if the &%spool_wireformat%& option is used.
35539
35540 .vitem &*unsigned&~int&~debug_selector*&
35541 This variable is set to zero when no debugging is taking place. Otherwise, it
35542 is a bitmap of debugging selectors. Two bits are identified for use in
35543 &[local_scan()]&; they are defined as macros:
35544
35545 .ilist
35546 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35547 testing option that is not privileged &-- any caller may set it. All the
35548 other selector bits can be set only by admin users.
35549
35550 .next
35551 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35552 by the &`+local_scan`& debug selector. It is not included in the default set
35553 of debugging bits.
35554 .endlist ilist
35555
35556 Thus, to write to the debugging output only when &`+local_scan`& has been
35557 selected, you should use code like this:
35558 .code
35559 if ((debug_selector & D_local_scan) != 0)
35560   debug_printf("xxx", ...);
35561 .endd
35562 .vitem &*uschar&~*expand_string_message*&
35563 After a failing call to &'expand_string()'& (returned value NULL), the
35564 variable &%expand_string_message%& contains the error message, zero-terminated.
35565
35566 .vitem &*header_line&~*header_list*&
35567 A pointer to a chain of header lines. The &%header_line%& structure is
35568 discussed below.
35569
35570 .vitem &*header_line&~*header_last*&
35571 A pointer to the last of the header lines.
35572
35573 .vitem &*const&~uschar&~*headers_charset*&
35574 The value of the &%headers_charset%& configuration option.
35575
35576 .vitem &*BOOL&~host_checking*&
35577 This variable is TRUE during a host checking session that is initiated by the
35578 &%-bh%& command line option.
35579
35580 .vitem &*uschar&~*interface_address*&
35581 The IP address of the interface that received the message, as a string. This
35582 is NULL for locally submitted messages.
35583
35584 .vitem &*int&~interface_port*&
35585 The port on which this message was received. When testing with the &%-bh%&
35586 command line option, the value of this variable is -1 unless a port has been
35587 specified via the &%-oMi%& option.
35588
35589 .vitem &*uschar&~*message_id*&
35590 This variable contains Exim's message id for the incoming message (the value of
35591 &$message_exim_id$&) as a zero-terminated string.
35592
35593 .vitem &*uschar&~*received_protocol*&
35594 The name of the protocol by which the message was received.
35595
35596 .vitem &*int&~recipients_count*&
35597 The number of accepted recipients.
35598
35599 .vitem &*recipient_item&~*recipients_list*&
35600 .cindex "recipient" "adding in local scan"
35601 .cindex "recipient" "removing in local scan"
35602 The list of accepted recipients, held in a vector of length
35603 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35604 can add additional recipients by calling &'receive_add_recipient()'& (see
35605 below). You can delete recipients by removing them from the vector and
35606 adjusting the value in &%recipients_count%&. In particular, by setting
35607 &%recipients_count%& to zero you remove all recipients. If you then return the
35608 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35609 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35610 and then call &'receive_add_recipient()'& as often as needed.
35611
35612 .vitem &*uschar&~*sender_address*&
35613 The envelope sender address. For bounce messages this is the empty string.
35614
35615 .vitem &*uschar&~*sender_host_address*&
35616 The IP address of the sending host, as a string. This is NULL for
35617 locally-submitted messages.
35618
35619 .vitem &*uschar&~*sender_host_authenticated*&
35620 The name of the authentication mechanism that was used, or NULL if the message
35621 was not received over an authenticated SMTP connection.
35622
35623 .vitem &*uschar&~*sender_host_name*&
35624 The name of the sending host, if known.
35625
35626 .vitem &*int&~sender_host_port*&
35627 The port on the sending host.
35628
35629 .vitem &*BOOL&~smtp_input*&
35630 This variable is TRUE for all SMTP input, including BSMTP.
35631
35632 .vitem &*BOOL&~smtp_batched_input*&
35633 This variable is TRUE for BSMTP input.
35634
35635 .vitem &*int&~store_pool*&
35636 The contents of this variable control which pool of memory is used for new
35637 requests. See section &<<SECTmemhanloc>>& for details.
35638 .endlist
35639
35640
35641 .section "Structure of header lines" "SECID209"
35642 The &%header_line%& structure contains the members listed below.
35643 You can add additional header lines by calling the &'header_add()'& function
35644 (see below). You can cause header lines to be ignored (deleted) by setting
35645 their type to *.
35646
35647
35648 .vlist
35649 .vitem &*struct&~header_line&~*next*&
35650 A pointer to the next header line, or NULL for the last line.
35651
35652 .vitem &*int&~type*&
35653 A code identifying certain headers that Exim recognizes. The codes are printing
35654 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35655 Notice in particular that any header line whose type is * is not transmitted
35656 with the message. This flagging is used for header lines that have been
35657 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35658 lines.) Effectively, * means &"deleted"&.
35659
35660 .vitem &*int&~slen*&
35661 The number of characters in the header line, including the terminating and any
35662 internal newlines.
35663
35664 .vitem &*uschar&~*text*&
35665 A pointer to the text of the header. It always ends with a newline, followed by
35666 a zero byte. Internal newlines are preserved.
35667 .endlist
35668
35669
35670
35671 .section "Structure of recipient items" "SECID210"
35672 The &%recipient_item%& structure contains these members:
35673
35674 .vlist
35675 .vitem &*uschar&~*address*&
35676 This is a pointer to the recipient address as it was received.
35677
35678 .vitem &*int&~pno*&
35679 This is used in later Exim processing when top level addresses are created by
35680 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35681 and must always contain -1 at this stage.
35682
35683 .vitem &*uschar&~*errors_to*&
35684 If this value is not NULL, bounce messages caused by failing to deliver to the
35685 recipient are sent to the address it contains. In other words, it overrides the
35686 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35687 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35688 an unqualified address, Exim qualifies it using the domain from
35689 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35690 is NULL for all recipients.
35691 .endlist
35692
35693
35694
35695 .section "Available Exim functions" "SECID211"
35696 .cindex "&[local_scan()]& function" "available Exim functions"
35697 The header &_local_scan.h_& gives you access to a number of Exim functions.
35698 These are the only ones that are guaranteed to be maintained from release to
35699 release:
35700
35701 .vlist
35702 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35703        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35704
35705 This function creates a child process that runs the command specified by
35706 &%argv%&. The environment for the process is specified by &%envp%&, which can
35707 be NULL if no environment variables are to be passed. A new umask is supplied
35708 for the process in &%newumask%&.
35709
35710 Pipes to the standard input and output of the new process are set up
35711 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35712 standard error is cloned to the standard output. If there are any file
35713 descriptors &"in the way"& in the new process, they are closed. If the final
35714 argument is TRUE, the new process is made into a process group leader.
35715
35716 The function returns the pid of the new process, or -1 if things go wrong.
35717
35718 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35719 This function waits for a child process to terminate, or for a timeout (in
35720 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35721 return value is as follows:
35722
35723 .ilist
35724 >= 0
35725
35726 The process terminated by a normal exit and the value is the process
35727 ending status.
35728
35729 .next
35730 < 0 and > &--256
35731
35732 The process was terminated by a signal and the value is the negation of the
35733 signal number.
35734
35735 .next
35736 &--256
35737
35738 The process timed out.
35739 .next
35740 &--257
35741
35742 The was some other error in wait(); &%errno%& is still set.
35743 .endlist
35744
35745 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35746 This function provide you with a means of submitting a new message to
35747 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35748 want, but this packages it all up for you.) The function creates a pipe,
35749 forks a subprocess that is running
35750 .code
35751 exim -t -oem -oi -f <>
35752 .endd
35753 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35754 that is connected to the standard input. The yield of the function is the PID
35755 of the subprocess. You can then write a message to the file descriptor, with
35756 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35757
35758 When you have finished, call &'child_close()'& to wait for the process to
35759 finish and to collect its ending status. A timeout value of zero is usually
35760 fine in this circumstance. Unless you have made a mistake with the recipient
35761 addresses, you should get a return code of zero.
35762
35763
35764 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35765        *sender_authentication)*&
35766 This function is a more sophisticated version of &'child_open()'&. The command
35767 that it runs is:
35768 .display
35769 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35770 .endd
35771 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35772
35773
35774 .vitem &*void&~debug_printf(char&~*,&~...)*&
35775 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35776 output is written to the standard error stream. If no debugging is selected,
35777 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35778 conditional on the &`local_scan`& debug selector by coding like this:
35779 .code
35780 if ((debug_selector & D_local_scan) != 0)
35781   debug_printf("xxx", ...);
35782 .endd
35783
35784 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35785 This is an interface to Exim's string expansion code. The return value is the
35786 expanded string, or NULL if there was an expansion failure.
35787 The C variable &%expand_string_message%& contains an error message after an
35788 expansion failure. If expansion does not change the string, the return value is
35789 the pointer to the input string. Otherwise, the return value points to a new
35790 block of memory that was obtained by a call to &'store_get()'&. See section
35791 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35792
35793 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35794 This function allows you to an add additional header line at the end of the
35795 existing ones. The first argument is the type, and should normally be a space
35796 character. The second argument is a format string and any number of
35797 substitution arguments as for &[sprintf()]&. You may include internal newlines
35798 if you want, and you must ensure that the string ends with a newline.
35799
35800 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35801         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35802 This function adds a new header line at a specified point in the header
35803 chain. The header itself is specified as for &'header_add()'&.
35804
35805 If &%name%& is NULL, the new header is added at the end of the chain if
35806 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35807 NULL, the header lines are searched for the first non-deleted header that
35808 matches the name. If one is found, the new header is added before it if
35809 &%after%& is false. If &%after%& is true, the new header is added after the
35810 found header and any adjacent subsequent ones with the same name (even if
35811 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35812 option controls where the header is added. If it is true, addition is at the
35813 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35814 headers, or at the top if there are no &'Received:'& headers, you could use
35815 .code
35816 header_add_at_position(TRUE, US"Received", TRUE,
35817   ' ', "X-xxx: ...");
35818 .endd
35819 Normally, there is always at least one non-deleted &'Received:'& header, but
35820 there may not be if &%received_header_text%& expands to an empty string.
35821
35822
35823 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35824 This function removes header lines. If &%occurrence%& is zero or negative, all
35825 occurrences of the header are removed. If occurrence is greater than zero, that
35826 particular instance of the header is removed. If no header(s) can be found that
35827 match the specification, the function does nothing.
35828
35829
35830 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35831         int&~length,&~BOOL&~notdel)*&"
35832 This function tests whether the given header has the given name. It is not just
35833 a string comparison, because white space is permitted between the name and the
35834 colon. If the &%notdel%& argument is true, a false return is forced for all
35835 &"deleted"& headers; otherwise they are not treated specially. For example:
35836 .code
35837 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35838 .endd
35839 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35840 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35841 This function base64-encodes a string, which is passed by address and length.
35842 The text may contain bytes of any value, including zero. The result is passed
35843 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35844 zero-terminated.
35845
35846 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35847 This function decodes a base64-encoded string. Its arguments are a
35848 zero-terminated base64-encoded string and the address of a variable that is set
35849 to point to the result, which is in dynamic memory. The length of the decoded
35850 string is the yield of the function. If the input is invalid base64 data, the
35851 yield is -1. A zero byte is added to the end of the output string to make it
35852 easy to interpret as a C string (assuming it contains no zeros of its own). The
35853 added zero byte is not included in the returned count.
35854
35855 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35856 This function checks for a match in a domain list. Domains are always
35857 matched caselessly. The return value is one of the following:
35858 .itable none 0 0 2 15* left 85* left
35859 .irow &`OK`&    "match succeeded"
35860 .irow &`FAIL`&  "match failed"
35861 .irow &`DEFER`& "match deferred"
35862 .endtable
35863 DEFER is usually caused by some kind of lookup defer, such as the
35864 inability to contact a database.
35865
35866 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35867         BOOL&~caseless)*&"
35868 This function checks for a match in a local part list. The third argument
35869 controls case-sensitivity. The return values are as for
35870 &'lss_match_domain()'&.
35871
35872 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35873         BOOL&~caseless)*&"
35874 This function checks for a match in an address list. The third argument
35875 controls the case-sensitivity of the local part match. The domain is always
35876 matched caselessly. The return values are as for &'lss_match_domain()'&.
35877
35878 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35879         uschar&~*list)*&"
35880 This function checks for a match in a host list. The most common usage is
35881 expected to be
35882 .code
35883 lss_match_host(sender_host_name, sender_host_address, ...)
35884 .endd
35885 .vindex "&$sender_host_address$&"
35886 An empty address field matches an empty item in the host list. If the host name
35887 is NULL, the name corresponding to &$sender_host_address$& is automatically
35888 looked up if a host name is required to match an item in the list. The return
35889 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35890 returns ERROR in the case when it had to look up a host name, but the lookup
35891 failed.
35892
35893 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35894         *format,&~...)*&"
35895 This function writes to Exim's log files. The first argument should be zero (it
35896 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35897 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35898 them. It specifies to which log or logs the message is written. The remaining
35899 arguments are a format and relevant insertion arguments. The string should not
35900 contain any newlines, not even at the end.
35901
35902
35903 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35904 This function adds an additional recipient to the message. The first argument
35905 is the recipient address. If it is unqualified (has no domain), it is qualified
35906 with the &%qualify_recipient%& domain. The second argument must always be -1.
35907
35908 This function does not allow you to specify a private &%errors_to%& address (as
35909 described with the structure of &%recipient_item%& above), because it pre-dates
35910 the addition of that field to the structure. However, it is easy to add such a
35911 value afterwards. For example:
35912 .code
35913  receive_add_recipient(US"monitor@mydom.example", -1);
35914  recipients_list[recipients_count-1].errors_to =
35915    US"postmaster@mydom.example";
35916 .endd
35917
35918 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35919 This is a convenience function to remove a named recipient from the list of
35920 recipients. It returns true if a recipient was removed, and false if no
35921 matching recipient could be found. The argument must be a complete email
35922 address.
35923 .endlist
35924
35925
35926 .cindex "RFC 2047"
35927 .vlist
35928 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35929   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35930 This function decodes strings that are encoded according to RFC 2047. Typically
35931 these are the contents of header lines. First, each &"encoded word"& is decoded
35932 from the Q or B encoding into a byte-string. Then, if provided with the name of
35933 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35934 made  to translate the result to the named character set. If this fails, the
35935 binary string is returned with an error message.
35936
35937 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35938 maximum MIME word length is enforced. The third argument is the target
35939 encoding, or NULL if no translation is wanted.
35940
35941 .cindex "binary zero" "in RFC 2047 decoding"
35942 .cindex "RFC 2047" "binary zero in"
35943 If a binary zero is encountered in the decoded string, it is replaced by the
35944 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35945 not be 0 because header lines are handled as zero-terminated strings.
35946
35947 The function returns the result of processing the string, zero-terminated; if
35948 &%lenptr%& is not NULL, the length of the result is set in the variable to
35949 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35950
35951 If an error is encountered, the function returns NULL and uses the &%error%&
35952 argument to return an error message. The variable pointed to by &%error%& is
35953 set to NULL if there is no error; it may be set non-NULL even when the function
35954 returns a non-NULL value if decoding was successful, but there was a problem
35955 with translation.
35956
35957
35958 .vitem &*int&~smtp_fflush(void)*&
35959 This function is used in conjunction with &'smtp_printf()'&, as described
35960 below.
35961
35962 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35963 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35964 output stream. You should use this function only when there is an SMTP output
35965 stream, that is, when the incoming message is being received via interactive
35966 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35967 is FALSE. If you want to test for an incoming message from another host (as
35968 opposed to a local process that used the &%-bs%& command line option), you can
35969 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35970 is involved.
35971
35972 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35973 output function, so it can be used for all forms of SMTP connection.
35974
35975 The second argument is used to request that the data be buffered
35976 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35977 This is advisory only, but likely to save on system-calls and packets
35978 sent when a sequence of calls to the function are made.
35979
35980 The argument was added in Exim version 4.90 - changing the API/ABI.
35981 Nobody noticed until 4.93 was imminent, at which point the
35982 ABI version number was incremented.
35983
35984 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35985 must start with an appropriate response code: 550 if you are going to return
35986 LOCAL_SCAN_REJECT, 451 if you are going to return
35987 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35988 initial lines of a multi-line response, the code must be followed by a hyphen
35989 to indicate that the line is not the final response line. You must also ensure
35990 that the lines you write terminate with CRLF. For example:
35991 .code
35992 smtp_printf("550-this is some extra info\r\n");
35993 return LOCAL_SCAN_REJECT;
35994 .endd
35995 Note that you can also create multi-line responses by including newlines in
35996 the data returned via the &%return_text%& argument. The added value of using
35997 &'smtp_printf()'& is that, for instance, you could introduce delays between
35998 multiple output lines.
35999
36000 The &'smtp_printf()'& function does not return any error indication, because it
36001 does not
36002 guarantee a flush of
36003 pending output, and therefore does not test
36004 the state of the stream. (In the main code of Exim, flushing and error
36005 detection is done when Exim is ready for the next SMTP input command.) If
36006 you want to flush the output and check for an error (for example, the
36007 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
36008 arguments. It flushes the output stream, and returns a non-zero value if there
36009 is an error.
36010
36011 .vitem &*void&~*store_get(int,BOOL)*&
36012 This function accesses Exim's internal store (memory) manager. It gets a new
36013 chunk of memory whose size is given by the first argument.
36014 The second argument should be given as TRUE if the memory will be used for
36015 data possibly coming from an attacker (eg. the message content),
36016 FALSE if it is locally-sourced.
36017 Exim bombs out if it ever
36018 runs out of memory. See the next section for a discussion of memory handling.
36019
36020 .vitem &*void&~*store_get_perm(int,BOOL)*&
36021 This function is like &'store_get()'&, but it always gets memory from the
36022 permanent pool. See the next section for a discussion of memory handling.
36023
36024 .vitem &*uschar&~*string_copy(uschar&~*string)*&
36025 See below.
36026
36027 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
36028 See below.
36029
36030 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
36031 These three functions create strings using Exim's dynamic memory facilities.
36032 The first makes a copy of an entire string. The second copies up to a maximum
36033 number of characters, indicated by the second argument. The third uses a format
36034 and insertion arguments to create a new string. In each case, the result is a
36035 pointer to a new string in the current memory pool. See the next section for
36036 more discussion.
36037 .endlist
36038
36039
36040
36041 .section "More about Exim's memory handling" "SECTmemhanloc"
36042 .cindex "&[local_scan()]& function" "memory handling"
36043 No function is provided for freeing memory, because that is never needed.
36044 The dynamic memory that Exim uses when receiving a message is automatically
36045 recycled if another message is received by the same process (this applies only
36046 to incoming SMTP connections &-- other input methods can supply only one
36047 message at a time). After receiving the last message, a reception process
36048 terminates.
36049
36050 Because it is recycled, the normal dynamic memory cannot be used for holding
36051 data that must be preserved over a number of incoming messages on the same SMTP
36052 connection. However, Exim in fact uses two pools of dynamic memory; the second
36053 one is not recycled, and can be used for this purpose.
36054
36055 If you want to allocate memory that remains available for subsequent messages
36056 in the same SMTP connection, you should set
36057 .code
36058 store_pool = POOL_PERM
36059 .endd
36060 before calling the function that does the allocation. There is no need to
36061 restore the value if you do not need to; however, if you do want to revert to
36062 the normal pool, you can either restore the previous value of &%store_pool%& or
36063 set it explicitly to POOL_MAIN.
36064
36065 The pool setting applies to all functions that get dynamic memory, including
36066 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36067 There is also a convenience function called &'store_get_perm()'& that gets a
36068 block of memory from the permanent pool while preserving the value of
36069 &%store_pool%&.
36070 .ecindex IIDlosca
36071
36072
36073
36074
36075 . ////////////////////////////////////////////////////////////////////////////
36076 . ////////////////////////////////////////////////////////////////////////////
36077
36078 .chapter "System-wide message filtering" "CHAPsystemfilter"
36079 .scindex IIDsysfil1 "filter" "system filter"
36080 .scindex IIDsysfil2 "filtering all mail"
36081 .scindex IIDsysfil3 "system filter"
36082 The previous chapters (on ACLs and the local scan function) describe checks
36083 that can be applied to messages before they are accepted by a host. There is
36084 also a mechanism for checking messages once they have been received, but before
36085 they are delivered. This is called the &'system filter'&.
36086
36087 The system filter operates in a similar manner to users' filter files, but it
36088 is run just once per message (however many recipients the message has).
36089 It should not normally be used as a substitute for routing, because &%deliver%&
36090 commands in a system router provide new envelope recipient addresses.
36091 The system filter must be an Exim filter. It cannot be a Sieve filter.
36092
36093 The system filter is run at the start of a delivery attempt, before any routing
36094 is done. If a message fails to be completely delivered at the first attempt,
36095 the system filter is run again at the start of every retry.
36096 If you want your filter to do something only once per message, you can make use
36097 .cindex retry condition
36098 of the &%first_delivery%& condition in an &%if%& command in the filter to
36099 prevent it happening on retries.
36100
36101 .vindex "&$domain$&"
36102 .vindex "&$local_part$&"
36103 &*Warning*&: Because the system filter runs just once, variables that are
36104 specific to individual recipient addresses, such as &$local_part$& and
36105 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36106 you want to run a centrally-specified filter for each recipient address
36107 independently, you can do so by setting up a suitable &(redirect)& router, as
36108 described in section &<<SECTperaddfil>>& below.
36109
36110
36111 .section "Specifying a system filter" "SECID212"
36112 .cindex "uid (user id)" "system filter"
36113 .cindex "gid (group id)" "system filter"
36114 The name of the file that contains the system filter must be specified by
36115 setting &%system_filter%&. If you want the filter to run under a uid and gid
36116 other than root, you must also set &%system_filter_user%& and
36117 &%system_filter_group%& as appropriate. For example:
36118 .code
36119 system_filter = /etc/mail/exim.filter
36120 system_filter_user = exim
36121 .endd
36122 If a system filter generates any deliveries directly to files or pipes (via the
36123 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36124 specified by setting &%system_filter_file_transport%& and
36125 &%system_filter_pipe_transport%&, respectively. Similarly,
36126 &%system_filter_reply_transport%& must be set to handle any messages generated
36127 by the &%reply%& command.
36128
36129
36130 .section "Testing a system filter" "SECID213"
36131 You can run simple tests of a system filter in the same way as for a user
36132 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36133 are permitted only in system filters are recognized.
36134
36135 If you want to test the combined effect of a system filter and a user filter,
36136 you can use both &%-bF%& and &%-bf%& on the same command line.
36137
36138
36139
36140 .section "Contents of a system filter" "SECID214"
36141 The language used to specify system filters is the same as for users' filter
36142 files. It is described in the separate end-user document &'Exim's interface to
36143 mail filtering'&. However, there are some additional features that are
36144 available only in system filters; these are described in subsequent sections.
36145 If they are encountered in a user's filter file or when testing with &%-bf%&,
36146 they cause errors.
36147
36148 .cindex "frozen messages" "manual thaw; testing in filter"
36149 There are two special conditions which, though available in users' filter
36150 files, are designed for use in system filters. The condition &%first_delivery%&
36151 is true only for the first attempt at delivering a message, and
36152 &%manually_thawed%& is true only if the message has been frozen, and
36153 subsequently thawed by an admin user. An explicit forced delivery counts as a
36154 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36155
36156 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36157 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36158 succeed, it will not be tried again.
36159 If you want Exim to retry an unseen delivery until it succeeds, you should
36160 arrange to set it up every time the filter runs.
36161
36162 When a system filter finishes running, the values of the variables &$n0$& &--
36163 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36164 users' filter files. Thus a system filter can, for example, set up &"scores"&
36165 to which users' filter files can refer.
36166
36167
36168
36169 .section "Additional variable for system filters" "SECID215"
36170 .vindex "&$recipients$&"
36171 The expansion variable &$recipients$&, containing a list of all the recipients
36172 of the message (separated by commas and white space), is available in system
36173 filters. It is not available in users' filters for privacy reasons.
36174
36175
36176
36177 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36178 .cindex "freezing messages"
36179 .cindex "message" "freezing"
36180 .cindex "message" "forced failure"
36181 .cindex "&%fail%&" "in system filter"
36182 .cindex "&%freeze%& in system filter"
36183 .cindex "&%defer%& in system filter"
36184 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36185 always available in system filters, but are not normally enabled in users'
36186 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36187 for the &(redirect)& router.) These commands can optionally be followed by the
36188 word &%text%& and a string containing an error message, for example:
36189 .code
36190 fail text "this message looks like spam to me"
36191 .endd
36192 The keyword &%text%& is optional if the next character is a double quote.
36193
36194 The &%defer%& command defers delivery of the original recipients of the
36195 message. The &%fail%& command causes all the original recipients to be failed,
36196 and a bounce message to be created. The &%freeze%& command suspends all
36197 delivery attempts for the original recipients. In all cases, any new deliveries
36198 that are specified by the filter are attempted as normal after the filter has
36199 run.
36200
36201 The &%freeze%& command is ignored if the message has been manually unfrozen and
36202 not manually frozen since. This means that automatic freezing by a system
36203 filter can be used as a way of checking out suspicious messages. If a message
36204 is found to be all right, manually unfreezing it allows it to be delivered.
36205
36206 .cindex "log" "&%fail%& command log line"
36207 .cindex "&%fail%&" "log line; reducing"
36208 The text given with a fail command is used as part of the bounce message as
36209 well as being written to the log. If the message is quite long, this can fill
36210 up a lot of log space when such failures are common. To reduce the size of the
36211 log message, Exim interprets the text in a special way if it starts with the
36212 two characters &`<<`& and contains &`>>`& later. The text between these two
36213 strings is written to the log, and the rest of the text is used in the bounce
36214 message. For example:
36215 .code
36216 fail "<<filter test 1>>Your message is rejected \
36217      because it contains attachments that we are \
36218      not prepared to receive."
36219 .endd
36220
36221 .cindex "loop" "caused by &%fail%&"
36222 Take great care with the &%fail%& command when basing the decision to fail on
36223 the contents of the message, because the bounce message will of course include
36224 the contents of the original message and will therefore trigger the &%fail%&
36225 command again (causing a mail loop) unless steps are taken to prevent this.
36226 Testing the &%error_message%& condition is one way to prevent this. You could
36227 use, for example
36228 .code
36229 if $message_body contains "this is spam" and not error_message
36230 then fail text "spam is not wanted here" endif
36231 .endd
36232 though of course that might let through unwanted bounce messages. The
36233 alternative is clever checking of the body and/or headers to detect bounces
36234 generated by the filter.
36235
36236 The interpretation of a system filter file ceases after a
36237 &%defer%&,
36238 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36239 set up earlier in the filter file are honoured, so you can use a sequence such
36240 as
36241 .code
36242 mail ...
36243 freeze
36244 .endd
36245 to send a specified message when the system filter is freezing (or deferring or
36246 failing) a message. The normal deliveries for the message do not, of course,
36247 take place.
36248
36249
36250
36251 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36252 .cindex "header lines" "adding; in system filter"
36253 .cindex "header lines" "removing; in system filter"
36254 .cindex "filter" "header lines; adding/removing"
36255 Two filter commands that are available only in system filters are:
36256 .code
36257 headers add <string>
36258 headers remove <string>
36259 .endd
36260 The argument for the &%headers add%& is a string that is expanded and then
36261 added to the end of the message's headers. It is the responsibility of the
36262 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36263 space is ignored, and if the string is otherwise empty, or if the expansion is
36264 forced to fail, the command has no effect.
36265
36266 You can use &"\n"& within the string, followed by white space, to specify
36267 continued header lines. More than one header may be added in one command by
36268 including &"\n"& within the string without any following white space. For
36269 example:
36270 .code
36271 headers add "X-header-1: ....\n  \
36272              continuation of X-header-1 ...\n\
36273              X-header-2: ...."
36274 .endd
36275 Note that the header line continuation white space after the first newline must
36276 be placed before the backslash that continues the input string, because white
36277 space after input continuations is ignored.
36278
36279 The argument for &%headers remove%& is a colon-separated list of header names.
36280 This command applies only to those headers that are stored with the message;
36281 those that are added at delivery time (such as &'Envelope-To:'& and
36282 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36283 header with the same name, they are all removed.
36284
36285 The &%headers%& command in a system filter makes an immediate change to the set
36286 of header lines that was received with the message (with possible additions
36287 from ACL processing). Subsequent commands in the system filter operate on the
36288 modified set, which also forms the basis for subsequent message delivery.
36289 Unless further modified during routing or transporting, this set of headers is
36290 used for all recipients of the message.
36291
36292 During routing and transporting, the variables that refer to the contents of
36293 header lines refer only to those lines that are in this set. Thus, header lines
36294 that are added by a system filter are visible to users' filter files and to all
36295 routers and transports. This contrasts with the manipulation of header lines by
36296 routers and transports, which is not immediate, but which instead is saved up
36297 until the message is actually being written (see section
36298 &<<SECTheadersaddrem>>&).
36299
36300 If the message is not delivered at the first attempt, header lines that were
36301 added by the system filter are stored with the message, and so are still
36302 present at the next delivery attempt. Header lines that were removed are still
36303 present, but marked &"deleted"& so that they are not transported with the
36304 message. For this reason, it is usual to make the &%headers%& command
36305 conditional on &%first_delivery%& so that the set of header lines is not
36306 modified more than once.
36307
36308 Because header modification in a system filter acts immediately, you have to
36309 use an indirect approach if you want to modify the contents of a header line.
36310 For example:
36311 .code
36312 headers add "Old-Subject: $h_subject:"
36313 headers remove "Subject"
36314 headers add "Subject: new subject (was: $h_old-subject:)"
36315 headers remove "Old-Subject"
36316 .endd
36317
36318
36319
36320 .section "Setting an errors address in a system filter" "SECID217"
36321 .cindex "envelope from"
36322 .cindex "envelope sender"
36323 In a system filter, if a &%deliver%& command is followed by
36324 .code
36325 errors_to <some address>
36326 .endd
36327 in order to change the envelope sender (and hence the error reporting) for that
36328 delivery, any address may be specified. (In a user filter, only the current
36329 user's address can be set.) For example, if some mail is being monitored, you
36330 might use
36331 .code
36332 unseen deliver monitor@spying.example errors_to root@local.example
36333 .endd
36334 to take a copy which would not be sent back to the normal error reporting
36335 address if its delivery failed.
36336
36337
36338
36339 .section "Per-address filtering" "SECTperaddfil"
36340 .vindex "&$domain_data$&"
36341 .vindex "&$local_part_data$&"
36342 In contrast to the system filter, which is run just once per message for each
36343 delivery attempt, it is also possible to set up a system-wide filtering
36344 operation that runs once for each recipient address. In this case, variables
36345 such as &$local_part_data$& and &$domain_data$& can be used,
36346 and indeed, the choice of filter file could be made dependent on them.
36347 This is an example of a router which implements such a filter:
36348 .code
36349 central_filter:
36350   check_local_user
36351   driver = redirect
36352   domains = +local_domains
36353   file = /central/filters/$local_part_data
36354   no_verify
36355   allow_filter
36356   allow_freeze
36357 .endd
36358 The filter is run in a separate process under its own uid. Therefore, either
36359 &%check_local_user%& must be set (as above), in which case the filter is run as
36360 the local user, or the &%user%& option must be used to specify which user to
36361 use. If both are set, &%user%& overrides.
36362
36363 Care should be taken to ensure that none of the commands in the filter file
36364 specify a significant delivery if the message is to go on to be delivered to
36365 its intended recipient. The router will not then claim to have dealt with the
36366 address, so it will be passed on to subsequent routers to be delivered in the
36367 normal way.
36368 .ecindex IIDsysfil1
36369 .ecindex IIDsysfil2
36370 .ecindex IIDsysfil3
36371
36372
36373
36374
36375
36376
36377 . ////////////////////////////////////////////////////////////////////////////
36378 . ////////////////////////////////////////////////////////////////////////////
36379
36380 .chapter "Message processing" "CHAPmsgproc"
36381 .scindex IIDmesproc "message" "general processing"
36382 Exim performs various transformations on the sender and recipient addresses of
36383 all messages that it handles, and also on the messages' header lines. Some of
36384 these are optional and configurable, while others always take place. All of
36385 this processing, except rewriting as a result of routing, and the addition or
36386 removal of header lines while delivering, happens when a message is received,
36387 before it is placed on Exim's queue.
36388
36389 Some of the automatic processing takes place by default only for
36390 &"locally-originated"& messages. This adjective is used to describe messages
36391 that are not received over TCP/IP, but instead are passed to an Exim process on
36392 its standard input. This includes the interactive &"local SMTP"& case that is
36393 set up by the &%-bs%& command line option.
36394
36395 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36396 or ::1) are not considered to be locally-originated. Exim does not treat the
36397 loopback interface specially in any way.
36398
36399 If you want the loopback interface to be treated specially, you must ensure
36400 that there are appropriate entries in your ACLs.
36401
36402
36403
36404
36405 .section "Submission mode for non-local messages" "SECTsubmodnon"
36406 .cindex "message" "submission"
36407 .cindex "submission mode"
36408 Processing that happens automatically for locally-originated messages (unless
36409 &%suppress_local_fixups%& is set) can also be requested for messages that are
36410 received over TCP/IP. The term &"submission mode"& is used to describe this
36411 state. Submission mode is set by the modifier
36412 .code
36413 control = submission
36414 .endd
36415 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36416 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36417 a local submission, and is normally used when the source of the message is
36418 known to be an MUA running on a client host (as opposed to an MTA). For
36419 example, to set submission mode for messages originating on the IPv4 loopback
36420 interface, you could include the following in the MAIL ACL:
36421 .code
36422 warn  hosts = 127.0.0.1
36423       control = submission
36424 .endd
36425 .cindex "&%sender_retain%& submission option"
36426 There are some options that can be used when setting submission mode. A slash
36427 is used to separate options. For example:
36428 .code
36429 control = submission/sender_retain
36430 .endd
36431 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36432 true and &%local_from_check%& false for the current incoming message. The first
36433 of these allows an existing &'Sender:'& header in the message to remain, and
36434 the second suppresses the check to ensure that &'From:'& matches the
36435 authenticated sender. With this setting, Exim still fixes up messages by adding
36436 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36437 attempt to check sender authenticity in header lines.
36438
36439 When &%sender_retain%& is not set, a submission mode setting may specify a
36440 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36441 example:
36442 .code
36443 control = submission/domain=some.domain
36444 .endd
36445 The domain may be empty. How this value is used is described in sections
36446 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36447 that allows you to specify the user's full name for inclusion in a created
36448 &'Sender:'& or &'From:'& header line. For example:
36449 .code
36450 accept authenticated = *
36451        control = submission/domain=wonderland.example/\
36452                             name=${lookup {$authenticated_id} \
36453                                    lsearch {/etc/exim/namelist}}
36454 .endd
36455 Because the name may contain any characters, including slashes, the &%name%&
36456 option must be given last. The remainder of the string is used as the name. For
36457 the example above, if &_/etc/exim/namelist_& contains:
36458 .code
36459 bigegg:  Humpty Dumpty
36460 .endd
36461 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36462 line would be:
36463 .code
36464 Sender: Humpty Dumpty <bigegg@wonderland.example>
36465 .endd
36466 .cindex "return path" "in submission mode"
36467 By default, submission mode forces the return path to the same address as is
36468 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36469 specified, the return path is also left unchanged.
36470
36471 &*Note*&: The changes caused by submission mode take effect after the predata
36472 ACL. This means that any sender checks performed before the fix-ups use the
36473 untrusted sender address specified by the user, not the trusted sender address
36474 specified by submission mode. Although this might be slightly unexpected, it
36475 does mean that you can configure ACL checks to spot that a user is trying to
36476 spoof another's address.
36477
36478 .section "Line endings" "SECTlineendings"
36479 .cindex "line endings"
36480 .cindex "carriage return"
36481 .cindex "linefeed"
36482 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36483 linefeed) is the line ending for messages transmitted over the Internet using
36484 SMTP over TCP/IP. However, within individual operating systems, different
36485 conventions are used. For example, Unix-like systems use just LF, but others
36486 use CRLF or just CR.
36487
36488 Exim was designed for Unix-like systems, and internally, it stores messages
36489 using the system's convention of a single LF as a line terminator. When
36490 receiving a message, all line endings are translated to this standard format.
36491 Originally, it was thought that programs that passed messages directly to an
36492 MTA within an operating system would use that system's convention. Experience
36493 has shown that this is not the case; for example, there are Unix applications
36494 that use CRLF in this circumstance. For this reason, and for compatibility with
36495 other MTAs, the way Exim handles line endings for all messages is now as
36496 follows:
36497
36498 .ilist
36499 LF not preceded by CR is treated as a line ending.
36500 .next
36501 CR is treated as a line ending; if it is immediately followed by LF, the LF
36502 is ignored.
36503 .next
36504 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36505 nor a local message in the state where a line containing only a dot is a
36506 terminator.
36507 .next
36508 If a bare CR is encountered within a header line, an extra space is added after
36509 the line terminator so as not to end the header line. The reasoning behind this
36510 is that bare CRs in header lines are most likely either to be mistakes, or
36511 people trying to play silly games.
36512 .next
36513 If the first header line received in a message ends with CRLF, a subsequent
36514 bare LF in a header line is treated in the same way as a bare CR in a header
36515 line.
36516 .endlist
36517
36518
36519
36520
36521
36522 .section "Unqualified addresses" "SECID218"
36523 .cindex "unqualified addresses"
36524 .cindex "address" "qualification"
36525 By default, Exim expects every envelope address it receives from an external
36526 host to be fully qualified. Unqualified addresses cause negative responses to
36527 SMTP commands. However, because SMTP is used as a means of transporting
36528 messages from MUAs running on personal workstations, there is sometimes a
36529 requirement to accept unqualified addresses from specific hosts or IP networks.
36530
36531 Exim has two options that separately control which hosts may send unqualified
36532 sender or recipient addresses in SMTP commands, namely
36533 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36534 cases, if an unqualified address is accepted, it is qualified by adding the
36535 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36536
36537 .oindex "&%qualify_domain%&"
36538 .oindex "&%qualify_recipient%&"
36539 Unqualified addresses in header lines are automatically qualified for messages
36540 that are locally originated, unless the &%-bnq%& option is given on the command
36541 line. For messages received over SMTP, unqualified addresses in header lines
36542 are qualified only if unqualified addresses are permitted in SMTP commands. In
36543 other words, such qualification is also controlled by
36544 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36545
36546
36547
36548
36549 .section "The UUCP From line" "SECID219"
36550 .cindex "&""From""& line"
36551 .cindex "UUCP" "&""From""& line"
36552 .cindex "sender" "address"
36553 .oindex "&%uucp_from_pattern%&"
36554 .oindex "&%uucp_from_sender%&"
36555 .cindex "envelope from"
36556 .cindex "envelope sender"
36557 .cindex "Sendmail compatibility" "&""From""& line"
36558 Messages that have come from UUCP (and some other applications) often begin
36559 with a line containing the envelope sender and a timestamp, following the word
36560 &"From"&. Examples of two common formats are:
36561 .code
36562 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36563 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36564 .endd
36565 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36566 Exim recognizes such lines at the start of messages that are submitted to it
36567 via the command line (that is, on the standard input). It does not recognize
36568 such lines in incoming SMTP messages, unless the sending host matches
36569 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36570 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36571 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36572 default value matches the two common cases shown above and puts the address
36573 that follows &"From"& into &$1$&.
36574
36575 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36576 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36577 a trusted user, the message's sender address is constructed by expanding the
36578 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36579 then parsed as an RFC 2822 address. If there is no domain, the local part is
36580 qualified with &%qualify_domain%& unless it is the empty string. However, if
36581 the command line &%-f%& option is used, it overrides the &"From"& line.
36582
36583 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36584 sender address is not changed. This is also the case for incoming SMTP messages
36585 that are permitted to contain &"From"& lines.
36586
36587 Only one &"From"& line is recognized. If there is more than one, the second is
36588 treated as a data line that starts the body of the message, as it is not valid
36589 as a header line. This also happens if a &"From"& line is present in an
36590 incoming SMTP message from a source that is not permitted to send them.
36591
36592
36593
36594 .section "Header lines"
36595 .subsection "Resent- header lines" SECID220
36596 .chindex Resent-
36597 RFC 2822 makes provision for sets of header lines starting with the string
36598 &`Resent-`& to be added to a message when it is resent by the original
36599 recipient to somebody else. These headers are &'Resent-Date:'&,
36600 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36601 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36602
36603 .blockquote
36604 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36605 processing of replies or other such automatic actions on messages.'&
36606 .endblockquote
36607
36608 This leaves things a bit vague as far as other processing actions such as
36609 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36610 follows:
36611
36612 .ilist
36613 A &'Resent-From:'& line that just contains the login id of the submitting user
36614 is automatically rewritten in the same way as &'From:'& (see below).
36615 .next
36616 If there's a rewriting rule for a particular header line, it is also applied to
36617 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36618 &'From:'& also rewrites &'Resent-From:'&.
36619 .next
36620 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36621 also removed.
36622 .next
36623 For a locally-submitted message,
36624 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36625 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36626 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36627 included in log lines in this case.
36628 .next
36629 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36630 &%Resent-%& header lines are present.
36631 .endlist
36632
36633
36634
36635
36636 .subsection Auto-Submitted: SECID221
36637 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36638 includes the header line:
36639 .code
36640 Auto-Submitted: auto-replied
36641 .endd
36642
36643 .subsection Bcc: SECID222
36644 .cindex "&'Bcc:'& header line"
36645 If Exim is called with the &%-t%& option, to take recipient addresses from a
36646 message's header, it removes any &'Bcc:'& header line that may exist (after
36647 extracting its addresses). If &%-t%& is not present on the command line, any
36648 existing &'Bcc:'& is not removed.
36649
36650
36651 .subsection Date: SECID223
36652 .cindex Date:
36653 If a locally-generated or submission-mode message has no &'Date:'& header line,
36654 Exim adds one, using the current date and time, unless the
36655 &%suppress_local_fixups%& control has been specified.
36656
36657 .subsection Delivery-date: SECID224
36658 .cindex "&'Delivery-date:'& header line"
36659 .oindex "&%delivery_date_remove%&"
36660 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36661 set. Exim can be configured to add them to the final delivery of messages. (See
36662 the generic &%delivery_date_add%& transport option.) They should not be present
36663 in messages in transit. If the &%delivery_date_remove%& configuration option is
36664 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36665 messages.
36666
36667
36668 .subsection Envelope-to: SECID225
36669 .chindex Envelope-to:
36670 .oindex "&%envelope_to_remove%&"
36671 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36672 Exim can be configured to add them to the final delivery of messages. (See the
36673 generic &%envelope_to_add%& transport option.) They should not be present in
36674 messages in transit. If the &%envelope_to_remove%& configuration option is set
36675 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36676 messages.
36677
36678
36679 .subsection From: SECTthefrohea
36680 .chindex From:
36681 .cindex "Sendmail compatibility" "&""From""& line"
36682 .cindex "message" "submission"
36683 .cindex "submission mode"
36684 If a submission-mode message does not contain a &'From:'& header line, Exim
36685 adds one if either of the following conditions is true:
36686
36687 .ilist
36688 The envelope sender address is not empty (that is, this is not a bounce
36689 message). The added header line copies the envelope sender address.
36690 .next
36691 .vindex "&$authenticated_id$&"
36692 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36693 .olist
36694 .vindex "&$qualify_domain$&"
36695 If no domain is specified by the submission control, the local part is
36696 &$authenticated_id$& and the domain is &$qualify_domain$&.
36697 .next
36698 If a non-empty domain is specified by the submission control, the local
36699 part is &$authenticated_id$&, and the domain is the specified domain.
36700 .next
36701 If an empty domain is specified by the submission control,
36702 &$authenticated_id$& is assumed to be the complete address.
36703 .endlist
36704 .endlist
36705
36706 A non-empty envelope sender takes precedence.
36707
36708 If a locally-generated incoming message does not contain a &'From:'& header
36709 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36710 containing the sender's address. The calling user's login name and full name
36711 are used to construct the address, as described in section &<<SECTconstr>>&.
36712 They are obtained from the password data by calling &[getpwuid()]& (but see the
36713 &%unknown_login%& configuration option). The address is qualified with
36714 &%qualify_domain%&.
36715
36716 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36717 &'From:'& header line containing just the unqualified login name of the calling
36718 user, this is replaced by an address containing the user's login name and full
36719 name as described in section &<<SECTconstr>>&.
36720
36721
36722 .subsection Message-ID: SECID226
36723 .chindex Message-ID:
36724 .cindex "message" "submission"
36725 .oindex "&%message_id_header_text%&"
36726 If a locally-generated or submission-mode incoming message does not contain a
36727 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36728 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36729 to the message. If there are any &'Resent-:'& headers in the message, it
36730 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36731 message id, preceded by the letter E to ensure it starts with a letter, and
36732 followed by @ and the primary host name. Additional information can be included
36733 in this header line by setting the &%message_id_header_text%& and/or
36734 &%message_id_header_domain%& options.
36735
36736
36737 .subsection Received: SECID227
36738 .chindex Received:
36739 A &'Received:'& header line is added at the start of every message. The
36740 contents are defined by the &%received_header_text%& configuration option, and
36741 Exim automatically adds a semicolon and a timestamp to the configured string.
36742
36743 The &'Received:'& header is generated as soon as the message's header lines
36744 have been received. At this stage, the timestamp in the &'Received:'& header
36745 line is the time that the message started to be received. This is the value
36746 that is seen by the DATA ACL and by the &[local_scan()]& function.
36747
36748 Once a message is accepted, the timestamp in the &'Received:'& header line is
36749 changed to the time of acceptance, which is (apart from a small delay while the
36750 -H spool file is written) the earliest time at which delivery could start.
36751
36752
36753 .subsection References: SECID228
36754 .chindex References:
36755 Messages created by the &(autoreply)& transport include a &'References:'&
36756 header line. This is constructed according to the rules that are described in
36757 section 3.64 of RFC 2822 (which states that replies should contain such a
36758 header line), and section 3.14 of RFC 3834 (which states that automatic
36759 responses are not different in this respect). However, because some mail
36760 processing software does not cope well with very long header lines, no more
36761 than 12 message IDs are copied from the &'References:'& header line in the
36762 incoming message. If there are more than 12, the first one and then the final
36763 11 are copied, before adding the message ID of the incoming message.
36764
36765
36766
36767 .subsection Return-path: SECID229
36768 .chindex Return-path:
36769 .oindex "&%return_path_remove%&"
36770 &'Return-path:'& header lines are defined as something an MTA may insert when
36771 it does the final delivery of messages. (See the generic &%return_path_add%&
36772 transport option.) Therefore, they should not be present in messages in
36773 transit. If the &%return_path_remove%& configuration option is set (the
36774 default), Exim removes &'Return-path:'& header lines from incoming messages.
36775
36776
36777
36778 .subsection Sender: SECTthesenhea
36779 .cindex "&'Sender:'& header line"
36780 .cindex "message" "submission"
36781 .chindex Sender:
36782 For a locally-originated message from an untrusted user, Exim may remove an
36783 existing &'Sender:'& header line, and it may add a new one. You can modify
36784 these actions by setting the &%local_sender_retain%& option true, the
36785 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36786 control setting.
36787
36788 When a local message is received from an untrusted user and
36789 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36790 control has not been set, a check is made to see if the address given in the
36791 &'From:'& header line is the correct (local) sender of the message. The address
36792 that is expected has the login name as the local part and the value of
36793 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36794 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36795 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36796 line is added to the message.
36797
36798 If you set &%local_from_check%& false, this checking does not occur. However,
36799 the removal of an existing &'Sender:'& line still happens, unless you also set
36800 &%local_sender_retain%& to be true. It is not possible to set both of these
36801 options true at the same time.
36802
36803 .cindex "submission mode"
36804 By default, no processing of &'Sender:'& header lines is done for messages
36805 received over TCP/IP or for messages submitted by trusted users. However, when
36806 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36807 not specified on the submission control, the following processing takes place:
36808
36809 .vindex "&$authenticated_id$&"
36810 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36811 authenticated, and &$authenticated_id$& is not empty, a sender address is
36812 created as follows:
36813
36814 .ilist
36815 .vindex "&$qualify_domain$&"
36816 If no domain is specified by the submission control, the local part is
36817 &$authenticated_id$& and the domain is &$qualify_domain$&.
36818 .next
36819 If a non-empty domain is specified by the submission control, the local part
36820 is &$authenticated_id$&, and the domain is the specified domain.
36821 .next
36822 If an empty domain is specified by the submission control,
36823 &$authenticated_id$& is assumed to be the complete address.
36824 .endlist
36825
36826 This address is compared with the address in the &'From:'& header line. If they
36827 are different, a &'Sender:'& header line containing the created address is
36828 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36829 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36830
36831 .cindex "return path" "created from &'Sender:'&"
36832 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36833 the message (the envelope sender address) is changed to be the same address,
36834 except in the case of submission mode when &%sender_retain%& is specified.
36835
36836
36837
36838 .section "Adding and removing header lines in routers and transports" &&&
36839          "SECTheadersaddrem"
36840 .cindex "header lines" "adding; in router or transport"
36841 .cindex "header lines" "removing; in router or transport"
36842 When a message is delivered, the addition and removal of header lines can be
36843 specified in a system filter, or on any of the routers and transports that
36844 process the message. Section &<<SECTaddremheasys>>& contains details about
36845 modifying headers in a system filter. Header lines can also be added in an ACL
36846 as a message is received (see section &<<SECTaddheadacl>>&).
36847
36848 In contrast to what happens in a system filter, header modifications that are
36849 specified on routers and transports apply only to the particular recipient
36850 addresses that are being processed by those routers and transports. These
36851 changes do not actually take place until a copy of the message is being
36852 transported. Therefore, they do not affect the basic set of header lines, and
36853 they do not affect the values of the variables that refer to header lines.
36854
36855 &*Note*&: In particular, this means that any expansions in the configuration of
36856 the transport cannot refer to the modified header lines, because such
36857 expansions all occur before the message is actually transported.
36858
36859 For both routers and transports, the argument of a &%headers_add%&
36860 option must be in the form of one or more RFC 2822 header lines, separated by
36861 newlines (coded as &"\n"&). For example:
36862 .code
36863 headers_add = X-added-header: added by $primary_hostname\n\
36864               X-added-second: another added header line
36865 .endd
36866 Exim does not check the syntax of these added header lines.
36867
36868 Multiple &%headers_add%& options for a single router or transport can be
36869 specified; the values will append to a single list of header lines.
36870 Each header-line is separately expanded.
36871
36872 The argument of a &%headers_remove%& option must consist of a colon-separated
36873 list of header names. This is confusing, because header names themselves are
36874 often terminated by colons. In this case, the colons are the list separators,
36875 not part of the names. For example:
36876 .code
36877 headers_remove = return-receipt-to:acknowledge-to
36878 .endd
36879
36880 Multiple &%headers_remove%& options for a single router or transport can be
36881 specified; the arguments will append to a single header-names list.
36882 Each item is separately expanded.
36883 Note that colons in complex expansions which are used to
36884 form all or part of a &%headers_remove%& list
36885 will act as list separators.
36886
36887 When &%headers_add%& or &%headers_remove%& is specified on a router,
36888 items are expanded at routing time,
36889 and then associated with all addresses that are
36890 accepted by that router, and also with any new addresses that it generates. If
36891 an address passes through several routers as a result of aliasing or
36892 forwarding, the changes are cumulative.
36893
36894 .oindex "&%unseen%&"
36895 However, this does not apply to multiple routers that result from the use of
36896 the &%unseen%& option. Any header modifications that were specified by the
36897 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36898
36899 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36900 settings cannot be delivered together in a batch, so a transport is always
36901 dealing with a set of addresses that have the same header-processing
36902 requirements.
36903
36904 The transport starts by writing the original set of header lines that arrived
36905 with the message, possibly modified by the system filter. As it writes out
36906 these lines, it consults the list of header names that were attached to the
36907 recipient address(es) by &%headers_remove%& options in routers, and it also
36908 consults the transport's own &%headers_remove%& option. Header lines whose
36909 names are on either of these lists are not written out. If there are multiple
36910 instances of any listed header, they are all skipped.
36911
36912 After the remaining original header lines have been written, new header
36913 lines that were specified by routers' &%headers_add%& options are written, in
36914 the order in which they were attached to the address. These are followed by any
36915 header lines specified by the transport's &%headers_add%& option.
36916
36917 This way of handling header line modifications in routers and transports has
36918 the following consequences:
36919
36920 .ilist
36921 The original set of header lines, possibly modified by the system filter,
36922 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36923 to it, at all times.
36924 .next
36925 Header lines that are added by a router's
36926 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36927 expansion syntax in subsequent routers or the transport.
36928 .next
36929 Conversely, header lines that are specified for removal by &%headers_remove%&
36930 in a router remain visible to subsequent routers and the transport.
36931 .next
36932 Headers added to an address by &%headers_add%& in a router cannot be removed by
36933 a later router or by a transport.
36934 .next
36935 An added header can refer to the contents of an original header that is to be
36936 removed, even it has the same name as the added header. For example:
36937 .code
36938 headers_remove = subject
36939 headers_add = Subject: new subject (was: $h_subject:)
36940 .endd
36941 .endlist
36942
36943 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36944 for a &(redirect)& router that has the &%one_time%& option set.
36945
36946
36947
36948
36949
36950 .section "Constructed addresses" "SECTconstr"
36951 .cindex "address" "constructed"
36952 .cindex "constructed address"
36953 When Exim constructs a sender address for a locally-generated message, it uses
36954 the form
36955 .display
36956 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36957 .endd
36958 For example:
36959 .code
36960 Zaphod Beeblebrox <zaphod@end.univ.example>
36961 .endd
36962 The user name is obtained from the &%-F%& command line option if set, or
36963 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36964 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36965 ampersand character, this is replaced by the login name with the first letter
36966 upper cased, as is conventional in a number of operating systems. See the
36967 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36968 The &%unknown_username%& option can be used to specify user names in cases when
36969 there is no password file entry.
36970
36971 .cindex "RFC 2047"
36972 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36973 parts of it if necessary. In addition, if it contains any non-printing
36974 characters, it is encoded as described in RFC 2047, which defines a way of
36975 including non-ASCII characters in header lines. The value of the
36976 &%headers_charset%& option specifies the name of the encoding that is used (the
36977 characters are assumed to be in this encoding). The setting of
36978 &%print_topbitchars%& controls whether characters with the top bit set (that
36979 is, with codes greater than 127) count as printing characters or not.
36980
36981
36982
36983 .section "Case of local parts" "SECID230"
36984 .cindex "case of local parts"
36985 .cindex "local part" "case of"
36986 RFC 2822 states that the case of letters in the local parts of addresses cannot
36987 be assumed to be non-significant. Exim preserves the case of local parts of
36988 addresses, but by default it uses a lower-cased form when it is routing,
36989 because on most Unix systems, usernames are in lower case and case-insensitive
36990 routing is required. However, any particular router can be made to use the
36991 original case for local parts by setting the &%caseful_local_part%& generic
36992 router option.
36993
36994 .cindex "mixed-case login names"
36995 If you must have mixed-case user names on your system, the best way to proceed,
36996 assuming you want case-independent handling of incoming email, is to set up
36997 your first router to convert incoming local parts in your domains to the
36998 correct case by means of a file lookup. For example:
36999 .code
37000 correct_case:
37001   driver = redirect
37002   domains = +local_domains
37003   data = ${lookup{$local_part}cdb\
37004               {/etc/usercased.cdb}{$value}fail}\
37005               @$domain
37006 .endd
37007 For this router, the local part is forced to lower case by the default action
37008 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
37009 up a new local part in the correct case. If you then set &%caseful_local_part%&
37010 on any subsequent routers which process your domains, they will operate on
37011 local parts with the correct case in a case-sensitive manner.
37012
37013
37014
37015 .section "Dots in local parts" "SECID231"
37016 .cindex "dot" "in local part"
37017 .cindex "local part" "dots in"
37018 RFC 2822 forbids empty components in local parts. That is, an unquoted local
37019 part may not begin or end with a dot, nor have two consecutive dots in the
37020 middle. However, it seems that many MTAs do not enforce this, so Exim permits
37021 empty components for compatibility.
37022
37023
37024
37025 .section "Rewriting addresses" "SECID232"
37026 .cindex "rewriting" "addresses"
37027 Rewriting of sender and recipient addresses, and addresses in headers, can
37028 happen automatically, or as the result of configuration options, as described
37029 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
37030 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
37031
37032 Automatic rewriting includes qualification, as mentioned above. The other case
37033 in which it can happen is when an incomplete non-local domain is given. The
37034 routing process may cause this to be expanded into the full domain name. For
37035 example, a header such as
37036 .code
37037 To: hare@teaparty
37038 .endd
37039 might get rewritten as
37040 .code
37041 To: hare@teaparty.wonderland.fict.example
37042 .endd
37043 Rewriting as a result of routing is the one kind of message processing that
37044 does not happen at input time, as it cannot be done until the address has
37045 been routed.
37046
37047 Strictly, one should not do &'any'& deliveries of a message until all its
37048 addresses have been routed, in case any of the headers get changed as a
37049 result of routing. However, doing this in practice would hold up many
37050 deliveries for unreasonable amounts of time, just because one address could not
37051 immediately be routed. Exim therefore does not delay other deliveries when
37052 routing of one or more addresses is deferred.
37053 .ecindex IIDmesproc
37054
37055
37056
37057 . ////////////////////////////////////////////////////////////////////////////
37058 . ////////////////////////////////////////////////////////////////////////////
37059
37060 .chapter "SMTP processing" "CHAPSMTP"
37061 .scindex IIDsmtpproc1 "SMTP" "processing details"
37062 .scindex IIDsmtpproc2 "LMTP" "processing details"
37063 Exim supports a number of different ways of using the SMTP protocol, and its
37064 LMTP variant, which is an interactive protocol for transferring messages into a
37065 closed mail store application. This chapter contains details of how SMTP is
37066 processed. For incoming mail, the following are available:
37067
37068 .ilist
37069 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37070 .next
37071 SMTP over the standard input and output (the &%-bs%& option);
37072 .next
37073 Batched SMTP on the standard input (the &%-bS%& option).
37074 .endlist
37075
37076 For mail delivery, the following are available:
37077
37078 .ilist
37079 SMTP over TCP/IP (the &(smtp)& transport);
37080 .next
37081 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37082 &"lmtp"&);
37083 .next
37084 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37085 transport);
37086 .next
37087 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37088 the &%use_bsmtp%& option set).
37089 .endlist
37090
37091 &'Batched SMTP'& is the name for a process in which batches of messages are
37092 stored in or read from files (or pipes), in a format in which SMTP commands are
37093 used to contain the envelope information.
37094
37095
37096
37097 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37098 .cindex "SMTP" "outgoing over TCP/IP"
37099 .cindex "outgoing SMTP over TCP/IP"
37100 .cindex "LMTP" "over TCP/IP"
37101 .cindex "outgoing LMTP over TCP/IP"
37102 .cindex "EHLO"
37103 .cindex "HELO"
37104 .cindex "SIZE" "option on MAIL command"
37105 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37106 The &%protocol%& option selects which protocol is to be used, but the actual
37107 processing is the same in both cases.
37108
37109 .cindex "ESMTP extensions" SIZE
37110 If, in response to its EHLO command, Exim is told that the SIZE
37111 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37112 command. The value of <&'n'&> is the message size plus the value of the
37113 &%size_addition%& option (default 1024) to allow for additions to the message
37114 such as per-transport header lines, or changes made in a
37115 .cindex "transport" "filter"
37116 .cindex "filter" "transport filter"
37117 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37118 suppressed.
37119
37120 If the remote server advertises support for PIPELINING, Exim uses the
37121 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37122 required for the transaction.
37123
37124 If the remote server advertises support for the STARTTLS command, and Exim
37125 was built to support TLS encryption, it tries to start a TLS session unless the
37126 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37127 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37128 is called for verification.
37129
37130 If the remote server advertises support for the AUTH command, Exim scans
37131 the authenticators configuration for any suitable client settings, as described
37132 in chapter &<<CHAPSMTPAUTH>>&.
37133
37134 .cindex "carriage return"
37135 .cindex "linefeed"
37136 Responses from the remote host are supposed to be terminated by CR followed by
37137 LF. However, there are known to be hosts that do not send CR characters, so in
37138 order to be able to interwork with such hosts, Exim treats LF on its own as a
37139 line terminator.
37140
37141 If a message contains a number of different addresses, all those with the same
37142 characteristics (for example, the same envelope sender) that resolve to the
37143 same set of hosts, in the same order, are sent in a single SMTP transaction,
37144 even if they are for different domains, unless there are more than the setting
37145 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37146 they are split into groups containing no more than &%max_rcpt%&s addresses
37147 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37148 in parallel sessions. The order of hosts with identical MX values is not
37149 significant when checking whether addresses can be batched in this way.
37150
37151 When the &(smtp)& transport suffers a temporary failure that is not
37152 message-related, Exim updates its transport-specific database, which contains
37153 records indexed by host name that remember which messages are waiting for each
37154 particular host. It also updates the retry database with new retry times.
37155
37156 .cindex "hints database" "retry keys"
37157 Exim's retry hints are based on host name plus IP address, so if one address of
37158 a multi-homed host is broken, it will soon be skipped most of the time.
37159 See the next section for more detail about error handling.
37160
37161 .cindex "SMTP" "passed connection"
37162 .cindex "SMTP" "batching over TCP/IP"
37163 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37164 looks in the hints database for the transport to see if there are any queued
37165 messages waiting for the host to which it is connected. If it finds one, it
37166 creates a new Exim process using the &%-MC%& option (which can only be used by
37167 a process running as root or the Exim user) and passes the TCP/IP socket to it
37168 so that it can deliver another message using the same socket. The new process
37169 does only those deliveries that are routed to the connected host, and may in
37170 turn pass the socket on to a third process, and so on.
37171
37172 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37173 limit the number of messages sent down a single TCP/IP connection.
37174
37175 .cindex "asterisk" "after IP address"
37176 The second and subsequent messages delivered down an existing connection are
37177 identified in the main log by the addition of an asterisk after the closing
37178 square bracket of the IP address.
37179
37180
37181
37182
37183 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37184 .cindex "error" "in outgoing SMTP"
37185 .cindex "SMTP" "errors in outgoing"
37186 .cindex "host" "error"
37187 Three different kinds of error are recognized for outgoing SMTP: host errors,
37188 message errors, and recipient errors.
37189
37190 .vlist
37191 .vitem "&*Host errors*&"
37192 A host error is not associated with a particular message or with a
37193 particular recipient of a message. The host errors are:
37194
37195 .ilist
37196 Connection refused or timed out,
37197 .next
37198 Any error response code on connection,
37199 .next
37200 Any error response code to EHLO or HELO,
37201 .next
37202 Loss of connection at any time, except after &"."&,
37203 .next
37204 I/O errors at any time,
37205 .next
37206 Timeouts during the session, other than in response to MAIL, RCPT or
37207 the &"."& at the end of the data.
37208 .endlist ilist
37209
37210 For a host error, a permanent error response on connection, or in response to
37211 EHLO, causes all addresses routed to the host to be failed. Any other host
37212 error causes all addresses to be deferred, and retry data to be created for the
37213 host. It is not tried again, for any message, until its retry time arrives. If
37214 the current set of addresses are not all delivered in this run (to some
37215 alternative host), the message is added to the list of those waiting for this
37216 host, so if it is still undelivered when a subsequent successful delivery is
37217 made to the host, it will be sent down the same SMTP connection.
37218
37219 .vitem "&*Message errors*&"
37220 .cindex "message" "error"
37221 A message error is associated with a particular message when sent to a
37222 particular host, but not with a particular recipient of the message. The
37223 message errors are:
37224
37225 .ilist
37226 Any error response code to MAIL, DATA, or the &"."& that terminates
37227 the data,
37228 .next
37229 Timeout after MAIL,
37230 .next
37231 Timeout or loss of connection after the &"."& that terminates the data. A
37232 timeout after the DATA command itself is treated as a host error, as is loss of
37233 connection at any other time.
37234 .endlist ilist
37235
37236 For a message error, a permanent error response (5&'xx'&) causes all addresses
37237 to be failed, and a delivery error report to be returned to the sender. A
37238 temporary error response (4&'xx'&), or one of the timeouts, causes all
37239 addresses to be deferred. Retry data is not created for the host, but instead,
37240 a retry record for the combination of host plus message id is created. The
37241 message is not added to the list of those waiting for this host. This ensures
37242 that the failing message will not be sent to this host again until the retry
37243 time arrives. However, other messages that are routed to the host are not
37244 affected, so if it is some property of the message that is causing the error,
37245 it will not stop the delivery of other mail.
37246
37247 If the remote host specified support for the SIZE parameter in its response
37248 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37249 over-large message will cause a message error because the error arrives as a
37250 response to MAIL.
37251
37252 .vitem "&*Recipient errors*&"
37253 .cindex "recipient" "error"
37254 A recipient error is associated with a particular recipient of a message. The
37255 recipient errors are:
37256
37257 .ilist
37258 Any error response to RCPT,
37259 .next
37260 Timeout after RCPT.
37261 .endlist
37262
37263 For a recipient error, a permanent error response (5&'xx'&) causes the
37264 recipient address to be failed, and a bounce message to be returned to the
37265 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37266 address to be deferred, and routing retry data to be created for it. This is
37267 used to delay processing of the address in subsequent queue runs, until its
37268 routing retry time arrives. This applies to all messages, but because it
37269 operates only in queue runs, one attempt will be made to deliver a new message
37270 to the failing address before the delay starts to operate. This ensures that,
37271 if the failure is really related to the message rather than the recipient
37272 (&"message too big for this recipient"& is a possible example), other messages
37273 have a chance of getting delivered. If a delivery to the address does succeed,
37274 the retry information gets cleared, so all stuck messages get tried again, and
37275 the retry clock is reset.
37276
37277 The message is not added to the list of those waiting for this host. Use of the
37278 host for other messages is unaffected, and except in the case of a timeout,
37279 other recipients are processed independently, and may be successfully delivered
37280 in the current SMTP session. After a timeout it is of course impossible to
37281 proceed with the session, so all addresses get deferred. However, those other
37282 than the one that failed do not suffer any subsequent retry delays. Therefore,
37283 if one recipient is causing trouble, the others have a chance of getting
37284 through when a subsequent delivery attempt occurs before the failing
37285 recipient's retry time.
37286 .endlist
37287
37288 In all cases, if there are other hosts (or IP addresses) available for the
37289 current set of addresses (for example, from multiple MX records), they are
37290 tried in this run for any undelivered addresses, subject of course to their
37291 own retry data. In other words, recipient error retry data does not take effect
37292 until the next delivery attempt.
37293
37294 Some hosts have been observed to give temporary error responses to every
37295 MAIL command at certain times (&"insufficient space"& has been seen). It
37296 would be nice if such circumstances could be recognized, and defer data for the
37297 host itself created, but this is not possible within the current Exim design.
37298 What actually happens is that retry data for every (host, message) combination
37299 is created.
37300
37301 The reason that timeouts after MAIL and RCPT are treated specially is that
37302 these can sometimes arise as a result of the remote host's verification
37303 procedures. Exim makes this assumption, and treats them as if a temporary error
37304 response had been received. A timeout after &"."& is treated specially because
37305 it is known that some broken implementations fail to recognize the end of the
37306 message if the last character of the last line is a binary zero. Thus, it is
37307 helpful to treat this case as a message error.
37308
37309 Timeouts at other times are treated as host errors, assuming a problem with the
37310 host, or the connection to it. If a timeout after MAIL, RCPT,
37311 or &"."& is really a connection problem, the assumption is that at the next try
37312 the timeout is likely to occur at some other point in the dialogue, causing it
37313 then to be treated as a host error.
37314
37315 There is experimental evidence that some MTAs drop the connection after the
37316 terminating &"."& if they do not like the contents of the message for some
37317 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37318 should be given. That is why Exim treats this case as a message rather than a
37319 host error, in order not to delay other messages to the same host.
37320
37321
37322
37323
37324 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37325 .cindex "SMTP" "incoming over TCP/IP"
37326 .cindex "incoming SMTP over TCP/IP"
37327 .cindex "inetd"
37328 .cindex "daemon"
37329 Incoming SMTP messages can be accepted in one of two ways: by running a
37330 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37331 &_/etc/inetd.conf_& should be like this:
37332 .code
37333 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37334 .endd
37335 Exim distinguishes between this case and the case of a locally running user
37336 agent using the &%-bs%& option by checking whether or not the standard input is
37337 a socket. When it is, either the port must be privileged (less than 1024), or
37338 the caller must be root or the Exim user. If any other user passes a socket
37339 with an unprivileged port number, Exim prints a message on the standard error
37340 stream and exits with an error code.
37341
37342 By default, Exim does not make a log entry when a remote host connects or
37343 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37344 unexpected. It can be made to write such log entries by setting the
37345 &%smtp_connection%& log selector.
37346
37347 .cindex "carriage return"
37348 .cindex "linefeed"
37349 Commands from the remote host are supposed to be terminated by CR followed by
37350 LF. However, there are known to be hosts that do not send CR characters. In
37351 order to be able to interwork with such hosts, Exim treats LF on its own as a
37352 line terminator.
37353 Furthermore, because common code is used for receiving messages from all
37354 sources, a CR on its own is also interpreted as a line terminator. However, the
37355 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37356
37357 .cindex "EHLO" "invalid data"
37358 .cindex "HELO" "invalid data"
37359 One area that sometimes gives rise to problems concerns the EHLO or
37360 HELO commands. Some clients send syntactically invalid versions of these
37361 commands, which Exim rejects by default. (This is nothing to do with verifying
37362 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37363 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37364 match the broken hosts that send invalid commands.
37365
37366 .cindex "SIZE option on MAIL command"
37367 .cindex "MAIL" "SIZE option"
37368 The amount of disk space available is checked whenever SIZE is received on
37369 a MAIL command, independently of whether &%message_size_limit%& or
37370 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37371 false. A temporary error is given if there is not enough space. If
37372 &%check_spool_space%& is set, the check is for that amount of space plus the
37373 value given with SIZE, that is, it checks that the addition of the incoming
37374 message will not reduce the space below the threshold.
37375
37376 When a message is successfully received, Exim includes the local message id in
37377 its response to the final &"."& that terminates the data. If the remote host
37378 logs this text it can help with tracing what has happened to a message.
37379
37380 The Exim daemon can limit the number of simultaneous incoming connections it is
37381 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37382 number of simultaneous incoming connections from a single remote host (see the
37383 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37384 rejected using the SMTP temporary error code 421.
37385
37386 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37387 subprocess has finished, as this can get lost at busy times. Instead, it looks
37388 for completed subprocesses every time it wakes up. Provided there are other
37389 things happening (new incoming calls, starts of queue runs), completed
37390 processes will be noticed and tidied away. On very quiet systems you may
37391 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37392 it will be noticed when the daemon next wakes up.
37393
37394 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37395 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37396 high system load &-- for details see the &%smtp_accept_reserve%&,
37397 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37398 applies in both the daemon and &'inetd'& cases.
37399
37400 Exim normally starts a delivery process for each message received, though this
37401 can be varied by means of the &%-odq%& command line option and the
37402 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37403 number of simultaneously running delivery processes started in this way from
37404 SMTP input can be limited by the &%smtp_accept_queue%& and
37405 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37406 subsequently received messages are just put on the input queue without starting
37407 a delivery process.
37408
37409 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37410 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37411 started up from the &'inetd'& daemon, because in that case each connection is
37412 handled by an entirely independent Exim process. Control by load average is,
37413 however, available with &'inetd'&.
37414
37415 Exim can be configured to verify addresses in incoming SMTP commands as they
37416 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37417 to rewrite addresses at this time &-- before any syntax checking is done. See
37418 section &<<SSECTrewriteS>>&.
37419
37420 Exim can also be configured to limit the rate at which a client host submits
37421 MAIL and RCPT commands in a single SMTP session. See the
37422 &%smtp_ratelimit_hosts%& option.
37423
37424
37425
37426 .subsection "Unrecognized SMTP commands" SECID234
37427 .cindex "SMTP" "unrecognized commands"
37428 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37429 commands during a single SMTP connection, it drops the connection after sending
37430 the error response to the last command. The default value for
37431 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37432 abuse that subvert web servers into making connections to SMTP ports; in these
37433 circumstances, a number of non-SMTP lines are sent first.
37434
37435
37436 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37437 .cindex "SMTP" "syntax errors"
37438 .cindex "SMTP" "protocol errors"
37439 A syntax error is detected if an SMTP command is recognized, but there is
37440 something syntactically wrong with its data, for example, a malformed email
37441 address in a RCPT command. Protocol errors include invalid command
37442 sequencing such as RCPT before MAIL. If Exim receives more than
37443 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37444 drops the connection after sending the error response to the last command. The
37445 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37446 broken clients that loop sending bad commands (yes, it has been seen).
37447
37448
37449
37450 .subsection "Use of non-mail SMTP commands" SECID236
37451 .cindex "SMTP" "non-mail commands"
37452 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37453 DATA. Exim counts such commands, and drops the connection if there are too
37454 many of them in a single SMTP session. This action catches some
37455 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37456 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37457 defines what &"too many"& means. Its default value is 10.
37458
37459 When a new message is expected, one occurrence of RSET is not counted. This
37460 allows a client to send one RSET between messages (this is not necessary,
37461 but some clients do it). Exim also allows one uncounted occurrence of HELO
37462 or EHLO, and one occurrence of STARTTLS between messages. After
37463 starting up a TLS session, another EHLO is expected, and so it too is not
37464 counted.
37465
37466 The first occurrence of AUTH in a connection, or immediately following
37467 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37468 RCPT, DATA, and QUIT are counted.
37469
37470 You can control which hosts are subject to the limit set by
37471 &%smtp_accept_max_nonmail%& by setting
37472 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37473 the limit apply to all hosts. This option means that you can exclude any
37474 specific badly-behaved hosts that you have to live with.
37475
37476
37477
37478
37479 .subsection "The VRFY and EXPN commands" SECID237
37480 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37481 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37482 appropriate) in order to decide whether the command should be accepted or not.
37483
37484 .cindex "VRFY" "processing"
37485 When no ACL is defined for VRFY, or if it rejects without
37486 setting an explicit response code, the command is accepted
37487 (with a 252 SMTP response code)
37488 in order to support awkward clients that do a VRFY before every RCPT.
37489 When VRFY is accepted, it runs exactly the same code as when Exim is
37490 called with the &%-bv%& option, and returns 250/451/550
37491 SMTP response codes.
37492
37493 .cindex "EXPN" "processing"
37494 If no ACL for EXPN is defined, the command is rejected.
37495 When EXPN is accepted, a single-level expansion of the address is done.
37496 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37497 than a verification (the &%-bv%& option). If an unqualified local part is given
37498 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37499 of VRFY and EXPN commands are logged on the main and reject logs, and
37500 VRFY verification failures are logged in the main log for consistency with
37501 RCPT failures.
37502
37503
37504
37505 .subsection "The ETRN command" SECTETRN
37506 .cindex "ETRN" "processing"
37507 .cindex "ESMTP extensions" ETRN
37508 RFC 1985 describes an ESMTP command called ETRN that is designed to
37509 overcome the security problems of the TURN command (which has fallen into
37510 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37511 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37512 should be accepted or not. If no ACL is defined, the command is rejected.
37513
37514 The ETRN command is concerned with &"releasing"& messages that are awaiting
37515 delivery to certain hosts. As Exim does not organize its message queue by host,
37516 the only form of ETRN that is supported by default is the one where the
37517 text starts with the &"#"& prefix, in which case the remainder of the text is
37518 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37519 the &%-R%& option to happen, with the remainder of the ETRN text as its
37520 argument. For example,
37521 .code
37522 ETRN #brigadoon
37523 .endd
37524 runs the command
37525 .code
37526 exim -R brigadoon
37527 .endd
37528 which causes a delivery attempt on all messages with undelivered addresses
37529 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37530 default), Exim prevents the simultaneous execution of more than one queue run
37531 for the same argument string as a result of an ETRN command. This stops
37532 a misbehaving client from starting more than one queue runner at once.
37533
37534 .cindex "hints database" "ETRN serialization"
37535 Exim implements the serialization by means of a hints database in which a
37536 record is written whenever a process is started by ETRN, and deleted when
37537 the process completes. However, Exim does not keep the SMTP session waiting for
37538 the ETRN process to complete. Once ETRN is accepted, the client is sent
37539 a &"success"& return code. Obviously there is scope for hints records to get
37540 left lying around if there is a system or program crash. To guard against this,
37541 Exim ignores any records that are more than six hours old.
37542
37543 .oindex "&%smtp_etrn_command%&"
37544 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37545 used. This specifies a command that is run whenever ETRN is received,
37546 whatever the form of its argument. For
37547 example:
37548 .code
37549 smtp_etrn_command = /etc/etrn_command $domain \
37550                     $sender_host_address
37551 .endd
37552 .vindex "&$domain$&"
37553 The string is split up into arguments which are independently expanded. The
37554 expansion variable &$domain$& is set to the argument of the ETRN command,
37555 and no syntax checking is done on the contents of this argument. Exim does not
37556 wait for the command to complete, so its status code is not checked. Exim runs
37557 under its own uid and gid when receiving incoming SMTP, so it is not possible
37558 for it to change them before running the command.
37559
37560
37561
37562 .section "Incoming local SMTP" "SECID238"
37563 .cindex "SMTP" "local incoming"
37564 Some user agents use SMTP to pass messages to their local MTA using the
37565 standard input and output, as opposed to passing the envelope on the command
37566 line and writing the message to the standard input. This is supported by the
37567 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37568 messages over TCP/IP (including the use of ACLs), except that the envelope
37569 sender given in a MAIL command is ignored unless the caller is trusted. In
37570 an ACL you can detect this form of SMTP input by testing for an empty host
37571 identification. It is common to have this as the first line in the ACL that
37572 runs for RCPT commands:
37573 .code
37574 accept hosts = :
37575 .endd
37576 This accepts SMTP messages from local processes without doing any other tests.
37577
37578
37579
37580 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37581 .cindex "SMTP" "batched outgoing"
37582 .cindex "batched SMTP output"
37583 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37584 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37585 be output in BSMTP format. No SMTP responses are possible for this form of
37586 delivery. All it is doing is using SMTP commands as a way of transmitting the
37587 envelope along with the message.
37588
37589 The message is written to the file or pipe preceded by the SMTP commands
37590 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37591 the message that start with a dot have an extra dot added. The SMTP command
37592 HELO is not normally used. If it is required, the &%message_prefix%& option
37593 can be used to specify it.
37594
37595 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37596 one recipient address at a time by default. However, you can arrange for them
37597 to handle several addresses at once by setting the &%batch_max%& option. When
37598 this is done for BSMTP, messages may contain multiple RCPT commands. See
37599 chapter &<<CHAPbatching>>& for more details.
37600
37601 .vindex "&$host$&"
37602 When one or more addresses are routed to a BSMTP transport by a router that
37603 sets up a host list, the name of the first host on the list is available to the
37604 transport in the variable &$host$&. Here is an example of such a transport and
37605 router:
37606 .code
37607 begin routers
37608 route_append:
37609   driver = manualroute
37610   transport = smtp_appendfile
37611   route_list = domain.example  batch.host.example
37612
37613 begin transports
37614 smtp_appendfile:
37615   driver = appendfile
37616   directory = /var/bsmtp/$host
37617   batch_max = 1000
37618   use_bsmtp
37619   user = exim
37620 .endd
37621 This causes messages addressed to &'domain.example'& to be written in BSMTP
37622 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37623 message (unless there are more than 1000 recipients).
37624
37625
37626
37627 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37628 .cindex "SMTP" "batched incoming"
37629 .cindex "batched SMTP input"
37630 The &%-bS%& command line option causes Exim to accept one or more messages by
37631 reading SMTP on the standard input, but to generate no responses. If the caller
37632 is trusted, the senders in the MAIL commands are believed; otherwise the
37633 sender is always the caller of Exim. Unqualified senders and receivers are not
37634 rejected (there seems little point) but instead just get qualified. HELO
37635 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37636 as NOOP; QUIT quits.
37637
37638 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37639 ACL is run in the same way as for non-SMTP local input.
37640
37641 If an error is detected while reading a message, including a missing &"."& at
37642 the end, Exim gives up immediately. It writes details of the error to the
37643 standard output in a stylized way that the calling program should be able to
37644 make some use of automatically, for example:
37645 .code
37646 554 Unexpected end of file
37647 Transaction started in line 10
37648 Error detected in line 14
37649 .endd
37650 It writes a more verbose version, for human consumption, to the standard error
37651 file, for example:
37652 .code
37653 An error was detected while processing a file of BSMTP input.
37654 The error message was:
37655
37656 501 '>' missing at end of address
37657
37658 The SMTP transaction started in line 10.
37659 The error was detected in line 12.
37660 The SMTP command at fault was:
37661
37662 rcpt to:<malformed@in.com.plete
37663
37664 1 previous message was successfully processed.
37665 The rest of the batch was abandoned.
37666 .endd
37667 The return code from Exim is zero only if there were no errors. It is 1 if some
37668 messages were accepted before an error was detected, and 2 if no messages were
37669 accepted.
37670 .ecindex IIDsmtpproc1
37671 .ecindex IIDsmtpproc2
37672
37673
37674
37675 . ////////////////////////////////////////////////////////////////////////////
37676 . ////////////////////////////////////////////////////////////////////////////
37677
37678 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37679          "Customizing messages"
37680 When a message fails to be delivered, or remains in the queue for more than a
37681 configured amount of time, Exim sends a message to the original sender, or
37682 to an alternative configured address. The text of these messages is built into
37683 the code of Exim, but it is possible to change it, either by adding a single
37684 string, or by replacing each of the paragraphs by text supplied in a file.
37685
37686 The &'From:'& and &'To:'& header lines are automatically generated; you can
37687 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37688 option. Exim also adds the line
37689 .code
37690 Auto-Submitted: auto-generated
37691 .endd
37692 to all warning and bounce messages,
37693
37694
37695 .section "Customizing bounce messages" "SECID239"
37696 .cindex "customizing" "bounce message"
37697 .cindex "bounce message" "customizing"
37698 If &%bounce_message_text%& is set, its contents are included in the default
37699 message immediately after &"This message was created automatically by mail
37700 delivery software."& The string is not expanded. It is not used if
37701 &%bounce_message_file%& is set.
37702
37703 When &%bounce_message_file%& is set, it must point to a template file for
37704 constructing error messages. The file consists of a series of text items,
37705 separated by lines consisting of exactly four asterisks. If the file cannot be
37706 opened, default text is used and a message is written to the main and panic
37707 logs. If any text item in the file is empty, default text is used for that
37708 item.
37709
37710 .vindex "&$bounce_recipient$&"
37711 .vindex "&$bounce_return_size_limit$&"
37712 Each item of text that is read from the file is expanded, and there are two
37713 expansion variables which can be of use here: &$bounce_recipient$& is set to
37714 the recipient of an error message while it is being created, and
37715 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37716 option, rounded to a whole number.
37717
37718 The items must appear in the file in the following order:
37719
37720 .ilist
37721 The first item is included in the headers, and should include at least a
37722 &'Subject:'& header. Exim does not check the syntax of these headers.
37723 .next
37724 The second item forms the start of the error message. After it, Exim lists the
37725 failing addresses with their error messages.
37726 .next
37727 The third item is used to introduce any text from pipe transports that is to be
37728 returned to the sender. It is omitted if there is no such text.
37729 .next
37730 The fourth, fifth and sixth items will be ignored and may be empty.
37731 The fields exist for back-compatibility
37732 .endlist
37733
37734 The default state (&%bounce_message_file%& unset) is equivalent to the
37735 following file, in which the sixth item is empty. The &'Subject:'& and some
37736 other lines have been split in order to fit them on the page:
37737 .code
37738 Subject: Mail delivery failed
37739   ${if eq{$sender_address}{$bounce_recipient}
37740   {: returning message to sender}}
37741 ****
37742 This message was created automatically by mail delivery software.
37743
37744 A message ${if eq{$sender_address}{$bounce_recipient}
37745   {that you sent }{sent by
37746
37747 <$sender_address>
37748
37749 }}could not be delivered to all of its recipients.
37750 This is a permanent error. The following address(es) failed:
37751 ****
37752 The following text was generated during the delivery attempt(s):
37753 ****
37754 ------ This is a copy of the message, including all the headers.
37755   ------
37756 ****
37757 ------ The body of the message is $message_size characters long;
37758   only the first
37759 ------ $bounce_return_size_limit or so are included here.
37760 ****
37761 .endd
37762 .section "Customizing warning messages" "SECTcustwarn"
37763 .cindex "customizing" "warning message"
37764 .cindex "warning of delay" "customizing the message"
37765 The option &%warn_message_file%& can be pointed at a template file for use when
37766 warnings about message delays are created. In this case there are only three
37767 text sections:
37768
37769 .ilist
37770 The first item is included in the headers, and should include at least a
37771 &'Subject:'& header. Exim does not check the syntax of these headers.
37772 .next
37773 The second item forms the start of the warning message. After it, Exim lists
37774 the delayed addresses.
37775 .next
37776 The third item then ends the message.
37777 .endlist
37778
37779 The default state is equivalent to the following file, except that some lines
37780 have been split here, in order to fit them on the page:
37781 .code
37782 Subject: Warning: message $message_exim_id delayed
37783   $warn_message_delay
37784 ****
37785 This message was created automatically by mail delivery software.
37786
37787 A message ${if eq{$sender_address}{$warn_message_recipients}
37788 {that you sent }{sent by
37789
37790 <$sender_address>
37791
37792 }}has not been delivered to all of its recipients after
37793 more than $warn_message_delay in the queue on $primary_hostname.
37794
37795 The message identifier is:     $message_exim_id
37796 The subject of the message is: $h_subject
37797 The date of the message is:    $h_date
37798
37799 The following address(es) have not yet been delivered:
37800 ****
37801 No action is required on your part. Delivery attempts will
37802 continue for some time, and this warning may be repeated at
37803 intervals if the message remains undelivered. Eventually the
37804 mail delivery software will give up, and when that happens,
37805 the message will be returned to you.
37806 .endd
37807 .vindex "&$warn_message_delay$&"
37808 .vindex "&$warn_message_recipients$&"
37809 However, in the default state the subject and date lines are omitted if no
37810 appropriate headers exist. During the expansion of this file,
37811 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37812 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37813 of recipients for the warning message. There may be more than one if there are
37814 multiple addresses with different &%errors_to%& settings on the routers that
37815 handled them.
37816
37817
37818
37819
37820 . ////////////////////////////////////////////////////////////////////////////
37821 . ////////////////////////////////////////////////////////////////////////////
37822
37823 .chapter "Some common configuration settings" "CHAPcomconreq"
37824 This chapter discusses some configuration settings that seem to be fairly
37825 common. More examples and discussion can be found in the Exim book.
37826
37827
37828
37829 .section "Sending mail to a smart host" "SECID240"
37830 .cindex "smart host" "example router"
37831 If you want to send all mail for non-local domains to a &"smart host"&, you
37832 should replace the default &(dnslookup)& router with a router which does the
37833 routing explicitly:
37834 .code
37835 send_to_smart_host:
37836   driver = manualroute
37837   route_list = !+local_domains smart.host.name
37838   transport = remote_smtp
37839 .endd
37840 You can use the smart host's IP address instead of the name if you wish.
37841 If you are using Exim only to submit messages to a smart host, and not for
37842 receiving incoming messages, you can arrange for it to do the submission
37843 synchronously by setting the &%mua_wrapper%& option (see chapter
37844 &<<CHAPnonqueueing>>&).
37845
37846
37847
37848
37849 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37850 .cindex "mailing lists"
37851 Exim can be used to run simple mailing lists, but for large and/or complicated
37852 requirements, the use of additional specialized mailing list software such as
37853 Majordomo or Mailman is recommended.
37854
37855 The &(redirect)& router can be used to handle mailing lists where each list
37856 is maintained in a separate file, which can therefore be managed by an
37857 independent manager. The &%domains%& router option can be used to run these
37858 lists in a separate domain from normal mail. For example:
37859 .code
37860 lists:
37861   driver = redirect
37862   domains = lists.example
37863   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37864   forbid_pipe
37865   forbid_file
37866   errors_to = ${quote_local_part:$local_part-request}@lists.example
37867   no_more
37868 .endd
37869 This router is skipped for domains other than &'lists.example'&. For addresses
37870 in that domain, it looks for a file that matches the local part. If there is no
37871 such file, the router declines, but because &%no_more%& is set, no subsequent
37872 routers are tried, and so the whole delivery fails.
37873
37874 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37875 expanded into a filename or a pipe delivery, which is usually inappropriate in
37876 a mailing list.
37877
37878 .oindex "&%errors_to%&"
37879 The &%errors_to%& option specifies that any delivery errors caused by addresses
37880 taken from a mailing list are to be sent to the given address rather than the
37881 original sender of the message. However, before acting on this, Exim verifies
37882 the error address, and ignores it if verification fails.
37883
37884 For example, using the configuration above, mail sent to
37885 &'dicts@lists.example'& is passed on to those addresses contained in
37886 &_/usr/lists/dicts_&, with error reports directed to
37887 &'dicts-request@lists.example'&, provided that this address can be verified.
37888 There could be a file called &_/usr/lists/dicts-request_& containing
37889 the address(es) of this particular list's manager(s), but other approaches,
37890 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37891 or &%local_part_suffix%& options) to handle addresses of the form
37892 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37893
37894
37895
37896 .section "Syntax errors in mailing lists" "SECID241"
37897 .cindex "mailing lists" "syntax errors in"
37898 If an entry in redirection data contains a syntax error, Exim normally defers
37899 delivery of the original address. That means that a syntax error in a mailing
37900 list holds up all deliveries to the list. This may not be appropriate when a
37901 list is being maintained automatically from data supplied by users, and the
37902 addresses are not rigorously checked.
37903
37904 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37905 entries that fail to parse, noting the incident in the log. If in addition
37906 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37907 whenever a broken address is skipped. It is usually appropriate to set
37908 &%syntax_errors_to%& to the same address as &%errors_to%&.
37909
37910
37911
37912 .section "Re-expansion of mailing lists" "SECID242"
37913 .cindex "mailing lists" "re-expansion of"
37914 Exim remembers every individual address to which a message has been delivered,
37915 in order to avoid duplication, but it normally stores only the original
37916 recipient addresses with a message. If all the deliveries to a mailing list
37917 cannot be done at the first attempt, the mailing list is re-expanded when the
37918 delivery is next tried. This means that alterations to the list are taken into
37919 account at each delivery attempt, so addresses that have been added to
37920 the list since the message arrived will therefore receive a copy of the
37921 message, even though it pre-dates their subscription.
37922
37923 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37924 on the &(redirect)& router. If this is done, any addresses generated by the
37925 router that fail to deliver at the first attempt are added to the message as
37926 &"top level"& addresses, and the parent address that generated them is marked
37927 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37928 subsequent delivery attempts. The disadvantage of this is that if any of the
37929 failing addresses are incorrect, correcting them in the file has no effect on
37930 pre-existing messages.
37931
37932 The original top-level address is remembered with each of the generated
37933 addresses, and is output in any log messages. However, any intermediate parent
37934 addresses are not recorded. This makes a difference to the log only if the
37935 &%all_parents%& selector is set, but for mailing lists there is normally only
37936 one level of expansion anyway.
37937
37938
37939
37940 .section "Closed mailing lists" "SECID243"
37941 .cindex "mailing lists" "closed"
37942 The examples so far have assumed open mailing lists, to which anybody may
37943 send mail. It is also possible to set up closed lists, where mail is accepted
37944 from specified senders only. This is done by making use of the generic
37945 &%senders%& option to restrict the router that handles the list.
37946
37947 The following example uses the same file as a list of recipients and as a list
37948 of permitted senders. It requires three routers:
37949 .code
37950 lists_request:
37951   driver = redirect
37952   domains = lists.example
37953   local_part_suffix = -request
37954   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37955   file = /usr/lists/${local_part_data}-request
37956   no_more
37957
37958 lists_post:
37959   driver = redirect
37960   domains = lists.example
37961   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37962   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37963   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37964   forbid_pipe
37965   forbid_file
37966   errors_to = ${quote_local_part:$local_part-request}@lists.example
37967   no_more
37968
37969 lists_closed:
37970   driver = redirect
37971   domains = lists.example
37972   allow_fail
37973   data = :fail: $local_part@lists.example is a closed mailing list
37974 .endd
37975 All three routers have the same &%domains%& setting, so for any other domains,
37976 they are all skipped. The first router runs only if the local part ends in
37977 &%-request%&. It handles messages to the list manager(s) by means of an open
37978 mailing list.
37979
37980 The second router runs only if the &%senders%& precondition is satisfied. It
37981 checks for the existence of a list that corresponds to the local part, and then
37982 checks that the sender is on the list by means of a linear search. It is
37983 necessary to check for the existence of the file before trying to search it,
37984 because otherwise Exim thinks there is a configuration error. If the file does
37985 not exist, the expansion of &%senders%& is *, which matches all senders. This
37986 means that the router runs, but because there is no list, declines, and
37987 &%no_more%& ensures that no further routers are run. The address fails with an
37988 &"unrouteable address"& error.
37989
37990 The third router runs only if the second router is skipped, which happens when
37991 a mailing list exists, but the sender is not on it. This router forcibly fails
37992 the address, giving a suitable error message.
37993
37994
37995
37996
37997 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37998 .cindex "VERP"
37999 .cindex "Variable Envelope Return Paths"
38000 .cindex "envelope from"
38001 .cindex "envelope sender"
38002 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
38003 are a way of helping mailing list administrators discover which subscription
38004 address is the cause of a particular delivery failure. The idea is to encode
38005 the original recipient address in the outgoing envelope sender address, so that
38006 if the message is forwarded by another host and then subsequently bounces, the
38007 original recipient can be extracted from the recipient address of the bounce.
38008
38009 .oindex &%errors_to%&
38010 .oindex &%return_path%&
38011 Envelope sender addresses can be modified by Exim using two different
38012 facilities: the &%errors_to%& option on a router (as shown in previous mailing
38013 list examples), or the &%return_path%& option on a transport. The second of
38014 these is effective only if the message is successfully delivered to another
38015 host; it is not used for errors detected on the local host (see the description
38016 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
38017 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
38018 .code
38019 verp_smtp:
38020   driver = smtp
38021   max_rcpt = 1
38022   return_path = \
38023     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38024       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38025 .endd
38026 This has the effect of rewriting the return path (envelope sender) on outgoing
38027 SMTP messages, if the local part of the original return path ends in
38028 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
38029 local part and domain of the recipient into the return path. Suppose, for
38030 example, that a message whose return path has been set to
38031 &'somelist-request@your.dom.example'& is sent to
38032 &'subscriber@other.dom.example'&. In the transport, the return path is
38033 rewritten as
38034 .code
38035 somelist-request+subscriber=other.dom.example@your.dom.example
38036 .endd
38037 .vindex "&$local_part$&"
38038 For this to work, you must tell Exim to send multiple copies of messages that
38039 have more than one recipient, so that each copy has just one recipient. This is
38040 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38041 might be sent to several different recipients in the same domain, in which case
38042 &$local_part$& is not available in the transport, because it is not unique.
38043
38044 Unless your host is doing nothing but mailing list deliveries, you should
38045 probably use a separate transport for the VERP deliveries, so as not to use
38046 extra resources in making one-per-recipient copies for other deliveries. This
38047 can easily be done by expanding the &%transport%& option in the router:
38048 .code
38049 dnslookup:
38050   driver = dnslookup
38051   domains = ! +local_domains
38052   transport = \
38053     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38054       {verp_smtp}{remote_smtp}}
38055   no_more
38056 .endd
38057 If you want to change the return path using &%errors_to%& in a router instead
38058 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38059 routers that handle mailing list addresses. This will ensure that all delivery
38060 errors, including those detected on the local host, are sent to the VERP
38061 address.
38062
38063 On a host that does no local deliveries and has no manual routing, only the
38064 &(dnslookup)& router needs to be changed. A special transport is not needed for
38065 SMTP deliveries. Every mailing list recipient has its own return path value,
38066 and so Exim must hand them to the transport one at a time. Here is an example
38067 of a &(dnslookup)& router that implements VERP:
38068 .code
38069 verp_dnslookup:
38070   driver = dnslookup
38071   domains = ! +local_domains
38072   transport = remote_smtp
38073   errors_to = \
38074     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38075      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38076   no_more
38077 .endd
38078 Before you start sending out messages with VERPed return paths, you must also
38079 configure Exim to accept the bounce messages that come back to those paths.
38080 Typically this is done by setting a &%local_part_suffix%& option for a
38081 router, and using this to route the messages to wherever you want to handle
38082 them.
38083
38084 The overhead incurred in using VERP depends very much on the size of the
38085 message, the number of recipient addresses that resolve to the same remote
38086 host, and the speed of the connection over which the message is being sent. If
38087 a lot of addresses resolve to the same host and the connection is slow, sending
38088 a separate copy of the message for each address may take substantially longer
38089 than sending a single copy with many recipients (for which VERP cannot be
38090 used).
38091
38092
38093
38094
38095
38096
38097 .section "Virtual domains" "SECTvirtualdomains"
38098 .cindex "virtual domains"
38099 .cindex "domain" "virtual"
38100 The phrase &'virtual domain'& is unfortunately used with two rather different
38101 meanings:
38102
38103 .ilist
38104 A domain for which there are no real mailboxes; all valid local parts are
38105 aliases for other email addresses. Common examples are organizational
38106 top-level domains and &"vanity"& domains.
38107 .next
38108 One of a number of independent domains that are all handled by the same host,
38109 with mailboxes on that host, but where the mailbox owners do not necessarily
38110 have login accounts on that host.
38111 .endlist
38112
38113 The first usage is probably more common, and does seem more &"virtual"& than
38114 the second. This kind of domain can be handled in Exim with a straightforward
38115 aliasing router. One approach is to create a separate alias file for each
38116 virtual domain. Exim can test for the existence of the alias file to determine
38117 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38118 to a router of this form:
38119 .code
38120 virtual:
38121   driver = redirect
38122   domains = dsearch;/etc/mail/virtual
38123   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38124   no_more
38125 .endd
38126 The &%domains%& option specifies that the router is to be skipped, unless there
38127 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38128 domain that is being processed.
38129 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38130 being placed into the &$domain_data$& variable.
38131
38132 When the router runs, it looks up the local
38133 part in the file to find a new address (or list of addresses). The &%no_more%&
38134 setting ensures that if the lookup fails (leading to &%data%& being an empty
38135 string), Exim gives up on the address without trying any subsequent routers.
38136
38137 This one router can handle all the virtual domains because the alias filenames
38138 follow a fixed pattern. Permissions can be arranged so that appropriate people
38139 can edit the different alias files. A successful aliasing operation results in
38140 a new envelope recipient address, which is then routed from scratch.
38141
38142 The other kind of &"virtual"& domain can also be handled in a straightforward
38143 way. One approach is to create a file for each domain containing a list of
38144 valid local parts, and use it in a router like this:
38145 .code
38146 my_domains:
38147   driver = accept
38148   domains = dsearch;/etc/mail/domains
38149   local_parts = lsearch;/etc/mail/domains/$domain
38150   transport = my_mailboxes
38151 .endd
38152 The address is accepted if there is a file for the domain, and the local part
38153 can be found in the file. The &%domains%& option is used to check for the
38154 file's existence because &%domains%& is tested before the &%local_parts%&
38155 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38156 because that option is tested after &%local_parts%&. The transport is as
38157 follows:
38158 .code
38159 my_mailboxes:
38160   driver = appendfile
38161   file = /var/mail/$domain_data/$local_part_data
38162   user = mail
38163 .endd
38164 This uses a directory of mailboxes for each domain. The &%user%& setting is
38165 required, to specify which uid is to be used for writing to the mailboxes.
38166
38167 The configuration shown here is just one example of how you might support this
38168 requirement. There are many other ways this kind of configuration can be set
38169 up, for example, by using a database instead of separate files to hold all the
38170 information about the domains.
38171
38172
38173
38174 .section "Multiple user mailboxes" "SECTmulbox"
38175 .cindex "multiple mailboxes"
38176 .cindex "mailbox" "multiple"
38177 .cindex "local part" "prefix"
38178 .cindex "local part" "suffix"
38179 Heavy email users often want to operate with multiple mailboxes, into which
38180 incoming mail is automatically sorted. A popular way of handling this is to
38181 allow users to use multiple sender addresses, so that replies can easily be
38182 identified. Users are permitted to add prefixes or suffixes to their local
38183 parts for this purpose. The wildcard facility of the generic router options
38184 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38185 example, consider this router:
38186 .code
38187 userforward:
38188   driver = redirect
38189   check_local_user
38190   file = $home/.forward
38191   local_part_suffix = -*
38192   local_part_suffix_optional
38193   allow_filter
38194 .endd
38195 .vindex "&$local_part_suffix$&"
38196 It runs a user's &_.forward_& file for all local parts of the form
38197 &'username-*'&. Within the filter file the user can distinguish different
38198 cases by testing the variable &$local_part_suffix$&. For example:
38199 .code
38200 if $local_part_suffix contains -special then
38201 save /home/$local_part_data/Mail/special
38202 endif
38203 .endd
38204 If the filter file does not exist, or does not deal with such addresses, they
38205 fall through to subsequent routers, and, assuming no subsequent use of the
38206 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38207 control over which suffixes are valid.
38208
38209 Alternatively, a suffix can be used to trigger the use of a different
38210 &_.forward_& file &-- which is the way a similar facility is implemented in
38211 another MTA:
38212 .code
38213 userforward:
38214   driver = redirect
38215   check_local_user
38216   local_part_suffix = -*
38217   local_part_suffix_optional
38218   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38219   allow_filter
38220 .endd
38221 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38222 example, &_.forward-special_& is used. Once again, if the appropriate file
38223 does not exist, or does not deal with the address, it is passed on to
38224 subsequent routers, which could, if required, look for an unqualified
38225 &_.forward_& file to use as a default.
38226
38227
38228
38229 .section "Simplified vacation processing" "SECID244"
38230 .cindex "vacation processing"
38231 The traditional way of running the &'vacation'& program is for a user to set up
38232 a pipe command in a &_.forward_& file
38233 (see section &<<SECTspecitredli>>& for syntax details).
38234 This is prone to error by inexperienced users. There are two features of Exim
38235 that can be used to make this process simpler for users:
38236
38237 .ilist
38238 A local part prefix such as &"vacation-"& can be specified on a router which
38239 can cause the message to be delivered directly to the &'vacation'& program, or
38240 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38241 &_.forward_& file are then much simpler. For example:
38242 .code
38243 spqr, vacation-spqr
38244 .endd
38245 .next
38246 The &%require_files%& generic router option can be used to trigger a
38247 vacation delivery by checking for the existence of a certain file in the
38248 user's home directory. The &%unseen%& generic option should also be used, to
38249 ensure that the original delivery also proceeds. In this case, all the user has
38250 to do is to create a file called, say, &_.vacation_&, containing a vacation
38251 message.
38252 .endlist
38253
38254 Another advantage of both these methods is that they both work even when the
38255 use of arbitrary pipes by users is locked out.
38256
38257
38258
38259 .section "Taking copies of mail" "SECID245"
38260 .cindex "message" "copying every"
38261 Some installations have policies that require archive copies of all messages to
38262 be made. A single copy of each message can easily be taken by an appropriate
38263 command in a system filter, which could, for example, use a different file for
38264 each day's messages.
38265
38266 There is also a shadow transport mechanism that can be used to take copies of
38267 messages that are successfully delivered by local transports, one copy per
38268 delivery. This could be used, &'inter alia'&, to implement automatic
38269 notification of delivery by sites that insist on doing such things.
38270
38271
38272
38273 .section "Intermittently connected hosts" "SECID246"
38274 .cindex "intermittently connected hosts"
38275 It has become quite common (because it is cheaper) for hosts to connect to the
38276 Internet periodically rather than remain connected all the time. The normal
38277 arrangement is that mail for such hosts accumulates on a system that is
38278 permanently connected.
38279
38280 Exim was designed for use on permanently connected hosts, and so it is not
38281 particularly well-suited to use in an intermittently connected environment.
38282 Nevertheless there are some features that can be used.
38283
38284
38285 .section "Exim on the upstream server host" "SECID247"
38286 It is tempting to arrange for incoming mail for the intermittently connected
38287 host to remain in Exim's queue until the client connects. However, this
38288 approach does not scale very well. Two different kinds of waiting message are
38289 being mixed up in the same queue &-- those that cannot be delivered because of
38290 some temporary problem, and those that are waiting for their destination host
38291 to connect. This makes it hard to manage the queue, as well as wasting
38292 resources, because each queue runner scans the entire queue.
38293
38294 A better approach is to separate off those messages that are waiting for an
38295 intermittently connected host. This can be done by delivering these messages
38296 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38297 format, from where they are transmitted by other software when their
38298 destination connects. This makes it easy to collect all the mail for one host
38299 in a single directory, and to apply local timeout rules on a per-message basis
38300 if required.
38301
38302 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38303 you are doing this, you should configure Exim with a long retry period for the
38304 intermittent host. For example:
38305 .code
38306 cheshire.wonderland.fict.example    *   F,5d,24h
38307 .endd
38308 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38309 which messages it has queued up for that host. Once the intermittent host comes
38310 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38311 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38312 causes all the queued up messages to be delivered, often down a single SMTP
38313 connection. While the host remains connected, any new messages get delivered
38314 immediately.
38315
38316 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38317 issued with a different IP address each time it connects, Exim's retry
38318 mechanisms on the holding host get confused, because the IP address is normally
38319 used as part of the key string for holding retry information. This can be
38320 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38321 Since this has disadvantages for permanently connected hosts, it is best to
38322 arrange a separate transport for the intermittently connected ones.
38323
38324
38325
38326 .section "Exim on the intermittently connected client host" "SECID248"
38327 The value of &%smtp_accept_queue_per_connection%& should probably be
38328 increased, or even set to zero (that is, disabled) on the intermittently
38329 connected host, so that all incoming messages down a single connection get
38330 delivered immediately.
38331
38332 .cindex "SMTP" "passed connection"
38333 .cindex "SMTP" "multiple deliveries"
38334 .cindex "multiple SMTP deliveries"
38335 .cindex "first pass routing"
38336 Mail waiting to be sent from an intermittently connected host will probably
38337 not have been routed, because without a connection DNS lookups are not
38338 possible. This means that if a normal queue run is done at connection time,
38339 each message is likely to be sent in a separate SMTP session. This can be
38340 avoided by starting the queue run with a command line option beginning with
38341 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38342 first pass, routing is done but no deliveries take place. The second pass is a
38343 normal queue run; since all the messages have been previously routed, those
38344 destined for the same host are likely to get sent as multiple deliveries in a
38345 single SMTP connection.
38346
38347
38348
38349 . ////////////////////////////////////////////////////////////////////////////
38350 . ////////////////////////////////////////////////////////////////////////////
38351
38352 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38353          "Exim as a non-queueing client"
38354 .cindex "client, non-queueing"
38355 .cindex "smart host" "suppressing queueing"
38356 On a personal computer, it is a common requirement for all
38357 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38358 configured to operate that way, for all the popular operating systems.
38359 However, there are some MUAs for Unix-like systems that cannot be so
38360 configured: they submit messages using the command line interface of
38361 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38362 messages this way.
38363
38364 If the personal computer runs continuously, there is no problem, because it can
38365 run a conventional MTA that handles delivery to the smart host, and deal with
38366 any delays via its queueing mechanism. However, if the computer does not run
38367 continuously or runs different operating systems at different times, queueing
38368 email is not desirable.
38369
38370 There is therefore a requirement for something that can provide the
38371 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38372 any queueing or retrying facilities. Furthermore, the delivery to the smart
38373 host should be synchronous, so that if it fails, the sending MUA is immediately
38374 informed. In other words, we want something that extends an MUA that submits
38375 to a local MTA via the command line so that it behaves like one that submits
38376 to a remote smart host using TCP/SMTP.
38377
38378 There are a number of applications (for example, there is one called &'ssmtp'&)
38379 that do this job. However, people have found them to be lacking in various
38380 ways. For instance, you might want to allow aliasing and forwarding to be done
38381 before sending a message to the smart host.
38382
38383 Exim already had the necessary infrastructure for doing this job. Just a few
38384 tweaks were needed to make it behave as required, though it is somewhat of an
38385 overkill to use a fully-featured MTA for this purpose.
38386
38387 .oindex "&%mua_wrapper%&"
38388 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38389 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38390 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38391 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38392 compatible router and transport configuration. Typically there will be just one
38393 router and one transport, sending everything to a smart host.
38394
38395 When run in MUA wrapping mode, the behaviour of Exim changes in the
38396 following ways:
38397
38398 .ilist
38399 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38400 In other words, the only way to submit messages is via the command line.
38401 .next
38402 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38403 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38404 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38405 does not finish until the delivery attempt is complete. If the delivery is
38406 successful, a zero return code is given.
38407 .next
38408 Address redirection is permitted, but the final routing for all addresses must
38409 be to the same remote transport, and to the same list of hosts. Furthermore,
38410 the return address (envelope sender) must be the same for all recipients, as
38411 must any added or deleted header lines. In other words, it must be possible to
38412 deliver the message in a single SMTP transaction, however many recipients there
38413 are.
38414 .next
38415 If these conditions are not met, or if routing any address results in a
38416 failure or defer status, or if Exim is unable to deliver all the recipients
38417 successfully to one of the smart hosts, delivery of the entire message fails.
38418 .next
38419 Because no queueing is allowed, all failures are treated as permanent; there
38420 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38421 smart host. Furthermore, because only a single yes/no response can be given to
38422 the caller, it is not possible to deliver to some recipients and not others. If
38423 there is an error (temporary or permanent) for any recipient, all are failed.
38424 .next
38425 If more than one smart host is listed, Exim will try another host after a
38426 connection failure or a timeout, in the normal way. However, if this kind of
38427 failure happens for all the hosts, the delivery fails.
38428 .next
38429 When delivery fails, an error message is written to the standard error stream
38430 (as well as to Exim's log), and Exim exits to the caller with a return code
38431 value 1. The message is expunged from Exim's spool files. No bounce messages
38432 are ever generated.
38433 .next
38434 No retry data is maintained, and any retry rules are ignored.
38435 .next
38436 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38437 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38438 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38439 .endlist
38440
38441 The overall effect is that Exim makes a single synchronous attempt to deliver
38442 the message, failing if there is any kind of problem. Because no local
38443 deliveries are done and no daemon can be run, Exim does not need root
38444 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38445 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38446 the advantages and disadvantages of running without root privilege.
38447
38448
38449
38450
38451 . ////////////////////////////////////////////////////////////////////////////
38452 . ////////////////////////////////////////////////////////////////////////////
38453
38454 .chapter "Log files" "CHAPlog"
38455 .scindex IIDloggen "log" "general description"
38456 .cindex "log" "types of"
38457 Exim writes three different logs, referred to as the main log, the reject log,
38458 and the panic log:
38459
38460 .ilist
38461 .cindex "main log"
38462 The main log records the arrival of each message and each delivery in a single
38463 line in each case. The format is as compact as possible, in an attempt to keep
38464 down the size of log files. Two-character flag sequences make it easy to pick
38465 out these lines. A number of other events are recorded in the main log. Some of
38466 them are optional, in which case the &%log_selector%& option controls whether
38467 they are included or not. A Perl script called &'eximstats'&, which does simple
38468 analysis of main log files, is provided in the Exim distribution (see section
38469 &<<SECTmailstat>>&).
38470 .next
38471 .cindex "reject log"
38472 The reject log records information from messages that are rejected as a result
38473 of a configuration option (that is, for policy reasons).
38474 The first line of each rejection is a copy of the line that is also written to
38475 the main log. Then, if the message's header has been read at the time the log
38476 is written, its contents are written to this log. Only the original header
38477 lines are available; header lines added by ACLs are not logged. You can use the
38478 reject log to check that your policy controls are working correctly; on a busy
38479 host this may be easier than scanning the main log for rejection messages. You
38480 can suppress the writing of the reject log by setting &%write_rejectlog%&
38481 false.
38482 .next
38483 .cindex "panic log"
38484 .cindex "system log"
38485 When certain serious errors occur, Exim writes entries to its panic log. If the
38486 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38487 are usually written to the main log as well, but can get lost amid the mass of
38488 other entries. The panic log should be empty under normal circumstances. It is
38489 therefore a good idea to check it (or to have a &'cron'& script check it)
38490 regularly, in order to become aware of any problems. When Exim cannot open its
38491 panic log, it tries as a last resort to write to the system log (syslog). This
38492 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38493 message itself is written at priority LOG_CRIT.
38494 .endlist
38495
38496 Every log line starts with a timestamp, in the format shown in the following
38497 example. Note that many of the examples shown in this chapter are line-wrapped.
38498 In the log file, this would be all on one line:
38499 .code
38500 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38501   by QUIT
38502 .endd
38503 By default, the timestamps are in the local timezone. There are two
38504 ways of changing this:
38505
38506 .ilist
38507 You can set the &%timezone%& option to a different time zone; in particular, if
38508 you set
38509 .code
38510 timezone = UTC
38511 .endd
38512 the timestamps will be in UTC (aka GMT).
38513 .next
38514 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38515 example:
38516 .code
38517 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38518 .endd
38519 .endlist
38520
38521 .cindex "log" "process ids in"
38522 .cindex "pid (process id)" "in log lines"
38523 Exim does not include its process id in log lines by default, but you can
38524 request that it does so by specifying the &`pid`& log selector (see section
38525 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38526 brackets, immediately after the time and date.
38527
38528
38529
38530
38531 .section "Where the logs are written" "SECTwhelogwri"
38532 .cindex "log" "destination"
38533 .cindex "log" "to file"
38534 .cindex "log" "to syslog"
38535 .cindex "syslog"
38536 The logs may be written to local files, or to syslog, or both. However, it
38537 should be noted that many syslog implementations use UDP as a transport, and
38538 are therefore unreliable in the sense that messages are not guaranteed to
38539 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38540 It has also been reported that on large log files (tens of megabytes) you may
38541 need to tweak syslog to prevent it syncing the file with each write &-- on
38542 Linux this has been seen to make syslog take 90% plus of CPU time.
38543
38544 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38545 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38546 configuration. This latter string is expanded, so it can contain, for example,
38547 references to the host name:
38548 .code
38549 log_file_path = /var/log/$primary_hostname/exim_%slog
38550 .endd
38551 It is generally advisable, however, to set the string in &_Local/Makefile_&
38552 rather than at runtime, because then the setting is available right from the
38553 start of Exim's execution. Otherwise, if there's something it wants to log
38554 before it has read the configuration file (for example, an error in the
38555 configuration file) it will not use the path you want, and may not be able to
38556 log at all.
38557
38558 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38559 list, currently limited to at most two items. This is one option where the
38560 facility for changing a list separator may not be used. The list must always be
38561 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38562 otherwise the item must either be an absolute path, containing &`%s`& at the
38563 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38564 implying the use of a default path.
38565
38566 When Exim encounters an empty item in the list, it searches the list defined by
38567 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38568 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38569 mean &"use the path specified at build time"&. If no such item exists, log
38570 files are written in the &_log_& subdirectory of the spool directory. This is
38571 equivalent to the configuration file setting:
38572 .code
38573 log_file_path = $spool_directory/log/%slog
38574 .endd
38575 If you do not specify anything at build time or runtime,
38576 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38577 that is where the logs are written.
38578
38579 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38580 are in use &-- see section &<<SECTdatlogfil>>& below.
38581
38582 Here are some examples of possible Makefile settings:
38583 .display
38584 &`LOG_FILE_PATH=syslog                    `& syslog only
38585 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38586 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38587 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38588 .endd
38589 If there are more than two paths in the list, the first is used and a panic
38590 error is logged.
38591
38592
38593
38594 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38595 .cindex "log" "cycling local files"
38596 .cindex "cycling logs"
38597 .cindex "&'exicyclog'&"
38598 .cindex "log" "local files; writing to"
38599 Some operating systems provide centralized and standardized methods for cycling
38600 log files. For those that do not, a utility script called &'exicyclog'& is
38601 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38602 main and reject logs each time it is called. The maximum number of old logs to
38603 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38604
38605 An Exim delivery process opens the main log when it first needs to write to it,
38606 and it keeps the file open in case subsequent entries are required &-- for
38607 example, if a number of different deliveries are being done for the same
38608 message. However, remote SMTP deliveries can take a long time, and this means
38609 that the file may be kept open long after it is renamed if &'exicyclog'& or
38610 something similar is being used to rename log files on a regular basis. To
38611 ensure that a switch of log files is noticed as soon as possible, Exim calls
38612 &[stat()]& on the main log's name before reusing an open file, and if the file
38613 does not exist, or its inode has changed, the old file is closed and Exim
38614 tries to open the main log from scratch. Thus, an old log file may remain open
38615 for quite some time, but no Exim processes should write to it once it has been
38616 renamed.
38617
38618
38619
38620 .section "Datestamped log files" "SECTdatlogfil"
38621 .cindex "log" "datestamped files"
38622 Instead of cycling the main and reject log files by renaming them
38623 periodically, some sites like to use files whose names contain a datestamp,
38624 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38625 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38626 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38627 point where the datestamp is required. For example:
38628 .code
38629 log_file_path = /var/spool/exim/log/%slog-%D
38630 log_file_path = /var/log/exim-%s-%D.log
38631 log_file_path = /var/spool/exim/log/%D-%slog
38632 log_file_path = /var/log/exim/%s.%M
38633 .endd
38634 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38635 examples of names generated by the above examples:
38636 .code
38637 /var/spool/exim/log/mainlog-20021225
38638 /var/log/exim-reject-20021225.log
38639 /var/spool/exim/log/20021225-mainlog
38640 /var/log/exim/main.200212
38641 .endd
38642 When this form of log file is specified, Exim automatically switches to new
38643 files at midnight. It does not make any attempt to compress old logs; you
38644 will need to write your own script if you require this. You should not
38645 run &'exicyclog'& with this form of logging.
38646
38647 The location of the panic log is also determined by &%log_file_path%&, but it
38648 is not datestamped, because rotation of the panic log does not make sense.
38649 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38650 the string. In addition, if it immediately follows a slash, a following
38651 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38652 character is removed. Thus, the four examples above would give these panic
38653 log names:
38654 .code
38655 /var/spool/exim/log/paniclog
38656 /var/log/exim-panic.log
38657 /var/spool/exim/log/paniclog
38658 /var/log/exim/panic
38659 .endd
38660
38661
38662 .section "Logging to syslog" "SECID249"
38663 .cindex "log" "syslog; writing to"
38664 The use of syslog does not change what Exim logs or the format of its messages,
38665 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38666 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38667 that, the same strings are written to syslog as to log files. The syslog
38668 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38669 by default, but you can change these by setting the &%syslog_facility%& and
38670 &%syslog_processname%& options, respectively. If Exim was compiled with
38671 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38672 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38673 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38674 the time and host name to each line.
38675 The three log streams are mapped onto syslog priorities as follows:
38676
38677 .ilist
38678 &'mainlog'& is mapped to LOG_INFO
38679 .next
38680 &'rejectlog'& is mapped to LOG_NOTICE
38681 .next
38682 &'paniclog'& is mapped to LOG_ALERT
38683 .endlist
38684
38685 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38686 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38687 these are routed by syslog to the same place. You can suppress this duplication
38688 by setting &%syslog_duplication%& false.
38689
38690 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38691 entries contain multiple lines when headers are included. To cope with both
38692 these cases, entries written to syslog are split into separate &[syslog()]&
38693 calls at each internal newline, and also after a maximum of
38694 870 data characters. (This allows for a total syslog line length of 1024, when
38695 additions such as timestamps are added.) If you are running a syslog
38696 replacement that can handle lines longer than the 1024 characters allowed by
38697 RFC 3164, you should set
38698 .code
38699 SYSLOG_LONG_LINES=yes
38700 .endd
38701 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38702 lines, but it still splits at internal newlines in &'reject'& log entries.
38703
38704 To make it easy to re-assemble split lines later, each component of a split
38705 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38706 where <&'n'&> is the component number and <&'m'&> is the total number of
38707 components in the entry. The / delimiter is used when the line was split
38708 because it was too long; if it was split because of an internal newline, the \
38709 delimiter is used. For example, supposing the length limit to be 50 instead of
38710 870, the following would be the result of a typical rejection message to
38711 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38712 name, and pid as added by syslog:
38713 .code
38714 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38715 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38716 [3/5]  when scanning for sender: missing or malformed lo
38717 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38718 [5/5] mple>)
38719 .endd
38720 The same error might cause the following lines to be written to &"rejectlog"&
38721 (LOG_NOTICE):
38722 .code
38723 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38724 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38725 [3/18] er when scanning for sender: missing or malformed
38726 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38727 [5\18] .example>)
38728 [6\18] Recipients: ph10@some.domain.cam.example
38729 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38730 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38731 [9\18]        id 16RdAL-0006pc-00
38732 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38733 [11\18] 09:43 +0100
38734 [12\18] F From: <>
38735 [13\18]   Subject: this is a test header
38736 [18\18]   X-something: this is another header
38737 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38738 [16\18] le>
38739 [17\18] B Bcc:
38740 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38741 .endd
38742 Log lines that are neither too long nor contain newlines are written to syslog
38743 without modification.
38744
38745 If only syslog is being used, the Exim monitor is unable to provide a log tail
38746 display, unless syslog is routing &'mainlog'& to a file on the local host and
38747 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38748 where it is.
38749
38750
38751
38752 .section "Log line flags" "SECID250"
38753 One line is written to the main log for each message received, and for each
38754 successful, unsuccessful, and delayed delivery. These lines can readily be
38755 picked out by the distinctive two-character flags that immediately follow the
38756 timestamp. The flags are:
38757 .itable none 0 0 2 10* left 90* left
38758 .irow &%<=%&     "message arrival"
38759 .irow &%(=%&     "message fakereject"
38760 .irow &%=>%&     "normal message delivery"
38761 .irow &%->%&     "additional address in same delivery"
38762 .irow &%>>%&     "cutthrough message delivery"
38763 .irow &%*>%&     "delivery suppressed by &%-N%&"
38764 .irow &%**%&     "delivery failed; address bounced"
38765 .irow &%==%&     "delivery deferred; temporary problem"
38766 .endtable
38767
38768
38769 .section "Logging message reception" "SECID251"
38770 .cindex "log" "reception line"
38771 The format of the single-line entry in the main log that is written for every
38772 message received is shown in the basic example below, which is split over
38773 several lines in order to fit it on the page:
38774 .code
38775 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38776   H=mailer.fict.example [192.168.123.123] U=exim
38777   P=smtp S=5678 id=<incoming message id>
38778 .endd
38779 The address immediately following &"<="& is the envelope sender address. A
38780 bounce message is shown with the sender address &"<>"&, and if it is locally
38781 generated, this is followed by an item of the form
38782 .code
38783 R=<message id>
38784 .endd
38785 which is a reference to the message that caused the bounce to be sent.
38786
38787 .cindex "HELO"
38788 .cindex "EHLO"
38789 For messages from other hosts, the H and U fields identify the remote host and
38790 record the RFC 1413 identity of the user that sent the message, if one was
38791 received. The number given in square brackets is the IP address of the sending
38792 host. If there is a single, unparenthesized  host name in the H field, as
38793 above, it has been verified to correspond to the IP address (see the
38794 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38795 by the remote host in the SMTP HELO or EHLO command, and has not been
38796 verified. If verification yields a different name to that given for HELO or
38797 EHLO, the verified name appears first, followed by the HELO or EHLO
38798 name in parentheses.
38799
38800 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38801 without brackets, in the HELO or EHLO command, leading to entries in
38802 the log containing text like these examples:
38803 .code
38804 H=(10.21.32.43) [192.168.8.34]
38805 H=([10.21.32.43]) [192.168.8.34]
38806 .endd
38807 This can be confusing. Only the final address in square brackets can be relied
38808 on.
38809
38810 For locally generated messages (that is, messages not received over TCP/IP),
38811 the H field is omitted, and the U field contains the login name of the caller
38812 of Exim.
38813
38814 .cindex "authentication" "logging"
38815 .cindex "AUTH" "logging"
38816 For all messages, the P field specifies the protocol used to receive the
38817 message. This is the value that is stored in &$received_protocol$&. In the case
38818 of incoming SMTP messages, the value indicates whether or not any SMTP
38819 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38820 session was encrypted, there is an additional X field that records the cipher
38821 suite that was used.
38822
38823 .cindex log protocol
38824 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38825 hosts that have authenticated themselves using the SMTP AUTH command. The first
38826 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38827 there is an additional item A= followed by the name of the authenticator that
38828 was used. If an authenticated identification was set up by the authenticator's
38829 &%server_set_id%& option, this is logged too, separated by a colon from the
38830 authenticator name.
38831
38832 .cindex "size" "of message"
38833 The id field records the existing message id, if present. The size of the
38834 received message is given by the S field. When the message is delivered,
38835 headers may be removed or added, so that the size of delivered copies of the
38836 message may not correspond with this value (and indeed may be different to each
38837 other).
38838
38839 The &%log_selector%& option can be used to request the logging of additional
38840 data when a message is received. See section &<<SECTlogselector>>& below.
38841
38842
38843
38844 .section "Logging deliveries" "SECID252"
38845 .cindex "log" "delivery line"
38846 The format of the single-line entry in the main log that is written for every
38847 delivery is shown in one of the examples below, for local and remote
38848 deliveries, respectively. Each example has been split into multiple lines in order
38849 to fit it on the page:
38850 .code
38851 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38852   <marv@hitch.fict.example> R=localuser T=local_delivery
38853 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38854   monk@holistic.fict.example R=dnslookup T=remote_smtp
38855   H=holistic.fict.example [192.168.234.234]
38856 .endd
38857 For ordinary local deliveries, the original address is given in angle brackets
38858 after the final delivery address, which might be a pipe or a file. If
38859 intermediate address(es) exist between the original and the final address, the
38860 last of these is given in parentheses after the final address. The R and T
38861 fields record the router and transport that were used to process the address.
38862
38863 If SMTP AUTH was used for the delivery there is an additional item A=
38864 followed by the name of the authenticator that was used.
38865 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38866 option, this is logged too, as a second colon-separated list item.
38867 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38868
38869 If a shadow transport was run after a successful local delivery, the log line
38870 for the successful delivery has an item added on the end, of the form
38871 .display
38872 &`ST=<`&&'shadow transport name'&&`>`&
38873 .endd
38874 If the shadow transport did not succeed, the error message is put in
38875 parentheses afterwards.
38876
38877 .cindex "asterisk" "after IP address"
38878 When more than one address is included in a single delivery (for example, two
38879 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38880 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38881 down a single SMTP connection, an asterisk follows the
38882 remote IP address (and port if enabled)
38883 in the log lines for the second and subsequent messages.
38884 When two or more messages are delivered down a single TLS connection, the
38885 DNS and some TLS-related information logged for the first message delivered
38886 will not be present in the log lines for the second and subsequent messages.
38887 TLS cipher information is still available.
38888
38889 .cindex "delivery" "cutthrough; logging"
38890 .cindex "cutthrough" "logging"
38891 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38892 line precedes the reception line, since cutthrough waits for a possible
38893 rejection from the destination in case it can reject the sourced item.
38894
38895 The generation of a reply message by a filter file gets logged as a
38896 &"delivery"& to the addressee, preceded by &">"&.
38897
38898 The &%log_selector%& option can be used to request the logging of additional
38899 data when a message is delivered. See section &<<SECTlogselector>>& below.
38900
38901
38902 .section "Discarded deliveries" "SECID253"
38903 .cindex "discarded messages"
38904 .cindex "message" "discarded"
38905 .cindex "delivery" "discarded; logging"
38906 When a message is discarded as a result of the command &"seen finish"& being
38907 obeyed in a filter file which generates no deliveries, a log entry of the form
38908 .code
38909 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38910   <low.club@bridge.example> R=userforward
38911 .endd
38912 is written, to record why no deliveries are logged. When a message is discarded
38913 because it is aliased to &":blackhole:"& the log line is like this:
38914 .code
38915 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38916   <hole@nowhere.example> R=blackhole_router
38917 .endd
38918
38919
38920 .section "Deferred deliveries" "SECID254"
38921 When a delivery is deferred, a line of the following form is logged:
38922 .code
38923 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38924   R=dnslookup T=smtp defer (146): Connection refused
38925 .endd
38926 In the case of remote deliveries, the error is the one that was given for the
38927 last IP address that was tried. Details of individual SMTP failures are also
38928 written to the log, so the above line would be preceded by something like
38929 .code
38930 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38931   mail1.endrest.example [192.168.239.239]: Connection refused
38932 .endd
38933 When a deferred address is skipped because its retry time has not been reached,
38934 a message is written to the log, but this can be suppressed by setting an
38935 appropriate value in &%log_selector%&.
38936
38937
38938
38939 .section "Delivery failures" "SECID255"
38940 .cindex "delivery" "failure; logging"
38941 If a delivery fails because an address cannot be routed, a line of the
38942 following form is logged:
38943 .code
38944 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38945   <jim@trek99.example>: unknown mail domain
38946 .endd
38947 If a delivery fails at transport time, the router and transport are shown, and
38948 the response from the remote host is included, as in this example:
38949 .code
38950 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38951   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38952   after pipelined RCPT TO:<ace400@pb.example>: host
38953   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38954   <ace400@pb.example>...Addressee unknown
38955 .endd
38956 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38957 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38958 disabling PIPELINING. The log lines for all forms of delivery failure are
38959 flagged with &`**`&.
38960
38961
38962
38963 .section "Fake deliveries" "SECID256"
38964 .cindex "delivery" "fake; logging"
38965 If a delivery does not actually take place because the &%-N%& option has been
38966 used to suppress it, a normal delivery line is written to the log, except that
38967 &"=>"& is replaced by &"*>"&.
38968
38969
38970
38971 .section "Completion" "SECID257"
38972 A line of the form
38973 .code
38974 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38975 .endd
38976 is written to the main log when a message is about to be removed from the spool
38977 at the end of its processing.
38978
38979
38980
38981
38982 .section "Summary of Fields in Log Lines" "SECID258"
38983 .cindex "log" "summary of fields"
38984 A summary of the field identifiers that are used in log lines is shown in
38985 the following table:
38986 .display
38987 &`A   `&        authenticator name (and optional id and sender)
38988 &`C   `&        SMTP confirmation on delivery
38989 &`Ci  `&        connection identifier
38990 &`    `&        command list for &"no mail in SMTP session"&
38991 &`CV  `&        certificate verification status
38992 &`D   `&        duration of &"no mail in SMTP session"&
38993 &`DKIM`&        domain verified in incoming message
38994 &`DN  `&        distinguished name from peer certificate
38995 &`DS  `&        DNSSEC secured lookups
38996 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38997 &`F   `&        sender address (on delivery lines)
38998 &`H   `&        host name and IP address
38999 &`I   `&        local interface used
39000 &`id  `&        message id (from header) for incoming message
39001 &`K   `&        CHUNKING extension used
39002 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
39003 &`M8S `&        8BITMIME status for incoming message
39004 &`P   `&        on &`<=`& lines: protocol used
39005 &`    `&        on &`=>`& and &`**`& lines: return path
39006 &`PRDR`&        PRDR extension used
39007 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
39008 &`Q   `&        alternate queue name
39009 &`QT  `&        on &`=>`& lines: time spent on queue so far
39010 &`    `&        on &"Completed"& lines: time spent on queue
39011 &`R   `&        on &`<=`& lines: reference for local bounce
39012 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
39013 &`RT  `&        on &`<=`& lines: time taken for reception
39014 &`S   `&        size of message in bytes
39015 &`SNI `&        server name indication from TLS client hello
39016 &`ST  `&        shadow transport name
39017 &`T   `&        on &`<=`& lines: message subject (topic)
39018 &`TFO `&        connection took advantage of TCP Fast Open
39019 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
39020 &`U   `&        local user or RFC 1413 identity
39021 &`X   `&        TLS cipher suite
39022 .endd
39023
39024
39025 .section "Other log entries" "SECID259"
39026 Various other types of log entry are written from time to time. Most should be
39027 self-explanatory. Among the more common are:
39028
39029 .ilist
39030 .cindex "retry" "time not reached"
39031 &'retry time not reached'&&~&~An address previously suffered a temporary error
39032 during routing or local delivery, and the time to retry has not yet arrived.
39033 This message is not written to an individual message log file unless it happens
39034 during the first delivery attempt.
39035 .next
39036 &'retry time not reached for any host'&&~&~An address previously suffered
39037 temporary errors during remote delivery, and the retry time has not yet arrived
39038 for any of the hosts to which it is routed.
39039 .next
39040 .cindex "spool directory" "file locked"
39041 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39042 some other Exim process is already working on the message. This can be quite
39043 common if queue running processes are started at frequent intervals. The
39044 &'exiwhat'& utility script can be used to find out what Exim processes are
39045 doing.
39046 .next
39047 .cindex "error" "ignored"
39048 &'error ignored'&&~&~There are several circumstances that give rise to this
39049 message:
39050 .olist
39051 Exim failed to deliver a bounce message whose age was greater than
39052 &%ignore_bounce_errors_after%&. The bounce was discarded.
39053 .next
39054 A filter file set up a delivery using the &"noerror"& option, and the delivery
39055 failed. The delivery was discarded.
39056 .next
39057 A delivery set up by a router configured with
39058 . ==== As this is a nested list, any displays it contains must be indented
39059 . ==== as otherwise they are too far to the left.
39060 .code
39061     errors_to = <>
39062 .endd
39063 failed. The delivery was discarded.
39064 .endlist olist
39065 .next
39066 .cindex DKIM "log line"
39067 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39068 logging and the message has a DKIM signature header.
39069 .endlist ilist
39070
39071
39072
39073
39074
39075 .section "Reducing or increasing what is logged" "SECTlogselector"
39076 .cindex "log" "selectors"
39077 By setting the &%log_selector%& global option, you can disable some of Exim's
39078 default logging to the main log, or you can request additional logging. The value of
39079 &%log_selector%& is made up of names preceded by plus or minus characters. For
39080 example:
39081 .code
39082 log_selector = +arguments -retry_defer
39083 .endd
39084 The list of optional log items is in the following table, with the default
39085 selection marked by asterisks:
39086 .itable none 0 0 3 2.8in left 10pt center 3in left
39087 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39088 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39089 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39090 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39091 .irow &`arguments`&                     &nbsp; "command line arguments"
39092 .irow &`connection_id`&                 &nbsp;  "connection identifier"
39093 .irow &`connection_reject`&             *       "connection rejections"
39094 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39095 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39096 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39097 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39098 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
39099 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39100 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39101 .irow &`etrn`&                          *       "ETRN commands"
39102 .irow &`host_lookup_failed`&            *       "as it says"
39103 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39104 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39105 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39106 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39107 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39108 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39109 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39110 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39111 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39112 .irow &`queue_run`&                     *       "start and end queue runs"
39113 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39114 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39115 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39116 .irow &`pid`&                           &nbsp; "Exim process id"
39117 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39118 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39119 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39120 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39121 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39122 .irow &`rejected_header`&               *       "header contents on reject log"
39123 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39124 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39125 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39126 .irow &`sender_verify_fail`&            *       "sender verification failures"
39127 .irow &`size_reject`&                   *       "rejection because too big"
39128 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39129 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39130 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39131 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39132 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39133 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39134 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39135 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39136 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39137 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39138 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39139 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39140 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39141 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39142 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39143 .irow &`all`&                           &nbsp; "&*all of the above*&"
39144 .endtable
39145 See also the &%slow_lookup_log%& main configuration option,
39146 section &<<SECID99>>&
39147
39148 More details on each of these items follows:
39149
39150 .ilist
39151 .cindex "8BITMIME"
39152 .cindex "log" "8BITMIME"
39153 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39154 which may help in tracking down interoperability issues with ancient MTAs
39155 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39156 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39157 &`7BIT`& and &`8BITMIME`& respectively.
39158 .next
39159 .cindex "&%warn%& ACL verb" "log when skipping"
39160 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39161 its conditions cannot be evaluated, a log line to this effect is written if
39162 this log selector is set.
39163 .next
39164 .cindex "log" "rewriting"
39165 .cindex "rewriting" "logging"
39166 &%address_rewrite%&: This applies both to global rewrites and per-transport
39167 rewrites, but not to rewrites in filters run as an unprivileged user (because
39168 such users cannot access the log).
39169 .next
39170 .cindex "log" "full parentage"
39171 &%all_parents%&: Normally only the original and final addresses are logged on
39172 delivery lines; with this selector, intermediate parents are given in
39173 parentheses between them.
39174 .next
39175 .cindex "log" "Exim arguments"
39176 .cindex "Exim arguments, logging"
39177 &%arguments%&: This causes Exim to write the arguments with which it was called
39178 to the main log, preceded by the current working directory. This is a debugging
39179 feature, added to make it easier to find out how certain MUAs call
39180 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39181 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39182 that are empty or that contain white space are quoted. Non-printing characters
39183 are shown as escape sequences. This facility cannot log unrecognized arguments,
39184 because the arguments are checked before the configuration file is read. The
39185 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39186 between the caller and Exim.
39187 .next
39188 .cindex "log" "connection identifier"
39189 .new
39190 &%connection_identifier%&: An identifier for the accepted connection is added to
39191 connection start and end lines and to message accept lines.
39192 The identifier is tagged by Ci=.
39193 The value is PID-based, so will reset on reboot and will wrap.
39194 .wen
39195 .next
39196 .cindex "log" "connection rejections"
39197 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39198 connection is rejected, for whatever reason.
39199 .next
39200 .cindex "log" "delayed delivery"
39201 .cindex "delayed delivery, logging"
39202 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39203 started for an incoming message because the load is too high or too many
39204 messages were received on one connection. Logging does not occur if no delivery
39205 process is started because &%queue_only%& is set or &%-odq%& was used.
39206 .next
39207 .cindex "log" "delivery duration"
39208 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39209 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39210 If millisecond logging is enabled, short times will be shown with greater
39211 precision, eg. &`DT=0.304s`&.
39212 .next
39213 .cindex "log" "message size on delivery"
39214 .cindex "size" "of message"
39215 &%delivery_size%&: For each delivery, the size of message delivered is added to
39216 the &"=>"& line, tagged with S=.
39217 .next
39218 .cindex log "DKIM verification"
39219 .cindex DKIM "verification logging"
39220 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39221 verifies successfully a tag of DKIM is added, with one of the verified domains.
39222 .next
39223 .cindex log "DKIM verification"
39224 .cindex DKIM "verification logging"
39225 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39226 .next
39227 .cindex "log" "dnslist defer"
39228 .cindex "DNS list" "logging defer"
39229 .cindex "black list (DNS)"
39230 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39231 DNS black list suffers a temporary error.
39232 .next
39233 .cindex log dnssec
39234 .cindex dnssec logging
39235 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39236 dns lookups gave secure results a tag of DS is added.
39237 For acceptance this covers the reverse and forward lookups for host name verification.
39238 It does not cover helo-name verification.
39239 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39240 .next
39241 .cindex "log" "ETRN commands"
39242 .cindex "ETRN" "logging"
39243 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39244 is run to determine whether or not it is actually accepted. An invalid ETRN
39245 command, or one received within a message transaction is not logged by this
39246 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39247 .next
39248 .cindex "log" "host lookup failure"
39249 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39250 any addresses, or when a lookup of an IP address fails to find a host name, a
39251 log line is written. This logging does not apply to direct DNS lookups when
39252 routing email addresses, but it does apply to &"byname"& lookups.
39253 .next
39254 .cindex "log" "ident timeout"
39255 .cindex "RFC 1413" "logging timeout"
39256 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39257 client's ident port times out.
39258 .next
39259 .cindex "log" "incoming interface"
39260 .cindex "log" "outgoing interface"
39261 .cindex "log" "local interface"
39262 .cindex "log" "local address and port"
39263 .cindex "TCP/IP" "logging local address and port"
39264 .cindex "interface" "logging"
39265 &%incoming_interface%&: The interface on which a message was received is added
39266 to the &"<="& line as an IP address in square brackets, tagged by I= and
39267 followed by a colon and the port number. The local interface and port are also
39268 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39269 rejection lines, and (despite the name) to outgoing
39270 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39271 The latter can be disabled by turning off the &%outgoing_interface%& option.
39272 .next
39273 .cindex log "incoming proxy address"
39274 .cindex proxy "logging proxy address"
39275 .cindex "TCP/IP" "logging proxy address"
39276 &%proxy%&: The internal (closest to the system running Exim) IP address
39277 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39278 on a proxied connection
39279 or the &"=>"& line for a message delivered on a proxied connection.
39280 See &<<SECTproxyInbound>>& for more information.
39281 .next
39282 .cindex "log" "incoming remote port"
39283 .cindex "port" "logging remote"
39284 .cindex "TCP/IP" "logging incoming remote port"
39285 .vindex "&$sender_fullhost$&"
39286 .vindex "&$sender_rcvhost$&"
39287 &%incoming_port%&: The remote port number from which a message was received is
39288 added to log entries and &'Received:'& header lines, following the IP address
39289 in square brackets, and separated from it by a colon. This is implemented by
39290 changing the value that is put in the &$sender_fullhost$& and
39291 &$sender_rcvhost$& variables. Recording the remote port number has become more
39292 important with the widening use of NAT (see RFC 2505).
39293 .next
39294 .cindex "log" "dropped connection"
39295 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39296 connection is unexpectedly dropped.
39297 .next
39298 .cindex "log" "millisecond timestamps"
39299 .cindex millisecond logging
39300 .cindex timestamps "millisecond, in logs"
39301 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39302 appended to the seconds value.
39303 .next
39304 .cindex "log" "message id"
39305 &%msg_id%&: The value of the Message-ID: header.
39306 .next
39307 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39308 This will be either because the message is a bounce, or was submitted locally
39309 (submission mode) without one.
39310 The field identifier will have an asterix appended: &"id*="&.
39311 .next
39312 .cindex "log" "outgoing interface"
39313 .cindex "log" "local interface"
39314 .cindex "log" "local address and port"
39315 .cindex "TCP/IP" "logging local address and port"
39316 .cindex "interface" "logging"
39317 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39318 interface on which a message was sent is added to delivery lines as an I= tag
39319 followed by IP address in square brackets. You can disable this by turning
39320 off the &%outgoing_interface%& option.
39321 .next
39322 .cindex "log" "outgoing remote port"
39323 .cindex "port" "logging outgoing remote"
39324 .cindex "TCP/IP" "logging outgoing remote port"
39325 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39326 containing => tags) following the IP address.
39327 The local port is also added if &%incoming_interface%& and
39328 &%outgoing_interface%& are both enabled.
39329 This option is not included in the default setting, because for most ordinary
39330 configurations, the remote port number is always 25 (the SMTP port), and the
39331 local port is a random ephemeral port.
39332 .next
39333 .cindex "log" "process ids in"
39334 .cindex "pid (process id)" "in log lines"
39335 &%pid%&: The current process id is added to every log line, in square brackets,
39336 immediately after the time and date.
39337 .next
39338 .cindex log pipelining
39339 .cindex pipelining "logging outgoing"
39340 &%pipelining%&: A field is added to delivery and accept
39341 log lines when the ESMTP PIPELINING extension was used.
39342 The field is a single "L".
39343
39344 On accept lines, where PIPELINING was offered but not used by the client,
39345 the field has a minus appended.
39346
39347 .cindex "pipelining" "early connection"
39348 If Exim is built without the DISABLE_PIPE_CONNECT build option
39349 accept "L" fields have a period appended if the feature was
39350 offered but not used, or an asterisk appended if used.
39351 Delivery "L" fields have an asterisk appended if used.
39352
39353 .next
39354 .cindex "log" "queue run"
39355 .cindex "queue runner" "logging"
39356 &%queue_run%&: The start and end of every queue run are logged.
39357 .next
39358 .cindex "log" "queue time"
39359 &%queue_time%&: The amount of time the message has been in the queue on the
39360 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39361 &`QT=3m45s`&.
39362 If millisecond logging is enabled, short times will be shown with greater
39363 precision, eg. &`QT=1.578s`&.
39364 .next
39365 &%queue_time_overall%&: The amount of time the message has been in the queue on
39366 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39367 example, &`QT=3m45s`&.
39368 .next
39369 .cindex "log" "receive duration"
39370 &%receive_time%&: For each message, the amount of real time it has taken to
39371 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39372 If millisecond logging is enabled, short times will be shown with greater
39373 precision, eg. &`RT=0.204s`&.
39374 .next
39375 .cindex "log" "recipients"
39376 &%received_recipients%&: The recipients of a message are listed in the main log
39377 as soon as the message is received. The list appears at the end of the log line
39378 that is written when a message is received, preceded by the word &"for"&. The
39379 addresses are listed after they have been qualified, but before any rewriting
39380 has taken place.
39381 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39382 in the list.
39383 .next
39384 .cindex "log" "sender reception"
39385 &%received_sender%&: The unrewritten original sender of a message is added to
39386 the end of the log line that records the message's arrival, after the word
39387 &"from"& (before the recipients if &%received_recipients%& is also set).
39388 .next
39389 .cindex "log" "header lines for rejection"
39390 &%rejected_header%&: If a message's header has been received at the time a
39391 rejection is written to the reject log, the complete header is added to the
39392 log. Header logging can be turned off individually for messages that are
39393 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39394 .next
39395 .cindex "log" "retry defer"
39396 &%retry_defer%&: A log line is written if a delivery is deferred because a
39397 retry time has not yet been reached. However, this &"retry time not reached"&
39398 message is always omitted from individual message logs after the first delivery
39399 attempt.
39400 .next
39401 .cindex "log" "return path"
39402 &%return_path_on_delivery%&: The return path that is being transmitted with
39403 the message is included in delivery and bounce lines, using the tag P=.
39404 This is omitted if no delivery actually happens, for example, if routing fails,
39405 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39406 .next
39407 .cindex "log" "sender on delivery"
39408 &%sender_on_delivery%&: The message's sender address is added to every delivery
39409 and bounce line, tagged by F= (for &"from"&).
39410 This is the original sender that was received with the message; it is not
39411 necessarily the same as the outgoing return path.
39412 .next
39413 .cindex "log" "sender verify failure"
39414 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39415 gives details of a sender verification failure is not written. Log lines for
39416 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39417 detail is lost.
39418 .next
39419 .cindex "log" "size rejection"
39420 &%size_reject%&: A log line is written whenever a message is rejected because
39421 it is too big.
39422 .next
39423 .cindex "log" "frozen messages; skipped"
39424 .cindex "frozen messages" "logging skipping"
39425 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39426 queue run because it another process is already delivering it or because
39427 it is frozen.
39428 .cindex "&""spool file is locked""&"
39429 .cindex "&""message is frozen""&"
39430 The message that is written is either &"spool file is locked"& or
39431 &"message is frozen"&.
39432 .next
39433 .cindex "log" "smtp confirmation"
39434 .cindex "SMTP" "logging confirmation"
39435 .cindex "LMTP" "logging confirmation"
39436 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39437 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39438 A number of MTAs (including Exim) return an identifying string in this
39439 response.
39440 .next
39441 .cindex "log" "SMTP connections"
39442 .cindex "SMTP" "logging connections"
39443 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39444 established or closed, unless the connection is from a host that matches
39445 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39446 only when the closure is unexpected.) This applies to connections from local
39447 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39448 dropped in the middle of a message, a log line is always written, whether or
39449 not this selector is set, but otherwise nothing is written at the start and end
39450 of connections unless this selector is enabled.
39451
39452 For TCP/IP connections to an Exim daemon, the current number of connections is
39453 included in the log message for each new connection, but note that the count is
39454 reset if the daemon is restarted.
39455 Also, because connections are closed (and the closure is logged) in
39456 subprocesses, the count may not include connections that have been closed but
39457 whose termination the daemon has not yet noticed. Thus, while it is possible to
39458 match up the opening and closing of connections in the log, the value of the
39459 logged counts may not be entirely accurate.
39460 .next
39461 .cindex "log" "SMTP transaction; incomplete"
39462 .cindex "SMTP" "logging incomplete transactions"
39463 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39464 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39465 and the message sender plus any accepted recipients are included in the log
39466 line. This can provide evidence of dictionary attacks.
39467 .next
39468 .cindex "log" "non-MAIL SMTP sessions"
39469 .cindex "MAIL" "logging session without"
39470 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39471 connection terminates without having issued a MAIL command. This includes both
39472 the case when the connection is dropped, and the case when QUIT is used. It
39473 does not include cases where the connection is rejected right at the start (by
39474 an ACL, or because there are too many connections, or whatever). These cases
39475 already have their own log lines.
39476
39477 The log line that is written contains the identity of the client in the usual
39478 way, followed by D= and a time, which records the duration of the connection.
39479 If the connection was authenticated, this fact is logged exactly as it is for
39480 an incoming message, with an A= item. If the connection was encrypted, CV=,
39481 DN=, and X= items may appear as they do for an incoming message, controlled by
39482 the same logging options.
39483
39484 Finally, if any SMTP commands were issued during the connection, a C= item
39485 is added to the line, listing the commands that were used. For example,
39486 .code
39487 C=EHLO,QUIT
39488 .endd
39489 shows that the client issued QUIT straight after EHLO. If there were fewer
39490 than 20 commands, they are all listed. If there were more than 20 commands,
39491 the last 20 are listed, preceded by &"..."&. However, with the default
39492 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39493 have been aborted before 20 non-mail commands are processed.
39494 .next
39495 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39496 colon-separated, is appended to the A= item for a message arrival or delivery
39497 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39498 was accepted or used.
39499 .next
39500 .cindex "log" "SMTP protocol error"
39501 .cindex "SMTP" "logging protocol error"
39502 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39503 encountered. Exim does not have perfect detection of all protocol errors
39504 because of transmission delays and the use of pipelining. If PIPELINING has
39505 been advertised to a client, an Exim server assumes that the client will use
39506 it, and therefore it does not count &"expected"& errors (for example, RCPT
39507 received after rejecting MAIL) as protocol errors.
39508 .next
39509 .cindex "SMTP" "logging syntax errors"
39510 .cindex "SMTP" "syntax errors; logging"
39511 .cindex "SMTP" "unknown command; logging"
39512 .cindex "log" "unknown SMTP command"
39513 .cindex "log" "SMTP syntax error"
39514 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39515 encountered. An unrecognized command is treated as a syntax error. For an
39516 external connection, the host identity is given; for an internal connection
39517 using &%-bs%& the sender identification (normally the calling user) is given.
39518 .next
39519 .cindex "log" "subject"
39520 .cindex "subject, logging"
39521 &%subject%&: The subject of the message is added to the arrival log line,
39522 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39523 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39524 specifies whether characters with values greater than 127 should be logged
39525 unchanged, or whether they should be rendered as escape sequences.
39526 .next
39527 .cindex "log" "certificate verification"
39528 .cindex log DANE
39529 .cindex DANE logging
39530 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39531 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39532 verified
39533 using a CA trust anchor,
39534 &`CV=dane`& if using a DNS trust anchor,
39535 and &`CV=no`& if not.
39536 .next
39537 .cindex "log" "TLS cipher"
39538 .cindex "TLS" "logging cipher"
39539 &%tls_cipher%&: When a message is sent or received over an encrypted
39540 connection, the cipher suite used is added to the log line, preceded by X=.
39541 .next
39542 .cindex "log" "TLS peer DN"
39543 .cindex "TLS" "logging peer DN"
39544 &%tls_peerdn%&: When a message is sent or received over an encrypted
39545 connection, and a certificate is supplied by the remote host, the peer DN is
39546 added to the log line, preceded by DN=.
39547 .next
39548 .cindex "log" "TLS resumption"
39549 .cindex "TLS" "logging session resumption"
39550 &%tls_resumption%&: When a message is sent or received over an encrypted
39551 connection and the TLS session resumed one used on a previous TCP connection,
39552 an asterisk is appended to the X= cipher field in the log line.
39553 .next
39554 .cindex "log" "TLS SNI"
39555 .cindex "TLS" "logging SNI"
39556 .cindex SNI logging
39557 &%tls_sni%&: When a message is received over an encrypted connection, and
39558 the remote host provided the Server Name Indication extension, the SNI is
39559 added to the log line, preceded by SNI=.
39560 .next
39561 .cindex "log" "DNS failure in list"
39562 &%unknown_in_list%&: This setting causes a log entry to be written when the
39563 result of a list match is failure because a DNS lookup failed.
39564 .endlist
39565
39566
39567 .section "Message log" "SECID260"
39568 .cindex "message" "log file for"
39569 .cindex "log" "message log; description of"
39570 .cindex "&_msglog_& directory"
39571 .oindex "&%preserve_message_logs%&"
39572 In addition to the general log files, Exim writes a log file for each message
39573 that it handles. The names of these per-message logs are the message ids, and
39574 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39575 message log contains copies of the log lines that apply to the message. This
39576 makes it easier to inspect the status of an individual message without having
39577 to search the main log. A message log is deleted when processing of the message
39578 is complete, unless &%preserve_message_logs%& is set, but this should be used
39579 only with great care because they can fill up your disk very quickly.
39580
39581 On a heavily loaded system, it may be desirable to disable the use of
39582 per-message logs, in order to reduce disk I/O. This can be done by setting the
39583 &%message_logs%& option false.
39584 .ecindex IIDloggen
39585
39586
39587
39588
39589 . ////////////////////////////////////////////////////////////////////////////
39590 . ////////////////////////////////////////////////////////////////////////////
39591
39592 .chapter "Exim utilities" "CHAPutils"
39593 .scindex IIDutils "utilities"
39594 A number of utility scripts and programs are supplied with Exim and are
39595 described in this chapter. There is also the Exim Monitor, which is covered in
39596 the next chapter. The utilities described here are:
39597
39598 .itable none 0 0 3  7* left  15* left  40* left
39599 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39600   "list what Exim processes are doing"
39601 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39602 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39603 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39604 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39605                                                 various criteria"
39606 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39607 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39608   "extract statistics from the log"
39609 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39610   "check address acceptance from given IP"
39611 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39612 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39613 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39614 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39615 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39616 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39617 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39618 .endtable
39619
39620 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39621 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39622 &url(https://duncanthrax.net/exilog/) for details.
39623
39624
39625
39626
39627 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39628 .cindex "&'exiwhat'&"
39629 .cindex "process, querying"
39630 .cindex "SIGUSR1"
39631 On operating systems that can restart a system call after receiving a signal
39632 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39633 a line describing what it is doing to the file &_exim-process.info_& in the
39634 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39635 processes it can find, having first emptied the file. It then waits for one
39636 second to allow the Exim processes to react before displaying the results. In
39637 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39638 send the signal to the Exim processes, so it is normally run as root.
39639
39640 &*Warning*&: This is not an efficient process. It is intended for occasional
39641 use by system administrators. It is not sensible, for example, to set up a
39642 script that sends SIGUSR1 signals to Exim processes at short intervals.
39643
39644
39645 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39646 varies in different operating systems. Not only are different options used,
39647 but the format of the output is different. For this reason, there are some
39648 system configuration options that configure exactly how &'exiwhat'& works. If
39649 it doesn't seem to be working for you, check the following compile-time
39650 options:
39651 .itable none 0 0 2 30* left 70* left
39652 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39653 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39654 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39655 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39656 .endtable
39657 An example of typical output from &'exiwhat'& is
39658 .code
39659 164 daemon: -q1h, listening on port 25
39660 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39661 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39662   [10.19.42.42] (editor@ref.example)
39663 10592 handling incoming call from [192.168.243.242]
39664 10628 accepting a local non-SMTP message
39665 .endd
39666 The first number in the output line is the process number. The third line has
39667 been split here, in order to fit it on the page.
39668
39669
39670
39671 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39672 .cindex "&'exiqgrep'&"
39673 .cindex "queue" "grepping"
39674 This utility is a Perl script contributed by Matt Hubbard. It runs
39675 .code
39676 exim -bpu
39677 .endd
39678 or (in case &*-a*& switch is specified)
39679 .code
39680 exim -bp
39681 .endd
39682 to obtain a queue listing, and then greps the output to select messages
39683 that match given criteria. The following selection options are available:
39684
39685 .vlist
39686 .vitem &*-f*&&~<&'regex'&>
39687 Match the sender address using a case-insensitive search. The field that is
39688 tested is enclosed in angle brackets, so you can test for bounce messages with
39689 .code
39690 exiqgrep -f '^<>$'
39691 .endd
39692 .vitem &*-r*&&~<&'regex'&>
39693 Match a recipient address using a case-insensitive search. The field that is
39694 tested is not enclosed in angle brackets.
39695
39696 .vitem &*-s*&&~<&'regex'&>
39697 Match against the size field.
39698
39699 .vitem &*-y*&&~<&'seconds'&>
39700 Match messages that are younger than the given time.
39701
39702 .vitem &*-o*&&~<&'seconds'&>
39703 Match messages that are older than the given time.
39704
39705 .vitem &*-z*&
39706 Match only frozen messages.
39707
39708 .vitem &*-x*&
39709 Match only non-frozen messages.
39710
39711 .vitem &*-G*&&~<&'queuename'&>
39712 Match only messages in the given queue.  Without this, the default queue is searched.
39713 .endlist
39714
39715 The following options control the format of the output:
39716
39717 .vlist
39718 .vitem &*-c*&
39719 Display only the count of matching messages.
39720
39721 .vitem &*-l*&
39722 Long format &-- display the full message information as output by Exim. This is
39723 the default.
39724
39725 .vitem &*-i*&
39726 Display message ids only.
39727
39728 .vitem &*-b*&
39729 Brief format &-- one line per message.
39730
39731 .vitem &*-R*&
39732 Display messages in reverse order.
39733
39734 .vitem &*-a*&
39735 Include delivered recipients in queue listing.
39736 .endlist
39737
39738 The following options give alternates for configuration:
39739
39740 .vlist
39741 .vitem &*-C*&&~<&'config&~file'&>
39742 is used to specify an alternate &_exim.conf_& which might
39743 contain alternate exim configuration the queue management might be using.
39744
39745 .vitem &*-E*&&~<&'path'&>
39746 can be used to specify a path for the exim binary,
39747 overriding the built-in one.
39748 .endlist
39749
39750 There is one more option, &%-h%&, which outputs a list of options.
39751 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39752
39753
39754
39755 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39756 .cindex "&'exiqsumm'&"
39757 .cindex "queue" "summary"
39758 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39759 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39760 running a command such as
39761 .code
39762 exim -bp | exiqsumm
39763 .endd
39764 The output consists of one line for each domain that has messages waiting for
39765 it, as in the following example:
39766 .code
39767 3   2322   74m   66m  msn.com.example
39768 .endd
39769 Each line lists the number of pending deliveries for a domain, their total
39770 volume, and the length of time that the oldest and the newest messages have
39771 been waiting. Note that the number of pending deliveries is greater than the
39772 number of messages when messages have more than one recipient.
39773
39774 A summary line is output at the end. By default the output is sorted on the
39775 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39776 the output to be sorted by oldest message and by count of messages,
39777 respectively. There are also three options that split the messages for each
39778 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39779 separates frozen messages, and &%-s%& separates messages according to their
39780 sender.
39781
39782 The output of &'exim -bp'& contains the original addresses in the message, so
39783 this also applies to the output from &'exiqsumm'&. No domains from addresses
39784 generated by aliasing or forwarding are included (unless the &%one_time%&
39785 option of the &(redirect)& router has been used to convert them into &"top
39786 level"& addresses).
39787
39788
39789
39790
39791 .section "Extracting specific information from the log (exigrep)" &&&
39792          "SECTextspeinf"
39793 .cindex "&'exigrep'&"
39794 .cindex "log" "extracts; grepping for"
39795 The &'exigrep'& utility is a Perl script that searches one or more main log
39796 files for entries that match a given pattern. When it finds a match, it
39797 extracts all the log entries for the relevant message, not just those that
39798 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39799 given message, or all mail for a given user, or for a given host, for example.
39800 The input files can be in Exim log format or syslog format.
39801 If a matching log line is not associated with a specific message, it is
39802 included in &'exigrep'&'s output without any additional lines. The usage is:
39803 .display
39804 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39805 .endd
39806 If no log filenames are given on the command line, the standard input is read.
39807
39808 The &%-t%& argument specifies a number of seconds. It adds an additional
39809 condition for message selection. Messages that are complete are shown only if
39810 they spent more than <&'n'&> seconds in the queue.
39811
39812 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39813 makes it case-sensitive. This may give a performance improvement when searching
39814 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39815 option; with &%-I%& they do not. In both cases it is possible to change the
39816 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39817
39818 The &%-l%& option means &"literal"&, that is, treat all characters in the
39819 pattern as standing for themselves. Otherwise the pattern must be a Perl
39820 regular expression.
39821
39822 The &%-v%& option inverts the matching condition. That is, a line is selected
39823 if it does &'not'& match the pattern.
39824
39825 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39826 that are generated as a result/response to a message that &'exigrep'& matched
39827 normally.
39828
39829 Example of &%-M%&:
39830 user_a sends a message to user_b, which generates a bounce back to user_b. If
39831 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39832 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39833 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39834 when searching for &"user_a"& will show both messages since the bounce is
39835 &"related"& to or a &"result"& of the first message that was found by the
39836 search term.
39837
39838 If the location of a &'zcat'& command is known from the definition of
39839 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39840 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39841 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39842 autodetection of some well known compression extensions.
39843
39844
39845 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39846 .cindex "&'exipick'&"
39847 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39848 lists messages from the queue according to a variety of criteria. For details
39849 of &'exipick'&'s facilities, run &'exipick'& with
39850 the &%--help%& option.
39851
39852
39853 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39854 .cindex "log" "cycling local files"
39855 .cindex "cycling logs"
39856 .cindex "&'exicyclog'&"
39857 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39858 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39859 you are using log files with datestamps in their names (see section
39860 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39861 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39862 There are two command line options for &'exicyclog'&:
39863 .ilist
39864 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39865 default that is set when Exim is built. The default default is 10.
39866 .next
39867 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39868 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39869 overriding the script's default, which is to find the setting from Exim's
39870 configuration.
39871 .endlist
39872
39873 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39874 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39875 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39876 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39877 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39878 logs are handled similarly.
39879
39880 If the limit is greater than 99, the script uses 3-digit numbers such as
39881 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39882 to one that is greater, or &'vice versa'&, you will have to fix the names of
39883 any existing log files.
39884
39885 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39886 the end are deleted. All files with numbers greater than 01 are compressed,
39887 using a compression command which is configured by the COMPRESS_COMMAND
39888 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39889 root &%crontab%& entry of the form
39890 .code
39891 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39892 .endd
39893 assuming you have used the name &"exim"& for the Exim user. You can run
39894 &'exicyclog'& as root if you wish, but there is no need.
39895
39896
39897
39898 .section "Mail statistics (eximstats)" "SECTmailstat"
39899 .cindex "statistics"
39900 .cindex "&'eximstats'&"
39901 A Perl script called &'eximstats'& is provided for extracting statistical
39902 information from log files. The output is either plain text, or HTML.
39903 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39904 . --- 404 error and everything else points to that.
39905
39906 The &'eximstats'& script has been hacked about quite a bit over time. The
39907 latest version is the result of some extensive revision by Steve Campbell. A
39908 lot of information is given by default, but there are options for suppressing
39909 various parts of it. Following any options, the arguments to the script are a
39910 list of files, which should be main log files. For example:
39911 .code
39912 eximstats -nr /var/spool/exim/log/mainlog.01
39913 .endd
39914 By default, &'eximstats'& extracts information about the number and volume of
39915 messages received from or delivered to various hosts. The information is sorted
39916 both by message count and by volume, and the top fifty hosts in each category
39917 are listed on the standard output. Similar information, based on email
39918 addresses or domains instead of hosts can be requested by means of various
39919 options. For messages delivered and received locally, similar statistics are
39920 also produced per user.
39921
39922 The output also includes total counts and statistics about delivery errors, and
39923 histograms showing the number of messages received and deliveries made in each
39924 hour of the day. A delivery with more than one address in its envelope (for
39925 example, an SMTP transaction with more than one RCPT command) is counted
39926 as a single delivery by &'eximstats'&.
39927
39928 Though normally more deliveries than receipts are reported (as messages may
39929 have multiple recipients), it is possible for &'eximstats'& to report more
39930 messages received than delivered, even though the queue is empty at the start
39931 and end of the period in question. If an incoming message contains no valid
39932 recipients, no deliveries are recorded for it. A bounce message is handled as
39933 an entirely separate message.
39934
39935 &'eximstats'& always outputs a grand total summary giving the volume and number
39936 of messages received and deliveries made, and the number of hosts involved in
39937 each case. It also outputs the number of messages that were delayed (that is,
39938 not completely delivered at the first attempt), and the number that had at
39939 least one address that failed.
39940
39941 The remainder of the output is in sections that can be independently disabled
39942 or modified by various options. It consists of a summary of deliveries by
39943 transport, histograms of messages received and delivered per time interval
39944 (default per hour), information about the time messages spent in the queue,
39945 a list of relayed messages, lists of the top fifty sending hosts, local
39946 senders, destination hosts, and destination local users by count and by volume,
39947 and a list of delivery errors that occurred.
39948
39949 The relay information lists messages that were actually relayed, that is, they
39950 came from a remote host and were directly delivered to some other remote host,
39951 without being processed (for example, for aliasing or forwarding) locally.
39952
39953 There are quite a few options for &'eximstats'& to control exactly what it
39954 outputs. These are documented in the Perl script itself, and can be extracted
39955 by running the command &(perldoc)& on the script. For example:
39956 .code
39957 perldoc /usr/exim/bin/eximstats
39958 .endd
39959
39960 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39961 .cindex "&'exim_checkaccess'&"
39962 .cindex "policy control" "checking access"
39963 .cindex "checking access"
39964 The &%-bh%& command line argument allows you to run a fake SMTP session with
39965 debugging output, in order to check what Exim is doing when it is applying
39966 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39967 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39968 sometimes you just want to answer the question &"Does this address have
39969 access?"& without bothering with any further details.
39970
39971 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39972 two arguments, an IP address and an email address:
39973 .code
39974 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39975 .endd
39976 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39977 given email address would be accepted in a RCPT command in a TCP/IP
39978 connection from the host with the given IP address. The output of the utility
39979 is either the word &"accepted"&, or the SMTP error response, for example:
39980 .code
39981 Rejected:
39982 550 Relay not permitted
39983 .endd
39984 When running this test, the utility uses &`<>`& as the envelope sender address
39985 for the MAIL command, but you can change this by providing additional
39986 options. These are passed directly to the Exim command. For example, to specify
39987 that the test is to be run with the sender address &'himself@there.example'&
39988 you can use:
39989 .code
39990 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39991                  -f himself@there.example
39992 .endd
39993 Note that these additional Exim command line items must be given after the two
39994 mandatory arguments.
39995
39996 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39997 while running its checks. You can run checks that include callouts by using
39998 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39999
40000
40001
40002 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
40003 .cindex "DBM" "building dbm files"
40004 .cindex "building DBM files"
40005 .cindex "&'exim_dbmbuild'&"
40006 .cindex "lower casing"
40007 .cindex "binary zero" "in lookup key"
40008 The &'exim_dbmbuild'& program reads an input file containing keys and data in
40009 the format used by the &(lsearch)& lookup (see section
40010 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
40011 names as keys and the remainder of the information as data. The lower-casing
40012 can be prevented by calling the program with the &%-nolc%& option.
40013
40014 A terminating zero is included as part of the key string. This is expected by
40015 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
40016 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
40017 strings or the data strings. The &(dbmnz)& lookup type can be used with such
40018 files.
40019
40020 The program requires two arguments: the name of the input file (which can be a
40021 single hyphen to indicate the standard input), and the name of the output file.
40022 It creates the output under a temporary name, and then renames it if all went
40023 well.
40024
40025 .cindex "USE_DB"
40026 If the native DB interface is in use (USE_DB is set in a compile-time
40027 configuration file &-- this is common in free versions of Unix) the two
40028 filenames must be different, because in this mode the Berkeley DB functions
40029 create a single output file using exactly the name given. For example,
40030 .code
40031 exim_dbmbuild /etc/aliases /etc/aliases.db
40032 .endd
40033 reads the system alias file and creates a DBM version of it in
40034 &_/etc/aliases.db_&.
40035
40036 In systems that use the &'ndbm'& routines (mostly proprietary versions of
40037 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
40038 environment, the suffixes are added to the second argument of
40039 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40040 when the Berkeley functions are used in compatibility mode (though this is not
40041 recommended), because in that case it adds a &_.db_& suffix to the filename.
40042
40043 If a duplicate key is encountered, the program outputs a warning, and when it
40044 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40045 option is used. By default, only the first of a set of duplicates is used &--
40046 this makes it compatible with &(lsearch)& lookups. There is an option
40047 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40048 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40049 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40050 return code is 2.
40051
40052
40053
40054
40055 .section "Finding individual retry times (exinext)" "SECTfinindret"
40056 .cindex "retry" "times"
40057 .cindex "&'exinext'&"
40058 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40059 fish specific information out of the retry database. Given a mail domain (or a
40060 complete address), it looks up the hosts for that domain, and outputs any retry
40061 information for the hosts or for the domain. At present, the retry information
40062 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40063 output. For example:
40064 .code
40065 $ exinext piglet@milne.fict.example
40066 kanga.milne.example:192.168.8.1 error 146: Connection refused
40067   first failed: 21-Feb-1996 14:57:34
40068   last tried:   21-Feb-1996 14:57:34
40069   next try at:  21-Feb-1996 15:02:34
40070 roo.milne.example:192.168.8.3 error 146: Connection refused
40071   first failed: 20-Jan-1996 13:12:08
40072   last tried:   21-Feb-1996 11:42:03
40073   next try at:  21-Feb-1996 19:42:03
40074   past final cutoff time
40075 .endd
40076 You can also give &'exinext'& a local part, without a domain, and it
40077 will give any retry information for that local part in your default domain.
40078 A message id can be used to obtain retry information pertaining to a specific
40079 message. This exists only when an attempt to deliver a message to a remote host
40080 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40081 &'exinext'& is not particularly efficient, but then it is not expected to be
40082 run very often.
40083
40084 The &'exinext'& utility calls Exim to find out information such as the location
40085 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40086 passed on to the &'exim'& commands. The first specifies an alternate Exim
40087 configuration file, and the second sets macros for use within the configuration
40088 file. These features are mainly to help in testing, but might also be useful in
40089 environments where more than one configuration file is in use.
40090
40091
40092
40093 .section "Hints database maintenance" "SECThindatmai"
40094 .cindex "hints database" "maintenance"
40095 .cindex "maintaining Exim's hints database"
40096 Three utility programs are provided for maintaining the DBM files that Exim
40097 uses to contain its delivery hint information. Each program requires two
40098 arguments. The first specifies the name of Exim's spool directory, and the
40099 second is the name of the database it is to operate on. These are as follows:
40100
40101 .ilist
40102 &'retry'&: the database of retry information
40103 .next
40104 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40105 for remote hosts
40106 .next
40107 &'callout'&: the callout cache
40108 .next
40109 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40110 .next
40111 &'tls'&: TLS session resumption data
40112 .next
40113 &'misc'&: other hints data
40114 .endlist
40115
40116 The &'misc'& database is used for
40117
40118 .ilist
40119 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40120 .next
40121 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40122 &(smtp)& transport)
40123 .next
40124 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40125 in a transport)
40126 .next
40127 Recording EHLO-time facilities advertised by hosts
40128 .endlist
40129
40130
40131
40132 .section "exim_dumpdb" "SECTdumpdb"
40133 .cindex "&'exim_dumpdb'&"
40134 The entire contents of a database are written to the standard output by the
40135 &'exim_dumpdb'& program,
40136 taking as arguments the spool and database names.
40137 An option &'-z'& may be given to request times in UTC;
40138 otherwise times are in the local timezone.
40139 An option &'-k'& may be given to dump only the record keys.
40140 For example, to dump the retry database:
40141 .code
40142 exim_dumpdb /var/spool/exim retry
40143 .endd
40144 For the retry database
40145 two lines of output are produced for each entry:
40146 .code
40147 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40148 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40149 .endd
40150 The first item on the first line is the key of the record. It starts with one
40151 of the letters R, or T, depending on whether it refers to a routing or
40152 transport retry. For a local delivery, the next part is the local address; for
40153 a remote delivery it is the name of the remote host, followed by its failing IP
40154 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40155 transport). If the remote port is not the standard one (port 25), it is added
40156 to the IP address. Then there follows an error code, an additional error code,
40157 and a textual description of the error.
40158
40159 The three times on the second line are the time of first failure, the time of
40160 the last delivery attempt, and the computed time for the next attempt. The line
40161 ends with an asterisk if the cutoff time for the last retry rule has been
40162 exceeded.
40163
40164 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40165 consists of a host name followed by a list of ids for messages that are or were
40166 waiting to be delivered to that host. If there are a very large number for any
40167 one host, continuation records, with a sequence number added to the host name,
40168 may be seen. The data in these records is often out of date, because a message
40169 may be routed to several alternative hosts, and Exim makes no effort to keep
40170 cross-references.
40171
40172
40173
40174 .section "exim_tidydb" "SECTtidydb"
40175 .cindex "&'exim_tidydb'&"
40176 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40177 database. If run with no options, it removes all records that are more than 30
40178 days old. The age is calculated from the date and time that the record was last
40179 updated. Note that, in the case of the retry database, it is &'not'& the time
40180 since the first delivery failure. Information about a host that has been down
40181 for more than 30 days will remain in the database, provided that the record is
40182 updated sufficiently often.
40183
40184 The cutoff date can be altered by means of the &%-t%& option, which must be
40185 followed by a time. For example, to remove all records older than a week from
40186 the retry database:
40187 .code
40188 exim_tidydb -t 7d /var/spool/exim retry
40189 .endd
40190 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40191 message ids. In the former these appear as data in records keyed by host &--
40192 they were messages that were waiting for that host &-- and in the latter they
40193 are the keys for retry information for messages that have suffered certain
40194 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40195 message ids in database records are those of messages that are still on the
40196 queue. Message ids for messages that no longer exist are removed from
40197 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40198 For the &'retry'& database, records whose keys are non-existent message ids are
40199 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40200 whenever it removes information from the database.
40201
40202 Certain records are automatically removed by Exim when they are no longer
40203 needed, but others are not. For example, if all the MX hosts for a domain are
40204 down, a retry record is created for each one. If the primary MX host comes back
40205 first, its record is removed when Exim successfully delivers to it, but the
40206 records for the others remain because Exim has not tried to use those hosts.
40207
40208 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40209 hints databases. You should do this at a quiet time of day, because it requires
40210 a database to be locked (and therefore inaccessible to Exim) while it does its
40211 work. Removing records from a DBM file does not normally make the file smaller,
40212 but all the common DBM libraries are able to re-use the space that is released.
40213 After an initial phase of increasing in size, the databases normally reach a
40214 point at which they no longer get any bigger, as long as they are regularly
40215 tidied.
40216
40217 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40218 databases is likely to keep on increasing.
40219
40220
40221
40222
40223 .section "exim_fixdb" "SECTfixdb"
40224 .cindex "&'exim_fixdb'&"
40225 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40226 Its main use is for testing Exim, but it might also be occasionally useful for
40227 getting round problems in a live system. Its interface
40228 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40229 key of a database record can then be entered, and the data for that record is
40230 displayed.
40231
40232 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40233 except the &'retry'& database, that is the only operation that can be carried
40234 out. For the &'retry'& database, each field is output preceded by a number, and
40235 data for individual fields can be changed by typing the field number followed
40236 by new data, for example:
40237 .code
40238 > 4 951102:1000
40239 .endd
40240 resets the time of the next delivery attempt. Time values are given as a
40241 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40242 used as optional separators.
40243
40244 Both displayed and input times are in the local timezone by default.
40245 If an option &'-z'& is used on the command line, displayed times
40246 are in UTC.
40247
40248
40249
40250
40251 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40252 .cindex "mailbox" "maintenance"
40253 .cindex "&'exim_lock'&"
40254 .cindex "locking mailboxes"
40255 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40256 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40257 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40258 a user agent while investigating a problem. The utility requires the name of
40259 the file as its first argument. If the locking is successful, the second
40260 argument is run as a command (using C's &[system()]& function); if there is no
40261 second argument, the value of the SHELL environment variable is used; if this
40262 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40263 is unlocked and the utility ends. The following options are available:
40264
40265 .vlist
40266 .vitem &%-fcntl%&
40267 Use &[fcntl()]& locking on the open mailbox.
40268
40269 .vitem &%-flock%&
40270 Use &[flock()]& locking on the open mailbox, provided the operating system
40271 supports it.
40272
40273 .vitem &%-interval%&
40274 This must be followed by a number, which is a number of seconds; it sets the
40275 interval to sleep between retries (default 3).
40276
40277 .vitem &%-lockfile%&
40278 Create a lock file before opening the mailbox.
40279
40280 .vitem &%-mbx%&
40281 Lock the mailbox using MBX rules.
40282
40283 .vitem &%-q%&
40284 Suppress verification output.
40285
40286 .vitem &%-retries%&
40287 This must be followed by a number; it sets the number of times to try to get
40288 the lock (default 10).
40289
40290 .vitem &%-restore_time%&
40291 This option causes &%exim_lock%& to restore the modified and read times to the
40292 locked file before exiting. This allows you to access a locked mailbox (for
40293 example, to take a backup copy) without disturbing the times that the user
40294 subsequently sees.
40295
40296 .vitem &%-timeout%&
40297 This must be followed by a number, which is a number of seconds; it sets a
40298 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40299 default), a non-blocking call is used.
40300
40301 .vitem &%-v%&
40302 Generate verbose output.
40303 .endlist
40304
40305 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40306 default is to create a lock file and also to use &[fcntl()]& locking on the
40307 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40308 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40309 requires that the directory containing the file be writeable. Locking by lock
40310 file does not last forever; Exim assumes that a lock file is expired if it is
40311 more than 30 minutes old.
40312
40313 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40314 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40315 to be taken out on the open mailbox, and an exclusive lock on the file
40316 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40317 number of the mailbox file. When the locking is released, if an exclusive lock
40318 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40319
40320 The default output contains verification of the locking that takes place. The
40321 &%-v%& option causes some additional information to be given. The &%-q%& option
40322 suppresses all output except error messages.
40323
40324 A command such as
40325 .code
40326 exim_lock /var/spool/mail/spqr
40327 .endd
40328 runs an interactive shell while the file is locked, whereas
40329 .display
40330 &`exim_lock -q /var/spool/mail/spqr <<End`&
40331 <&'some commands'&>
40332 &`End`&
40333 .endd
40334 runs a specific non-interactive sequence of commands while the file is locked,
40335 suppressing all verification output. A single command can be run by a command
40336 such as
40337 .code
40338 exim_lock -q /var/spool/mail/spqr \
40339   "cp /var/spool/mail/spqr /some/where"
40340 .endd
40341 Note that if a command is supplied, it must be entirely contained within the
40342 second argument &-- hence the quotes.
40343
40344
40345 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40346 .cindex "exim_msgdate"
40347 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40348 This Perl script converts an Exim Mesage ID back into a human readable form.
40349 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40350
40351 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40352 .ecindex IIDutils
40353 . ////////////////////////////////////////////////////////////////////////////
40354 . ////////////////////////////////////////////////////////////////////////////
40355
40356 .chapter "The Exim monitor" "CHAPeximon"
40357 .scindex IIDeximon "Exim monitor" "description"
40358 .cindex "X-windows"
40359 .cindex "&'eximon'&"
40360 .cindex "Local/eximon.conf"
40361 .cindex "&_exim_monitor/EDITME_&"
40362 The Exim monitor is an application which displays in an X window information
40363 about the state of Exim's queue and what Exim is doing. An admin user can
40364 perform certain operations on messages from this GUI interface; however all
40365 such facilities are also available from the command line, and indeed, the
40366 monitor itself makes use of the command line to perform any actions requested.
40367
40368
40369
40370 .section "Running the monitor" "SECID264"
40371 The monitor is started by running the script called &'eximon'&. This is a shell
40372 script that sets up a number of environment variables, and then runs the
40373 binary called &_eximon.bin_&. The default appearance of the monitor window can
40374 be changed by editing the &_Local/eximon.conf_& file created by editing
40375 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40376 parameters are for.
40377
40378 The parameters that get built into the &'eximon'& script can be overridden for
40379 a particular invocation by setting up environment variables of the same names,
40380 preceded by &`EXIMON_`&. For example, a shell command such as
40381 .code
40382 EXIMON_LOG_DEPTH=400 eximon
40383 .endd
40384 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40385 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40386 overrides the Exim log file configuration. This makes it possible to have
40387 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40388 syslog messages are routed to a file on the local host.
40389
40390 X resources can be used to change the appearance of the window in the normal
40391 way. For example, a resource setting of the form
40392 .code
40393 Eximon*background: gray94
40394 .endd
40395 changes the colour of the background to light grey rather than white. The
40396 stripcharts are drawn with both the data lines and the reference lines in
40397 black. This means that the reference lines are not visible when on top of the
40398 data. However, their colour can be changed by setting a resource called
40399 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40400 For example, if your X server is running Unix, you could set up lighter
40401 reference lines in the stripcharts by obeying
40402 .code
40403 xrdb -merge <<End
40404 Eximon*highlight: gray
40405 End
40406 .endd
40407 .cindex "admin user"
40408 In order to see the contents of messages in the queue, and to operate on them,
40409 &'eximon'& must either be run as root or by an admin user.
40410
40411 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40412 contain X11 resource parameters interpreted by the X11 library.  In addition,
40413 if the first parameter starts with the string "gdb" then it is removed and the
40414 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40415 versioned variants of gdb can be invoked).
40416
40417 The monitor's window is divided into three parts. The first contains one or
40418 more stripcharts and two action buttons, the second contains a &"tail"& of the
40419 main log file, and the third is a display of the queue of messages awaiting
40420 delivery, with two more action buttons. The following sections describe these
40421 different parts of the display.
40422
40423
40424
40425
40426 .section "The stripcharts" "SECID265"
40427 .cindex "stripchart"
40428 The first stripchart is always a count of messages in the queue. Its name can
40429 be configured by setting QUEUE_STRIPCHART_NAME in the
40430 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40431 configuration script by regular expression matches on log file entries, making
40432 it possible to display, for example, counts of messages delivered to certain
40433 hosts or using certain transports. The supplied defaults display counts of
40434 received and delivered messages, and of local and SMTP deliveries. The default
40435 period between stripchart updates is one minute; this can be adjusted by a
40436 parameter in the &_Local/eximon.conf_& file.
40437
40438 The stripchart displays rescale themselves automatically as the value they are
40439 displaying changes. There are always 10 horizontal lines in each chart; the
40440 title string indicates the value of each division when it is greater than one.
40441 For example, &"x2"& means that each division represents a value of 2.
40442
40443 It is also possible to have a stripchart which shows the percentage fullness of
40444 a particular disk partition, which is useful when local deliveries are confined
40445 to a single partition.
40446
40447 .cindex "&%statvfs%& function"
40448 This relies on the availability of the &[statvfs()]& function or equivalent in
40449 the operating system. Most, but not all versions of Unix that support Exim have
40450 this. For this particular stripchart, the top of the chart always represents
40451 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40452 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40453 &_Local/eximon.conf_& file.
40454
40455
40456
40457
40458 .section "Main action buttons" "SECID266"
40459 .cindex "size" "of monitor window"
40460 .cindex "Exim monitor" "window size"
40461 .cindex "window size"
40462 Below the stripcharts there is an action button for quitting the monitor. Next
40463 to this is another button marked &"Size"&. They are placed here so that
40464 shrinking the window to its default minimum size leaves just the queue count
40465 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40466 the window to expand to its maximum size, unless it is already at the maximum,
40467 in which case it is reduced to its minimum.
40468
40469 When expanding to the maximum, if the window cannot be fully seen where it
40470 currently is, it is moved back to where it was the last time it was at full
40471 size. When it is expanding from its minimum size, the old position is
40472 remembered, and next time it is reduced to the minimum it is moved back there.
40473
40474 The idea is that you can keep a reduced window just showing one or two
40475 stripcharts at a convenient place on your screen, easily expand it to show
40476 the full window when required, and just as easily put it back to what it was.
40477 The idea is copied from what the &'twm'& window manager does for its
40478 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40479 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40480
40481 Normally, the monitor starts up with the window at its full size, but it can be
40482 built so that it starts up with the window at its smallest size, by setting
40483 START_SMALL=yes in &_Local/eximon.conf_&.
40484
40485
40486
40487 .section "The log display" "SECID267"
40488 .cindex "log" "tail of; in monitor"
40489 The second section of the window is an area in which a display of the tail of
40490 the main log is maintained.
40491 To save space on the screen, the timestamp on each log line is shortened by
40492 removing the date and, if &%log_timezone%& is set, the timezone.
40493 The log tail is not available when the only destination for logging data is
40494 syslog, unless the syslog lines are routed to a local file whose name is passed
40495 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40496
40497 The log sub-window has a scroll bar at its lefthand side which can be used to
40498 move back to look at earlier text, and the up and down arrow keys also have a
40499 scrolling effect. The amount of log that is kept depends on the setting of
40500 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40501 to use. When this is full, the earlier 50% of data is discarded &-- this is
40502 much more efficient than throwing it away line by line. The sub-window also has
40503 a horizontal scroll bar for accessing the ends of long log lines. This is the
40504 only means of horizontal scrolling; the right and left arrow keys are not
40505 available. Text can be cut from this part of the window using the mouse in the
40506 normal way. The size of this subwindow is controlled by parameters in the
40507 configuration file &_Local/eximon.conf_&.
40508
40509 Searches of the text in the log window can be carried out by means of the ^R
40510 and ^S keystrokes, which default to a reverse and a forward search,
40511 respectively. The search covers only the text that is displayed in the window.
40512 It cannot go further back up the log.
40513
40514 The point from which the search starts is indicated by a caret marker. This is
40515 normally at the end of the text in the window, but can be positioned explicitly
40516 by pointing and clicking with the left mouse button, and is moved automatically
40517 by a successful search. If new text arrives in the window when it is scrolled
40518 back, the caret remains where it is, but if the window is not scrolled back,
40519 the caret is moved to the end of the new text.
40520
40521 Pressing ^R or ^S pops up a window into which the search text can be typed.
40522 There are buttons for selecting forward or reverse searching, for carrying out
40523 the search, and for cancelling. If the &"Search"& button is pressed, the search
40524 happens and the window remains so that further searches can be done. If the
40525 &"Return"& key is pressed, a single search is done and the window is closed. If
40526 ^C is typed the search is cancelled.
40527
40528 The searching facility is implemented using the facilities of the Athena text
40529 widget. By default this pops up a window containing both &"search"& and
40530 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40531 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40532 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40533 provided version of &%TextPop%& when the remaining parts of the text widget
40534 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40535 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40536 on these systems, at the expense of having unwanted items in the search popup
40537 window.
40538
40539
40540
40541 .section "The queue display" "SECID268"
40542 .cindex "queue" "display in monitor"
40543 The bottom section of the monitor window contains a list of all messages that
40544 are in the queue, which includes those currently being received or delivered,
40545 as well as those awaiting delivery. The size of this subwindow is controlled by
40546 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40547 at which it is updated is controlled by another parameter in the same file &--
40548 the default is 5 minutes, since queue scans can be quite expensive. However,
40549 there is an &"Update"& action button just above the display which can be used
40550 to force an update of the queue display at any time.
40551
40552 When a host is down for some time, a lot of pending mail can build up for it,
40553 and this can make it hard to deal with other messages in the queue. To help
40554 with this situation there is a button next to &"Update"& called &"Hide"&. If
40555 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40556 type anything in here and press &"Return"&, the text is added to a chain of
40557 such texts, and if every undelivered address in a message matches at least one
40558 of the texts, the message is not displayed.
40559
40560 If there is an address that does not match any of the texts, all the addresses
40561 are displayed as normal. The matching happens on the ends of addresses so, for
40562 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40563 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40564 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40565 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40566 a hide request is automatically cancelled after one hour.
40567
40568 While the dialogue box is displayed, you can't press any buttons or do anything
40569 else to the monitor window. For this reason, if you want to cut text from the
40570 queue display to use in the dialogue box, you have to do the cutting before
40571 pressing the &"Hide"& button.
40572
40573 The queue display contains, for each unhidden queued message, the length of
40574 time it has been in the queue, the size of the message, the message id, the
40575 message sender, and the first undelivered recipient, all on one line. If it is
40576 a bounce message, the sender is shown as &"<>"&. If there is more than one
40577 recipient to which the message has not yet been delivered, subsequent ones are
40578 listed on additional lines, up to a maximum configured number, following which
40579 an ellipsis is displayed. Recipients that have already received the message are
40580 not shown.
40581
40582 .cindex "frozen messages" "display"
40583 If a message is frozen, an asterisk is displayed at the left-hand side.
40584
40585 The queue display has a vertical scroll bar, and can also be scrolled by means
40586 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40587 The text searching facilities, as described above for the log window, are also
40588 available, but the caret is always moved to the end of the text when the queue
40589 display is updated.
40590
40591
40592
40593 .section "The queue menu" "SECID269"
40594 .cindex "queue" "menu in monitor"
40595 If the &%shift%& key is held down and the left button is clicked when the mouse
40596 pointer is over the text for any message, an action menu pops up, and the first
40597 line of the queue display for the message is highlighted. This does not affect
40598 any selected text.
40599
40600 If you want to use some other event for popping up the menu, you can set the
40601 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40602 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40603 value set in this parameter is a standard X event description. For example, to
40604 run eximon using &%ctrl%& rather than &%shift%& you could use
40605 .code
40606 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40607 .endd
40608 The title of the menu is the message id, and it contains entries which act as
40609 follows:
40610
40611 .ilist
40612 &'message log'&: The contents of the message log for the message are displayed
40613 in a new text window.
40614 .next
40615 &'headers'&: Information from the spool file that contains the envelope
40616 information and headers is displayed in a new text window. See chapter
40617 &<<CHAPspool>>& for a description of the format of spool files.
40618 .next
40619 &'body'&: The contents of the spool file containing the body of the message are
40620 displayed in a new text window. There is a default limit of 20,000 bytes to the
40621 amount of data displayed. This can be changed by setting the BODY_MAX
40622 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40623 .next
40624 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40625 delivery of the message. This causes an automatic thaw if the message is
40626 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40627 a new text window. The delivery is run in a separate process, to avoid holding
40628 up the monitor while the delivery proceeds.
40629 .next
40630 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40631 that the message be frozen.
40632 .next
40633 .cindex "thawing messages"
40634 .cindex "unfreezing messages"
40635 .cindex "frozen messages" "thawing"
40636 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40637 that the message be thawed.
40638 .next
40639 .cindex "delivery" "forcing failure"
40640 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40641 that Exim gives up trying to deliver the message. A bounce message is generated
40642 for any remaining undelivered addresses.
40643 .next
40644 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40645 that the message be deleted from the system without generating a bounce
40646 message.
40647 .next
40648 &'add recipient'&: A dialog box is displayed into which a recipient address can
40649 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40650 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40651 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40652 causes a call to Exim to be made using the &%-Mar%& option to request that an
40653 additional recipient be added to the message, unless the entry box is empty, in
40654 which case no action is taken.
40655 .next
40656 &'mark delivered'&: A dialog box is displayed into which a recipient address
40657 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40658 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40659 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40660 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40661 recipient address as already delivered, unless the entry box is empty, in which
40662 case no action is taken.
40663 .next
40664 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40665 mark all recipient addresses as already delivered.
40666 .next
40667 &'edit sender'&: A dialog box is displayed initialized with the current
40668 sender's address. Pressing RETURN causes a call to Exim to be made using the
40669 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40670 in which case no action is taken. If you want to set an empty sender (as in
40671 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40672 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40673 the address is qualified with that domain.
40674 .endlist
40675
40676 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40677 other cases when a call to Exim is made, if there is any output from Exim (in
40678 particular, if the command fails) a window containing the command and the
40679 output is displayed. Otherwise, the results of the action are normally apparent
40680 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40681 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40682 if no output is generated.
40683
40684 The queue display is automatically updated for actions such as freezing and
40685 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40686 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40687 force an update of the display after one of these actions.
40688
40689 In any text window that is displayed as result of a menu action, the normal
40690 cut-and-paste facility is available, and searching can be carried out using ^R
40691 and ^S, as described above for the log tail window.
40692 .ecindex IIDeximon
40693
40694
40695
40696
40697
40698 . ////////////////////////////////////////////////////////////////////////////
40699 . ////////////////////////////////////////////////////////////////////////////
40700
40701 .chapter "Security considerations" "CHAPsecurity"
40702 .scindex IIDsecurcon "security" "discussion of"
40703 This chapter discusses a number of issues concerned with security, some of
40704 which are also covered in other parts of this manual.
40705
40706 For reasons that this author does not understand, some people have promoted
40707 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40708 existence of this chapter in the documentation. However, the intent of the
40709 chapter is simply to describe the way Exim works in relation to certain
40710 security concerns, not to make any specific claims about the effectiveness of
40711 its security as compared with other MTAs.
40712
40713 What follows is a description of the way Exim is supposed to be. Best efforts
40714 have been made to try to ensure that the code agrees with the theory, but an
40715 absence of bugs can never be guaranteed. Any that are reported will get fixed
40716 as soon as possible.
40717
40718
40719 .section "Building a more &""hardened""& Exim" "SECID286"
40720 .cindex "security" "build-time features"
40721 There are a number of build-time options that can be set in &_Local/Makefile_&
40722 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40723 Exim administrator who does not have the root password, or by someone who has
40724 penetrated the Exim (but not the root) account. These options are as follows:
40725
40726 .ilist
40727 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40728 start of any filenames used with the &%-C%& option. When it is set, these
40729 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40730 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40731 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40732 default setting for &%ALT_CONFIG_PREFIX%&.
40733
40734 If the permitted configuration files are confined to a directory to
40735 which only root has access, this guards against someone who has broken
40736 into the Exim account from running a privileged Exim with an arbitrary
40737 configuration file, and using it to break into other accounts.
40738 .next
40739
40740 If a non-trusted configuration file (i.e. not the default configuration file
40741 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40742 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40743 the next item), then root privilege is retained only if the caller of Exim is
40744 root. This locks out the possibility of testing a configuration using &%-C%&
40745 right through message reception and delivery, even if the caller is root. The
40746 reception works, but by that time, Exim is running as the Exim user, so when
40747 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40748 privilege to be lost. However, root can test reception and delivery using two
40749 separate commands.
40750
40751 .next
40752 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40753 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40754 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40755 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40756 the restrictive side.  Requiring build-time selection of safe macros is onerous
40757 but this option is intended solely as a transition mechanism to permit
40758 previously-working configurations to continue to work after release 4.73.
40759 .next
40760 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40761 is disabled.
40762 .next
40763 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40764 never to be used for any deliveries. This is like the &%never_users%& runtime
40765 option, but it cannot be overridden; the runtime option adds additional users
40766 to the list. The default setting is &"root"&; this prevents a non-root user who
40767 is permitted to modify the runtime file from using Exim as a way to get root.
40768 .endlist
40769
40770
40771
40772 .section "Root privilege" "SECID270"
40773 .cindex "setuid"
40774 .cindex "root privilege"
40775 The Exim binary is normally setuid to root, which means that it gains root
40776 privilege (runs as root) when it starts execution. In some special cases (for
40777 example, when the daemon is not in use and there are no local deliveries), it
40778 may be possible to run Exim setuid to some user other than root. This is
40779 discussed in the next section. However, in most installations, root privilege
40780 is required for two things:
40781
40782 .ilist
40783 To set up a socket connected to the standard SMTP port (25) when initialising
40784 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40785 not required.
40786 .next
40787 To be able to change uid and gid in order to read users' &_.forward_& files and
40788 perform local deliveries as the receiving user or as specified in the
40789 configuration.
40790 .endlist
40791
40792 It is not necessary to be root to do any of the other things Exim does, such as
40793 receiving messages and delivering them externally over SMTP, and it is
40794 obviously more secure if Exim does not run as root except when necessary.
40795 For this reason, a user and group for Exim to use must be defined in
40796 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40797 group"&. Their values can be changed by the runtime configuration, though this
40798 is not recommended. Often a user called &'exim'& is used, but some sites use
40799 &'mail'& or another user name altogether.
40800
40801 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40802 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40803 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40804
40805 After a new Exim process has interpreted its command line options, it changes
40806 uid and gid in the following cases:
40807
40808 .ilist
40809 .oindex "&%-C%&"
40810 .oindex "&%-D%&"
40811 If the &%-C%& option is used to specify an alternate configuration file, or if
40812 the &%-D%& option is used to define macro values for the configuration, and the
40813 calling process is not running as root, the uid and gid are changed to those of
40814 the calling process.
40815 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40816 option may not be used at all.
40817 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40818 can be supplied if the calling process is running as root, the Exim run-time
40819 user or CONFIGURE_OWNER, if defined.
40820 .next
40821 .oindex "&%-be%&"
40822 .oindex "&%-bf%&"
40823 .oindex "&%-bF%&"
40824 If the expansion test option (&%-be%&) or one of the filter testing options
40825 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40826 calling process.
40827 .next
40828 If the process is not a daemon process or a queue runner process or a delivery
40829 process or a process for testing address routing (started with &%-bt%&), the
40830 uid and gid are changed to the Exim user and group. This means that Exim always
40831 runs under its own uid and gid when receiving messages. This also applies when
40832 testing address verification
40833 .oindex "&%-bv%&"
40834 .oindex "&%-bh%&"
40835 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40836 option).
40837 .next
40838 For a daemon, queue runner, delivery, or address testing process, the uid
40839 remains as root at this stage, but the gid is changed to the Exim group.
40840 .endlist
40841
40842 The processes that initially retain root privilege behave as follows:
40843
40844 .ilist
40845 A daemon process changes the gid to the Exim group and the uid to the Exim
40846 user after setting up one or more listening sockets. The &[initgroups()]&
40847 function is called, so that if the Exim user is in any additional groups, they
40848 will be used during message reception.
40849 .next
40850 A queue runner process retains root privilege throughout its execution. Its
40851 job is to fork a controlled sequence of delivery processes.
40852 .next
40853 A delivery process retains root privilege throughout most of its execution,
40854 but any actual deliveries (that is, the transports themselves) are run in
40855 subprocesses which always change to a non-root uid and gid. For local
40856 deliveries this is typically the uid and gid of the owner of the mailbox; for
40857 remote deliveries, the Exim uid and gid are used. Once all the delivery
40858 subprocesses have been run, a delivery process changes to the Exim uid and gid
40859 while doing post-delivery tidying up such as updating the retry database and
40860 generating bounce and warning messages.
40861
40862 While the recipient addresses in a message are being routed, the delivery
40863 process runs as root. However, if a user's filter file has to be processed,
40864 this is done in a subprocess that runs under the individual user's uid and
40865 gid. A system filter is run as root unless &%system_filter_user%& is set.
40866 .next
40867 A process that is testing addresses (the &%-bt%& option) runs as root so that
40868 the routing is done in the same environment as a message delivery.
40869 .endlist
40870
40871
40872
40873
40874 .section "Running Exim without privilege" "SECTrunexiwitpri"
40875 .cindex "privilege, running without"
40876 .cindex "unprivileged running"
40877 .cindex "root privilege" "running without"
40878 Some installations like to run Exim in an unprivileged state for more of its
40879 operation, for added security. Support for this mode of operation is provided
40880 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40881 gid are changed to the Exim user and group at the start of a delivery process
40882 (and also queue runner and address testing processes). This means that address
40883 routing is no longer run as root, and the deliveries themselves cannot change
40884 to any other uid.
40885
40886 .cindex SIGHUP
40887 .cindex "daemon" "restarting"
40888 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40889 that the daemon can still be started in the usual way, and it can respond
40890 correctly to SIGHUP because the re-invocation regains root privilege.
40891
40892 An alternative approach is to make Exim setuid to the Exim user and also setgid
40893 to the Exim group. If you do this, the daemon must be started from a root
40894 process. (Calling Exim from a root process makes it behave in the way it does
40895 when it is setuid root.) However, the daemon cannot restart itself after a
40896 SIGHUP signal because it cannot regain privilege.
40897
40898 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40899 stops Exim from trying to re-invoke itself to do a delivery after a message has
40900 been received. Such a re-invocation is a waste of resources because it has no
40901 effect.
40902
40903 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40904 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40905 to the Exim user seems a clean approach, but there is one complication:
40906
40907 In this style of operation, Exim is running with the real uid and gid set to
40908 those of the calling process, and the effective uid/gid set to Exim's values.
40909 Ideally, any association with the calling process' uid/gid should be dropped,
40910 that is, the real uid/gid should be reset to the effective values so as to
40911 discard any privileges that the caller may have. While some operating systems
40912 have a function that permits this action for a non-root effective uid, quite a
40913 number of them do not. Because of this lack of standardization, Exim does not
40914 address this problem at this time.
40915
40916 For this reason, the recommended approach for &"mostly unprivileged"& running
40917 is to keep the Exim binary setuid to root, and to set
40918 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40919 be used in the most straightforward way.
40920
40921 If you configure Exim not to run delivery processes as root, there are a
40922 number of restrictions on what you can do:
40923
40924 .ilist
40925 You can deliver only as the Exim user/group. You should  explicitly use the
40926 &%user%& and &%group%& options to override routers or local transports that
40927 normally deliver as the recipient. This makes sure that configurations that
40928 work in this mode function the same way in normal mode. Any implicit or
40929 explicit specification of another user causes an error.
40930 .next
40931 Use of &_.forward_& files is severely restricted, such that it is usually
40932 not worthwhile to include them in the configuration.
40933 .next
40934 Users who wish to use &_.forward_& would have to make their home directory and
40935 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40936 and their equivalents in Exim filters, cannot be used. While they could be
40937 enabled in the Exim user's name, that would be insecure and not very useful.
40938 .next
40939 Unless the local user mailboxes are all owned by the Exim user (possible in
40940 some POP3 or IMAP-only environments):
40941
40942 .olist
40943 They must be owned by the Exim group and be writeable by that group. This
40944 implies you must set &%mode%& in the appendfile configuration, as well as the
40945 mode of the mailbox files themselves.
40946 .next
40947 You must set &%no_check_owner%&, since most or all of the files will not be
40948 owned by the Exim user.
40949 .next
40950 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40951 on a newly created mailbox when unprivileged. This also implies that new
40952 mailboxes need to be created manually.
40953 .endlist olist
40954 .endlist ilist
40955
40956
40957 These restrictions severely restrict what can be done in local deliveries.
40958 However, there are no restrictions on remote deliveries. If you are running a
40959 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40960 gives more security at essentially no cost.
40961
40962 If you are using the &%mua_wrapper%& facility (see chapter
40963 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40964
40965
40966
40967
40968 .section "Delivering to local files" "SECID271"
40969 Full details of the checks applied by &(appendfile)& before it writes to a file
40970 are given in chapter &<<CHAPappendfile>>&.
40971
40972
40973
40974 .section "Running local commands" "SECTsecconslocalcmds"
40975 .cindex "security" "local commands"
40976 .cindex "security" "command injection attacks"
40977 There are a number of ways in which an administrator can configure Exim to run
40978 commands based upon received, untrustworthy, data. Further, in some
40979 configurations a user who can control a &_.forward_& file can also arrange to
40980 run commands. Configuration to check includes, but is not limited to:
40981
40982 .ilist
40983 Use of &%use_shell%& in the pipe transport: various forms of shell command
40984 injection may be possible with this option present. It is dangerous and should
40985 be used only with considerable caution. Consider constraints which whitelist
40986 allowed characters in a variable which is to be used in a pipe transport that
40987 has &%use_shell%& enabled.
40988 .next
40989 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40990 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40991 &_.forward_& files in a redirect router. If Exim is running on a central mail
40992 hub to which ordinary users do not have shell access, but home directories are
40993 NFS mounted (for instance) then administrators should review the list of these
40994 forbid options available, and should bear in mind that the options that may
40995 need forbidding can change as new features are added between releases.
40996 .next
40997 The &%${run...}%& expansion item does not use a shell by default, but
40998 administrators can configure use of &_/bin/sh_& as part of the command.
40999 Such invocations should be viewed with prejudicial suspicion.
41000 .next
41001 Administrators who use embedded Perl are advised to explore how Perl's
41002 taint checking might apply to their usage.
41003 .next
41004 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
41005 administrators are well advised to view its use with suspicion, in case (for
41006 instance) it allows a local-part to contain embedded Exim directives.
41007 .next
41008 Use of &%${match_local_part...}%& and friends becomes more dangerous if
41009 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
41010 each can reference arbitrary lists and files, rather than just being a list
41011 of opaque strings.
41012 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
41013 real-world security vulnerabilities caused by its use with untrustworthy data
41014 injected in, for SQL injection attacks.
41015 Consider the use of the &%inlisti%& expansion condition instead.
41016 .endlist
41017
41018
41019
41020
41021 .section "Trust in configuration data" "SECTsecconfdata"
41022 .cindex "security" "data sources"
41023 .cindex "security" "regular expressions"
41024 .cindex "regular expressions" "security"
41025 .cindex "PCRE2" "security"
41026 If configuration data for Exim can come from untrustworthy sources, there
41027 are some issues to be aware of:
41028
41029 .ilist
41030 Use of &%${expand...}%& may provide a path for shell injection attacks.
41031 .next
41032 Letting untrusted data provide a regular expression is unwise.
41033 .next
41034 Using &%${match...}%& to apply a fixed regular expression against untrusted
41035 data may result in pathological behaviour within PCRE2.  Be aware of what
41036 "backtracking" means and consider options for being more strict with a regular
41037 expression. Avenues to explore include limiting what can match (avoiding &`.`&
41038 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
41039 possessive quantifiers or just not using regular expressions against untrusted
41040 data.
41041 .next
41042 It can be important to correctly use &%${quote:...}%&,
41043 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41044 items to ensure that data is correctly constructed.
41045 .next
41046 Some lookups might return multiple results, even though normal usage is only
41047 expected to yield one result.
41048 .endlist
41049
41050
41051
41052
41053 .section "IPv4 source routing" "SECID272"
41054 .cindex "source routing" "in IP packets"
41055 .cindex "IP source routing"
41056 Many operating systems suppress IP source-routed packets in the kernel, but
41057 some cannot be made to do this, so Exim does its own check. It logs incoming
41058 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41059 IPv6. No special checking is currently done.
41060
41061
41062
41063 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41064 Support for these SMTP commands is disabled by default. If required, they can
41065 be enabled by defining suitable ACLs.
41066
41067
41068
41069
41070 .section "Privileged users" "SECID274"
41071 .cindex "trusted users"
41072 .cindex "admin user"
41073 .cindex "privileged user"
41074 .cindex "user" "trusted"
41075 .cindex "user" "admin"
41076 Exim recognizes two sets of users with special privileges. Trusted users are
41077 able to submit new messages to Exim locally, but supply their own sender
41078 addresses and information about a sending host. For other users submitting
41079 local messages, Exim sets up the sender address from the uid, and doesn't
41080 permit a remote host to be specified.
41081
41082 .oindex "&%-f%&"
41083 However, an untrusted user is permitted to use the &%-f%& command line option
41084 in the special form &%-f <>%& to indicate that a delivery failure for the
41085 message should not cause an error report. This affects the message's envelope,
41086 but it does not affect the &'Sender:'& header. Untrusted users may also be
41087 permitted to use specific forms of address with the &%-f%& option by setting
41088 the &%untrusted_set_sender%& option.
41089
41090 Trusted users are used to run processes that receive mail messages from some
41091 other mail domain and pass them on to Exim for delivery either locally, or over
41092 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41093 as any user listed in the &%trusted_users%& configuration option, or under any
41094 group listed in the &%trusted_groups%& option.
41095
41096 Admin users are permitted to do things to the messages on Exim's queue. They
41097 can freeze or thaw messages, cause them to be returned to their senders, remove
41098 them entirely, or modify them in various ways. In addition, admin users can run
41099 the Exim monitor and see all the information it is capable of providing, which
41100 includes the contents of files on the spool.
41101
41102 .oindex "&%-M%&"
41103 .oindex "&%-q%&"
41104 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41105 delivery of messages on its queue is restricted to admin users. This
41106 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41107 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41108 queue is also restricted to admin users. This restriction can be relaxed by
41109 setting &%no_queue_list_requires_admin%&.
41110
41111 Exim recognizes an admin user if the calling process is running as root or as
41112 the Exim user or if any of the groups associated with the calling process is
41113 the Exim group. It is not necessary actually to be running under the Exim
41114 group. However, if admin users who are not root or the Exim user are to access
41115 the contents of files on the spool via the Exim monitor (which runs
41116 unprivileged), Exim must be built to allow group read access to its spool
41117 files.
41118
41119 By default, regular users are trusted to perform basic testing and
41120 introspection commands, as themselves.  This setting can be tightened by
41121 setting the &%commandline_checks_require_admin%& option.
41122 This affects most of the checking options,
41123 such as &%-be%& and anything else &%-b*%&.
41124
41125
41126 .section "Spool files" "SECID275"
41127 .cindex "spool directory" "files"
41128 Exim's spool directory and everything it contains is owned by the Exim user and
41129 set to the Exim group. The mode for spool files is defined in the
41130 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41131 any user who is a member of the Exim group can access these files.
41132
41133
41134
41135 .section "Use of argv[0]" "SECID276"
41136 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41137 of specific strings, Exim assumes certain options. For example, calling Exim
41138 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41139 to calling it with the option &%-bS%&. There are no security implications in
41140 this.
41141
41142
41143
41144 .section "Use of %f formatting" "SECID277"
41145 The only use made of &"%f"& by Exim is in formatting load average values. These
41146 are actually stored in integer variables as 1000 times the load average.
41147 Consequently, their range is limited and so therefore is the length of the
41148 converted output.
41149
41150
41151
41152 .section "Embedded Exim path" "SECID278"
41153 Exim uses its own path name, which is embedded in the code, only when it needs
41154 to re-exec in order to regain root privilege. Therefore, it is not root when it
41155 does so. If some bug allowed the path to get overwritten, it would lead to an
41156 arbitrary program's being run as exim, not as root.
41157
41158
41159
41160 .section "Dynamic module directory" "SECTdynmoddir"
41161 Any dynamically loadable modules must be installed into the directory
41162 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41163 loading it.
41164
41165
41166 .section "Use of sprintf()" "SECID279"
41167 .cindex "&[sprintf()]&"
41168 A large number of occurrences of &"sprintf"& in the code are actually calls to
41169 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41170 The intermediate formatting is done into a large fixed buffer by a function
41171 that runs through the format string itself, and checks the length of each
41172 conversion before performing it, thus preventing buffer overruns.
41173
41174 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41175 the output buffer is known to be sufficiently long to contain the converted
41176 string.
41177
41178
41179
41180 .section "Use of debug_printf() and log_write()" "SECID280"
41181 Arbitrary strings are passed to both these functions, but they do their
41182 formatting by calling the function &'string_vformat()'&, which runs through
41183 the format string itself, and checks the length of each conversion.
41184
41185
41186
41187 .section "Use of strcat() and strcpy()" "SECID281"
41188 These are used only in cases where the output buffer is known to be large
41189 enough to hold the result.
41190 .ecindex IIDsecurcon
41191
41192
41193
41194
41195 . ////////////////////////////////////////////////////////////////////////////
41196 . ////////////////////////////////////////////////////////////////////////////
41197
41198 .chapter "Format of spool files" "CHAPspool"
41199 .scindex IIDforspo1 "format" "spool files"
41200 .scindex IIDforspo2 "spool directory" "format of files"
41201 .scindex IIDforspo3 "spool files" "format of"
41202 .cindex "spool files" "editing"
41203 A message on Exim's queue consists of two files, whose names are the message id
41204 followed by -D and -H, respectively. The data portion of the message is kept in
41205 the -D file on its own. The message's envelope, status, and headers are all
41206 kept in the -H file, whose format is described in this chapter. Each of these
41207 two files contains the final component of its own name as its first line. This
41208 is insurance against disk crashes where the directory is lost but the files
41209 themselves are recoverable.
41210
41211 The file formats may be changed, or new formats added, at any release.
41212 Spool files are not intended as an interface to other programs
41213 and should not be used as such.
41214
41215 Some people are tempted into editing -D files in order to modify messages. You
41216 need to be extremely careful if you do this; it is not recommended and you are
41217 on your own if you do it. Here are some of the pitfalls:
41218
41219 .ilist
41220 You must ensure that Exim does not try to deliver the message while you are
41221 fiddling with it. The safest way is to take out a write lock on the -D file,
41222 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41223 place, the lock will be retained. If you write a new file and rename it, the
41224 lock will be lost at the instant of rename.
41225 .next
41226 .vindex "&$body_linecount$&"
41227 If you change the number of lines in the file, the value of
41228 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41229 cause incomplete transmission of messages or undeliverable messages.
41230 .next
41231 If the message is in MIME format, you must take care not to break it.
41232 .next
41233 If the message is cryptographically signed, any change will invalidate the
41234 signature.
41235 .endlist
41236 All in all, modifying -D files is fraught with danger.
41237
41238 Files whose names end with -J may also be seen in the &_input_& directory (or
41239 its subdirectories when &%split_spool_directory%& is set). These are journal
41240 files, used to record addresses to which the message has been delivered during
41241 the course of a delivery attempt. If there are still undelivered recipients at
41242 the end, the -H file is updated, and the -J file is deleted. If, however, there
41243 is some kind of crash (for example, a power outage) before this happens, the -J
41244 file remains in existence. When Exim next processes the message, it notices the
41245 -J file and uses it to update the -H file before starting the next delivery
41246 attempt.
41247
41248 Files whose names end with -K or .eml may also be seen in the spool.
41249 These are temporaries used for DKIM or malware processing, when that is used.
41250 They should be tidied up by normal operations; any old ones are probably
41251 relics of crashes and can be removed.
41252
41253 .section "Format of the -H file" "SECID282"
41254 .cindex "uid (user id)" "in spool file"
41255 .cindex "gid (group id)" "in spool file"
41256 The second line of the -H file contains the login name for the uid of the
41257 process that called Exim to read the message, followed by the numerical uid and
41258 gid. For a locally generated message, this is normally the user who sent the
41259 message. For a message received over TCP/IP via the daemon, it is
41260 normally the Exim user.
41261
41262 The third line of the file contains the address of the message's sender as
41263 transmitted in the envelope, contained in angle brackets. The sender address is
41264 empty for bounce messages. For incoming SMTP mail, the sender address is given
41265 in the MAIL command. For locally generated mail, the sender address is
41266 created by Exim from the login name of the current user and the configured
41267 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41268 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41269 &"<>"& or an address that matches &%untrusted_set_senders%&.
41270
41271 The fourth line contains two numbers. The first is the time that the message
41272 was received, in the conventional Unix form &-- the number of seconds since the
41273 start of the epoch. The second number is a count of the number of messages
41274 warning of delayed delivery that have been sent to the sender.
41275
41276 There follow a number of lines starting with a hyphen.
41277 These contain variables, can appear in any
41278 order, and are omitted when not relevant.
41279
41280 If there is a second hyphen after the first,
41281 the corresponding data is tainted.
41282 If there is a value in parentheses, the data is quoted for a lookup.
41283
41284 The following word specifies a variable,
41285 and the remainder of the item depends on the variable.
41286
41287 .vlist
41288 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41289 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41290 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41291 recognized, to provide backward compatibility. In the old format, a line of
41292 this form is present for every ACL variable that is not empty. The number
41293 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41294 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41295 the data string for the variable. The string itself starts at the beginning of
41296 the next line, and is followed by a newline character. It may contain internal
41297 newlines.
41298
41299 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41300 A line of this form is present for every ACL connection variable that is
41301 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41302 The length is the length of the data string for the variable. The string itself
41303 starts at the beginning of the next line, and is followed by a newline
41304 character. It may contain internal newlines.
41305
41306 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41307 A line of this form is present for every ACL message variable that is defined.
41308 Note that there is a space between &%-aclm%& and the rest of the name. The
41309 length is the length of the data string for the variable. The string itself
41310 starts at the beginning of the next line, and is followed by a newline
41311 character. It may contain internal newlines.
41312
41313 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41314 This is present if, when the message was received over SMTP, the value of
41315 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41316
41317 .vitem &%-allow_unqualified_recipient%&
41318 This is present if unqualified recipient addresses are permitted in header
41319 lines (to stop such addresses from being qualified if rewriting occurs at
41320 transport time). Local messages that were input using &%-bnq%& and remote
41321 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41322
41323 .vitem &%-allow_unqualified_sender%&
41324 This is present if unqualified sender addresses are permitted in header lines
41325 (to stop such addresses from being qualified if rewriting occurs at transport
41326 time). Local messages that were input using &%-bnq%& and remote messages from
41327 hosts that match &%sender_unqualified_hosts%& set this flag.
41328
41329 .vitem "&%-auth_id%&&~<&'text'&>"
41330 The id information for a message received on an authenticated SMTP connection
41331 &-- the value of the &$authenticated_id$& variable.
41332
41333 .vitem "&%-auth_sender%&&~<&'address'&>"
41334 The address of an authenticated sender &-- the value of the
41335 &$authenticated_sender$& variable.
41336
41337 .vitem "&%-body_linecount%&&~<&'number'&>"
41338 This records the number of lines in the body of the message, and is
41339 present unless &%-spool_file_wireformat%& is.
41340
41341 .vitem "&%-body_zerocount%&&~<&'number'&>"
41342 This records the number of binary zero bytes in the body of the message, and is
41343 present if the number is greater than zero.
41344
41345 .vitem &%-deliver_firsttime%&
41346 This is written when a new message is first added to the spool. When the spool
41347 file is updated after a deferral, it is omitted.
41348
41349 .vitem "&%-frozen%&&~<&'time'&>"
41350 .cindex "frozen messages" "spool data"
41351 The message is frozen, and the freezing happened at <&'time'&>.
41352
41353 .vitem "&%-helo_name%&&~<&'text'&>"
41354 This records the host name as specified by a remote host in a HELO or EHLO
41355 command.
41356
41357 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41358 This records the IP address of the host from which the message was received and
41359 the remote port number that was used. It is omitted for locally generated
41360 messages.
41361
41362 .vitem "&%-host_auth%&&~<&'text'&>"
41363 If the message was received on an authenticated SMTP connection, this records
41364 the name of the authenticator &-- the value of the
41365 &$sender_host_authenticated$& variable.
41366
41367 .vitem &%-host_lookup_failed%&
41368 This is present if an attempt to look up the sending host's name from its IP
41369 address failed. It corresponds to the &$host_lookup_failed$& variable.
41370
41371 .vitem "&%-host_name%&&~<&'text'&>"
41372 .cindex "reverse DNS lookup"
41373 .cindex "DNS" "reverse lookup"
41374 This records the name of the remote host from which the message was received,
41375 if the host name was looked up from the IP address when the message was being
41376 received. It is not present if no reverse lookup was done.
41377
41378 .vitem "&%-ident%&&~<&'text'&>"
41379 For locally submitted messages, this records the login of the originating user,
41380 unless it was a trusted user and the &%-oMt%& option was used to specify an
41381 ident value. For messages received over TCP/IP, this records the ident string
41382 supplied by the remote host, if any.
41383
41384 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41385 This records the IP address of the local interface and the port number through
41386 which a message was received from a remote host. It is omitted for locally
41387 generated messages.
41388
41389 .vitem &%-local%&
41390 The message is from a local sender.
41391
41392 .vitem &%-localerror%&
41393 The message is a locally-generated bounce message.
41394
41395 .vitem "&%-local_scan%&&~<&'string'&>"
41396 This records the data string that was returned by the &[local_scan()]& function
41397 when the message was received &-- the value of the &$local_scan_data$&
41398 variable. It is omitted if no data was returned.
41399
41400 .vitem &%-manual_thaw%&
41401 The message was frozen but has been thawed manually, that is, by an explicit
41402 Exim command rather than via the auto-thaw process.
41403
41404 .vitem &%-N%&
41405 A testing delivery process was started using the &%-N%& option to suppress any
41406 actual deliveries, but delivery was deferred. At any further delivery attempts,
41407 &%-N%& is assumed.
41408
41409 .vitem &%-received_protocol%&
41410 This records the value of the &$received_protocol$& variable, which contains
41411 the name of the protocol by which the message was received.
41412
41413 .vitem &%-sender_set_untrusted%&
41414 The envelope sender of this message was set by an untrusted local caller (used
41415 to ensure that the caller is displayed in queue listings).
41416
41417 .vitem "&%-spam_score_int%&&~<&'number'&>"
41418 If a message was scanned by SpamAssassin, this is present. It records the value
41419 of &$spam_score_int$&.
41420
41421 .vitem &%-spool_file_wireformat%&
41422 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41423 rather than Unix-format.
41424 The line-ending is CRLF rather than newline.
41425 There is still, however, no leading-dot-stuffing.
41426
41427 .vitem &%-tls_certificate_verified%&
41428 A TLS certificate was received from the client that sent this message, and the
41429 certificate was verified by the server.
41430
41431 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41432 When the message was received over an encrypted connection, this records the
41433 name of the cipher suite that was used.
41434
41435 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41436 When the message was received over an encrypted connection, and a certificate
41437 was received from the client, this records the Distinguished Name from that
41438 certificate.
41439 .endlist
41440
41441 Following the options there is a list of those addresses to which the message
41442 is not to be delivered. This set of addresses is initialized from the command
41443 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41444 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41445 the address is added to this set. The addresses are kept internally as a
41446 balanced binary tree, and it is a representation of that tree which is written
41447 to the spool file. If an address is expanded via an alias or forward file, the
41448 original address is added to the tree when deliveries to all its child
41449 addresses are complete.
41450
41451 If the tree is empty, there is a single line in the spool file containing just
41452 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41453 Y or N, followed by an address. The address is the value for the node of the
41454 tree, and the letters indicate whether the node has a left branch and/or a
41455 right branch attached to it, respectively. If branches exist, they immediately
41456 follow. Here is an example of a three-node tree:
41457 .code
41458 YY darcy@austen.fict.example
41459 NN alice@wonderland.fict.example
41460 NN editor@thesaurus.ref.example
41461 .endd
41462 After the non-recipients tree, there is a list of the message's recipients.
41463 This is a simple list, preceded by a count. It includes all the original
41464 recipients of the message, including those to whom the message has already been
41465 delivered. In the simplest case, the list contains one address per line. For
41466 example:
41467 .code
41468 4
41469 editor@thesaurus.ref.example
41470 darcy@austen.fict.example
41471 rdo@foundation
41472 alice@wonderland.fict.example
41473 .endd
41474 However, when a child address has been added to the top-level addresses as a
41475 result of the use of the &%one_time%& option on a &(redirect)& router, each
41476 line is of the following form:
41477 .display
41478 <&'top-level address'&> <&'errors_to address'&> &&&
41479   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41480 .endd
41481 The 01 flag bit indicates the presence of the three other fields that follow
41482 the top-level address. Other bits may be used in future to support additional
41483 fields. The <&'parent number'&> is the offset in the recipients list of the
41484 original parent of the &"one time"& address. The first two fields are the
41485 envelope sender that is associated with this address and its length. If the
41486 length is zero, there is no special envelope sender (there are then two space
41487 characters in the line). A non-empty field can arise from a &(redirect)& router
41488 that has an &%errors_to%& setting.
41489
41490
41491 A blank line separates the envelope and status information from the headers
41492 which follow. A header may occupy several lines of the file, and to save effort
41493 when reading it in, each header is preceded by a number and an identifying
41494 character. The number is the number of characters in the header, including any
41495 embedded newlines and the terminating newline. The character is one of the
41496 following:
41497
41498 .table2 50pt
41499 .row <&'blank'&>         "header in which Exim has no special interest"
41500 .row &`B`&               "&'Bcc:'& header"
41501 .row &`C`&               "&'Cc:'& header"
41502 .row &`F`&               "&'From:'& header"
41503 .row &`I`&               "&'Message-id:'& header"
41504 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41505 .row &`R`&               "&'Reply-To:'& header"
41506 .row &`S`&               "&'Sender:'& header"
41507 .row &`T`&               "&'To:'& header"
41508 .row &`*`&               "replaced or deleted header"
41509 .endtable
41510
41511 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41512 purposes. They are not transmitted when the message is delivered. Here is a
41513 typical set of headers:
41514 .code
41515 111P Received: by hobbit.fict.example with local (Exim 4.00)
41516 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41517 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41518 038* X-rewrote-sender: bb@hobbit.fict.example
41519 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41520 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41521 099* To: alice@wonderland.fict.example, rdo@foundation,
41522 darcy@austen.fict.example, editor@thesaurus.ref.example
41523 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41524 darcy@austen.fict.example, editor@thesaurus.ref.example
41525 038  Date: Fri, 11 May 2001 10:28:59 +0100
41526 .endd
41527 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41528 &'To:'& header have been rewritten, the last one because routing expanded the
41529 unqualified domain &'foundation'&.
41530 .ecindex IIDforspo1
41531 .ecindex IIDforspo2
41532 .ecindex IIDforspo3
41533
41534 .section "Format of the -D file" "SECID282a"
41535 The data file is traditionally in Unix-standard format: lines are ended with
41536 an ASCII newline character.
41537 However, when the &%spool_wireformat%& main option is used some -D files
41538 can have an alternate format.
41539 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41540 The -D file lines (not including the first name-component line) are
41541 suitable for direct copying to the wire when transmitting using the
41542 ESMTP CHUNKING option, meaning lower processing overhead.
41543 Lines are terminated with an ASCII CRLF pair.
41544 There is no dot-stuffing (and no dot-termination).
41545
41546 . ////////////////////////////////////////////////////////////////////////////
41547 . ////////////////////////////////////////////////////////////////////////////
41548
41549 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41550          "DKIM, SPF, SRS and DMARC Support"
41551
41552 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41553 .cindex "DKIM"
41554
41555 DKIM is a mechanism by which messages sent by some entity can be provably
41556 linked to a domain which that entity controls.  It permits reputation to
41557 be tracked on a per-domain basis, rather than merely upon source IP address.
41558 DKIM is documented in RFC 6376.
41559
41560 As DKIM relies on the message being unchanged in transit, messages handled
41561 by a mailing-list (which traditionally adds to the message) will not match
41562 any original DKIM signature.
41563
41564 DKIM support is compiled into Exim by default if TLS support is present.
41565 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41566
41567 Exim's DKIM implementation allows for
41568 .olist
41569 Signing outgoing messages: This function is implemented in the SMTP transport.
41570 It can co-exist with all other Exim features
41571 (including transport filters)
41572 except cutthrough delivery.
41573 .next
41574 Verifying signatures in incoming messages: This is implemented by an additional
41575 ACL (acl_smtp_dkim), which can be called several times per message, with
41576 different signature contexts.
41577 .endlist
41578
41579 In typical Exim style, the verification implementation does not include any
41580 default "policy". Instead it enables you to build your own policy using
41581 Exim's standard controls.
41582
41583 Please note that verification of DKIM signatures in incoming mail is turned
41584 on by default for logging (in the <= line) purposes.
41585
41586 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41587 When set, for each signature in incoming email,
41588 exim will log a line displaying the most important signature details, and the
41589 signature status. Here is an example (with line-breaks added for clarity):
41590 .code
41591 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41592     d=facebookmail.com s=q1-2009b
41593     c=relaxed/relaxed a=rsa-sha1
41594     i=@facebookmail.com t=1252484542 [verification succeeded]
41595 .endd
41596
41597 You might want to turn off DKIM verification processing entirely for internal
41598 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41599 control modifier. This should typically be done in the RCPT ACL, at points
41600 where you accept mail from relay sources (internal hosts or authenticated
41601 senders).
41602
41603
41604 .subsection "Signing outgoing messages" SECDKIMSIGN
41605 .cindex DKIM signing
41606
41607 For signing to be usable you must have published a DKIM record in DNS.
41608 Note that RFC 8301 (which does not cover EC keys) says:
41609 .code
41610 rsa-sha1 MUST NOT be used for signing or verifying.
41611
41612 Signers MUST use RSA keys of at least 1024 bits for all keys.
41613 Signers SHOULD use RSA keys of at least 2048 bits.
41614 .endd
41615
41616 Note also that the key content (the 'p=' field)
41617 in the DNS record is different between RSA and EC keys;
41618 for the former it is the base64 of the ASN.1 for the RSA public key
41619 (equivalent to the private-key .pem with the header/trailer stripped)
41620 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41621
41622 Signing is enabled by setting private options on the SMTP transport.
41623 These options take (expandable) strings as arguments.
41624
41625 .option dkim_domain smtp "string list&!!" unset
41626 The domain(s) you want to sign with.
41627 After expansion, this can be a list.
41628 Each element in turn,
41629 lowercased,
41630 .vindex "&$dkim_domain$&"
41631 is put into the &%$dkim_domain%& expansion variable
41632 while expanding the remaining signing options.
41633 If it is empty after expansion, DKIM signing is not done,
41634 and no error will result even if &%dkim_strict%& is set.
41635
41636 .option dkim_selector smtp "string list&!!" unset
41637 This sets the key selector string.
41638 After expansion, which can use &$dkim_domain$&, this can be a list.
41639 Each element in turn is put in the expansion
41640 .vindex "&$dkim_selector$&"
41641 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41642 option along with &%$dkim_domain%&.
41643 If the option is empty after expansion, DKIM signing is not done for this domain,
41644 and no error will result even if &%dkim_strict%& is set.
41645
41646 To do, for example, dual-signing with RSA and EC keys
41647 this could be be used:
41648 .code
41649 dkim_selector = ec_sel : rsa_sel
41650 dkim_private_key = KEYS_DIR/$dkim_selector
41651 .endd
41652
41653 .option dkim_private_key smtp string&!! unset
41654 This sets the private key to use.
41655 You can use the &%$dkim_domain%& and
41656 &%$dkim_selector%& expansion variables to determine the private key to use.
41657 The result can either
41658 .ilist
41659 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41660 .next
41661 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41662 be a valid Ed25519 private key (same format as above)
41663 .next
41664 start with a slash, in which case it is treated as a file that contains
41665 the private key
41666 .next
41667 be "0", "false" or the empty string, in which case the message will not
41668 be signed. This case will not result in an error, even if &%dkim_strict%&
41669 is set.
41670 .endlist
41671
41672 To generate keys under OpenSSL:
41673 .code
41674 openssl genrsa -out dkim_rsa.private 2048
41675 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41676 .endd
41677 The result file from the first command should be retained, and
41678 this option set to use it.
41679 Take the base-64 lines from the output of the second command, concatenated,
41680 for the DNS TXT record.
41681 See section 3.6 of RFC6376 for the record specification.
41682
41683 Under GnuTLS:
41684 .code
41685 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41686 certtool --load-privkey=dkim_rsa.private --pubkey-info
41687 .endd
41688
41689 Note that RFC 8301 says:
41690 .code
41691 Signers MUST use RSA keys of at least 1024 bits for all keys.
41692 Signers SHOULD use RSA keys of at least 2048 bits.
41693 .endd
41694
41695 EC keys for DKIM are defined by RFC 8463.
41696 They are considerably smaller than RSA keys for equivalent protection.
41697 As they are a recent development, users should consider dual-signing
41698 (by setting a list of selectors, and an expansion for this option)
41699 for some transition period.
41700 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41701 for EC keys.
41702
41703 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41704 .code
41705 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41706 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41707 .endd
41708
41709 To produce the required public key value for a DNS record:
41710 .code
41711 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41712 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41713 .endd
41714
41715 Exim also supports an alternate format
41716 of Ed25519 keys in DNS which was a candidate during development
41717 of the standard, but not adopted.
41718 A future release will probably drop that support.
41719
41720 .option dkim_hash smtp string&!! sha256
41721 Can be set to any one of the supported hash methods, which are:
41722 .ilist
41723 &`sha1`& &-- should not be used, is old and insecure
41724 .next
41725 &`sha256`& &-- the default
41726 .next
41727 &`sha512`& &-- possibly more secure but less well supported
41728 .endlist
41729
41730 Note that RFC 8301 says:
41731 .code
41732 rsa-sha1 MUST NOT be used for signing or verifying.
41733 .endd
41734
41735 .option dkim_identity smtp string&!! unset
41736 If set after expansion, the value is used to set an "i=" tag in
41737 the signing header.  The DKIM standards restrict the permissible
41738 syntax of this optional tag to a mail address, with possibly-empty
41739 local part, an @, and a domain identical to or subdomain of the "d="
41740 tag value.  Note that Exim does not check the value.
41741
41742 .option dkim_canon smtp string&!! unset
41743 This option sets the canonicalization method used when signing a message.
41744 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41745 The option defaults to "relaxed" when unset. Note: the current implementation
41746 only supports signing with the same canonicalization method for both headers and body.
41747
41748 .option dkim_strict smtp string&!! unset
41749 This  option  defines  how  Exim  behaves  when  signing a message that
41750 should be signed fails for some reason.  When the expansion evaluates to
41751 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41752 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41753 variables here.
41754
41755 .option dkim_sign_headers smtp string&!! "see below"
41756 If set, this option must expand to a colon-separated
41757 list of header names.
41758 Headers with these names, or the absence or such a header, will be included
41759 in the message signature.
41760 When unspecified, the header names listed in RFC4871 will be used,
41761 whether or not each header is present in the message.
41762 The default list is available for the expansion in the macro
41763 &"_DKIM_SIGN_HEADERS"&
41764 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41765
41766 If a name is repeated, multiple headers by that name (or the absence thereof)
41767 will be signed.  The textually later headers in the headers part of the
41768 message are signed first, if there are multiples.
41769
41770 A name can be prefixed with either an &"="& or a &"+"& character.
41771 If an &"="& prefix is used, all headers that are present with this name
41772 will be signed.
41773 If a &"+"& prefix if used, all headers that are present with this name
41774 will be signed, and one signature added for a missing header with the
41775 name will be appended.
41776
41777 .option dkim_timestamps smtp integer&!! unset
41778 This option controls the inclusion of timestamp information in the signature.
41779 If not set, no such information will be included.
41780 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41781 for the expiry tag
41782 (eg. 1209600 for two weeks);
41783 both creation (t=) and expiry (x=) tags will be included.
41784
41785 RFC 6376 lists these tags as RECOMMENDED.
41786
41787
41788 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41789 .cindex DKIM verification
41790
41791 Verification of DKIM signatures in SMTP incoming email is done for all
41792 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41793 .cindex DKIM "selecting signature algorithms"
41794 Individual classes of signature algorithm can be ignored by changing
41795 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41796 The &%dkim_verify_minimal%& option can be set to cease verification
41797 processing for a message once the first passing signature is found.
41798
41799 .cindex authentication "expansion item"
41800 Performing verification sets up information used by the
41801 &%authresults%& expansion item.
41802
41803 For most purposes the default option settings suffice and the remainder
41804 of this section can be ignored.
41805
41806 The results of verification are made available to the
41807 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41808 A missing ACL definition defaults to accept.
41809 By default, the ACL is called once for each
41810 syntactically(!) correct signature in the incoming message.
41811 If any ACL call does not accept, the message is not accepted.
41812 If a cutthrough delivery was in progress for the message, that is
41813 summarily dropped (having wasted the transmission effort).
41814
41815 To evaluate the verification result in the ACL
41816 a large number of expansion variables
41817 containing the signature status and its details are set up during the
41818 runtime of the ACL.
41819
41820 Calling the ACL only for existing signatures is not sufficient to build
41821 more advanced policies. For that reason, the main option
41822 &%dkim_verify_signers%&, and an expansion variable
41823 &%$dkim_signers%& exist.
41824
41825 The main option &%dkim_verify_signers%& can be set to a colon-separated
41826 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41827 called. It is expanded when the message has been received. At this point,
41828 the expansion variable &%$dkim_signers%& already contains a colon-separated
41829 list of signer domains and identities for the message. When
41830 &%dkim_verify_signers%& is not specified in the main configuration,
41831 it defaults as:
41832 .code
41833 dkim_verify_signers = $dkim_signers
41834 .endd
41835 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41836 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41837 call the ACL for known domains or identities. This would be achieved as follows:
41838 .code
41839 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41840 .endd
41841 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41842 and "ebay.com", plus all domains and identities that have signatures in the message.
41843 You can also be more creative in constructing your policy. For example:
41844 .code
41845 dkim_verify_signers = $sender_address_domain:$dkim_signers
41846 .endd
41847
41848 If a domain or identity is listed several times in the (expanded) value of
41849 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41850
41851 Note that if the option is set using untrustworthy data
41852 (such as the From: header)
41853 care should be taken to force lowercase for domains
41854 and for the domain part if identities.
41855 The default setting can be regarded as trustworthy in this respect.
41856
41857 If multiple signatures match a domain (or identity), the ACL is called once
41858 for each matching signature.
41859
41860
41861 Inside the DKIM ACL, the following expansion variables are
41862 available (from most to least important):
41863
41864
41865 .vlist
41866 .vitem &%$dkim_cur_signer%&
41867 The signer that is being evaluated in this ACL run. This can be a domain or
41868 an identity. This is one of the list items from the expanded main option
41869 &%dkim_verify_signers%& (see above).
41870
41871 .vitem &%$dkim_verify_status%&
41872 Within the DKIM ACL,
41873 a string describing the general status of the signature. One of
41874 .ilist
41875 &%none%&: There is no signature in the message for the current domain or
41876 identity (as reflected by &%$dkim_cur_signer%&).
41877 .next
41878 &%invalid%&: The signature could not be verified due to a processing error.
41879 More detail is available in &%$dkim_verify_reason%&.
41880 .next
41881 &%fail%&: Verification of the signature failed.  More detail is
41882 available in &%$dkim_verify_reason%&.
41883 .next
41884 &%pass%&: The signature passed verification. It is valid.
41885 .endlist
41886
41887 This variable can be overwritten using an ACL 'set' modifier.
41888 This might, for instance, be done to enforce a policy restriction on
41889 hash-method or key-size:
41890 .code
41891   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41892        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41893        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41894                                   {< {$dkim_key_length}{1024}}}}
41895        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41896        set dkim_verify_status = fail
41897        set dkim_verify_reason = hash too weak or key too short
41898 .endd
41899
41900 So long as a DKIM ACL is defined (it need do no more than accept),
41901 after all the DKIM ACL runs have completed, the value becomes a
41902 colon-separated list of the values after each run.
41903 This is maintained for the mime, prdr and data ACLs.
41904
41905 .vitem &%$dkim_verify_reason%&
41906 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41907 "fail" or "invalid". One of
41908 .ilist
41909 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41910 key for the domain could not be retrieved. This may be a temporary problem.
41911 .next
41912 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41913 record for the domain is syntactically invalid.
41914 .next
41915 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41916 body hash does not match the one specified in the signature header. This
41917 means that the message body was modified in transit.
41918 .next
41919 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41920 could not be verified. This may mean that headers were modified,
41921 re-written or otherwise changed in a way which is incompatible with
41922 DKIM verification. It may of course also mean that the signature is forged.
41923 .endlist
41924
41925 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41926
41927 .vitem &%$dkim_domain%&
41928 The signing domain. IMPORTANT: This variable is only populated if there is
41929 an actual signature in the message for the current domain or identity (as
41930 reflected by &%$dkim_cur_signer%&).
41931
41932 .vitem &%$dkim_identity%&
41933 The signing identity, if present. IMPORTANT: This variable is only populated
41934 if there is an actual signature in the message for the current domain or
41935 identity (as reflected by &%$dkim_cur_signer%&).
41936
41937 .vitem &%$dkim_selector%&
41938 The key record selector string.
41939
41940 .vitem &%$dkim_algo%&
41941 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41942 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41943 may also be 'ed25519-sha256'.
41944 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41945 for EC keys.
41946
41947 Note that RFC 8301 says:
41948 .code
41949 rsa-sha1 MUST NOT be used for signing or verifying.
41950
41951 DKIM signatures identified as having been signed with historic
41952 algorithms (currently, rsa-sha1) have permanently failed evaluation
41953 .endd
41954
41955 To enforce this you must either have a DKIM ACL which checks this variable
41956 and overwrites the &$dkim_verify_status$& variable as discussed above,
41957 or have set the main option &%dkim_verify_hashes%& to exclude
41958 processing of such signatures.
41959
41960 .vitem &%$dkim_canon_body%&
41961 The body canonicalization method. One of 'relaxed' or 'simple'.
41962
41963 .vitem &%$dkim_canon_headers%&
41964 The header canonicalization method. One of 'relaxed' or 'simple'.
41965
41966 .vitem &%$dkim_copiedheaders%&
41967 A transcript of headers and their values which are included in the signature
41968 (copied from the 'z=' tag of the signature).
41969 Note that RFC6376 requires that verification fail if the From: header is
41970 not included in the signature.  Exim does not enforce this; sites wishing
41971 strict enforcement should code the check explicitly.
41972
41973 .vitem &%$dkim_bodylength%&
41974 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41975 limit was set by the signer, "9999999999999" is returned. This makes sure
41976 that this variable always expands to an integer value.
41977 &*Note:*& The presence of the signature tag specifying a signing body length
41978 is one possible route to spoofing of valid DKIM signatures.
41979 A paranoid implementation might wish to regard signature where this variable
41980 shows less than the "no limit" return as being invalid.
41981
41982 .vitem &%$dkim_created%&
41983 UNIX timestamp reflecting the date and time when the signature was created.
41984 When this was not specified by the signer, "0" is returned.
41985
41986 .vitem &%$dkim_expires%&
41987 UNIX timestamp reflecting the date and time when the signer wants the
41988 signature to be treated as "expired". When this was not specified by the
41989 signer, "9999999999999" is returned. This makes it possible to do useful
41990 integer size comparisons against this value.
41991 Note that Exim does not check this value.
41992
41993 .vitem &%$dkim_headernames%&
41994 A colon-separated list of names of headers included in the signature.
41995
41996 .vitem &%$dkim_key_testing%&
41997 "1" if the key record has the "testing" flag set, "0" if not.
41998
41999 .vitem &%$dkim_key_nosubdomains%&
42000 "1" if the key record forbids subdomaining, "0" otherwise.
42001
42002 .vitem &%$dkim_key_srvtype%&
42003 Service type (tag s=) from the key record. Defaults to "*" if not specified
42004 in the key record.
42005
42006 .vitem &%$dkim_key_granularity%&
42007 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
42008 in the key record.
42009
42010 .vitem &%$dkim_key_notes%&
42011 Notes from the key record (tag n=).
42012
42013 .vitem &%$dkim_key_length%&
42014 Number of bits in the key.
42015 Valid only once the key is loaded, which is at the time the header signature
42016 is verified, which is after the body hash is.
42017
42018 Note that RFC 8301 says:
42019 .code
42020 Verifiers MUST NOT consider signatures using RSA keys of
42021 less than 1024 bits as valid signatures.
42022 .endd
42023
42024 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
42025 option.
42026
42027 .endlist
42028
42029 In addition, two ACL conditions are provided, usable only in a DKIM ACL:
42030
42031 .vlist
42032 .vitem &%dkim_signers%&
42033 ACL condition that checks a colon-separated list of domains or identities
42034 for a match against the domain or identity that the ACL is currently verifying
42035 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
42036 verb to a group of domains or identities. For example:
42037
42038 .code
42039 # Warn when Mail purportedly from GMail has no gmail signature
42040 warn sender_domains = gmail.com
42041      dkim_signers = gmail.com
42042      dkim_status = none
42043      log_message = GMail sender without gmail.com DKIM signature
42044 .endd
42045
42046 Note that the above does not check for a total lack of DKIM signing;
42047 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42048
42049 .vitem &%dkim_status%&
42050 ACL condition that checks a colon-separated list of possible DKIM verification
42051 results against the actual result of verification. This is typically used
42052 to restrict an ACL verb to a list of verification outcomes, for example:
42053
42054 .code
42055 deny sender_domains = paypal.com:paypal.de
42056      dkim_signers = paypal.com:paypal.de
42057      dkim_status = none:invalid:fail
42058      message = Mail from Paypal with invalid/missing signature
42059 .endd
42060
42061 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42062 see the documentation of the &%$dkim_verify_status%& expansion variable above
42063 for more information of what they mean.
42064 .endlist
42065
42066
42067
42068
42069 .section "SPF (Sender Policy Framework)" SECSPF
42070 .cindex SPF verification
42071
42072 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42073 messages with its domain in the envelope from, documented by RFC 7208.
42074 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42075 the &url(http://openspf.org).
42076 . --- 2019-10-28: still not https, open-spf.org is told to be a
42077 . --- web-archive copy of the now dead openspf.org site
42078 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42079 . --- discussion.
42080
42081 Messages sent by a system not authorised will fail checking of such assertions.
42082 This includes retransmissions done by traditional forwarders.
42083
42084 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42085 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42086 &url(https://www.libspf2.org/).
42087 There is no Exim involvement in the transmission of messages;
42088 publishing certain DNS records is all that is required.
42089
42090 For verification, an ACL condition and an expansion lookup are provided.
42091 .cindex authentication "expansion item"
42092 Performing verification sets up information used by the
42093 &%authresults%& expansion item.
42094
42095
42096 .cindex SPF "ACL condition"
42097 .cindex ACL "spf condition"
42098 The ACL condition "spf" can be used at or after the MAIL ACL.
42099 It takes as an argument a list of strings giving the outcome of the SPF check,
42100 and will succeed for any matching outcome.
42101 Valid strings are:
42102 .vlist
42103 .vitem &%pass%&
42104 The SPF check passed, the sending host is positively verified by SPF.
42105
42106 .vitem &%fail%&
42107 The SPF check failed, the sending host is NOT allowed to send mail for the
42108 domain in the envelope-from address.
42109
42110 .vitem &%softfail%&
42111 The SPF check failed, but the queried domain can't absolutely confirm that this
42112 is a forgery.
42113
42114 .vitem &%none%&
42115 The queried domain does not publish SPF records.
42116
42117 .vitem &%neutral%&
42118 The SPF check returned a "neutral" state.  This means the queried domain has
42119 published a SPF record, but wants to allow outside servers to send mail under
42120 its domain as well.  This should be treated like "none".
42121
42122 .vitem &%permerror%&
42123 This indicates a syntax error in the SPF record of the queried domain.
42124 You may deny messages when this occurs.
42125
42126 .vitem &%temperror%&
42127 This indicates a temporary error during all processing, including Exim's
42128 SPF processing.  You may defer messages when this occurs.
42129
42130 .vitem &%invalid%&
42131 There was an error during processing of the SPF lookup
42132 .endlist
42133
42134 You can prefix each string with an exclamation mark to  invert
42135 its meaning,  for example  "!fail" will  match all  results but
42136 "fail".  The  string  list is  evaluated  left-to-right,  in a
42137 short-circuit fashion.
42138
42139 Example:
42140 .code
42141 deny spf = fail
42142      message = $sender_host_address is not allowed to send mail from \
42143                ${if def:sender_address_domain \
42144                     {$sender_address_domain}{$sender_helo_name}}.  \
42145                Please see http://www.open-spf.org/Why;\
42146                identity=${if def:sender_address_domain \
42147                              {$sender_address}{$sender_helo_name}};\
42148                ip=$sender_host_address
42149 .endd
42150
42151 Note: The above mentioned URL may not be as helpful as expected. You are
42152 encouraged to replace the link with a link to a site with more
42153 explanations.
42154
42155 When the spf condition has run, it sets up several expansion
42156 variables:
42157
42158 .cindex SPF "verification variables"
42159 .vlist
42160 .vitem &$spf_header_comment$&
42161 .vindex &$spf_header_comment$&
42162   This contains a human-readable string describing the outcome
42163   of the SPF check. You can add it to a custom header or use
42164   it for logging purposes.
42165
42166 .vitem &$spf_received$&
42167 .vindex &$spf_received$&
42168   This contains a complete Received-SPF: header (name and
42169   content) that can be added to the message. Please note that
42170   according to the SPF draft, this header must be added at the
42171   top of the header list, i.e. with
42172 .code
42173 add_header = :at_start:$spf_received
42174 .endd
42175   See section &<<SECTaddheadacl>>& for further details.
42176
42177   Note: in case of "Best-guess" (see below), the convention is
42178   to put this string in a header called X-SPF-Guess: instead.
42179
42180 .vitem &$spf_result$&
42181 .vindex &$spf_result$&
42182   This contains the outcome of the SPF check in string form,
42183   currently one of pass, fail, softfail, none, neutral, permerror,
42184   temperror, or &"(invalid)"&.
42185
42186 .vitem &$spf_result_guessed$&
42187 .vindex &$spf_result_guessed$&
42188   This boolean is true only if a best-guess operation was used
42189   and required in order to obtain a result.
42190
42191 .vitem &$spf_smtp_comment$&
42192 .vindex &$spf_smtp_comment$&
42193 .vindex &%spf_smtp_comment_template%&
42194   This contains a string that can be used in a SMTP response
42195   to the calling party. Useful for "fail".
42196   The string is generated by the SPF library from the template configured in the main config
42197   option &%spf_smtp_comment_template%&.
42198 .endlist
42199
42200
42201 .cindex SPF "ACL condition"
42202 .cindex ACL "spf_guess condition"
42203 .cindex SPF "best guess"
42204 In addition to SPF, you can also perform checks for so-called
42205 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42206 SPF, but it is supported by the same framework that enables SPF
42207 capability.
42208 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42209 for a description of what it means.
42210 . --- 2019-10-28: still not https:
42211
42212 To access this feature, simply use the spf_guess condition in place
42213 of the spf one.  For example:
42214
42215 .code
42216 deny spf_guess = fail
42217      message = $sender_host_address doesn't look trustworthy to me
42218 .endd
42219
42220 In case you decide to reject messages based on this check, you
42221 should note that although it uses the same framework, "Best-guess"
42222 is not SPF, and therefore you should not mention SPF at all in your
42223 reject message.
42224
42225 When the spf_guess condition has run, it sets up the same expansion
42226 variables as when spf condition is run, described above.
42227
42228 Additionally, since Best-guess is not standardized, you may redefine
42229 what "Best-guess" means to you by redefining the main configuration
42230 &%spf_guess%& option.
42231 For example, the following:
42232
42233 .code
42234 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42235 .endd
42236
42237 would relax host matching rules to a broader network range.
42238
42239
42240 .cindex SPF "lookup expansion"
42241 .cindex lookup spf
42242 A lookup expansion is also available. It takes an email
42243 address as the key and an IP address
42244 (v4 or v6)
42245 as the database:
42246
42247 .code
42248   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42249 .endd
42250
42251 The lookup will return the same result strings as can appear in
42252 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42253
42254
42255
42256
42257
42258 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42259 .cindex SRS "sender rewriting scheme"
42260
42261 SRS can be used to modify sender addresses when forwarding so that
42262 SPF verification does not object to them.
42263 It operates by encoding the original envelope sender in a new
42264 sender local part and using a domain run by the forwarding site
42265 as the new domain for the sender.  Any DSN message should be returned
42266 to this new sender at the forwarding site, which can extract the
42267 original sender from the coded local part and forward the DSN to
42268 the originator.
42269
42270 This is a way of avoiding the breakage that SPF does to forwarding.
42271 The constructed local-part will be longer than the original,
42272 leading to possible problems with very long addresses.
42273 The changing of the sender address also hinders the tracing of mail
42274 problems.
42275
42276 Exim can be built to include native SRS support.  To do this
42277 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42278 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42279 will be defined.
42280 The support is limited to SRS0-encoding; SRS1 is not supported.
42281
42282 .cindex SRS excoding
42283 To encode an address use this expansion item:
42284 .vlist
42285 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42286 .cindex "&%srs_encode%& expansion item"
42287 .cindex SRS "expansion item"
42288 The first argument should be a secret known and used by all systems
42289 handling the recipient domain for the original message.
42290 There is no need to periodically change this key; a timestamp is also
42291 encoded.
42292 The second argument should be given as the envelope sender address before this
42293 encoding operation.
42294 If this value is empty the the expansion result will be empty.
42295 The third argument should be the recipient domain of the message when
42296 it arrived at this system.
42297 All arguments are expanded before use.
42298
42299 The result of the expansion is the replacement envelope-from (return path)
42300 to be used.
42301 .endlist
42302
42303 .cindex SRS decoding
42304 To decode an address use this expansion condition:
42305 .vlist
42306 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42307 The first argument should be the recipient local part as it was received.
42308 The second argument is the site secret.
42309 Both arguments are expanded before use.
42310
42311 If the messages is not for an SRS-encoded recipient the condition will
42312 return false.
42313 If it is, the condition will return true and the variable
42314 &$srs_recipient$& will be set to the decoded (original) value.
42315
42316 .new
42317 If the second argument is empty then the condition returns true if
42318 the first argument is in valid SRS formet, else false.
42319 The variable &$srs_recipient$& is not set for this case.
42320 .wen
42321 .endlist
42322
42323 Example usage:
42324 .code
42325   #macro
42326   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42327
42328   #routers
42329
42330   outbound:
42331     driver =    dnslookup
42332     # if outbound, and forwarding has been done, use an alternate transport
42333     domains =   ! +my_domains
42334     transport = ${if eq {$local_part@$domain} \
42335                         {$original_local_part@$original_domain} \
42336                      {remote_smtp} {remote_forwarded_smtp}}
42337
42338   inbound_srs:
42339     driver =    redirect
42340     senders =   :
42341     domains =   +my_domains
42342     # detect inbound bounces which are SRS'd, and decode them
42343     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42344     data =      $srs_recipient
42345
42346   inbound_srs_failure:
42347     driver =    redirect
42348     senders =   :
42349     domains =   +my_domains
42350     # detect inbound bounces which look SRS'd but are invalid
42351     condition = ${if inbound_srs {$local_part} {}}
42352     allow_fail
42353     data =      :fail: Invalid SRS recipient address
42354
42355   #... further routers here
42356
42357
42358   # transport; should look like the non-forward outbound
42359   # one, plus the max_rcpt and return_path options
42360   remote_forwarded_smtp:
42361     driver =              smtp
42362     # single-recipient so that $original_domain is valid
42363     max_rcpt =            1
42364     # modify the envelope from, for mails that we forward
42365     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42366 .endd
42367
42368
42369
42370
42371
42372 .section DMARC SECDMARC
42373 .cindex DMARC verification
42374
42375 DMARC combines feedback from SPF, DKIM, and header From: in order
42376 to attempt to provide better indicators of the authenticity of an
42377 email.  This document does not explain the fundamentals; you
42378 should read and understand how it works by visiting the website at
42379 &url(http://www.dmarc.org/).
42380
42381 If Exim is built with DMARC support,
42382 the libopendmarc library is used.
42383
42384 For building Exim yourself, obtain the library from
42385 &url(http://sourceforge.net/projects/opendmarc/)
42386 to obtain a copy, or find it in your favorite package
42387 repository.  You will need to attend to the local/Makefile feature
42388 SUPPORT_DMARC and the associated LDFLAGS addition.
42389 This description assumes
42390 that headers will be in /usr/local/include, and that the libraries
42391 are in /usr/local/lib.
42392
42393 .subsection Configuration SSECDMARCCONFIG
42394 .cindex DMARC configuration
42395
42396 There are three main-configuration options:
42397 .cindex DMARC "configuration options"
42398
42399 The &%dmarc_tld_file%& option
42400 .oindex &%dmarc_tld_file%&
42401 defines the location of a text file of valid
42402 top level domains the opendmarc library uses
42403 during domain parsing. Maintained by Mozilla,
42404 the most current version can be downloaded
42405 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42406 See also the util/renew-opendmarc-tlds.sh script.
42407 The default for the option is unset.
42408 If not set, DMARC processing is disabled.
42409
42410
42411 The &%dmarc_history_file%& option, if set
42412 .oindex &%dmarc_history_file%&
42413 defines the location of a file to log results
42414 of dmarc verification on inbound emails. The
42415 contents are importable by the opendmarc tools
42416 which will manage the data, send out DMARC
42417 reports, and expire the data. Make sure the
42418 directory of this file is writable by the user
42419 exim runs as.
42420 The default is unset.
42421
42422 The &%dmarc_forensic_sender%& option
42423 .oindex &%dmarc_forensic_sender%&
42424 defines an alternate email address to use when sending a
42425 forensic report detailing alignment failures
42426 if a sender domain's dmarc record specifies it
42427 and you have configured Exim to send them.
42428 If set, this is expanded and used for the
42429 From: header line; the address is extracted
42430 from it and used for the envelope from.
42431 If not set (the default), the From: header is expanded from
42432 the dsn_from option, and <> is used for the
42433 envelope from.
42434
42435 .subsection Controls SSECDMARCCONTROLS
42436 .cindex DMARC controls
42437
42438 By default, the DMARC processing will run for any remote,
42439 non-authenticated user.  It makes sense to only verify DMARC
42440 status of messages coming from remote, untrusted sources.  You can
42441 use standard conditions such as hosts, senders, etc, to decide that
42442 DMARC verification should *not* be performed for them and disable
42443 DMARC with an ACL control modifier:
42444 .code
42445   control = dmarc_disable_verify
42446 .endd
42447 A DMARC record can also specify a "forensic address", which gives
42448 exim an email address to submit reports about failed alignment.
42449 Exim does not do this by default because in certain conditions it
42450 results in unintended information leakage (what lists a user might
42451 be subscribed to, etc).  You must configure exim to submit forensic
42452 reports to the owner of the domain.  If the DMARC record contains a
42453 forensic address and you specify the control statement below, then
42454 exim will send these forensic emails.  It is also advised that you
42455 configure a &%dmarc_forensic_sender%& because the default sender address
42456 construction might be inadequate.
42457 .code
42458   control = dmarc_enable_forensic
42459 .endd
42460 (AGAIN: You can choose not to send these forensic reports by simply
42461 not putting the dmarc_enable_forensic control line at any point in
42462 your exim config.  If you don't tell exim to send them, it will not
42463 send them.)
42464
42465 There are no options to either control.  Both must appear before
42466 the DATA acl.
42467
42468 .subsection ACL SSECDMARCACL
42469 .cindex DMARC "ACL condition"
42470
42471 DMARC checks can be run on incoming SMTP  messages by using the
42472 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42473 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42474 condition.  Putting this condition in the ACLs is required in order
42475 for a DMARC check to actually occur.  All of the variables are set
42476 up before the DATA ACL, but there is no actual DMARC check that
42477 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42478
42479 The &"dmarc_status"& condition takes a list of strings on its
42480 right-hand side.  These strings describe recommended action based
42481 on the DMARC check.  To understand what the policy recommendations
42482 mean, refer to the DMARC website above.  Valid strings are:
42483 .itable none 0 0 2 20* left 80* left
42484 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42485 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42486 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42487 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42488 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42489 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42490 .irow &'temperror'&     "Library error or dns error"
42491 .irow &'off'&           "The DMARC check was disabled for this email"
42492 .endtable
42493 You can prefix each string with an exclamation mark to invert its
42494 meaning, for example "!accept" will match all results but
42495 "accept".  The string list is evaluated left-to-right in a
42496 short-circuit fashion.  When a string matches the outcome of the
42497 DMARC check, the condition succeeds.  If none of the listed
42498 strings matches the outcome of the DMARC check, the condition
42499 fails.
42500
42501 Of course, you can also use any other lookup method that Exim
42502 supports, including LDAP, Postgres, MySQL, etc, as long as the
42503 result is a list of colon-separated strings.
42504
42505 Performing the check sets up information used by the
42506 &%authresults%& expansion item.
42507
42508 Several expansion variables are set before the DATA ACL is
42509 processed, and you can use them in this ACL.  The following
42510 expansion variables are available:
42511
42512 .vlist
42513 .vitem &$dmarc_status$&
42514 .vindex &$dmarc_status$&
42515 .cindex DMARC result
42516 A one word status indicating what the DMARC library
42517 thinks of the email.  It is a combination of the results of
42518 DMARC record lookup and the SPF/DKIM/DMARC processing results
42519 (if a DMARC record was found).  The actual policy declared
42520 in the DMARC record is in a separate expansion variable.
42521
42522 .vitem &$dmarc_status_text$&
42523 .vindex &$dmarc_status_text$&
42524 Slightly longer, human readable status.
42525
42526 .vitem &$dmarc_used_domain$&
42527 .vindex &$dmarc_used_domain$&
42528 The domain which DMARC used to look up the DMARC policy record.
42529
42530 .vitem &$dmarc_domain_policy$&
42531 .vindex &$dmarc_domain_policy$&
42532 The policy declared in the DMARC record.  Valid values
42533 are "none", "reject" and "quarantine".  It is blank when there
42534 is any error, including no DMARC record.
42535 .endlist
42536
42537 .subsection Logging SSECDMARCLOGGING
42538 .cindex DMARC logging
42539
42540 By default, Exim's DMARC configuration is intended to be
42541 non-intrusive and conservative.  To facilitate this, Exim will not
42542 create any type of logging files without explicit configuration by
42543 you, the admin.  Nor will Exim send out any emails/reports about
42544 DMARC issues without explicit configuration by you, the admin (other
42545 than typical bounce messages that may come about due to ACL
42546 processing or failure delivery issues).
42547
42548 In order to log statistics suitable to be imported by the opendmarc
42549 tools, you need to:
42550 .ilist
42551 Configure the global option &%dmarc_history_file%&
42552 .next
42553 Configure cron jobs to call the appropriate opendmarc history
42554 import scripts and truncating the dmarc_history_file
42555 .endlist
42556
42557 In order to send forensic reports, you need to:
42558 .ilist
42559 Configure the global option &%dmarc_forensic_sender%&
42560 .next
42561 Configure, somewhere before the DATA ACL, the control option to
42562 enable sending DMARC forensic reports
42563 .endlist
42564
42565 .subsection Example SSECDMARCEXAMPLE
42566 .cindex DMARC example
42567
42568 Example usage:
42569 .code
42570 (RCPT ACL)
42571   warn    domains        = +local_domains
42572           hosts          = +local_hosts
42573           control        = dmarc_disable_verify
42574
42575   warn    !domains       = +screwed_up_dmarc_records
42576           control        = dmarc_enable_forensic
42577
42578   warn    condition      = (lookup if destined to mailing list)
42579           set acl_m_mailing_list = 1
42580
42581 (DATA ACL)
42582   warn    dmarc_status   = accept : none : off
42583           !authenticated = *
42584           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42585
42586   warn    dmarc_status   = !accept
42587           !authenticated = *
42588           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42589
42590   warn    dmarc_status   = quarantine
42591           !authenticated = *
42592           set $acl_m_quarantine = 1
42593           # Do something in a transport with this flag variable
42594
42595   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42596           condition      = ${if eq{$acl_m_mailing_list}{1}}
42597           message        = Messages from $dmarc_used_domain break mailing lists
42598
42599   deny    dmarc_status   = reject
42600           !authenticated = *
42601           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42602
42603   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42604 .endd
42605
42606
42607
42608
42609
42610 . ////////////////////////////////////////////////////////////////////////////
42611 . ////////////////////////////////////////////////////////////////////////////
42612
42613 .chapter "Proxies" "CHAPproxies" &&&
42614          "Proxy support"
42615 .cindex "proxy support"
42616 .cindex "proxy" "access via"
42617
42618 A proxy is an intermediate system through which communication is passed.
42619 Proxies may provide a security, availability or load-distribution function.
42620
42621
42622 .section "Inbound proxies" SECTproxyInbound
42623 .cindex proxy inbound
42624 .cindex proxy "server side"
42625 .cindex proxy "Proxy protocol"
42626 .cindex "Proxy protocol" proxy
42627
42628 Exim has support for receiving inbound SMTP connections via a proxy
42629 that uses &"Proxy Protocol"& to speak to it.
42630 To include this support, include &"SUPPORT_PROXY=yes"&
42631 in Local/Makefile.
42632
42633 It was built on the HAProxy specification, found at
42634 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42635
42636 The purpose of this facility is so that an application load balancer,
42637 such as HAProxy, can sit in front of several Exim servers
42638 to distribute load.
42639 Exim uses the local protocol communication with the proxy to obtain
42640 the remote SMTP system IP address and port information.
42641 There is no logging if a host passes or
42642 fails Proxy Protocol negotiation, but it can easily be determined and
42643 recorded in an ACL (example is below).
42644
42645 Use of a proxy is enabled by setting the &%hosts_proxy%&
42646 main configuration option to a hostlist; connections from these
42647 hosts will use Proxy Protocol.
42648 Exim supports both version 1 and version 2 of the Proxy Protocol and
42649 automatically determines which version is in use.
42650
42651 The Proxy Protocol header is the first data received on a TCP connection
42652 and is inserted before any TLS-on-connect handshake from the client; Exim
42653 negotiates TLS between Exim-as-server and the remote client, not between
42654 Exim and the proxy server. The Proxy Protocol header must be received
42655 within &%proxy_protocol_timeout%&, which defaults to 3s.
42656
42657 The following expansion variables are usable
42658 (&"internal"& and &"external"& here refer to the interfaces
42659 of the proxy):
42660 .itable none 0 0 2 30* left 70* left
42661 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42662 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42663 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42664 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42665 .irow $proxy_session            "boolean: SMTP connection via proxy"
42666 .endtable
42667 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42668 there was a protocol error.
42669 The variables &$sender_host_address$& and &$sender_host_port$&
42670 will have values for the actual client system, not the proxy.
42671
42672 Since the real connections are all coming from the proxy, and the
42673 per host connection tracking is done before Proxy Protocol is
42674 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42675 handle all of the parallel volume you expect per inbound proxy.
42676 With the option set so high, you lose the ability
42677 to protect your server from many connections from one IP.
42678 In order to prevent your server from overload, you
42679 need to add a per connection ratelimit to your connect ACL.
42680 A possible solution is:
42681 .display
42682   # Set max number of connections per host
42683   LIMIT   = 5
42684   # Or do some kind of IP lookup in a flat file or database
42685   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42686
42687   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42688           message        = Too many connections from this IP right now
42689 .endd
42690
42691
42692
42693 .section "Outbound proxies" SECTproxySOCKS
42694 .cindex proxy outbound
42695 .cindex proxy "client side"
42696 .cindex proxy SOCKS
42697 .cindex SOCKS proxy
42698 Exim has support for sending outbound SMTP via a proxy
42699 using a protocol called SOCKS5 (defined by RFC1928).
42700 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42701 Local/Makefile.
42702
42703 Use of a proxy is enabled by setting the &%socks_proxy%& option
42704 on an smtp transport.
42705 The option value is expanded and should then be a list
42706 (colon-separated by default) of proxy specifiers.
42707 Each proxy specifier is a list
42708 (space-separated by default) where the initial element
42709 is an IP address and any subsequent elements are options.
42710
42711 Options are a string <name>=<value>.
42712 The list of options is in the following table:
42713 .itable none 0 0 2 10* left 90* left
42714 .irow &'auth'&  "authentication method"
42715 .irow &'name'&  "authentication username"
42716 .irow &'pass'&  "authentication password"
42717 .irow &'port'&  "tcp port"
42718 .irow &'tmo'&   "connection timeout"
42719 .irow &'pri'&   "priority"
42720 .irow &'weight'& "selection bias"
42721 .endtable
42722
42723 More details on each of these options follows:
42724
42725 .ilist
42726 .cindex authentication "to proxy"
42727 .cindex proxy authentication
42728 &%auth%&: Either &"none"& (default) or &"name"&.
42729 Using &"name"& selects username/password authentication per RFC 1929
42730 for access to the proxy.
42731 Default is &"none"&.
42732 .next
42733 &%name%&: sets the username for the &"name"& authentication method.
42734 Default is empty.
42735 .next
42736 &%pass%&: sets the password for the &"name"& authentication method.
42737 Default is empty.
42738 .next
42739 &%port%&: the TCP port number to use for the connection to the proxy.
42740 Default is 1080.
42741 .next
42742 &%tmo%&: sets a connection timeout in seconds for this proxy.
42743 Default is 5.
42744 .next
42745 &%pri%&: specifies a priority for the proxy within the list,
42746 higher values being tried first.
42747 The default priority is 1.
42748 .next
42749 &%weight%&: specifies a selection bias.
42750 Within a priority set servers are queried in a random fashion,
42751 weighted by this value.
42752 The default value for selection bias is 1.
42753 .endlist
42754
42755 Proxies from the list are tried according to their priority
42756 and weight settings until one responds.  The timeout for the
42757 overall connection applies to the set of proxied attempts.
42758
42759 .section Logging SECTproxyLog
42760 To log the (local) IP of a proxy in the incoming or delivery logline,
42761 add &"+proxy"& to the &%log_selector%& option.
42762 This will add a component tagged with &"PRX="& to the line.
42763
42764 . ////////////////////////////////////////////////////////////////////////////
42765 . ////////////////////////////////////////////////////////////////////////////
42766
42767 .chapter "Internationalisation" "CHAPi18n" &&&
42768          "Internationalisation""
42769 .cindex internationalisation "email address"
42770 .cindex EAI
42771 .cindex i18n
42772 .cindex utf8 "mail name handling"
42773
42774 Exim has support for Internationalised mail names.
42775 To include this it must be built with SUPPORT_I18N and the libidn library.
42776 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42777
42778 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42779 instead of it) then IDNA2008 is supported; this adds an extra library
42780 requirement, upon libidn2.
42781
42782 .section "MTA operations" SECTi18nMTA
42783 .cindex SMTPUTF8 "ESMTP option"
42784 .cindex "ESMTP extensions" SMTPUTF8
42785 The main configuration option &%smtputf8_advertise_hosts%& specifies
42786 a host list.  If this matches the sending host and
42787 accept_8bitmime is true (the default) then the ESMTP option
42788 SMTPUTF8 will be advertised.
42789
42790 If the sender specifies the SMTPUTF8 option on a MAIL command
42791 international handling for the message is enabled and
42792 the expansion variable &$message_smtputf8$& will have value TRUE.
42793
42794 The option &%allow_utf8_domains%& is set to true for this
42795 message. All DNS lookups are converted to a-label form
42796 whatever the setting of &%allow_utf8_domains%&
42797 when Exim is built with SUPPORT_I18N.
42798
42799 Both localparts and domain are maintained as the original
42800 UTF-8 form internally; any comparison or regular-expression use will
42801 require appropriate care.  Filenames created, eg. by
42802 the appendfile transport, will have UTF-8 names.
42803
42804 HELO names sent by the smtp transport will have any UTF-8
42805 components expanded to a-label form,
42806 and any certificate name checks will be done using the a-label
42807 form of the name.
42808
42809 .cindex log protocol
42810 .cindex SMTPUTF8 logging
42811 .cindex i18n logging
42812 Log lines and Received-by: header lines will acquire a "utf8"
42813 prefix on the protocol element, eg. utf8esmtp.
42814
42815 The following expansion operators can be used:
42816 .code
42817 ${utf8_domain_to_alabel:str}
42818 ${utf8_domain_from_alabel:str}
42819 ${utf8_localpart_to_alabel:str}
42820 ${utf8_localpart_from_alabel:str}
42821 .endd
42822
42823 .cindex utf8 "address downconversion"
42824 .cindex i18n "utf8 address downconversion"
42825 The RCPT ACL
42826 may use the following modifier:
42827 .display
42828 control = utf8_downconvert
42829 control = utf8_downconvert/<value>
42830 .endd
42831 This sets a flag requiring that envelope addresses are converted to
42832 a-label form before smtp delivery.
42833 This is usually for use in a Message Submission Agent context,
42834 but could be used for any message.
42835
42836 If a value is appended it may be:
42837 .itable none 0 0 2 5* right 95* left
42838 .irow &`1`&     "mandatory downconversion"
42839 .irow &`0`&     "no downconversion"
42840 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42841 .endtable
42842 If no value is given, 1 is used.
42843
42844 If mua_wrapper is set, the utf8_downconvert control
42845 is initially set to -1.
42846
42847 The smtp transport has an option &%utf8_downconvert%&.
42848 If set it must expand to one of the three values described above,
42849 or an empty string.
42850 If non-empty it overrides value previously set
42851 (due to mua_wrapper or by an ACL control).
42852
42853
42854 There is no explicit support for VRFY and EXPN.
42855 Configurations supporting these should inspect
42856 &$smtp_command_argument$& for an SMTPUTF8 argument.
42857
42858 There is no support for LMTP on Unix sockets.
42859 Using the "lmtp" protocol option on an smtp transport,
42860 for LMTP over TCP, should work as expected.
42861
42862 There is no support for DSN unitext handling,
42863 and no provision for converting logging from or to UTF-8.
42864
42865
42866
42867 .section "MDA operations" SECTi18nMDA
42868 To aid in constructing names suitable for IMAP folders
42869 the following expansion operator can be used:
42870 .code
42871 ${imapfolder {<string>} {<sep>} {<specials>}}
42872 .endd
42873
42874 The string is converted from the charset specified by
42875 the "headers charset" command (in a filter file)
42876 or &%headers_charset%& main configuration option (otherwise),
42877 to the
42878 modified UTF-7 encoding specified by RFC 2060,
42879 with the following exception: All occurrences of <sep>
42880 (which has to be a single character)
42881 are replaced with periods ("."), and all periods and slashes that are not
42882 <sep> and are not in the <specials> string are BASE64 encoded.
42883
42884 The third argument can be omitted, defaulting to an empty string.
42885 The second argument can be omitted, defaulting to "/".
42886
42887 This is the encoding used by Courier for Maildir names on disk, and followed
42888 by many other IMAP servers.
42889
42890 Examples:
42891 .display
42892 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42893 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42894 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42895 .endd
42896
42897 Note that the source charset setting is vital, and also that characters
42898 must be representable in UTF-16.
42899
42900
42901 . ////////////////////////////////////////////////////////////////////////////
42902 . ////////////////////////////////////////////////////////////////////////////
42903
42904 .chapter "Events" "CHAPevents" &&&
42905          "Events"
42906 .cindex events
42907
42908 The events mechanism in Exim can be used to intercept processing at a number
42909 of points.  It was originally invented to give a way to do customised logging
42910 actions (for example, to a database) but can also be used to modify some
42911 processing actions.
42912
42913 Most installations will never need to use Events.
42914 The support can be left out of a build by defining DISABLE_EVENT=yes
42915 in &_Local/Makefile_&.
42916
42917 There are two major classes of events: main and transport.
42918 The main configuration option &%event_action%& controls reception events;
42919 a transport option &%event_action%& controls delivery events.
42920
42921 Both options are a string which is expanded when the event fires.
42922 An example might look like:
42923 .cindex logging custom
42924 .code
42925 event_action = ${if eq {msg:delivery}{$event_name} \
42926 {${lookup pgsql {SELECT * FROM record_Delivery( \
42927     '${quote_pgsql:$sender_address_domain}',\
42928     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42929     '${quote_pgsql:$domain}', \
42930     '${quote_pgsql:${lc:$local_part}}', \
42931     '${quote_pgsql:$host_address}', \
42932     '${quote_pgsql:${lc:$host}}', \
42933     '${quote_pgsql:$message_exim_id}')}} \
42934 } {}}
42935 .endd
42936
42937 Events have names which correspond to the point in process at which they fire.
42938 The name is placed in the variable &$event_name$& and the event action
42939 expansion must check this, as it will be called for every possible event type.
42940
42941 The current list of events is:
42942 .itable all 0 0 4 25* left 10* center 15* center 50* left
42943 .row auth:fail              after    both       "per driver per authentication attempt"
42944 .row dane:fail              after    transport  "per connection"
42945 .row msg:complete           after    main       "per message"
42946 .row msg:defer              after    transport  "per message per delivery try"
42947 .row msg:delivery           after    transport  "per recipient"
42948 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42949 .row msg:rcpt:defer         after    transport  "per recipient"
42950 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42951 .row msg:fail:delivery      after    transport  "per recipient"
42952 .row msg:fail:internal      after    main       "per recipient"
42953 .row tcp:connect            before   transport  "per connection"
42954 .row tcp:close              after    transport  "per connection"
42955 .row tls:cert               before   both       "per certificate in verification chain"
42956 .row tls:fail:connect       after    main       "per connection"
42957 .row smtp:connect           after    transport  "per connection"
42958 .row smtp:ehlo              after    transport  "per connection"
42959 .endtable
42960 New event types may be added in future.
42961
42962 The event name is a colon-separated list, defining the type of
42963 event in a tree of possibilities.  It may be used as a list
42964 or just matched on as a whole.  There will be no spaces in the name.
42965
42966 The second column in the table above describes whether the event fires
42967 before or after the action is associates with.  Those which fire before
42968 can be used to affect that action (more on this below).
42969
42970 The third column in the table above says what section of the configuration
42971 should define the event action.
42972
42973 An additional variable, &$event_data$&, is filled with information varying
42974 with the event type:
42975 .itable all 0 0 2 20* left 80* left
42976 .row auth:fail            "smtp response"
42977 .row dane:fail            "failure reason"
42978 .row msg:defer            "error string"
42979 .row msg:delivery         "smtp confirmation message"
42980 .row msg:fail:internal    "failure reason"
42981 .row msg:fail:delivery    "smtp error message"
42982 .row msg:host:defer       "error string"
42983 .row msg:rcpt:host:defer  "error string"
42984 .row msg:rcpt:defer       "error string"
42985 .row tls:cert             "verification chain depth"
42986 .row tls:fail:connect     "error string"
42987 .row smtp:connect         "smtp banner"
42988 .row smtp:ehlo            "smtp ehlo response"
42989 .endtable
42990
42991 The :defer events populate one extra variable: &$event_defer_errno$&.
42992
42993 For complex operations an ACL expansion can be used in &%event_action%&,
42994 however due to the multiple contexts that Exim operates in during
42995 the course of its processing:
42996 .ilist
42997 variables set in transport events will not be visible outside that
42998 transport call
42999 .next
43000 acl_m variables in a server context are lost on a new connection,
43001 and after smtp helo/ehlo/mail/starttls/rset commands
43002 .endlist
43003 Using an ACL expansion with the logwrite modifier can be
43004 a useful way of writing to the main log.
43005
43006 The expansion of the event_action option should normally
43007 return an empty string.  Should it return anything else the
43008 following will be forced:
43009 .itable all 0 0 2 20* left 80* left
43010 .row auth:fail        "log information to write"
43011 .row tcp:connect      "do not connect"
43012 .row tls:cert         "refuse verification"
43013 .row smtp:connect     "close connection"
43014 .endtable
43015 All other message types ignore the result string, and
43016 no other use is made of it.
43017
43018 For a tcp:connect event, if the connection is being made to a proxy
43019 then the &$host_address$& and &$host_port$& variables
43020 will be that of the proxy and not the target system.
43021
43022 For tls:cert events, if GnuTLS is in use this will trigger only per
43023 chain element received on the connection.
43024 For OpenSSL it will trigger for every chain element including those
43025 loaded locally.
43026
43027 . ////////////////////////////////////////////////////////////////////////////
43028 . ////////////////////////////////////////////////////////////////////////////
43029
43030 .chapter "Adding new drivers or lookup types" "CHID13" &&&
43031          "Adding drivers or lookups"
43032 .cindex "adding drivers"
43033 .cindex "new drivers, adding"
43034 .cindex "drivers" "adding new"
43035 The following actions have to be taken in order to add a new router, transport,
43036 authenticator, or lookup type to Exim:
43037
43038 .olist
43039 Choose a name for the driver or lookup type that does not conflict with any
43040 existing name; I will use &"newdriver"& in what follows.
43041 .next
43042 Add to &_src/EDITME_& the line:
43043 .display
43044 <&'type'&>&`_NEWDRIVER=yes`&
43045 .endd
43046 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
43047 code is not to be included in the binary by default, comment this line out. You
43048 should also add any relevant comments about the driver or lookup type.
43049 .next
43050 Add to &_src/config.h.defaults_& the line:
43051 .code
43052 #define <type>_NEWDRIVER
43053 .endd
43054 .next
43055 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43056 and create a table entry as is done for all the other drivers and lookup types.
43057 .next
43058 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43059 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43060 Add your &`NEWDRIVER`& to that list.
43061 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43062 simple form that most lookups have.
43063 .next
43064 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43065 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43066 driver or lookup type and add it to the definition of OBJ.
43067 .next
43068 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43069 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43070 .next
43071 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43072 &_src_&.
43073 .next
43074 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43075 as for other drivers and lookups.
43076 .endlist
43077
43078 Then all you need to do is write the code! A good way to start is to make a
43079 proforma by copying an existing module of the same type, globally changing all
43080 occurrences of the name, and cutting out most of the code. Note that any
43081 options you create must be listed in alphabetical order, because the tables are
43082 searched using a binary chop procedure.
43083
43084 There is a &_README_& file in each of the sub-directories of &_src_& describing
43085 the interface that is expected.
43086
43087
43088
43089
43090 . ////////////////////////////////////////////////////////////////////////////
43091 . ////////////////////////////////////////////////////////////////////////////
43092
43093 . /////////////////////////////////////////////////////////////////////////////
43094 . These lines are processing instructions for the Simple DocBook Processor that
43095 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43096 . PDFs than using xmlto and fop. They will be ignored by all other XML
43097 . processors.
43098 . /////////////////////////////////////////////////////////////////////////////
43099
43100 .literal xml
43101 <?sdop
43102   format="newpage"
43103   foot_right_recto="&chaptertitle;"
43104   foot_right_verso="&chaptertitle;"
43105 ?>
43106 .literal off
43107
43108 .makeindex "Options index"   "option"
43109 .makeindex "Variables index" "variable"
43110 .makeindex "Concept index"   "concept"
43111
43112
43113 . /////////////////////////////////////////////////////////////////////////////
43114 . /////////////////////////////////////////////////////////////////////////////