4a044bb11fdb499799dab400cacf6fea2fbe8d4b
[exim.git] / doc / doc-docbook / spec.xfpt
1
2 . /////////////////////////////////////////////////////////////////////////////
3 . This is the primary source of the Exim Manual. It is an xfpt document that is
4 . converted into DocBook XML for subsequent conversion into printable and online
5 . formats. The markup used herein is "standard" xfpt markup, with some extras.
6 . The markup is summarized in a file called Markup.txt.
7 .
8 . WARNING: When you use the .new macro, make sure it appears *before* any
9 . adjacent index items; otherwise you get an empty "paragraph" which causes
10 . unwanted vertical space.
11 . /////////////////////////////////////////////////////////////////////////////
12
13 .include stdflags
14 .include stdmacs
15
16 . /////////////////////////////////////////////////////////////////////////////
17 . This outputs the standard DocBook boilerplate.
18 . /////////////////////////////////////////////////////////////////////////////
19
20 .docbook
21
22 . /////////////////////////////////////////////////////////////////////////////
23 . These lines are processing instructions for the Simple DocBook Processor that
24 . Philip Hazel has developed as a less cumbersome way of making PostScript and
25 . PDFs than using xmlto and fop. They will be ignored by all other XML
26 . processors.
27 . /////////////////////////////////////////////////////////////////////////////
28
29 .literal xml
30 <?sdop
31   foot_right_recto="&chaptertitle; (&chapternumber;)"
32   foot_right_verso="&chaptertitle; (&chapternumber;)"
33   toc_chapter_blanks="yes,yes"
34   table_warn_overflow="overprint"
35 ?>
36 .literal off
37
38 . /////////////////////////////////////////////////////////////////////////////
39 . This generates the outermost <book> element that wraps the entire document.
40 . /////////////////////////////////////////////////////////////////////////////
41
42 .book
43
44 . /////////////////////////////////////////////////////////////////////////////
45 . These definitions set some parameters and save some typing.
46 . Update the Copyright year (only) when changing content.
47 . /////////////////////////////////////////////////////////////////////////////
48
49 .set previousversion "4.96"
50 .include ./local_params
51
52 .set ACL "access control lists (ACLs)"
53 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
54
55 .set drivernamemax "64"
56
57 .macro copyyear
58 2022
59 .endmacro
60
61 . /////////////////////////////////////////////////////////////////////////////
62 . Additional xfpt markup used by this document, over and above the default
63 . provided in the xfpt library.
64 . /////////////////////////////////////////////////////////////////////////////
65
66 . --- Override the &$ flag to automatically insert a $ with the variable name.
67
68 .flag &$  $&   "<varname>$"  "</varname>"
69
70 . --- Short flags for daggers in option headings. They will always be inside
71 . --- an italic string, but we want the daggers to be in Roman.
72
73 .flag &!!      "</emphasis>&dagger;<emphasis>"
74 .flag &!?      "</emphasis>&Dagger;<emphasis>"
75
76 . --- A macro for an Exim option definition heading, generating a one-line
77 . --- table with four columns. For cases when the option name is given with
78 . --- a space, so that it can be split, a fifth argument is used for the
79 . --- index entry.
80
81 .macro option
82 .arg 5
83 .oindex "&%$5%&"
84 .endarg
85 .arg -5
86 .oindex "&%$1%&"
87 .endarg
88 .itable all 0 0 4 8* left 6* center 6* center 6* right
89 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
90 .endtable
91 .endmacro
92
93 . --- A macro for the common 2-column tables. The width of the first column
94 . --- is suitable for the many tables at the start of the main options chapter;
95 . --- a small number of other 2-column tables override it.
96
97 .macro table2 196pt 254pt
98 .itable none 0 0 2 $1 left $2 left
99 .endmacro
100
101
102 . --- A macro for a plain variable, including the .vitem and .vindex
103 .macro var
104 .vitem $1
105 .vindex $1
106 .endmacro
107
108 . --- A macro for a "tainted" marker, done as a one-element table
109 .macro tmark
110 .itable none 0 0 1 10pt left
111 .row &'Tainted'&
112 .endtable
113 .endmacro
114
115 . --- A macro for a tainted variable, adding a taint-marker
116 .macro tvar
117 .var $1
118 .tmark
119 .endmacro
120
121 . --- A macro for a cmdline option, including a .oindex
122 . --- 1st arg is the option name, undecorated (we do that here).
123 . --- 2nd arg, optional, text (decorated as needed) to be appended to the name
124 .macro cmdopt
125 .vitem  &%$1%&$=2+&~$2+
126 .oindex &%$1%&
127 .endmacro
128
129 . --- A macro that generates .row, but puts &I; at the start of the first
130 . --- argument, thus indenting it. Assume a minimum of two arguments, and
131 . --- allow up to four arguments, which is as many as we'll ever need.
132
133 .macro irow
134 .arg 4
135 .row "&I;$1" "$2" "$3" "$4"
136 .endarg
137 .arg -4
138 .arg 3
139 .row "&I;$1" "$2" "$3"
140 .endarg
141 .arg -3
142 .row "&I;$1" "$2"
143 .endarg
144 .endarg
145 .endmacro
146
147 . --- Macros for option, variable, and concept index entries. For a "range"
148 . --- style of entry, use .scindex for the start and .ecindex for the end. The
149 . --- first argument of .scindex and the only argument of .ecindex must be the
150 . --- ID that ties them together.
151 . --- The index entry points to the most-recent chapter head, section or subsection
152 . --- head, or list-item.
153
154 .macro cindex
155 &<indexterm role="concept">&
156 &<primary>&$1&</primary>&
157 .arg 2
158 &<secondary>&$2&</secondary>&
159 .endarg
160 &</indexterm>&
161 .endmacro
162
163 .macro scindex
164 &<indexterm role="concept" id="$1" class="startofrange">&
165 &<primary>&$2&</primary>&
166 .arg 3
167 &<secondary>&$3&</secondary>&
168 .endarg
169 &</indexterm>&
170 .endmacro
171
172 .macro ecindex
173 &<indexterm role="concept" startref="$1" class="endofrange"/>&
174 .endmacro
175
176 .macro oindex
177 &<indexterm role="option">&
178 &<primary>&$1&</primary>&
179 .arg 2
180 &<secondary>&$2&</secondary>&
181 .endarg
182 &</indexterm>&
183 .endmacro
184
185 . --- The index entry points to the most-recent chapter head, section or subsection
186 . --- head, or varlist item.
187
188 .macro vindex
189 &<indexterm role="variable">&
190 &<primary>&$1&</primary>&
191 .arg 2
192 &<secondary>&$2&</secondary>&
193 .endarg
194 &</indexterm>&
195 .endmacro
196
197 .macro index
198 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
199 .endmacro
200
201
202 . use this for a concept-index entry for a header line
203 .macro chindex
204 .cindex "&'$1'& header line"
205 .cindex "header lines" $1
206 .endmacro
207 . ////////////////////////////////////////////////////////////////////////////
208
209
210 . ////////////////////////////////////////////////////////////////////////////
211 . The <bookinfo> element is removed from the XML before processing for ASCII
212 . output formats.
213 . ////////////////////////////////////////////////////////////////////////////
214
215 .literal xml
216 <bookinfo>
217 <title>Specification of the Exim Mail Transfer Agent</title>
218 <titleabbrev>The Exim MTA</titleabbrev>
219 <date>
220 .fulldate
221 </date>
222 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
223 <authorinitials>EM</authorinitials>
224 <revhistory><revision>
225 .versiondatexml
226   <authorinitials>EM</authorinitials>
227 </revision></revhistory>
228 <copyright><year>
229 .copyyear
230            </year><holder>The Exim Maintainers</holder></copyright>
231 </bookinfo>
232 .literal off
233
234
235 . /////////////////////////////////////////////////////////////////////////////
236 . These implement index entries of the form "x, see y" and "x, see also y".
237 . However, the DocBook DTD doesn't allow <indexterm> entries
238 . at the top level, so we have to put the .chapter directive first.
239 . /////////////////////////////////////////////////////////////////////////////
240
241 .chapter "Introduction" "CHID1"
242
243 .macro seeother
244 .literal xml
245 <indexterm role="$2">
246   <primary>$3</primary>
247 .arg 5
248   <secondary>$5</secondary>
249 .endarg
250   <$1><emphasis>$4</emphasis></$1>
251 </indexterm>
252 .literal off
253 .endmacro
254
255 . NB: for the 4-arg variant the ordering is awkward
256 .macro see
257 .seeother see "$1" "$2" "$3" "$4"
258 .endmacro
259 .macro seealso
260 .seeother seealso "$1" "$2" "$3" "$4"
261 .endmacro
262
263 .see     variable "<emphasis>$1</emphasis>, <emphasis>$2</emphasis>, etc." "numerical variables"
264 .see     concept address        rewriting                       rewriting
265 .see     concept "Bounce Address Tag Validation"        BATV
266 .see     concept "Client SMTP Authorization"            CSA
267 .see     concept "CR character" "carriage return"
268 .see     concept CRL            "certificate revocation list"
269 .seealso concept de-tainting    "tainted data"
270 .see     concept delivery       "bounce message"                "failure report"
271 .see     concept dialup         "intermittently connected hosts"
272 .see     concept exiscan        "content scanning"
273 .see     concept fallover       fallback
274 .see     concept filter         "Sieve filter"                  Sieve
275 .see     concept headers        "header lines"
276 .see     concept ident          "RFC 1413"
277 .see     concept "LF character" "linefeed"
278 .seealso concept maximum        limit
279 .see     concept monitor        "Exim monitor"
280 .see     concept "no_<emphasis>xxx</emphasis>"          "entry for xxx"
281 .see     concept NUL            "binary zero"
282 .see     concept "passwd file"  "/etc/passwd"
283 .see     concept "process id"   pid
284 .see     concept RBL            "DNS list"
285 .see     concept redirection    "address redirection"
286 .see     concept "return path"  "envelope sender"
287 .see     concept scanning       "content scanning"
288 .see     concept SSL            TLS
289 .see     concept string         expansion expansion
290 .see     concept "top bit"      "8-bit characters"
291 .see     concept variables      "expansion, variables"
292 .see     concept "zero, binary" "binary zero"
293
294
295 . /////////////////////////////////////////////////////////////////////////////
296 . This is the real start of the first chapter. See the comment above as to why
297 . we can't have the .chapter line here.
298 . chapter "Introduction"
299 . /////////////////////////////////////////////////////////////////////////////
300
301 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
302 Unix-like operating systems. It was designed on the assumption that it would be
303 run on hosts that are permanently connected to the Internet. However, it can be
304 used on intermittently connected hosts with suitable configuration adjustments.
305
306 Configuration files currently exist for the following operating systems: AIX,
307 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
308 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
309 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
310 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
311 Some of these operating systems are no longer current and cannot easily be
312 tested, so the configuration files may no longer work in practice.
313
314 There are also configuration files for compiling Exim in the Cygwin environment
315 that can be installed on systems running Windows. However, this document does
316 not contain any information about running Exim in the Cygwin environment.
317
318 The terms and conditions for the use and distribution of Exim are contained in
319 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
320 Public Licence, a copy of which may be found in the file &_LICENCE_&.
321
322 The use, supply, or promotion of Exim for the purpose of sending bulk,
323 unsolicited electronic mail is incompatible with the basic aims of Exim,
324 which revolve around the free provision of a service that enhances the quality
325 of personal communications. The author of Exim regards indiscriminate
326 mass-mailing as an antisocial, irresponsible abuse of the Internet.
327
328 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
329 experience of running and working on the Smail 3 code, I could never have
330 contemplated starting to write a new MTA. Many of the ideas and user interfaces
331 were originally taken from Smail 3, though the actual code of Exim is entirely
332 new, and has developed far beyond the initial concept.
333
334 Many people, both in Cambridge and around the world, have contributed to the
335 development and the testing of Exim, and to porting it to various operating
336 systems. I am grateful to them all. The distribution now contains a file called
337 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
338 contributors.
339
340
341 .section "Exim documentation" "SECID1"
342 . Keep this example change bar when updating the documentation!
343
344 .new
345 .cindex "documentation"
346 This edition of the Exim specification applies to version &version() of Exim.
347 Substantive changes from the &previousversion; edition are marked in some
348 renditions of this document; this paragraph is so marked if the rendition is
349 capable of showing a change indicator.
350 .wen
351
352 This document is very much a reference manual; it is not a tutorial. The reader
353 is expected to have some familiarity with the SMTP mail transfer protocol and
354 with general Unix system administration. Although there are some discussions
355 and examples in places, the information is mostly organized in a way that makes
356 it easy to look up, rather than in a natural order for sequential reading.
357 Furthermore, this manual aims to cover every aspect of Exim in detail, including
358 a number of rarely-used, special-purpose features that are unlikely to be of
359 very wide interest.
360
361 .cindex "books about Exim"
362 An &"easier"& discussion of Exim which provides more in-depth explanatory,
363 introductory, and tutorial material can be found in a book entitled &'The Exim
364 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
365 (&url(https://www.uit.co.uk/exim-book/)).
366
367 The book also contains a chapter that gives a general introduction to SMTP and
368 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
369 with the latest release of Exim. (Note that the earlier book about Exim,
370 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
371
372 .cindex "Debian" "information sources"
373 If you are using a Debian distribution of Exim, you will find information about
374 Debian-specific features in the file
375 &_/usr/share/doc/exim4-base/README.Debian_&.
376 The command &(man update-exim.conf)& is another source of Debian-specific
377 information.
378
379 .cindex "&_doc/NewStuff_&"
380 .cindex "&_doc/ChangeLog_&"
381 .cindex "change log"
382 As Exim develops, there may be features in newer versions that have not
383 yet made it into this document, which is updated only when the most significant
384 digit of the fractional part of the version number changes. Specifications of
385 new features that are not yet in this manual are placed in the file
386 &_doc/NewStuff_& in the Exim distribution.
387
388 Some features may be classified as &"experimental"&. These may change
389 incompatibly while they are developing, or even be withdrawn. For this reason,
390 they are not documented in this manual. Information about experimental features
391 can be found in the file &_doc/experimental.txt_&.
392
393 All changes to Exim (whether new features, bug fixes, or other kinds of
394 change) are noted briefly in the file called &_doc/ChangeLog_&.
395
396 .cindex "&_doc/spec.txt_&"
397 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
398 that it can easily be searched with a text editor. Other files in the &_doc_&
399 directory are:
400
401 .table2 100pt
402 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
403 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
404 .row &_exim.8_&              "a man page of Exim's command line options"
405 .row &_experimental.txt_&    "documentation of experimental features"
406 .row &_filter.txt_&          "specification of the filter language"
407 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
408 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
409 .row &_openssl.txt_&         "installing a current OpenSSL release"
410 .endtable
411
412 The main specification and the specification of the filtering language are also
413 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
414 &<<SECTavail>>& below tells you how to get hold of these.
415
416
417
418 .section "FTP site and websites" "SECID2"
419 .cindex "website"
420 .cindex "FTP site"
421 The primary site for Exim source distributions is the &%exim.org%& FTP site,
422 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
423 website, are hosted at the University of Cambridge.
424
425 .cindex "wiki"
426 .cindex "FAQ"
427 As well as Exim distribution tar files, the Exim website contains a number of
428 differently formatted versions of the documentation. A recent addition to the
429 online information is the Exim wiki (&url(https://wiki.exim.org)),
430 which contains what used to be a separate FAQ, as well as various other
431 examples, tips, and know-how that have been contributed by Exim users.
432 The wiki site should always redirect to the correct place, which is currently
433 provided by GitHub, and is open to editing by anyone with a GitHub account.
434
435 .cindex Bugzilla
436 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
437 this to report bugs, and also to add items to the wish list. Please search
438 first to check that you are not duplicating a previous entry.
439 Please do not ask for configuration help in the bug-tracker.
440
441
442 .section "Mailing lists" "SECID3"
443 .cindex "mailing lists" "for Exim users"
444 The following Exim mailing lists exist:
445
446 .table2 140pt
447 .row &'exim-announce@lists.exim.org'&   "Moderated, low volume announcements list"
448 .row &'exim-users@lists.exim.org'&      "General discussion list"
449 .row &'exim-users-de@lists.exim.org'&   "General discussion list in German language"
450 .row &'exim-dev@lists.exim.org'&        "Discussion of bugs, enhancements, etc."
451 .row &'exim-cvs@lists.exim.org'&        "Automated commit messages from the VCS"
452 .endtable
453
454 You can subscribe to these lists, change your existing subscriptions, and view
455 or search the archives via the mailing lists link on the Exim home page.
456 .cindex "Debian" "mailing list for"
457 If you are using a Debian distribution of Exim, you may wish to subscribe to
458 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
459 via this web page:
460 .display
461 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
462 .endd
463 Please ask Debian-specific questions on that list and not on the general Exim
464 lists.
465
466 .section "Bug reports" "SECID5"
467 .cindex "bug reports"
468 .cindex "reporting bugs"
469 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
470 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
471 whether some behaviour is a bug or not, the best thing to do is to post a
472 message to the &'exim-dev'& mailing list and have it discussed.
473
474
475
476 .section "Where to find the Exim distribution" "SECTavail"
477 .cindex "FTP site"
478 .cindex "HTTPS download site"
479 .cindex "distribution" "FTP site"
480 .cindex "distribution" "https site"
481 The master distribution site for the Exim distribution is
482 .display
483 &url(https://downloads.exim.org/)
484 .endd
485 The service is available over HTTPS, HTTP and FTP.
486 We encourage people to migrate to HTTPS.
487
488 The content served at &url(https://downloads.exim.org/) is identical to the
489 content served at &url(https://ftp.exim.org/pub/exim) and
490 &url(ftp://ftp.exim.org/pub/exim).
491
492 If accessing via a hostname containing &'ftp'&, then the file references that
493 follow are relative to the &_exim_& directories at these sites.
494 If accessing via the hostname &'downloads'& then the subdirectories described
495 here are top-level directories.
496
497 There are now quite a number of independent mirror sites around
498 the world. Those that I know about are listed in the file called &_Mirrors_&.
499
500 Within the top exim directory there are subdirectories called &_exim3_& (for
501 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
502 distributions), and &_Testing_& for testing versions. In the &_exim4_&
503 subdirectory, the current release can always be found in files called
504 .display
505 &_exim-n.nn.tar.xz_&
506 &_exim-n.nn.tar.gz_&
507 &_exim-n.nn.tar.bz2_&
508 .endd
509 where &'n.nn'& is the highest such version number in the directory. The three
510 files contain identical data; the only difference is the type of compression.
511 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
512 most portable to old systems.
513
514 .cindex "distribution" "signing details"
515 .cindex "distribution" "public key"
516 .cindex "public key for signed distribution"
517 The distributions will be PGP signed by an individual key of the Release
518 Coordinator.  This key will have a uid containing an email address in the
519 &'exim.org'& domain and will have signatures from other people, including
520 other Exim maintainers.  We expect that the key will be in the "strong set" of
521 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
522 PGP keys, a version of which can be found in the release directory in the file
523 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
524 such as &'pool.sks-keyservers.net'&.
525
526 At the time of the last update, releases were being made by Jeremy Harris and signed
527 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
528 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
529 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
530
531 The signatures for the tar bundles are in:
532 .display
533 &_exim-n.nn.tar.xz.asc_&
534 &_exim-n.nn.tar.gz.asc_&
535 &_exim-n.nn.tar.bz2.asc_&
536 .endd
537 For each released version, the log of changes is made available in a
538 separate file in the directory &_ChangeLogs_& so that it is possible to
539 find out what has changed without having to download the entire distribution.
540
541 .cindex "documentation" "available formats"
542 The main distribution contains ASCII versions of this specification and other
543 documentation; other formats of the documents are available in separate files
544 inside the &_exim4_& directory of the FTP site:
545 .display
546 &_exim-html-n.nn.tar.gz_&
547 &_exim-pdf-n.nn.tar.gz_&
548 &_exim-postscript-n.nn.tar.gz_&
549 &_exim-texinfo-n.nn.tar.gz_&
550 .endd
551 These tar files contain only the &_doc_& directory, not the complete
552 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
553
554
555 .section "Limitations" "SECID6"
556 .ilist
557 .cindex "limitations of Exim"
558 .cindex "bang paths" "not handled by Exim"
559 Exim is designed for use as an Internet MTA, and therefore handles addresses in
560 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
561 simple two-component bang paths can be converted by a straightforward rewriting
562 configuration. This restriction does not prevent Exim from being interfaced to
563 UUCP as a transport mechanism, provided that domain addresses are used.
564 .next
565 .cindex "domainless addresses"
566 .cindex "address" "without domain"
567 Exim insists that every address it handles has a domain attached. For incoming
568 local messages, domainless addresses are automatically qualified with a
569 configured domain value. Configuration options specify from which remote
570 systems unqualified addresses are acceptable. These are then qualified on
571 arrival.
572 .next
573 .cindex "transport" "external"
574 .cindex "external transports"
575 The only external transport mechanisms that are currently implemented are SMTP
576 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
577 transport is available, and there are facilities for writing messages to files
578 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
579 to send messages to other transport mechanisms such as UUCP, provided they can
580 handle domain-style addresses. Batched SMTP input is also catered for.
581 .next
582 Exim is not designed for storing mail for dial-in hosts. When the volumes of
583 such mail are large, it is better to get the messages &"delivered"& into files
584 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
585 other means.
586 .next
587 Although Exim does have basic facilities for scanning incoming messages, these
588 are not comprehensive enough to do full virus or spam scanning. Such operations
589 are best carried out using additional specialized software packages. If you
590 compile Exim with the content-scanning extension, straightforward interfaces to
591 a number of common scanners are provided.
592 .endlist
593
594
595 .section "Runtime configuration" "SECID7"
596 Exim's runtime configuration is held in a single text file that is divided
597 into a number of sections. The entries in this file consist of keywords and
598 values, in the style of Smail 3 configuration files. A default configuration
599 file which is suitable for simple online installations is provided in the
600 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
601
602
603 .section "Calling interface" "SECID8"
604 .cindex "Sendmail compatibility" "command line interface"
605 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
606 can be a straight replacement for &_/usr/lib/sendmail_& or
607 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
608 about Sendmail in order to run Exim. For actions other than sending messages,
609 Sendmail-compatible options also exist, but those that produce output (for
610 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
611 format. There are also some additional options that are compatible with Smail
612 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
613 documents all Exim's command line options. This information is automatically
614 made into the man page that forms part of the Exim distribution.
615
616 Control of messages in the queue can be done via certain privileged command
617 line options. There is also an optional monitor program called &'eximon'&,
618 which displays current information in an X window, and which contains a menu
619 interface to Exim's command line administration options.
620
621
622
623 .section "Terminology" "SECID9"
624 .cindex "terminology definitions"
625 .cindex "body of message" "definition of"
626 The &'body'& of a message is the actual data that the sender wants to transmit.
627 It is the last part of a message and is separated from the &'header'& (see
628 below) by a blank line.
629
630 .cindex "bounce message" "definition of"
631 When a message cannot be delivered, it is normally returned to the sender in a
632 delivery failure message or a &"non-delivery report"& (NDR). The term
633 &'bounce'& is commonly used for this action, and the error reports are often
634 called &'bounce messages'&. This is a convenient shorthand for &"delivery
635 failure error report"&. Such messages have an empty sender address in the
636 message's &'envelope'& (see below) to ensure that they cannot themselves give
637 rise to further bounce messages.
638
639 The term &'default'& appears frequently in this manual. It is used to qualify a
640 value which is used in the absence of any setting in the configuration. It may
641 also qualify an action which is taken unless a configuration setting specifies
642 otherwise.
643
644 The term &'defer'& is used when the delivery of a message to a specific
645 destination cannot immediately take place for some reason (a remote host may be
646 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
647 until a later time.
648
649 The word &'domain'& is sometimes used to mean all but the first component of a
650 host's name. It is &'not'& used in that sense here, where it normally refers to
651 the part of an email address following the @ sign.
652
653 .cindex "envelope, definition of"
654 .cindex "sender" "definition of"
655 A message in transit has an associated &'envelope'&, as well as a header and a
656 body. The envelope contains a sender address (to which bounce messages should
657 be delivered), and any number of recipient addresses. References to the
658 sender or the recipients of a message usually mean the addresses in the
659 envelope. An MTA uses these addresses for delivery, and for returning bounce
660 messages, not the addresses that appear in the header lines.
661
662 .cindex "message" "header, definition of"
663 .cindex "header section" "definition of"
664 The &'header'& of a message is the first part of a message's text, consisting
665 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
666 &'Subject:'&, etc. Long header lines can be split over several text lines by
667 indenting the continuations. The header is separated from the body by a blank
668 line.
669
670 .cindex "local part" "definition of"
671 .cindex "domain" "definition of"
672 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
673 part of an email address that precedes the @ sign. The part that follows the
674 @ sign is called the &'domain'& or &'mail domain'&.
675
676 .cindex "local delivery" "definition of"
677 .cindex "remote delivery, definition of"
678 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
679 delivery to a file or a pipe on the local host from delivery by SMTP over
680 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
681 host it is running on are &'remote'&.
682
683 .cindex "return path" "definition of"
684 &'Return path'& is another name that is used for the sender address in a
685 message's envelope.
686
687 .cindex "queue" "definition of"
688 The term &'queue'& is used to refer to the set of messages awaiting delivery
689 because this term is in widespread use in the context of MTAs. However, in
690 Exim's case, the reality is more like a pool than a queue, because there is
691 normally no ordering of waiting messages.
692
693 .cindex "queue runner" "definition of"
694 The term &'queue runner'& is used to describe a process that scans the queue
695 and attempts to deliver those messages whose retry times have come. This term
696 is used by other MTAs and also relates to the command &%runq%&, but in Exim
697 the waiting messages are normally processed in an unpredictable order.
698
699 .cindex "spool directory" "definition of"
700 The term &'spool directory'& is used for a directory in which Exim keeps the
701 messages in its queue &-- that is, those that it is in the process of
702 delivering. This should not be confused with the directory in which local
703 mailboxes are stored, which is called a &"spool directory"& by some people. In
704 the Exim documentation, &"spool"& is always used in the first sense.
705
706
707
708
709
710
711 . ////////////////////////////////////////////////////////////////////////////
712 . ////////////////////////////////////////////////////////////////////////////
713
714 .chapter "Incorporated code" "CHID2"
715 .cindex "incorporated code"
716 .cindex "regular expressions" "library"
717 .cindex "PCRE2"
718 .cindex "OpenDMARC"
719 A number of pieces of external code are included in the Exim distribution.
720
721 .ilist
722 Regular expressions are supported in the main Exim program and in the
723 Exim monitor using the freely-distributable PCRE2 library, copyright
724 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
725 Exim, so you will need to use the version of PCRE2 shipped with your system,
726 or obtain and install the full version of the library from
727 &url(https://github.com/PhilipHazel/pcre2/releases).
728 .next
729 .cindex "cdb" "acknowledgment"
730 Support for the cdb (Constant DataBase) lookup method is provided by code
731 contributed by Nigel Metheringham of (at the time he contributed it) Planet
732 Online Ltd. The implementation is completely contained within the code of Exim.
733 It does not link against an external cdb library. The code contains the
734 following statements:
735
736 .blockquote
737 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
738
739 This program is free software; you can redistribute it and/or modify it under
740 the terms of the GNU General Public License as published by the Free Software
741 Foundation; either version 2 of the License, or (at your option) any later
742 version.
743 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
744 the spec and sample code for cdb can be obtained from
745 &url(https://cr.yp.to/cdb.html). This implementation borrows
746 some code from Dan Bernstein's implementation (which has no license
747 restrictions applied to it).
748 .endblockquote
749 .next
750 .cindex "SPA authentication"
751 .cindex "Samba project"
752 .cindex "Microsoft Secure Password Authentication"
753 Client support for Microsoft's &'Secure Password Authentication'& is provided
754 by code contributed by Marc Prud'hommeaux. Server support was contributed by
755 Tom Kistner. This includes code taken from the Samba project, which is released
756 under the Gnu GPL.
757 .next
758 .cindex "Cyrus"
759 .cindex "&'pwcheck'& daemon"
760 .cindex "&'pwauthd'& daemon"
761 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
762 by code taken from the Cyrus-SASL library and adapted by Alexander S.
763 Sabourenkov. The permission notice appears below, in accordance with the
764 conditions expressed therein.
765
766 .blockquote
767 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
768
769 Redistribution and use in source and binary forms, with or without
770 modification, are permitted provided that the following conditions
771 are met:
772
773 .olist
774 Redistributions of source code must retain the above copyright
775 notice, this list of conditions and the following disclaimer.
776 .next
777 Redistributions in binary form must reproduce the above copyright
778 notice, this list of conditions and the following disclaimer in
779 the documentation and/or other materials provided with the
780 distribution.
781 .next
782 The name &"Carnegie Mellon University"& must not be used to
783 endorse or promote products derived from this software without
784 prior written permission. For permission or any other legal
785 details, please contact
786 .display
787               Office of Technology Transfer
788               Carnegie Mellon University
789               5000 Forbes Avenue
790               Pittsburgh, PA  15213-3890
791               (412) 268-4387, fax: (412) 268-7395
792               tech-transfer@andrew.cmu.edu
793 .endd
794 .next
795 Redistributions of any form whatsoever must retain the following
796 acknowledgment:
797
798 &"This product includes software developed by Computing Services
799 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
800
801 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
802 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
803 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
804 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
805 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
806 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
807 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
808 .endlist
809 .endblockquote
810
811 .next
812 .cindex "Exim monitor" "acknowledgment"
813 .cindex "X-windows"
814 .cindex "Athena"
815 The Exim Monitor program, which is an X-Window application, includes
816 modified versions of the Athena StripChart and TextPop widgets.
817 This code is copyright by DEC and MIT, and their permission notice appears
818 below, in accordance with the conditions expressed therein.
819
820 .blockquote
821 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
822 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
823
824 All Rights Reserved
825
826 Permission to use, copy, modify, and distribute this software and its
827 documentation for any purpose and without fee is hereby granted,
828 provided that the above copyright notice appear in all copies and that
829 both that copyright notice and this permission notice appear in
830 supporting documentation, and that the names of Digital or MIT not be
831 used in advertising or publicity pertaining to distribution of the
832 software without specific, written prior permission.
833
834 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
835 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
836 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
837 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
838 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
839 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
840 SOFTWARE.
841 .endblockquote
842
843 .next
844 .cindex "opendmarc" "acknowledgment"
845 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
846 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
847 derived code are indicated in the respective source files. The full OpenDMARC
848 license is provided in the LICENSE.opendmarc file contained in the distributed
849 source code.
850
851 .next
852 Many people have contributed code fragments, some large, some small, that were
853 not covered by any specific license requirements. It is assumed that the
854 contributors are happy to see their code incorporated into Exim under the GPL.
855 .endlist
856
857
858
859
860
861 . ////////////////////////////////////////////////////////////////////////////
862 . ////////////////////////////////////////////////////////////////////////////
863
864 .chapter "How Exim receives and delivers mail" "CHID11" &&&
865          "Receiving and delivering mail"
866
867
868 .section "Overall philosophy" "SECID10"
869 .cindex "design philosophy"
870 Exim is designed to work efficiently on systems that are permanently connected
871 to the Internet and are handling a general mix of mail. In such circumstances,
872 most messages can be delivered immediately. Consequently, Exim does not
873 maintain independent queues of messages for specific domains or hosts, though
874 it does try to send several messages in a single SMTP connection after a host
875 has been down, and it also maintains per-host retry information.
876
877
878 .section "Policy control" "SECID11"
879 .cindex "policy control" "overview"
880 Policy controls are now an important feature of MTAs that are connected to the
881 Internet. Perhaps their most important job is to stop MTAs from being abused as
882 &"open relays"& by misguided individuals who send out vast amounts of
883 unsolicited junk and want to disguise its source. Exim provides flexible
884 facilities for specifying policy controls on incoming mail:
885
886 .ilist
887 .cindex "&ACL;" "introduction"
888 Exim 4 (unlike previous versions of Exim) implements policy controls on
889 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
890 series of statements that may either grant or deny access. ACLs can be used at
891 several places in the SMTP dialogue while receiving a message from a remote
892 host. However, the most common places are after each RCPT command, and at the
893 very end of the message. The sysadmin can specify conditions for accepting or
894 rejecting individual recipients or the entire message, respectively, at these
895 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
896 error code.
897 .next
898 An ACL is also available for locally generated, non-SMTP messages. In this
899 case, the only available actions are to accept or deny the entire message.
900 .next
901 When Exim is compiled with the content-scanning extension, facilities are
902 provided in the ACL mechanism for passing the message to external virus and/or
903 spam scanning software. The result of such a scan is passed back to the ACL,
904 which can then use it to decide what to do with the message.
905 .next
906 When a message has been received, either from a remote host or from the local
907 host, but before the final acknowledgment has been sent, a locally supplied C
908 function called &[local_scan()]& can be run to inspect the message and decide
909 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
910 is accepted, the list of recipients can be modified by the function.
911 .next
912 Using the &[local_scan()]& mechanism is another way of calling external scanner
913 software. The &%SA-Exim%& add-on package works this way. It does not require
914 Exim to be compiled with the content-scanning extension.
915 .next
916 After a message has been accepted, a further checking mechanism is available in
917 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
918 runs at the start of every delivery process.
919 .endlist
920
921
922
923 .section "User filters" "SECID12"
924 .cindex "filter" "introduction"
925 .cindex "Sieve filter"
926 In a conventional Exim configuration, users are able to run private filters by
927 setting up appropriate &_.forward_& files in their home directories. See
928 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
929 configuration needed to support this, and the separate document entitled
930 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
931 of filtering are available:
932
933 .ilist
934 Sieve filters are written in the standard filtering language that is defined
935 by RFC 3028.
936 .next
937 Exim filters are written in a syntax that is unique to Exim, but which is more
938 powerful than Sieve, which it pre-dates.
939 .endlist
940
941 User filters are run as part of the routing process, described below.
942
943
944
945 .section "Message identification" "SECTmessiden"
946 .cindex "message ids" "details of format"
947 .cindex "format" "of message id"
948 .cindex "id of message"
949 .cindex "base62"
950 .cindex "base36"
951 .cindex "Darwin"
952 .cindex "Cygwin"
953 .cindex "exim_msgdate"
954 Every message handled by Exim is given a &'message id'& which is sixteen
955 characters long. It is divided into three parts, separated by hyphens, for
956 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
957 normally encoding numbers in base 62. However, in the Darwin operating
958 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
959 (avoiding the use of lower case letters) is used instead, because the message
960 id is used to construct filenames, and the names of files in those systems are
961 not always case-sensitive.
962
963 .cindex "pid (process id)" "re-use of"
964 The detail of the contents of the message id have changed as Exim has evolved.
965 Earlier versions relied on the operating system not re-using a process id (pid)
966 within one second. On modern operating systems, this assumption can no longer
967 be made, so the algorithm had to be changed. To retain backward compatibility,
968 the format of the message id was retained, which is why the following rules are
969 somewhat eccentric:
970
971 .ilist
972 The first six characters of the message id are the time at which the message
973 started to be received, to a granularity of one second. That is, this field
974 contains the number of seconds since the start of the epoch (the normal Unix
975 way of representing the date and time of day).
976 .next
977 After the first hyphen, the next six characters are the id of the process that
978 received the message.
979 .next
980 There are two different possibilities for the final two characters:
981 .olist
982 .oindex "&%localhost_number%&"
983 If &%localhost_number%& is not set, this value is the fractional part of the
984 time of reception, normally in units of 1/2000 of a second, but for systems
985 that must use base 36 instead of base 62 (because of case-insensitive file
986 systems), the units are 1/1000 of a second.
987 .next
988 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
989 the fractional part of the time, which in this case is in units of 1/200
990 (1/100) of a second.
991 .endlist
992 .endlist
993
994 After a message has been received, Exim waits for the clock to tick at the
995 appropriate resolution before proceeding, so that if another message is
996 received by the same process, or by another process with the same (re-used)
997 pid, it is guaranteed that the time will be different. In most cases, the clock
998 will already have ticked while the message was being received.
999
1000 The exim_msgdate utility (see section &<<SECTexim_msgdate>>&) can be
1001 used to display the date, and optionally the process id, of an Exim
1002 Message ID.
1003
1004
1005 .section "Receiving mail" "SECID13"
1006 .cindex "receiving mail"
1007 .cindex "message" "reception"
1008 The only way Exim can receive mail from another host is using SMTP over
1009 TCP/IP, in which case the sender and recipient addresses are transferred using
1010 SMTP commands. However, from a locally running process (such as a user's MUA),
1011 there are several possibilities:
1012
1013 .ilist
1014 If the process runs Exim with the &%-bm%& option, the message is read
1015 non-interactively (usually via a pipe), with the recipients taken from the
1016 command line, or from the body of the message if &%-t%& is also used.
1017 .next
1018 If the process runs Exim with the &%-bS%& option, the message is also read
1019 non-interactively, but in this case the recipients are listed at the start of
1020 the message in a series of SMTP RCPT commands, terminated by a DATA
1021 command. This is called &"batch SMTP"& format,
1022 but it isn't really SMTP. The SMTP commands are just another way of passing
1023 envelope addresses in a non-interactive submission.
1024 .next
1025 If the process runs Exim with the &%-bs%& option, the message is read
1026 interactively, using the SMTP protocol. A two-way pipe is normally used for
1027 passing data between the local process and the Exim process.
1028 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1029 example, the ACLs for SMTP commands are used for this form of submission.
1030 .next
1031 A local process may also make a TCP/IP call to the host's loopback address
1032 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1033 does not treat the loopback address specially. It treats all such connections
1034 in the same way as connections from other hosts.
1035 .endlist
1036
1037
1038 .cindex "message sender, constructed by Exim"
1039 .cindex "sender" "constructed by Exim"
1040 In the three cases that do not involve TCP/IP, the sender address is
1041 constructed from the login name of the user that called Exim and a default
1042 qualification domain (which can be set by the &%qualify_domain%& configuration
1043 option). For local or batch SMTP, a sender address that is passed using the
1044 SMTP MAIL command is ignored. However, the system administrator may allow
1045 certain users (&"trusted users"&) to specify a different sender addresses
1046 unconditionally, or all users to specify certain forms of different sender
1047 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1048 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1049 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1050 users to change sender addresses.
1051
1052 Messages received by either of the non-interactive mechanisms are subject to
1053 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1054 (either over TCP/IP or interacting with a local process) can be checked by a
1055 number of ACLs that operate at different times during the SMTP session. Either
1056 individual recipients or the entire message can be rejected if local policy
1057 requirements are not met. The &[local_scan()]& function (see chapter
1058 &<<CHAPlocalscan>>&) is run for all incoming messages.
1059
1060 Exim can be configured not to start a delivery process when a message is
1061 received; this can be unconditional, or depend on the number of incoming SMTP
1062 connections or the system load. In these situations, new messages wait on the
1063 queue until a queue runner process picks them up. However, in standard
1064 configurations under normal conditions, delivery is started as soon as a
1065 message is received.
1066
1067
1068
1069
1070
1071 .section "Handling an incoming message" "SECID14"
1072 .cindex "spool directory" "files that hold a message"
1073 .cindex "file" "how a message is held"
1074 When Exim accepts a message, it writes two files in its spool directory. The
1075 first contains the envelope information, the current status of the message, and
1076 the header lines, and the second contains the body of the message. The names of
1077 the two spool files consist of the message id, followed by &`-H`& for the
1078 file containing the envelope and header, and &`-D`& for the data file.
1079
1080 .cindex "spool directory" "&_input_& sub-directory"
1081 By default, all these message files are held in a single directory called
1082 &_input_& inside the general Exim spool directory. Some operating systems do
1083 not perform very well if the number of files in a directory gets large; to
1084 improve performance in such cases, the &%split_spool_directory%& option can be
1085 used. This causes Exim to split up the input files into 62 sub-directories
1086 whose names are single letters or digits. When this is done, the queue is
1087 processed one sub-directory at a time instead of all at once, which can improve
1088 overall performance even when there are not enough files in each directory to
1089 affect file system performance.
1090
1091 The envelope information consists of the address of the message's sender and
1092 the addresses of the recipients. This information is entirely separate from
1093 any addresses contained in the header lines. The status of the message includes
1094 a list of recipients who have already received the message. The format of the
1095 first spool file is described in chapter &<<CHAPspool>>&.
1096
1097 .cindex "rewriting" "addresses"
1098 Address rewriting that is specified in the rewrite section of the configuration
1099 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1100 both in the header lines and the envelope, at the time the message is accepted.
1101 If during the course of delivery additional addresses are generated (for
1102 example, via aliasing), these new addresses are rewritten as soon as they are
1103 generated. At the time a message is actually delivered (transported) further
1104 rewriting can take place; because this is a transport option, it can be
1105 different for different forms of delivery. It is also possible to specify the
1106 addition or removal of certain header lines at the time the message is
1107 delivered (see chapters &<<CHAProutergeneric>>& and
1108 &<<CHAPtransportgeneric>>&).
1109
1110
1111
1112 .section "Life of a message" "SECID15"
1113 .cindex "message" "life of"
1114 .cindex "message" "frozen"
1115 A message remains in the spool directory until it is completely delivered to
1116 its recipients or to an error address, or until it is deleted by an
1117 administrator or by the user who originally created it. In cases when delivery
1118 cannot proceed &-- for example when a message can neither be delivered to its
1119 recipients nor returned to its sender, the message is marked &"frozen"& on the
1120 spool, and no more deliveries are attempted.
1121
1122 .cindex "frozen messages" "thawing"
1123 .cindex "message" "thawing frozen"
1124 An administrator can &"thaw"& such messages when the problem has been
1125 corrected, and can also freeze individual messages by hand if necessary. In
1126 addition, an administrator can force a delivery error, causing a bounce message
1127 to be sent.
1128
1129 .oindex "&%timeout_frozen_after%&"
1130 .oindex "&%ignore_bounce_errors_after%&"
1131 There are options called &%ignore_bounce_errors_after%& and
1132 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1133 The first applies only to frozen bounces, the second to all frozen messages.
1134
1135 .cindex "message" "log file for"
1136 .cindex "log" "file for each message"
1137 While Exim is working on a message, it writes information about each delivery
1138 attempt to its main log file. This includes successful, unsuccessful, and
1139 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1140 lines are also written to a separate &'message log'& file for each message.
1141 These logs are solely for the benefit of the administrator and are normally
1142 deleted along with the spool files when processing of a message is complete.
1143 The use of individual message logs can be disabled by setting
1144 &%no_message_logs%&; this might give an improvement in performance on very busy
1145 systems.
1146
1147 .cindex "journal file"
1148 .cindex "file" "journal"
1149 All the information Exim itself needs to set up a delivery is kept in the first
1150 spool file, along with the header lines. When a successful delivery occurs, the
1151 address is immediately written at the end of a journal file, whose name is the
1152 message id followed by &`-J`&. At the end of a delivery run, if there are some
1153 addresses left to be tried again later, the first spool file (the &`-H`& file)
1154 is updated to indicate which these are, and the journal file is then deleted.
1155 Updating the spool file is done by writing a new file and renaming it, to
1156 minimize the possibility of data loss.
1157
1158 Should the system or Exim crash after a successful delivery but before
1159 the spool file has been updated, the journal is left lying around. The next
1160 time Exim attempts to deliver the message, it reads the journal file and
1161 updates the spool file before proceeding. This minimizes the chances of double
1162 deliveries caused by crashes.
1163
1164
1165
1166 .section "Processing an address for delivery" "SECTprocaddress"
1167 .cindex "drivers" "definition of"
1168 .cindex "router" "definition of"
1169 .cindex "transport" "definition of"
1170 The main delivery processing elements of Exim are called &'routers'& and
1171 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1172 number of them is provided in the source distribution, and compile-time options
1173 specify which ones are included in the binary. Runtime options specify which
1174 ones are actually used for delivering messages.
1175
1176 .cindex "drivers" "instance definition"
1177 Each driver that is specified in the runtime configuration is an &'instance'&
1178 of that particular driver type. Multiple instances are allowed; for example,
1179 you can set up several different &(smtp)& transports, each with different
1180 option values that might specify different ports or different timeouts. Each
1181 instance has its own identifying name. In what follows we will normally use the
1182 instance name when discussing one particular instance (that is, one specific
1183 configuration of the driver), and the generic driver name when discussing
1184 the driver's features in general.
1185
1186 A &'router'& is a driver that operates on an address, either determining how
1187 its delivery should happen, by assigning it to a specific transport, or
1188 converting the address into one or more new addresses (for example, via an
1189 alias file). A router may also explicitly choose to fail an address, causing it
1190 to be bounced.
1191
1192 A &'transport'& is a driver that transmits a copy of the message from Exim's
1193 spool to some destination. There are two kinds of transport: for a &'local'&
1194 transport, the destination is a file or a pipe on the local host, whereas for a
1195 &'remote'& transport the destination is some other host. A message is passed
1196 to a specific transport as a result of successful routing. If a message has
1197 several recipients, it may be passed to a number of different transports.
1198
1199 .cindex "preconditions" "definition of"
1200 An address is processed by passing it to each configured router instance in
1201 turn, subject to certain preconditions, until a router accepts the address or
1202 specifies that it should be bounced. We will describe this process in more
1203 detail shortly. First, as a simple example, we consider how each recipient
1204 address in a message is processed in a small configuration of three routers.
1205
1206 To make this a more concrete example, it is described in terms of some actual
1207 routers, but remember, this is only an example. You can configure Exim's
1208 routers in many different ways, and there may be any number of routers in a
1209 configuration.
1210
1211 The first router that is specified in a configuration is often one that handles
1212 addresses in domains that are not recognized specifically by the local host.
1213 Typically these are addresses for arbitrary domains on the Internet. A precondition
1214 is set up which looks for the special domains known to the host (for example,
1215 its own domain name), and the router is run for addresses that do &'not'&
1216 match. Typically, this is a router that looks up domains in the DNS in order to
1217 find the hosts to which this address routes. If it succeeds, the address is
1218 assigned to a suitable SMTP transport; if it does not succeed, the router is
1219 configured to fail the address.
1220
1221 The second router is reached only when the domain is recognized as one that
1222 &"belongs"& to the local host. This router does redirection &-- also known as
1223 aliasing and forwarding. When it generates one or more new addresses from the
1224 original, each of them is routed independently from the start. Otherwise, the
1225 router may cause an address to fail, or it may simply decline to handle the
1226 address, in which case the address is passed to the next router.
1227
1228 The final router in many configurations is one that checks to see if the
1229 address belongs to a local mailbox. The precondition may involve a check to
1230 see if the local part is the name of a login account, or it may look up the
1231 local part in a file or a database. If its preconditions are not met, or if
1232 the router declines, we have reached the end of the routers. When this happens,
1233 the address is bounced.
1234
1235
1236
1237 .section "Processing an address for verification" "SECID16"
1238 .cindex "router" "for verification"
1239 .cindex "verifying address" "overview"
1240 As well as being used to decide how to deliver to an address, Exim's routers
1241 are also used for &'address verification'&. Verification can be requested as
1242 one of the checks to be performed in an ACL for incoming messages, on both
1243 sender and recipient addresses, and it can be tested using the &%-bv%& and
1244 &%-bvs%& command line options.
1245
1246 When an address is being verified, the routers are run in &"verify mode"&. This
1247 does not affect the way the routers work, but it is a state that can be
1248 detected. By this means, a router can be skipped or made to behave differently
1249 when verifying. A common example is a configuration in which the first router
1250 sends all messages to a message-scanning program unless they have been
1251 previously scanned. Thus, the first router accepts all addresses without any
1252 checking, making it useless for verifying. Normally, the &%no_verify%& option
1253 would be set for such a router, causing it to be skipped in verify mode.
1254
1255
1256
1257
1258 .section "Running an individual router" "SECTrunindrou"
1259 .cindex "router" "running details"
1260 .cindex "preconditions" "checking"
1261 .cindex "router" "result of running"
1262 As explained in the example above, a number of preconditions are checked before
1263 running a router. If any are not met, the router is skipped, and the address is
1264 passed to the next router. When all the preconditions on a router &'are'& met,
1265 the router is run. What happens next depends on the outcome, which is one of
1266 the following:
1267
1268 .ilist
1269 &'accept'&: The router accepts the address, and either assigns it to a
1270 transport or generates one or more &"child"& addresses. Processing the
1271 original address ceases
1272 .oindex "&%unseen%&"
1273 unless the &%unseen%& option is set on the router. This option
1274 can be used to set up multiple deliveries with different routing (for example,
1275 for keeping archive copies of messages). When &%unseen%& is set, the address is
1276 passed to the next router. Normally, however, an &'accept'& return marks the
1277 end of routing.
1278
1279 Any child addresses generated by the router are processed independently,
1280 starting with the first router by default. It is possible to change this by
1281 setting the &%redirect_router%& option to specify which router to start at for
1282 child addresses. Unlike &%pass_router%& (see below) the router specified by
1283 &%redirect_router%& may be anywhere in the router configuration.
1284 .next
1285 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1286 requests that the address be passed to another router. By default, the address
1287 is passed to the next router, but this can be changed by setting the
1288 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1289 must be below the current router (to avoid loops).
1290 .next
1291 &'decline'&: The router declines to accept the address because it does not
1292 recognize it at all. By default, the address is passed to the next router, but
1293 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1294 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1295 &'decline'& into &'fail'&.
1296 .next
1297 &'fail'&: The router determines that the address should fail, and queues it for
1298 the generation of a bounce message. There is no further processing of the
1299 original address unless &%unseen%& is set on the router.
1300 .next
1301 &'defer'&: The router cannot handle the address at the present time. (A
1302 database may be offline, or a DNS lookup may have timed out.) No further
1303 processing of the address happens in this delivery attempt. It is tried again
1304 next time the message is considered for delivery.
1305 .next
1306 &'error'&: There is some error in the router (for example, a syntax error in
1307 its configuration). The action is as for defer.
1308 .endlist
1309
1310 If an address reaches the end of the routers without having been accepted by
1311 any of them, it is bounced as unrouteable. The default error message in this
1312 situation is &"unrouteable address"&, but you can set your own message by
1313 making use of the &%cannot_route_message%& option. This can be set for any
1314 router; the value from the last router that &"saw"& the address is used.
1315
1316 Sometimes while routing you want to fail a delivery when some conditions are
1317 met but others are not, instead of passing the address on for further routing.
1318 You can do this by having a second router that explicitly fails the delivery
1319 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1320 facility for this purpose.
1321
1322
1323 .section "Duplicate addresses" "SECID17"
1324 .cindex "case of local parts"
1325 .cindex "address duplicate, discarding"
1326 .cindex "duplicate addresses"
1327 Once routing is complete, Exim scans the addresses that are assigned to local
1328 and remote transports and discards any duplicates that it finds. During this
1329 check, local parts are treated case-sensitively. This happens only when
1330 actually delivering a message; when testing routers with &%-bt%&, all the
1331 routed addresses are shown.
1332
1333
1334
1335 .section "Router preconditions" "SECTrouprecon"
1336 .cindex "router" "preconditions, order of processing"
1337 .cindex "preconditions" "order of processing"
1338 The preconditions that are tested for each router are listed below, in the
1339 order in which they are tested. The individual configuration options are
1340 described in more detail in chapter &<<CHAProutergeneric>>&.
1341
1342 .olist
1343 .cindex affix "router precondition"
1344 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1345 the local parts handled by the router may or must have certain prefixes and/or
1346 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1347 skipped. These conditions are tested first. When an affix is present, it is
1348 removed from the local part before further processing, including the evaluation
1349 of any other conditions.
1350 .next
1351 Routers can be designated for use only when not verifying an address, that is,
1352 only when routing it for delivery (or testing its delivery routing). If the
1353 &%verify%& option is set false, the router is skipped when Exim is verifying an
1354 address.
1355 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1356 &%verify_recipient%&, which independently control the use of the router for
1357 sender and recipient verification. You can set these options directly if
1358 you want a router to be used for only one type of verification.
1359 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1360 .next
1361 If the &%address_test%& option is set false, the router is skipped when Exim is
1362 run with the &%-bt%& option to test an address routing. This can be helpful
1363 when the first router sends all new messages to a scanner of some sort; it
1364 makes it possible to use &%-bt%& to test subsequent delivery routing without
1365 having to simulate the effect of the scanner.
1366 .next
1367 Routers can be designated for use only when verifying an address, as
1368 opposed to routing it for delivery. The &%verify_only%& option controls this.
1369 Again, cutthrough delivery counts as a verification.
1370 .next
1371 Individual routers can be explicitly skipped when running the routers to
1372 check an address given in the SMTP EXPN command (see the &%expn%& option).
1373
1374 .next
1375 If the &%domains%& option is set, the domain of the address must be in the set
1376 of domains that it defines.
1377 .cindex "tainted data" "de-tainting"
1378 .cindex "de-tainting" "using router domains option"
1379 A match verifies the variable &$domain$& (which carries tainted data)
1380 and assigns an untainted value to the &$domain_data$& variable.
1381 Such an untainted value is often needed in the transport.
1382 For specifics of the matching operation and the resulting untainted value,
1383 refer to section &<<SECTdomainlist>>&.
1384
1385 When an untainted value is wanted, use this option
1386 rather than the generic &%condition%& option.
1387
1388 .next
1389 .vindex "&$local_part_prefix$&"
1390 .vindex "&$local_part_prefix_v$&"
1391 .vindex "&$local_part$&"
1392 .vindex "&$local_part_suffix$&"
1393 .vindex "&$local_part_suffix_v$&"
1394 .cindex affix "router precondition"
1395 If the &%local_parts%& option is set, the local part of the address must be in
1396 the set of local parts that it defines.
1397 A match verifies the variable &$local_part$& (which carries tainted data)
1398 and assigns an untainted value to the &$local_part_data$& variable.
1399 Such an untainted value is often needed in the transport.
1400 For specifics of the matching operation and the resulting untainted value,
1401 refer to section &<<SECTlocparlis>>&.
1402
1403 When an untainted value is wanted, use this option
1404 rather than the generic &%condition%& option.
1405
1406 If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&,
1411 &$local_part_prefix_v$&, &$local_part_suffix$&
1412 and &$local_part_suffix_v$& as necessary.
1413
1414 .next
1415 .vindex "&$local_user_uid$&"
1416 .vindex "&$local_user_gid$&"
1417 .vindex "&$home$&"
1418 If the &%check_local_user%& option is set, the local part must be the name of
1419 an account on the local host. If this check succeeds, the uid and gid of the
1420 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1421 user's home directory is placed in &$home$&; these values can be used in the
1422 remaining preconditions.
1423
1424 .next
1425 If the &%router_home_directory%& option is set, it is expanded at this point,
1426 because it overrides the value of &$home$&. If this expansion were left till
1427 later, the value of &$home$& as set by &%check_local_user%& would be used in
1428 subsequent tests. Having two different values of &$home$& in the same router
1429 could lead to confusion.
1430
1431 .next
1432 If the &%senders%& option is set, the envelope sender address must be in the
1433 set of addresses that it defines.
1434
1435 .next
1436 If the &%require_files%& option is set, the existence or non-existence of
1437 specified files is tested.
1438
1439 .next
1440 .cindex "customizing" "precondition"
1441 If the &%condition%& option is set, it is evaluated and tested. This option
1442 uses an expanded string to allow you to set up your own custom preconditions.
1443 Expanded strings are described in chapter &<<CHAPexpand>>&.
1444
1445 Note that while using
1446 this option for address matching technically works,
1447 it does not set any de-tainted values.
1448 Such values are often needed, either for router-specific options or
1449 for transport options.
1450 Using the &%domains%& and &%local_parts%& options is usually the most
1451 convenient way to obtain them.
1452 .endlist
1453
1454
1455 Note that &%require_files%& comes near the end of the list, so you cannot use
1456 it to check for the existence of a file in which to lookup up a domain, local
1457 part, or sender. However, as these options are all expanded, you can use the
1458 &%exists%& expansion condition to make such tests within each condition. The
1459 &%require_files%& option is intended for checking files that the router may be
1460 going to use internally, or which are needed by a specific transport (for
1461 example, &_.procmailrc_&).
1462
1463
1464
1465 .section "Delivery in detail" "SECID18"
1466 .cindex "delivery" "in detail"
1467 When a message is to be delivered, the sequence of events is as follows:
1468
1469 .olist
1470 If a system-wide filter file is specified, the message is passed to it. The
1471 filter may add recipients to the message, replace the recipients, discard the
1472 message, cause a new message to be generated, or cause the message delivery to
1473 fail. The format of the system filter file is the same as for Exim user filter
1474 files, described in the separate document entitled &'Exim's interfaces to mail
1475 filtering'&.
1476 .cindex "Sieve filter" "not available for system filter"
1477 (&*Note*&: Sieve cannot be used for system filter files.)
1478
1479 Some additional features are available in system filters &-- see chapter
1480 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1481 filter only once per delivery attempt, however many recipients it has. However,
1482 if there are several delivery attempts because one or more addresses could not
1483 be immediately delivered, the system filter is run each time. The filter
1484 condition &%first_delivery%& can be used to detect the first run of the system
1485 filter.
1486 .next
1487 Each recipient address is offered to each configured router, in turn, subject to
1488 its preconditions, until one is able to handle it. If no router can handle the
1489 address, that is, if they all decline, the address is failed. Because routers
1490 can be targeted at particular domains, several locally handled domains can be
1491 processed entirely independently of each other.
1492 .next
1493 .cindex "routing" "loops in"
1494 .cindex "loop" "while routing"
1495 A router that accepts an address may assign it to a local or a remote
1496 transport. However, the transport is not run at this time. Instead, the address
1497 is placed on a list for the particular transport, which will be run later.
1498 Alternatively, the router may generate one or more new addresses (typically
1499 from alias, forward, or filter files). New addresses are fed back into this
1500 process from the top, but in order to avoid loops, a router ignores any address
1501 which has an identically-named ancestor that was processed by itself.
1502 .next
1503 When all the routing has been done, addresses that have been successfully
1504 handled are passed to their assigned transports. When local transports are
1505 doing real local deliveries, they handle only one address at a time, but if a
1506 local transport is being used as a pseudo-remote transport (for example, to
1507 collect batched SMTP messages for transmission by some other means) multiple
1508 addresses can be handled. Remote transports can always handle more than one
1509 address at a time, but can be configured not to do so, or to restrict multiple
1510 addresses to the same domain.
1511 .next
1512 Each local delivery to a file or a pipe runs in a separate process under a
1513 non-privileged uid, and these deliveries are run one at a time. Remote
1514 deliveries also run in separate processes, normally under a uid that is private
1515 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1516 run in parallel. The maximum number of simultaneous remote deliveries for any
1517 one message is set by the &%remote_max_parallel%& option.
1518 The order in which deliveries are done is not defined, except that all local
1519 deliveries happen before any remote deliveries.
1520 .next
1521 .cindex "queue runner"
1522 When it encounters a local delivery during a queue run, Exim checks its retry
1523 database to see if there has been a previous temporary delivery failure for the
1524 address before running the local transport. If there was a previous failure,
1525 Exim does not attempt a new delivery until the retry time for the address is
1526 reached. However, this happens only for delivery attempts that are part of a
1527 queue run. Local deliveries are always attempted when delivery immediately
1528 follows message reception, even if retry times are set for them. This makes for
1529 better behaviour if one particular message is causing problems (for example,
1530 causing quota overflow, or provoking an error in a filter file).
1531 .next
1532 .cindex "delivery" "retry in remote transports"
1533 Remote transports do their own retry handling, since an address may be
1534 deliverable to one of a number of hosts, each of which may have a different
1535 retry time. If there have been previous temporary failures and no host has
1536 reached its retry time, no delivery is attempted, whether in a queue run or
1537 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1538 .next
1539 If there were any permanent errors, a bounce message is returned to an
1540 appropriate address (the sender in the common case), with details of the error
1541 for each failing address. Exim can be configured to send copies of bounce
1542 messages to other addresses.
1543 .next
1544 .cindex "delivery" "deferral"
1545 If one or more addresses suffered a temporary failure, the message is left on
1546 the queue, to be tried again later. Delivery of these addresses is said to be
1547 &'deferred'&.
1548 .next
1549 When all the recipient addresses have either been delivered or bounced,
1550 handling of the message is complete. The spool files and message log are
1551 deleted, though the message log can optionally be preserved if required.
1552 .endlist
1553
1554
1555
1556
1557 .section "Retry mechanism" "SECID19"
1558 .cindex "delivery" "retry mechanism"
1559 .cindex "retry" "description of mechanism"
1560 .cindex "queue runner"
1561 Exim's mechanism for retrying messages that fail to get delivered at the first
1562 attempt is the queue runner process. You must either run an Exim daemon that
1563 uses the &%-q%& option with a time interval to start queue runners at regular
1564 intervals or use some other means (such as &'cron'&) to start them. If you do
1565 not arrange for queue runners to be run, messages that fail temporarily at the
1566 first attempt will remain in your queue forever. A queue runner process works
1567 its way through the queue, one message at a time, trying each delivery that has
1568 passed its retry time.
1569 You can run several queue runners at once.
1570
1571 Exim uses a set of configured rules to determine when next to retry the failing
1572 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1573 should give up trying to deliver to the address, at which point it generates a
1574 bounce message. If no retry rules are set for a particular host, address, and
1575 error combination, no retries are attempted, and temporary errors are treated
1576 as permanent.
1577
1578
1579
1580 .subsection "Temporary delivery failure" SECID20
1581 .cindex "delivery" "temporary failure"
1582 There are many reasons why a message may not be immediately deliverable to a
1583 particular address. Failure to connect to a remote machine (because it, or the
1584 connection to it, is down) is one of the most common. Temporary failures may be
1585 detected during routing as well as during the transport stage of delivery.
1586 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1587 is on a file system where the user is over quota. Exim can be configured to
1588 impose its own quotas on local mailboxes; where system quotas are set they will
1589 also apply.
1590
1591 If a host is unreachable for a period of time, a number of messages may be
1592 waiting for it by the time it recovers, and sending them in a single SMTP
1593 connection is clearly beneficial. Whenever a delivery to a remote host is
1594 deferred,
1595 .cindex "hints database" "deferred deliveries"
1596 Exim makes a note in its hints database, and whenever a successful
1597 SMTP delivery has happened, it looks to see if any other messages are waiting
1598 for the same host. If any are found, they are sent over the same SMTP
1599 connection, subject to a configuration limit as to the maximum number in any
1600 one connection.
1601
1602
1603
1604 .subsection "Permanent delivery failure" SECID21
1605 .cindex "delivery" "permanent failure"
1606 .cindex "bounce message" "when generated"
1607 When a message cannot be delivered to some or all of its intended recipients, a
1608 bounce message is generated. Temporary delivery failures turn into permanent
1609 errors when their timeout expires. All the addresses that fail in a given
1610 delivery attempt are listed in a single message. If the original message has
1611 many recipients, it is possible for some addresses to fail in one delivery
1612 attempt and others to fail subsequently, giving rise to more than one bounce
1613 message. The wording of bounce messages can be customized by the administrator.
1614 See chapter &<<CHAPemsgcust>>& for details.
1615
1616 .cindex "&'X-Failed-Recipients:'& header line"
1617 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1618 failed addresses, for the benefit of programs that try to analyse such messages
1619 automatically.
1620
1621 .cindex "bounce message" "recipient of"
1622 A bounce message is normally sent to the sender of the original message, as
1623 obtained from the message's envelope. For incoming SMTP messages, this is the
1624 address given in the MAIL command. However, when an address is expanded via a
1625 forward or alias file, an alternative address can be specified for delivery
1626 failures of the generated addresses. For a mailing list expansion (see section
1627 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1628 of the list.
1629
1630
1631
1632 .subsection "Failures to deliver bounce messages" SECID22
1633 .cindex "bounce message" "failure to deliver"
1634 If a bounce message (either locally generated or received from a remote host)
1635 itself suffers a permanent delivery failure, the message is left in the queue,
1636 but it is frozen, awaiting the attention of an administrator. There are options
1637 that can be used to make Exim discard such failed messages, or to keep them
1638 for only a short time (see &%timeout_frozen_after%& and
1639 &%ignore_bounce_errors_after%&).
1640
1641
1642
1643
1644
1645 . ////////////////////////////////////////////////////////////////////////////
1646 . ////////////////////////////////////////////////////////////////////////////
1647
1648 .chapter "Building and installing Exim" "CHID3"
1649 .scindex IIDbuex "building Exim"
1650
1651 .section "Unpacking" "SECID23"
1652 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1653 creates a directory with the name of the current release (for example,
1654 &_exim-&version()_&) into which the following files are placed:
1655
1656 .table2 140pt
1657 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1658 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1659   documented"
1660 .irow &_LICENCE_&         "the GNU General Public Licence"
1661 .irow &_Makefile_&        "top-level make file"
1662 .irow &_NOTICE_&          "conditions for the use of Exim"
1663 .irow &_README_&          "list of files, directories and simple build &&&
1664   instructions"
1665 .endtable
1666
1667 Other files whose names begin with &_README_& may also be present. The
1668 following subdirectories are created:
1669
1670 .table2 140pt
1671 .irow &_Local_&           "an empty directory for local configuration files"
1672 .irow &_OS_&              "OS-specific files"
1673 .irow &_doc_&             "documentation files"
1674 .irow &_exim_monitor_&    "source files for the Exim monitor"
1675 .irow &_scripts_&         "scripts used in the build process"
1676 .irow &_src_&             "remaining source files"
1677 .irow &_util_&            "independent utilities"
1678 .endtable
1679
1680 The main utility programs are contained in the &_src_& directory and are built
1681 with the Exim binary. The &_util_& directory contains a few optional scripts
1682 that may be useful to some sites.
1683
1684
1685 .section "Multiple machine architectures and operating systems" "SECID24"
1686 .cindex "building Exim" "multiple OS/architectures"
1687 The building process for Exim is arranged to make it easy to build binaries for
1688 a number of different architectures and operating systems from the same set of
1689 source files. Compilation does not take place in the &_src_& directory.
1690 Instead, a &'build directory'& is created for each architecture and operating
1691 system.
1692 .cindex "symbolic link" "to build directory"
1693 Symbolic links to the sources are installed in this directory, which is where
1694 the actual building takes place. In most cases, Exim can discover the machine
1695 architecture and operating system for itself, but the defaults can be
1696 overridden if necessary.
1697 .cindex compiler requirements
1698 .cindex compiler version
1699 A C99-capable compiler will be required for the build.
1700
1701
1702 .section "PCRE2 library" "SECTpcre"
1703 .cindex "PCRE2 library"
1704 Exim no longer has an embedded regular-expression library as the vast majority of
1705 modern systems include PCRE2 as a system library, although you may need to
1706 install the PCRE2 package or the PCRE2 development package for your operating
1707 system. If your system has a normal PCRE2 installation the Exim build
1708 process will need no further configuration. If the library or the
1709 headers are in an unusual location you will need to either set the PCRE2_LIBS
1710 and INCLUDE directives appropriately,
1711 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1712 If your operating system has no
1713 PCRE2 support then you will need to obtain and build the current PCRE2
1714 from &url(https://github.com/PhilipHazel/pcre2/releases).
1715 More information on PCRE2 is available at &url(https://www.pcre.org/).
1716
1717 .section "DBM libraries" "SECTdb"
1718 .cindex "DBM libraries" "discussion of"
1719 .cindex "hints database" "DBM files used for"
1720 Even if you do not use any DBM files in your configuration, Exim still needs a
1721 DBM library in order to operate, because it uses indexed files for its hints
1722 databases. Unfortunately, there are a number of DBM libraries in existence, and
1723 different operating systems often have different ones installed.
1724
1725 .cindex "Solaris" "DBM library for"
1726 .cindex "IRIX, DBM library for"
1727 .cindex "BSD, DBM library for"
1728 .cindex "Linux, DBM library for"
1729 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1730 Linux distribution, the DBM configuration should happen automatically, and you
1731 may be able to ignore this section. Otherwise, you may have to learn more than
1732 you would like about DBM libraries from what follows.
1733
1734 .cindex "&'ndbm'& DBM library"
1735 Licensed versions of Unix normally contain a library of DBM functions operating
1736 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1737 versions of Unix seem to vary in what they contain as standard. In particular,
1738 some early versions of Linux have no default DBM library, and different
1739 distributors have chosen to bundle different libraries with their packaged
1740 versions. However, the more recent releases seem to have standardized on the
1741 Berkeley DB library.
1742
1743 Different DBM libraries have different conventions for naming the files they
1744 use. When a program opens a file called &_dbmfile_&, there are several
1745 possibilities:
1746
1747 .olist
1748 A traditional &'ndbm'& implementation, such as that supplied as part of
1749 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1750 .next
1751 .cindex "&'gdbm'& DBM library"
1752 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1753 compatibility interface it makes two different hard links to it with names
1754 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1755 filename is used unmodified.
1756 .next
1757 .cindex "Berkeley DB library"
1758 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1759 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1760 programmer exactly the same as the traditional &'ndbm'& implementation.
1761 .next
1762 If the Berkeley package is used in its native mode, it operates on a single
1763 file called &_dbmfile_&; the programmer's interface is somewhat different to
1764 the traditional &'ndbm'& interface.
1765 .next
1766 To complicate things further, there are several very different versions of the
1767 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1768 2.&'x'& and 3.&'x'& were current for a while,
1769 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1770 Maintenance of some of the earlier releases has ceased,
1771 and Exim no longer supports versions before 3.&'x'&.
1772 All versions of Berkeley DB could be obtained from
1773 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1774 page with far newer versions listed.
1775 It is probably wise to plan to move your storage configurations away from
1776 Berkeley DB format, as today there are smaller and simpler alternatives more
1777 suited to Exim's usage model.
1778 .next
1779 .cindex "&'tdb'& DBM library"
1780 Yet another DBM library, called &'tdb'&, is available from
1781 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1782 operates on a single file.
1783 .endlist
1784
1785 .cindex "USE_DB"
1786 .cindex "DBM libraries" "configuration for building"
1787 Exim and its utilities can be compiled to use any of these interfaces. In order
1788 to use any version of the Berkeley DB package in native mode, you must set
1789 USE_DB in an appropriate configuration file (typically
1790 &_Local/Makefile_&). For example:
1791 .code
1792 USE_DB=yes
1793 .endd
1794 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1795 error is diagnosed if you set more than one of these.
1796 You can set USE_NDBM if needed to override an operating system default.
1797
1798 At the lowest level, the build-time configuration sets none of these options,
1799 thereby assuming an interface of type (1). However, some operating system
1800 configuration files (for example, those for the BSD operating systems and
1801 Linux) assume type (4) by setting USE_DB as their default, and the
1802 configuration files for Cygwin set USE_GDBM. Anything you set in
1803 &_Local/Makefile_&, however, overrides these system defaults.
1804
1805 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1806 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1807 in one of these lines:
1808 .code
1809 DBMLIB = -ldb
1810 DBMLIB = -ltdb
1811 DBMLIB = -lgdbm -lgdbm_compat
1812 .endd
1813 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1814 Settings like that will work if the DBM library is installed in the standard
1815 place. Sometimes it is not, and the library's header file may also not be in
1816 the default path. You may need to set INCLUDE to specify where the header
1817 file is, and to specify the path to the library more fully in DBMLIB, as in
1818 this example:
1819 .code
1820 INCLUDE=-I/usr/local/include/db-4.1
1821 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1822 .endd
1823 There is further detailed discussion about the various DBM libraries in the
1824 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1825
1826
1827
1828 .section "Pre-building configuration" "SECID25"
1829 .cindex "building Exim" "pre-building configuration"
1830 .cindex "configuration for building Exim"
1831 .cindex "&_Local/Makefile_&"
1832 .cindex "&_src/EDITME_&"
1833 Before building Exim, a local configuration file that specifies options
1834 independent of any operating system has to be created with the name
1835 &_Local/Makefile_&. A template for this file is supplied as the file
1836 &_src/EDITME_&, and it contains full descriptions of all the option settings
1837 therein. These descriptions are therefore not repeated here. If you are
1838 building Exim for the first time, the simplest thing to do is to copy
1839 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1840
1841 There are three settings that you must supply, because Exim will not build
1842 without them. They are the location of the runtime configuration file
1843 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1844 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1845 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1846 a colon-separated list of filenames; Exim uses the first of them that exists.
1847
1848 There are a few other parameters that can be specified either at build time or
1849 at runtime, to enable the same binary to be used on a number of different
1850 machines. However, if the locations of Exim's spool directory and log file
1851 directory (if not within the spool directory) are fixed, it is recommended that
1852 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1853 detected early in Exim's execution (such as a malformed configuration file) can
1854 be logged.
1855
1856 .cindex "content scanning" "specifying at build time"
1857 Exim's interfaces for calling virus and spam scanning software directly from
1858 access control lists are not compiled by default. If you want to include these
1859 facilities, you need to set
1860 .code
1861 WITH_CONTENT_SCAN=yes
1862 .endd
1863 in your &_Local/Makefile_&. For details of the facilities themselves, see
1864 chapter &<<CHAPexiscan>>&.
1865
1866
1867 .cindex "&_Local/eximon.conf_&"
1868 .cindex "&_exim_monitor/EDITME_&"
1869 If you are going to build the Exim monitor, a similar configuration process is
1870 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1871 your installation and saved under the name &_Local/eximon.conf_&. If you are
1872 happy with the default settings described in &_exim_monitor/EDITME_&,
1873 &_Local/eximon.conf_& can be empty, but it must exist.
1874
1875 This is all the configuration that is needed in straightforward cases for known
1876 operating systems. However, the building process is set up so that it is easy
1877 to override options that are set by default or by operating-system-specific
1878 configuration files, for example, to change the C compiler, which
1879 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1880 do this.
1881
1882
1883
1884 .section "Support for iconv()" "SECID26"
1885 .cindex "&[iconv()]& support"
1886 .cindex "RFC 2047"
1887 The contents of header lines in messages may be encoded according to the rules
1888 described RFC 2047. This makes it possible to transmit characters that are not
1889 in the ASCII character set, and to label them as being in a particular
1890 character set. When Exim is inspecting header lines by means of the &%$h_%&
1891 mechanism, it decodes them, and translates them into a specified character set
1892 (default is set at build time). The translation is possible only if the operating system
1893 supports the &[iconv()]& function.
1894
1895 However, some of the operating systems that supply &[iconv()]& do not support
1896 very many conversions. The GNU &%libiconv%& library (available from
1897 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1898 systems to remedy this deficiency, as well as on systems that do not supply
1899 &[iconv()]& at all. After installing &%libiconv%&, you should add
1900 .code
1901 HAVE_ICONV=yes
1902 .endd
1903 to your &_Local/Makefile_& and rebuild Exim.
1904
1905
1906
1907 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1908 .cindex "TLS" "including support for TLS"
1909 .cindex "encryption" "including support for"
1910 .cindex "OpenSSL" "building Exim with"
1911 .cindex "GnuTLS" "building Exim with"
1912 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1913 command as per RFC 2487. It can also support clients that expect to
1914 start a TLS session immediately on connection to a non-standard port (see the
1915 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1916 line option).
1917
1918 If you want to build Exim with TLS support, you must first install either the
1919 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1920 implementing SSL.
1921
1922 If you do not want TLS support you should set
1923 .code
1924 DISABLE_TLS=yes
1925 .endd
1926 in &_Local/Makefile_&.
1927
1928 If OpenSSL is installed, you should set
1929 .code
1930 USE_OPENSL=yes
1931 TLS_LIBS=-lssl -lcrypto
1932 .endd
1933 in &_Local/Makefile_&. You may also need to specify the locations of the
1934 OpenSSL library and include files. For example:
1935 .code
1936 USE_OPENSSL=yes
1937 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1938 TLS_INCLUDE=-I/usr/local/openssl/include/
1939 .endd
1940 .cindex "pkg-config" "OpenSSL"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_OPENSSL=yes
1944 USE_OPENSSL_PC=openssl
1945 .endd
1946 .cindex "USE_GNUTLS"
1947 If GnuTLS is installed, you should set
1948 .code
1949 USE_GNUTLS=yes
1950 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1951 .endd
1952 in &_Local/Makefile_&, and again you may need to specify the locations of the
1953 library and include files. For example:
1954 .code
1955 USE_GNUTLS=yes
1956 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1957 TLS_INCLUDE=-I/usr/gnu/include
1958 .endd
1959 .cindex "pkg-config" "GnuTLS"
1960 If you have &'pkg-config'& available, then instead you can just use:
1961 .code
1962 USE_GNUTLS=yes
1963 USE_GNUTLS_PC=gnutls
1964 .endd
1965
1966 You do not need to set TLS_INCLUDE if the relevant directory is already
1967 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1968 given in chapter &<<CHAPTLS>>&.
1969
1970
1971
1972
1973 .section "Use of tcpwrappers" "SECID27"
1974
1975 .cindex "tcpwrappers, building Exim to support"
1976 .cindex "USE_TCP_WRAPPERS"
1977 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1978 .cindex "tcp_wrappers_daemon_name"
1979 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1980 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1981 alternative to Exim's own checking facilities for installations that are
1982 already making use of &'tcpwrappers'& for other purposes. To do this, you
1983 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1984 &_tcpd.h_& to be available at compile time, and also ensure that the library
1985 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1986 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1987 you might have
1988 .code
1989 USE_TCP_WRAPPERS=yes
1990 CFLAGS=-O -I/usr/local/include
1991 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1992 .endd
1993 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1994 files is &"exim"&. For example, the line
1995 .code
1996 exim : LOCAL  192.168.1.  .friendly.domain.example
1997 .endd
1998 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1999 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2000 All other connections are denied. The daemon name used by &'tcpwrappers'&
2001 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2002 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2003 configure file. Consult the &'tcpwrappers'& documentation for
2004 further details.
2005
2006
2007 .section "Including support for IPv6" "SECID28"
2008 .cindex "IPv6" "including support for"
2009 Exim contains code for use on systems that have IPv6 support. Setting
2010 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2011 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2012 where the IPv6 support is not fully integrated into the normal include and
2013 library files.
2014
2015 Two different types of DNS record for handling IPv6 addresses have been
2016 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2017 currently seen as the mainstream. Another record type called A6 was proposed
2018 as better than AAAA because it had more flexibility. However, it was felt to be
2019 over-complex, and its status was reduced to &"experimental"&.
2020 Exim used to
2021 have a compile option for including A6 record support but this has now been
2022 withdrawn.
2023
2024
2025
2026 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2027 .cindex "lookup modules"
2028 .cindex "dynamic modules"
2029 .cindex ".so building"
2030 On some platforms, Exim supports not compiling all lookup types directly into
2031 the main binary, instead putting some into external modules which can be loaded
2032 on demand.
2033 This permits packagers to build Exim with support for lookups with extensive
2034 library dependencies without requiring all users to install all of those
2035 dependencies.
2036 Most, but not all, lookup types can be built this way.
2037
2038 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2039 installed; Exim will only load modules from that directory, as a security
2040 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2041 for your OS; see &_OS/Makefile-Linux_& for an example.
2042 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2043 see &_src/EDITME_& for details.
2044
2045 Then, for each module to be loaded dynamically, define the relevant
2046 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2047 For example, this will build in lsearch but load sqlite and mysql support
2048 on demand:
2049 .code
2050 LOOKUP_LSEARCH=yes
2051 LOOKUP_SQLITE=2
2052 LOOKUP_MYSQL=2
2053 .endd
2054
2055
2056 .section "The building process" "SECID29"
2057 .cindex "build directory"
2058 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2059 created, run &'make'& at the top level. It determines the architecture and
2060 operating system types, and creates a build directory if one does not exist.
2061 For example, on a Sun system running Solaris 8, the directory
2062 &_build-SunOS5-5.8-sparc_& is created.
2063 .cindex "symbolic link" "to source files"
2064 Symbolic links to relevant source files are installed in the build directory.
2065
2066 If this is the first time &'make'& has been run, it calls a script that builds
2067 a make file inside the build directory, using the configuration files from the
2068 &_Local_& directory. The new make file is then passed to another instance of
2069 &'make'&. This does the real work, building a number of utility scripts, and
2070 then compiling and linking the binaries for the Exim monitor (if configured), a
2071 number of utility programs, and finally Exim itself. The command &`make
2072 makefile`& can be used to force a rebuild of the make file in the build
2073 directory, should this ever be necessary.
2074
2075 If you have problems building Exim, check for any comments there may be in the
2076 &_README_& file concerning your operating system, and also take a look at the
2077 FAQ, where some common problems are covered.
2078
2079
2080
2081 .section 'Output from &"make"&' "SECID283"
2082 The output produced by the &'make'& process for compile lines is often very
2083 unreadable, because these lines can be very long. For this reason, the normal
2084 output is suppressed by default, and instead output similar to that which
2085 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2086 each module that is being compiled or linked. However, it is still possible to
2087 get the full output, by calling &'make'& like this:
2088 .code
2089 FULLECHO='' make -e
2090 .endd
2091 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2092 command reflection in &'make'&. When you ask for the full output, it is
2093 given in addition to the short output.
2094
2095
2096
2097 .section "Overriding build-time options for Exim" "SECToverride"
2098 .cindex "build-time options, overriding"
2099 The main make file that is created at the beginning of the building process
2100 consists of the concatenation of a number of files which set configuration
2101 values, followed by a fixed set of &'make'& instructions. If a value is set
2102 more than once, the last setting overrides any previous ones. This provides a
2103 convenient way of overriding defaults. The files that are concatenated are, in
2104 order:
2105 .display
2106 &_OS/Makefile-Default_&
2107 &_OS/Makefile-_&<&'ostype'&>
2108 &_Local/Makefile_&
2109 &_Local/Makefile-_&<&'ostype'&>
2110 &_Local/Makefile-_&<&'archtype'&>
2111 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2112 &_OS/Makefile-Base_&
2113 .endd
2114 .cindex "&_Local/Makefile_&"
2115 .cindex "building Exim" "operating system type"
2116 .cindex "building Exim" "architecture type"
2117 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2118 architecture type. &_Local/Makefile_& is required to exist, and the building
2119 process fails if it is absent. The other three &_Local_& files are optional,
2120 and are often not needed.
2121
2122 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2123 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2124 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2125 values are used, thereby providing a means of forcing particular settings.
2126 Otherwise, the scripts try to get values from the &%uname%& command. If this
2127 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2128 of &'ad hoc'& transformations are then applied, to produce the standard names
2129 that Exim expects. You can run these scripts directly from the shell in order
2130 to find out what values are being used on your system.
2131
2132
2133 &_OS/Makefile-Default_& contains comments about the variables that are set
2134 therein. Some (but not all) are mentioned below. If there is something that
2135 needs changing, review the contents of this file and the contents of the make
2136 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2137 default values are.
2138
2139
2140 .cindex "building Exim" "overriding default settings"
2141 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2142 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2143 need to change the original files. Instead, you should make the changes by
2144 putting the new values in an appropriate &_Local_& file. For example,
2145 .cindex "Tru64-Unix build-time settings"
2146 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2147 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2148 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2149 called with the option &%-std1%&, to make it recognize some of the features of
2150 Standard C that Exim uses. (Most other compilers recognize Standard C by
2151 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2152 containing the lines
2153 .code
2154 CC=cc
2155 CFLAGS=-std1
2156 .endd
2157 If you are compiling for just one operating system, it may be easier to put
2158 these lines directly into &_Local/Makefile_&.
2159
2160 Keeping all your local configuration settings separate from the distributed
2161 files makes it easy to transfer them to new versions of Exim simply by copying
2162 the contents of the &_Local_& directory.
2163
2164
2165 .cindex "NIS lookup type" "including support for"
2166 .cindex "NIS+ lookup type" "including support for"
2167 .cindex "LDAP" "including support for"
2168 .cindex "lookup" "inclusion in binary"
2169 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2170 lookup, but not all systems have these components installed, so the default is
2171 not to include the relevant code in the binary. All the different kinds of file
2172 and database lookup that Exim supports are implemented as separate code modules
2173 which are included only if the relevant compile-time options are set. In the
2174 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2175 .code
2176 LOOKUP_LDAP=yes
2177 LOOKUP_NIS=yes
2178 LOOKUP_NISPLUS=yes
2179 .endd
2180 and similar settings apply to the other lookup types. They are all listed in
2181 &_src/EDITME_&. In many cases the relevant include files and interface
2182 libraries need to be installed before compiling Exim.
2183 .cindex "cdb" "including support for"
2184 However, there are some optional lookup types (such as cdb) for which
2185 the code is entirely contained within Exim, and no external include
2186 files or libraries are required. When a lookup type is not included in the
2187 binary, attempts to configure Exim to use it cause runtime configuration
2188 errors.
2189
2190 .cindex "pkg-config" "lookups"
2191 .cindex "pkg-config" "authenticators"
2192 Many systems now use a tool called &'pkg-config'& to encapsulate information
2193 about how to compile against a library; Exim has some initial support for
2194 being able to use pkg-config for lookups and authenticators.  For any given
2195 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2196 variable with the &`_PC`& suffix in the name and assign as the value the
2197 name of the package to be queried.  The results of querying via the
2198 &'pkg-config'& command will be added to the appropriate Makefile variables
2199 with &`+=`& directives, so your version of &'make'& will need to support that
2200 syntax.  For instance:
2201 .code
2202 LOOKUP_SQLITE=yes
2203 LOOKUP_SQLITE_PC=sqlite3
2204 AUTH_GSASL=yes
2205 AUTH_GSASL_PC=libgsasl
2206 AUTH_HEIMDAL_GSSAPI=yes
2207 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2208 .endd
2209
2210 .cindex "Perl" "including support for"
2211 Exim can be linked with an embedded Perl interpreter, allowing Perl
2212 subroutines to be called during string expansion. To enable this facility,
2213 .code
2214 EXIM_PERL=perl.o
2215 .endd
2216 must be defined in &_Local/Makefile_&. Details of this facility are given in
2217 chapter &<<CHAPperl>>&.
2218
2219 .cindex "X11 libraries, location of"
2220 The location of the X11 libraries is something that varies a lot between
2221 operating systems, and there may be different versions of X11 to cope
2222 with. Exim itself makes no use of X11, but if you are compiling the Exim
2223 monitor, the X11 libraries must be available.
2224 The following three variables are set in &_OS/Makefile-Default_&:
2225 .code
2226 X11=/usr/X11R6
2227 XINCLUDE=-I$(X11)/include
2228 XLFLAGS=-L$(X11)/lib
2229 .endd
2230 These are overridden in some of the operating-system configuration files. For
2231 example, in &_OS/Makefile-SunOS5_& there is
2232 .code
2233 X11=/usr/openwin
2234 XINCLUDE=-I$(X11)/include
2235 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2236 .endd
2237 If you need to override the default setting for your operating system, place a
2238 definition of all three of these variables into your
2239 &_Local/Makefile-<ostype>_& file.
2240
2241 .cindex "EXTRALIBS"
2242 If you need to add any extra libraries to the link steps, these can be put in a
2243 variable called EXTRALIBS, which appears in all the link commands, but by
2244 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2245 command for linking the main Exim binary, and not for any associated utilities.
2246
2247 .cindex "DBM libraries" "configuration for building"
2248 There is also DBMLIB, which appears in the link commands for binaries that
2249 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2250 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2251 binary, and which can be used, for example, to include additional X11
2252 libraries.
2253
2254 .cindex "configuration file" "editing"
2255 The make file copes with rebuilding Exim correctly if any of the configuration
2256 files are edited. However, if an optional configuration file is deleted, it is
2257 necessary to touch the associated non-optional file (that is,
2258 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2259
2260
2261 .section "OS-specific header files" "SECID30"
2262 .cindex "&_os.h_&"
2263 .cindex "building Exim" "OS-specific C header files"
2264 The &_OS_& directory contains a number of files with names of the form
2265 &_os.h-<ostype>_&. These are system-specific C header files that should not
2266 normally need to be changed. There is a list of macro settings that are
2267 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2268 are porting Exim to a new operating system.
2269
2270
2271
2272 .section "Overriding build-time options for the monitor" "SECID31"
2273 .cindex "building Eximon"
2274 A similar process is used for overriding things when building the Exim monitor,
2275 where the files that are involved are
2276 .display
2277 &_OS/eximon.conf-Default_&
2278 &_OS/eximon.conf-_&<&'ostype'&>
2279 &_Local/eximon.conf_&
2280 &_Local/eximon.conf-_&<&'ostype'&>
2281 &_Local/eximon.conf-_&<&'archtype'&>
2282 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2283 .endd
2284 .cindex "&_Local/eximon.conf_&"
2285 As with Exim itself, the final three files need not exist, and in this case the
2286 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2287 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2288 variables of the same name, preceded by EXIMON_. For example, setting
2289 EXIMON_LOG_DEPTH in the environment overrides the value of
2290 LOG_DEPTH at runtime.
2291 .ecindex IIDbuex
2292
2293
2294 .section "Installing Exim binaries and scripts" "SECID32"
2295 .cindex "installing Exim"
2296 .cindex "BIN_DIRECTORY"
2297 The command &`make install`& runs the &(exim_install)& script with no
2298 arguments. The script copies binaries and utility scripts into the directory
2299 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2300 .cindex "setuid" "installing Exim with"
2301 The install script copies files only if they are newer than the files they are
2302 going to replace. The Exim binary is required to be owned by root and have the
2303 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2304 install`& as root so that it can set up the Exim binary in this way. However, in
2305 some special situations (for example, if a host is doing no local deliveries)
2306 it may be possible to run Exim without making the binary setuid root (see
2307 chapter &<<CHAPsecurity>>& for details).
2308
2309 .cindex "CONFIGURE_FILE"
2310 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2311 in &_Local/Makefile_&. If this names a single file, and the file does not
2312 exist, the default configuration file &_src/configure.default_& is copied there
2313 by the installation script. If a runtime configuration file already exists, it
2314 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2315 alternative files, no default is installed.
2316
2317 .cindex "system aliases file"
2318 .cindex "&_/etc/aliases_&"
2319 One change is made to the default configuration file when it is installed: the
2320 default configuration contains a router that references a system aliases file.
2321 The path to this file is set to the value specified by
2322 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2323 If the system aliases file does not exist, the installation script creates it,
2324 and outputs a comment to the user.
2325
2326 The created file contains no aliases, but it does contain comments about the
2327 aliases a site should normally have. Mail aliases have traditionally been
2328 kept in &_/etc/aliases_&. However, some operating systems are now using
2329 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2330 Exim's configuration if necessary.
2331
2332 The default configuration uses the local host's name as the only local domain,
2333 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2334 running as the local user. System aliases and &_.forward_& files in users' home
2335 directories are supported, but no NIS or NIS+ support is configured. Domains
2336 other than the name of the local host are routed using the DNS, with delivery
2337 over SMTP.
2338
2339 It is possible to install Exim for special purposes (such as building a binary
2340 distribution) in a private part of the file system. You can do this by a
2341 command such as
2342 .code
2343 make DESTDIR=/some/directory/ install
2344 .endd
2345 This has the effect of pre-pending the specified directory to all the file
2346 paths, except the name of the system aliases file that appears in the default
2347 configuration. (If a default alias file is created, its name &'is'& modified.)
2348 For backwards compatibility, ROOT is used if DESTDIR is not set,
2349 but this usage is deprecated.
2350
2351 .cindex "installing Exim" "what is not installed"
2352 Running &'make install'& does not copy the Exim 4 conversion script
2353 &'convert4r4'&. You will probably run this only once if you are
2354 upgrading from Exim 3. None of the documentation files in the &_doc_&
2355 directory are copied, except for the info files when you have set
2356 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2357
2358 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2359 to their names. The Exim binary itself, however, is handled differently. It is
2360 installed under a name that includes the version number and the compile number,
2361 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2362 called &_exim_& to point to the binary. If you are updating a previous version
2363 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2364 from the directory (as seen by other processes).
2365
2366 .cindex "installing Exim" "testing the script"
2367 If you want to see what the &'make install'& will do before running it for
2368 real, you can pass the &%-n%& option to the installation script by this
2369 command:
2370 .code
2371 make INSTALL_ARG=-n install
2372 .endd
2373 The contents of the variable INSTALL_ARG are passed to the installation
2374 script. You do not need to be root to run this test. Alternatively, you can run
2375 the installation script directly, but this must be from within the build
2376 directory. For example, from the top-level Exim directory you could use this
2377 command:
2378 .code
2379 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2380 .endd
2381 .cindex "installing Exim" "install script options"
2382 There are two other options that can be supplied to the installation script.
2383
2384 .ilist
2385 &%-no_chown%& bypasses the call to change the owner of the installed binary
2386 to root, and the call to make it a setuid binary.
2387 .next
2388 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2389 installed binary.
2390 .endlist
2391
2392 INSTALL_ARG can be used to pass these options to the script. For example:
2393 .code
2394 make INSTALL_ARG=-no_symlink install
2395 .endd
2396 The installation script can also be given arguments specifying which files are
2397 to be copied. For example, to install just the Exim binary, and nothing else,
2398 without creating the symbolic link, you could use:
2399 .code
2400 make INSTALL_ARG='-no_symlink exim' install
2401 .endd
2402
2403
2404
2405 .section "Installing info documentation" "SECTinsinfdoc"
2406 .cindex "installing Exim" "&'info'& documentation"
2407 Not all systems use the GNU &'info'& system for documentation, and for this
2408 reason, the Texinfo source of Exim's documentation is not included in the main
2409 distribution. Instead it is available separately from the FTP site (see section
2410 &<<SECTavail>>&).
2411
2412 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2413 source of the documentation is found in the source tree, running &`make
2414 install`& automatically builds the info files and installs them.
2415
2416
2417
2418 .section "Setting up the spool directory" "SECID33"
2419 .cindex "spool directory" "creating"
2420 When it starts up, Exim tries to create its spool directory if it does not
2421 exist. The Exim uid and gid are used for the owner and group of the spool
2422 directory. Sub-directories are automatically created in the spool directory as
2423 necessary.
2424
2425
2426
2427
2428 .section "Testing" "SECID34"
2429 .cindex "testing" "installation"
2430 Having installed Exim, you can check that the runtime configuration file is
2431 syntactically valid by running the following command, which assumes that the
2432 Exim binary directory is within your PATH environment variable:
2433 .code
2434 exim -bV
2435 .endd
2436 If there are any errors in the configuration file, Exim outputs error messages.
2437 Otherwise it outputs the version number and build date,
2438 the DBM library that is being used, and information about which drivers and
2439 other optional code modules are included in the binary.
2440 Some simple routing tests can be done by using the address testing option. For
2441 example,
2442 .display
2443 &`exim -bt`& <&'local username'&>
2444 .endd
2445 should verify that it recognizes a local mailbox, and
2446 .display
2447 &`exim -bt`& <&'remote address'&>
2448 .endd
2449 a remote one. Then try getting it to deliver mail, both locally and remotely.
2450 This can be done by passing messages directly to Exim, without going through a
2451 user agent. For example:
2452 .code
2453 exim -v postmaster@your.domain.example
2454 From: user@your.domain.example
2455 To: postmaster@your.domain.example
2456 Subject: Testing Exim
2457
2458 This is a test message.
2459 ^D
2460 .endd
2461 The &%-v%& option causes Exim to output some verification of what it is doing.
2462 In this case you should see copies of three log lines, one for the message's
2463 arrival, one for its delivery, and one containing &"Completed"&.
2464
2465 .cindex "delivery" "problems with"
2466 If you encounter problems, look at Exim's log files (&'mainlog'& and
2467 &'paniclog'&) to see if there is any relevant information there. Another source
2468 of information is running Exim with debugging turned on, by specifying the
2469 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2470 with debugging turned on by a command of the form
2471 .display
2472 &`exim -d -M`& <&'exim-message-id'&>
2473 .endd
2474 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2475 produces rather a lot of output, but you can cut this down to specific areas.
2476 For example, if you use &%-d-all+route%& only the debugging information
2477 relevant to routing is included. (See the &%-d%& option in chapter
2478 &<<CHAPcommandline>>& for more details.)
2479
2480 .cindex '&"sticky"& bit'
2481 .cindex "lock files"
2482 One specific problem that has shown up on some sites is the inability to do
2483 local deliveries into a shared mailbox directory, because it does not have the
2484 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2485 writing to a mailbox file, and if it cannot create the lock file, the delivery
2486 is deferred. You can get round this either by setting the &"sticky bit"& on the
2487 directory, or by setting a specific group for local deliveries and allowing
2488 that group to create files in the directory (see the comments above the
2489 &(local_delivery)& transport in the default configuration file). Another
2490 approach is to configure Exim not to use lock files, but just to rely on
2491 &[fcntl()]& locking instead. However, you should do this only if all user
2492 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2493 see chapter &<<CHAPappendfile>>&.
2494
2495 One thing that cannot be tested on a system that is already running an MTA is
2496 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2497 &%-oX%& option can be used to run an Exim daemon that listens on some other
2498 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2499 &'exim_checkaccess'& utility can be used to check out policy controls on
2500 incoming SMTP mail.
2501
2502 Testing a new version on a system that is already running Exim can most easily
2503 be done by building a binary with a different CONFIGURE_FILE setting. From
2504 within the runtime configuration, all other file and directory names
2505 that Exim uses can be altered, in order to keep it entirely clear of the
2506 production version.
2507
2508
2509 .section "Replacing another MTA with Exim" "SECID35"
2510 .cindex "replacing another MTA"
2511 Building and installing Exim for the first time does not of itself put it in
2512 general use. The name by which the system's MTA is called by mail user agents
2513 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2514 operating system), and it is necessary to make this name point to the &'exim'&
2515 binary in order to get the user agents to pass messages to Exim. This is
2516 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2517 or &_/usr/lib/sendmail_&
2518 .cindex "symbolic link" "to &'exim'& binary"
2519 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2520 privilege and executable status from the old MTA. It is then necessary to stop
2521 and restart the mailer daemon, if one is running.
2522
2523 .cindex "FreeBSD, MTA indirection"
2524 .cindex "&_/etc/mail/mailer.conf_&"
2525 Some operating systems have introduced alternative ways of switching MTAs. For
2526 example, if you are running FreeBSD, you need to edit the file
2527 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2528 described. A typical example of the contents of this file for running Exim is
2529 as follows:
2530 .code
2531 sendmail            /usr/exim/bin/exim
2532 send-mail           /usr/exim/bin/exim
2533 mailq               /usr/exim/bin/exim -bp
2534 newaliases          /usr/bin/true
2535 .endd
2536 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2537 your Exim installation is &"live"&. Check it by sending a message from your
2538 favourite user agent.
2539
2540 You should consider what to tell your users about the change of MTA. Exim may
2541 have different capabilities to what was previously running, and there are
2542 various operational differences such as the text of messages produced by
2543 command line options and in bounce messages. If you allow your users to make
2544 use of Exim's filtering capabilities, you should make the document entitled
2545 &'Exim's interface to mail filtering'& available to them.
2546
2547
2548
2549 .section "Running the daemon" SECTdaemonLaunch
2550 The most common command line for launching the Exim daemon looks like
2551 .code
2552 exim -bd -q5m
2553 .endd
2554 This starts a daemon which
2555 .ilist
2556 listens for incoming smtp connections, launching handler processes for
2557 each new one
2558 .next
2559 starts a queue-runner process every five minutes, to inspect queued messages
2560 and run delivery attempts on any that have arrived at their retry time
2561 .endlist
2562 Should a queue run take longer than the time between queue-runner starts,
2563 they will run in parallel.
2564 Numbers of jobs of the various types are subject to policy controls
2565 defined in the configuration.
2566
2567
2568 .section "Upgrading Exim" "SECID36"
2569 .cindex "upgrading Exim"
2570 If you are already running Exim on your host, building and installing a new
2571 version automatically makes it available to MUAs, or any other programs that
2572 call the MTA directly. However, if you are running an Exim daemon, you do need
2573 .cindex restart "on HUP signal"
2574 .cindex signal "HUP, to restart"
2575 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2576 new binary. You do not need to stop processing mail in order to install a new
2577 version of Exim. The install script does not modify an existing runtime
2578 configuration file.
2579
2580
2581
2582
2583 .section "Stopping the Exim daemon on Solaris" "SECID37"
2584 .cindex "Solaris" "stopping Exim on"
2585 The standard command for stopping the mailer daemon on Solaris is
2586 .code
2587 /etc/init.d/sendmail stop
2588 .endd
2589 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2590 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2591 for the text &"sendmail"&; this is not present because the actual program name
2592 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2593 solution is to replace the line that finds the process id with something like
2594 .code
2595 pid=`cat /var/spool/exim/exim-daemon.pid`
2596 .endd
2597 to obtain the daemon's pid directly from the file that Exim saves it in.
2598
2599 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2600 still be received from local processes, and if automatic delivery is configured
2601 (the normal case), deliveries will still occur.
2602
2603
2604
2605
2606 . ////////////////////////////////////////////////////////////////////////////
2607 . ////////////////////////////////////////////////////////////////////////////
2608
2609 .chapter "The Exim command line" "CHAPcommandline"
2610 .scindex IIDclo1 "command line" "options"
2611 .scindex IIDclo2 "options" "command line"
2612 Exim's command line takes the standard Unix form of a sequence of options,
2613 each starting with a hyphen character, followed by a number of arguments. The
2614 options are compatible with the main options of Sendmail, and there are also
2615 some additional options, some of which are compatible with Smail 3. Certain
2616 combinations of options do not make sense, and provoke an error if used.
2617 The form of the arguments depends on which options are set.
2618
2619
2620 .section "Setting options by program name" "SECID38"
2621 .cindex "&'mailq'&"
2622 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2623 were present before any other options.
2624 The &%-bp%& option requests a listing of the contents of the mail queue on the
2625 standard output.
2626 This feature is for compatibility with some systems that contain a command of
2627 that name in one of the standard libraries, symbolically linked to
2628 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2629
2630 .cindex "&'rsmtp'&"
2631 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2632 were present before any other options, for compatibility with Smail. The
2633 &%-bS%& option is used for reading in a number of messages in batched SMTP
2634 format.
2635
2636 .cindex "&'rmail'&"
2637 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2638 &%-oee%& options were present before any other options, for compatibility with
2639 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2640
2641 .cindex "&'runq'&"
2642 .cindex "queue runner"
2643 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2644 were present before any other options, for compatibility with Smail. The &%-q%&
2645 option causes a single queue runner process to be started.
2646
2647 .cindex "&'newaliases'&"
2648 .cindex "alias file" "building"
2649 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2650 If Exim is called under the name &'newaliases'& it behaves as if the option
2651 &%-bi%& were present before any other options, for compatibility with Sendmail.
2652 This option is used for rebuilding Sendmail's alias file. Exim does not have
2653 the concept of a single alias file, but can be configured to run a given
2654 command if called with the &%-bi%& option.
2655
2656
2657 .section "Trusted and admin users" "SECTtrustedadmin"
2658 Some Exim options are available only to &'trusted users'& and others are
2659 available only to &'admin users'&. In the description below, the phrases &"Exim
2660 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2661 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2662 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2663
2664 .ilist
2665 .cindex "trusted users" "definition of"
2666 .cindex "user" "trusted definition of"
2667 The trusted users are root, the Exim user, any user listed in the
2668 &%trusted_users%& configuration option, and any user whose current group or any
2669 supplementary group is one of those listed in the &%trusted_groups%&
2670 configuration option. Note that the Exim group is not automatically trusted.
2671
2672 .cindex '&"From"& line'
2673 .cindex "envelope from"
2674 .cindex "envelope sender"
2675 Trusted users are always permitted to use the &%-f%& option or a leading
2676 &"From&~"& line to specify the envelope sender of a message that is passed to
2677 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2678 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2679 users to set envelope senders.
2680
2681 .chindex From:
2682 .chindex Sender:
2683 For a trusted user, there is never any check on the contents of the &'From:'&
2684 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2685 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2686
2687 Trusted users may also specify a host name, host address, interface address,
2688 protocol name, ident value, and authentication data when submitting a message
2689 locally. Thus, they are able to insert messages into Exim's queue locally that
2690 have the characteristics of messages received from a remote host. Untrusted
2691 users may in some circumstances use &%-f%&, but can never set the other values
2692 that are available to trusted users.
2693 .next
2694 .cindex "user" "admin definition of"
2695 .cindex "admin user" "definition of"
2696 The admin users are root, the Exim user, and any user that is a member of the
2697 Exim group or of any group listed in the &%admin_groups%& configuration option.
2698 The current group does not have to be one of these groups.
2699
2700 Admin users are permitted to list the queue, and to carry out certain
2701 operations on messages, for example, to force delivery failures. It is also
2702 necessary to be an admin user in order to see the full information provided by
2703 the Exim monitor, and full debugging output.
2704
2705 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2706 Exim to attempt delivery of messages on its queue is restricted to admin users.
2707 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2708 option false (that is, specifying &%no_prod_requires_admin%&).
2709
2710 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2711 is restricted to admin users unless &%queue_list_requires_admin%& is set
2712 false.
2713 .endlist
2714
2715
2716 &*Warning*&: If you configure your system so that admin users are able to
2717 edit Exim's configuration file, you are giving those users an easy way of
2718 getting root. There is further discussion of this issue at the start of chapter
2719 &<<CHAPconf>>&.
2720
2721
2722
2723
2724 .section "Command line options" "SECID39"
2725 Exim's command line options are described in alphabetical order below. If none
2726 of the options that specifies a specific action (such as starting the daemon or
2727 a queue runner, or testing an address, or receiving a message in a specific
2728 format, or listing the queue) are present, and there is at least one argument
2729 on the command line, &%-bm%& (accept a local message on the standard input,
2730 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2731 outputs a brief message about itself and exits.
2732
2733 . ////////////////////////////////////////////////////////////////////////////
2734 . Insert a stylized XML comment here, to identify the start of the command line
2735 . options. This is for the benefit of the Perl script that automatically
2736 . creates a man page for the options.
2737 . ////////////////////////////////////////////////////////////////////////////
2738
2739 .literal xml
2740 <!-- === Start of command line options === -->
2741 .literal off
2742
2743
2744 .vlist
2745 .cmdopt "--" "--"
2746 .cindex "options" "command line; terminating"
2747 This is a pseudo-option whose only purpose is to terminate the options and
2748 therefore to cause subsequent command line items to be treated as arguments
2749 rather than options, even if they begin with hyphens.
2750
2751 .cmdopt --help
2752 This option causes Exim to output a few sentences stating what it is.
2753 The same output is generated if the Exim binary is called with no options and
2754 no arguments.
2755
2756 .cmdopt --version
2757 This option is an alias for &%-bV%& and causes version information to be
2758 displayed.
2759
2760 .vitem &%-Ac%& &&&
2761        &%-Am%&
2762 .oindex "&%-Ac%&"
2763 .oindex "&%-Am%&"
2764 These options are used by Sendmail for selecting configuration files and are
2765 ignored by Exim.
2766
2767 .cmdopt -B <&'type'&>
2768 .oindex "&%-B%&"
2769 .cindex "8-bit characters"
2770 .cindex "Sendmail compatibility" "8-bit characters"
2771 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2772 clean; it ignores this option.
2773
2774 .cmdopt -bd
2775 .cindex "daemon"
2776 .cindex "SMTP" "listener"
2777 .cindex "queue runner"
2778 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2779 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2780 that the daemon should also initiate periodic queue runs.
2781
2782 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2783 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2784 disconnect from the controlling terminal. When running this way, it can be
2785 stopped by pressing ctrl-C.
2786
2787 By default, Exim listens for incoming connections to the standard SMTP port on
2788 all the host's running interfaces. However, it is possible to listen on other
2789 ports, on multiple ports, and only on specific interfaces. Chapter
2790 &<<CHAPinterfaces>>& contains a description of the options that control this.
2791
2792 When a listening daemon
2793 .cindex "daemon" "process id (pid)"
2794 .cindex "pid (process id)" "of daemon"
2795 is started without the use of &%-oX%& (that is, without overriding the normal
2796 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2797 in Exim's spool directory. This location can be overridden by setting
2798 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2799 running as root.
2800
2801 When &%-oX%& is used on the command line to start a listening daemon, the
2802 process id is not written to the normal pid file path. However, &%-oP%& can be
2803 used to specify a path on the command line if a pid file is required.
2804
2805 The SIGHUP signal
2806 .cindex "SIGHUP"
2807 .cindex restart "on HUP signal"
2808 .cindex signal "HUP, to restart"
2809 .cindex "daemon" "restarting"
2810 .cindex signal "to reload configuration"
2811 .cindex daemon "reload configuration"
2812 .cindex reload configuration
2813 can be used to cause the daemon to re-execute itself. This should be done
2814 whenever Exim's configuration file, or any file that is incorporated into it by
2815 means of the &%.include%& facility, is changed, and also whenever a new version
2816 of Exim is installed. It is not necessary to do this when other files that are
2817 referenced from the configuration (for example, alias files) are changed,
2818 because these are reread each time they are used.
2819
2820 .new
2821 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2822 to cleanly shut down.
2823 Subprocesses handling recceiving or delivering messages,
2824 or for scanning the queue,
2825 will not be affected by the termination of the daemon process.
2826 .wen
2827
2828 .cmdopt -bdf
2829 This option has the same effect as &%-bd%& except that it never disconnects
2830 from the controlling terminal, even when no debugging is specified.
2831
2832 .cmdopt -be
2833 .cindex "testing" "string expansion"
2834 .cindex "expansion" "testing"
2835 Run Exim in expansion testing mode. Exim discards its root privilege, to
2836 prevent ordinary users from using this mode to read otherwise inaccessible
2837 files. If no arguments are given, Exim runs interactively, prompting for lines
2838 of data. Otherwise, it processes each argument in turn.
2839
2840 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2841 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2842 used without command line arguments. If successful, it uses the &[readline()]&
2843 function, which provides extensive line-editing facilities, for reading the
2844 test data. A line history is supported.
2845
2846 Long expansion expressions can be split over several lines by using backslash
2847 continuations. As in Exim's runtime configuration, white space at the start of
2848 continuation lines is ignored. Each argument or data line is passed through the
2849 string expansion mechanism, and the result is output. Variable values from the
2850 configuration file (for example, &$qualify_domain$&) are available, but no
2851 message-specific values (such as &$message_exim_id$&) are set, because no message
2852 is being processed (but see &%-bem%& and &%-Mset%&).
2853
2854 &*Note*&: If you use this mechanism to test lookups, and you change the data
2855 files or databases you are using, you must exit and restart Exim before trying
2856 the same lookup again. Otherwise, because each Exim process caches the results
2857 of lookups, you will just get the same result as before.
2858
2859 Macro processing is done on lines before string-expansion: new macros can be
2860 defined and macros will be expanded.
2861 Because macros in the config file are often used for secrets, those are only
2862 available to admin users.
2863
2864 .new
2865 The word &"set"& at the start of a line, followed by a single space,
2866 is recognised specially as defining a value for a variable.
2867 The syntax is otherwise the same as the ACL modifier &"set ="&.
2868 .wen
2869
2870 .cmdopt -bem <&'filename'&>
2871 .cindex "testing" "string expansion"
2872 .cindex "expansion" "testing"
2873 This option operates like &%-be%& except that it must be followed by the name
2874 of a file. For example:
2875 .code
2876 exim -bem /tmp/testmessage
2877 .endd
2878 The file is read as a message (as if receiving a locally-submitted non-SMTP
2879 message) before any of the test expansions are done. Thus, message-specific
2880 variables such as &$message_size$& and &$header_from:$& are available. However,
2881 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2882 recipients are read from the headers in the normal way, and are shown in the
2883 &$recipients$& variable. Note that recipients cannot be given on the command
2884 line, because further arguments are taken as strings to expand (just like
2885 &%-be%&).
2886
2887 .cmdopt -bF <&'filename'&>
2888 .cindex "system filter" "testing"
2889 .cindex "testing" "system filter"
2890 This option is the same as &%-bf%& except that it assumes that the filter being
2891 tested is a system filter. The additional commands that are available only in
2892 system filters are recognized.
2893
2894 .cmdopt -bf <&'filename'&>
2895 .cindex "filter" "testing"
2896 .cindex "testing" "filter file"
2897 .cindex "forward file" "testing"
2898 .cindex "testing" "forward file"
2899 .cindex "Sieve filter" "testing"
2900 This option runs Exim in user filter testing mode; the file is the filter file
2901 to be tested, and a test message must be supplied on the standard input. If
2902 there are no message-dependent tests in the filter, an empty file can be
2903 supplied.
2904
2905 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2906 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2907 filter and a user filter in the same run. For example:
2908 .code
2909 exim -bF /system/filter -bf /user/filter </test/message
2910 .endd
2911 This is helpful when the system filter adds header lines or sets filter
2912 variables that are used by the user filter.
2913
2914 If the test filter file does not begin with one of the special lines
2915 .code
2916 # Exim filter
2917 # Sieve filter
2918 .endd
2919 it is taken to be a normal &_.forward_& file, and is tested for validity under
2920 that interpretation. See sections &<<SECTitenonfilred>>& to
2921 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2922 redirection lists.
2923
2924 The result of an Exim command that uses &%-bf%&, provided no errors are
2925 detected, is a list of the actions that Exim would try to take if presented
2926 with the message for real. More details of filter testing are given in the
2927 separate document entitled &'Exim's interfaces to mail filtering'&.
2928
2929 When testing a filter file,
2930 .cindex "&""From""& line"
2931 .cindex "envelope from"
2932 .cindex "envelope sender"
2933 .oindex "&%-f%&" "for filter testing"
2934 the envelope sender can be set by the &%-f%& option,
2935 or by a &"From&~"& line at the start of the test message. Various parameters
2936 that would normally be taken from the envelope recipient address of the message
2937 can be set by means of additional command line options (see the next four
2938 options).
2939
2940 .cmdopt -bfd <&'domain'&>
2941 .vindex "&$qualify_domain$&"
2942 This sets the domain of the recipient address when a filter file is being
2943 tested by means of the &%-bf%& option. The default is the value of
2944 &$qualify_domain$&.
2945
2946 .cmdopt -bfl <&'local&~part'&>
2947 This sets the local part of the recipient address when a filter file is being
2948 tested by means of the &%-bf%& option. The default is the username of the
2949 process that calls Exim. A local part should be specified with any prefix or
2950 suffix stripped, because that is how it appears to the filter when a message is
2951 actually being delivered.
2952
2953 .cmdopt -bfp <&'prefix'&>
2954 .cindex affix "filter testing"
2955 This sets the prefix of the local part of the recipient address when a filter
2956 file is being tested by means of the &%-bf%& option. The default is an empty
2957 prefix.
2958
2959 .cmdopt -bfs <&'suffix'&>
2960 .cindex affix "filter testing"
2961 This sets the suffix of the local part of the recipient address when a filter
2962 file is being tested by means of the &%-bf%& option. The default is an empty
2963 suffix.
2964
2965 .cmdopt -bh <&'IP&~address'&>
2966 .cindex "testing" "incoming SMTP"
2967 .cindex "SMTP" "testing incoming"
2968 .cindex "testing" "relay control"
2969 .cindex "relaying" "testing configuration"
2970 .cindex "policy control" "testing"
2971 .cindex "debugging" "&%-bh%& option"
2972 This option runs a fake SMTP session as if from the given IP address, using the
2973 standard input and output. The IP address may include a port number at the end,
2974 after a full stop. For example:
2975 .code
2976 exim -bh 10.9.8.7.1234
2977 exim -bh fe80::a00:20ff:fe86:a061.5678
2978 .endd
2979 When an IPv6 address is given, it is converted into canonical form. In the case
2980 of the second example above, the value of &$sender_host_address$& after
2981 conversion to the canonical form is
2982 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2983
2984 Comments as to what is going on are written to the standard error file. These
2985 include lines beginning with &"LOG"& for anything that would have been logged.
2986 This facility is provided for testing configuration options for incoming
2987 messages, to make sure they implement the required policy. For example, you can
2988 test your relay controls using &%-bh%&.
2989
2990 &*Warning 1*&:
2991 .cindex "RFC 1413"
2992 You can test features of the configuration that rely on ident (RFC 1413)
2993 information by using the &%-oMt%& option. However, Exim cannot actually perform
2994 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2995 connection.
2996
2997 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2998 are also skipped when testing using &%-bh%&. If you want these callouts to
2999 occur, use &%-bhc%& instead.
3000
3001 Messages supplied during the testing session are discarded, and nothing is
3002 written to any of the real log files. There may be pauses when DNS (and other)
3003 lookups are taking place, and of course these may time out. The &%-oMi%& option
3004 can be used to specify a specific IP interface and port if this is important,
3005 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3006 session were authenticated.
3007
3008 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3009 output just states whether a given recipient address from a given host is
3010 acceptable or not. See section &<<SECTcheckaccess>>&.
3011
3012 Features such as authentication and encryption, where the client input is not
3013 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3014 specialized SMTP test program such as
3015 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3016
3017 .cmdopt -bhc <&'IP&~address'&>
3018 This option operates in the same way as &%-bh%&, except that address
3019 verification callouts are performed if required. This includes consulting and
3020 updating the callout cache database.
3021
3022 .cmdopt -bi
3023 .cindex "alias file" "building"
3024 .cindex "building alias file"
3025 .cindex "Sendmail compatibility" "&%-bi%& option"
3026 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3027 Exim does not have the concept of a single alias file, and so it cannot mimic
3028 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3029 tend to appear in various scripts such as NIS make files, so the option must be
3030 recognized.
3031
3032 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3033 configuration option is run, under the uid and gid of the caller of Exim. If
3034 the &%-oA%& option is used, its value is passed to the command as an argument.
3035 The command set by &%bi_command%& may not contain arguments. The command can
3036 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3037 if this is required. If the &%bi_command%& option is not set, calling Exim with
3038 &%-bi%& is a no-op.
3039
3040 . // Keep :help first, then the rest in alphabetical order
3041 .cmdopt -bI:help
3042 .cindex "querying exim information"
3043 We shall provide various options starting &`-bI:`& for querying Exim for
3044 information.  The output of many of these will be intended for machine
3045 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3046 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3047 options shall cause Exim to exit after producing the requested output.
3048
3049 .cmdopt -bI:dscp
3050 .cindex "DSCP" "values"
3051 This option causes Exim to emit an alphabetically sorted list of all
3052 recognised DSCP names.
3053
3054 .cmdopt -bI:sieve
3055 .cindex "Sieve filter" "capabilities"
3056 This option causes Exim to emit an alphabetically sorted list of all supported
3057 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3058 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3059 &`SIEVE`& capability response line.  As the precise list may depend upon
3060 compile-time build options, which this option will adapt to, this is the only
3061 way to guarantee a correct response.
3062
3063 .cmdopt -bm
3064 .cindex "local message reception"
3065 This option runs an Exim receiving process that accepts an incoming,
3066 locally-generated message on the standard input. The recipients are given as the
3067 command arguments (except when &%-t%& is also present &-- see below). Each
3068 argument can be a comma-separated list of RFC 2822 addresses. This is the
3069 default option for selecting the overall action of an Exim call; it is assumed
3070 if no other conflicting option is present.
3071
3072 If any addresses in the message are unqualified (have no domain), they are
3073 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3074 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3075 suppressing this for special cases.
3076
3077 Policy checks on the contents of local messages can be enforced by means of
3078 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3079
3080 .cindex "return code" "for &%-bm%&"
3081 The return code is zero if the message is successfully accepted. Otherwise, the
3082 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3083
3084 The format
3085 .cindex "message" "format"
3086 .cindex "format" "message"
3087 .cindex "&""From""& line"
3088 .cindex "UUCP" "&""From""& line"
3089 .cindex "Sendmail compatibility" "&""From""& line"
3090 of the message must be as defined in RFC 2822, except that, for
3091 compatibility with Sendmail and Smail, a line in one of the forms
3092 .code
3093 From sender Fri Jan  5 12:55 GMT 1997
3094 From sender Fri, 5 Jan 97 12:55:01
3095 .endd
3096 (with the weekday optional, and possibly with additional text after the date)
3097 is permitted to appear at the start of the message. There appears to be no
3098 authoritative specification of the format of this line. Exim recognizes it by
3099 matching against the regular expression defined by the &%uucp_from_pattern%&
3100 option, which can be changed if necessary.
3101
3102 .oindex "&%-f%&" "overriding &""From""& line"
3103 The specified sender is treated as if it were given as the argument to the
3104 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3105 preference to the address taken from the message. The caller of Exim must be a
3106 trusted user for the sender of a message to be set in this way.
3107
3108 .cmdopt -bmalware <&'filename'&>
3109 .cindex "testing", "malware"
3110 .cindex "malware scan test"
3111 This debugging option causes Exim to scan the given file or directory
3112 (depending on the used scanner interface),
3113 using the malware scanning framework.  The option of &%av_scanner%& influences
3114 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3115 the expansion should have defaults which apply to this invocation.  ACLs are
3116 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3117 will never be populated and &%-bmalware%& will fail.
3118
3119 Exim will have changed working directory before resolving the filename, so
3120 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3121 user when it tries to open the file, rather than as the invoking user.
3122 This option requires admin privileges.
3123
3124 The &%-bmalware%& option will not be extended to be more generally useful,
3125 there are better tools for file-scanning.  This option exists to help
3126 administrators verify their Exim and AV scanner configuration.
3127
3128 .cmdopt -bnq
3129 .cindex "address qualification, suppressing"
3130 By default, Exim automatically qualifies unqualified addresses (those
3131 without domains) that appear in messages that are submitted locally (that
3132 is, not over TCP/IP). This qualification applies both to addresses in
3133 envelopes, and addresses in header lines. Sender addresses are qualified using
3134 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3135 defaults to the value of &%qualify_domain%&).
3136
3137 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3138 being used to re-submit messages that originally came from remote hosts after
3139 content scanning, you probably do not want to qualify unqualified addresses in
3140 header lines. (Such lines will be present only if you have not enabled a header
3141 syntax check in the appropriate ACL.)
3142
3143 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3144 messages that originate on the local host. When this is used, unqualified
3145 addresses in the envelope provoke errors (causing message rejection) and
3146 unqualified addresses in header lines are left alone.
3147
3148
3149 .cmdopt -bP
3150 .cindex "configuration options" "extracting"
3151 .cindex "options" "configuration &-- extracting"
3152 If this option is given with no arguments, it causes the values of all Exim's
3153 main configuration options to be written to the standard output. The values
3154 of one or more specific options can be requested by giving their names as
3155 arguments, for example:
3156 .code
3157 exim -bP qualify_domain hold_domains
3158 .endd
3159 .cindex "hiding configuration option values"
3160 .cindex "configuration options" "hiding value of"
3161 .cindex "options" "hiding value of"
3162 However, any option setting that is preceded by the word &"hide"& in the
3163 configuration file is not shown in full, except to an admin user. For other
3164 users, the output is as in this example:
3165 .code
3166 mysql_servers = <value not displayable>
3167 .endd
3168 If &%config%& is given as an argument, the config is
3169 output, as it was parsed, any include file resolved, any comment removed.
3170
3171 If &%config_file%& is given as an argument, the name of the runtime
3172 configuration file is output. (&%configure_file%& works too, for
3173 backward compatibility.)
3174 If a list of configuration files was supplied, the value that is output here
3175 is the name of the file that was actually used.
3176
3177 .cindex "options" "hiding name of"
3178 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3179 name will not be output.
3180
3181 .cindex "daemon" "process id (pid)"
3182 .cindex "pid (process id)" "of daemon"
3183 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3184 directories where log files and daemon pid files are written are output,
3185 respectively. If these values are unset, log files are written in a
3186 sub-directory of the spool directory called &%log%&, and the pid file is
3187 written directly into the spool directory.
3188
3189 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3190 .code
3191 exim -bP +local_domains
3192 .endd
3193 it searches for a matching named list of any type (domain, host, address, or
3194 local part) and outputs what it finds.
3195
3196 .cindex "options" "router &-- extracting"
3197 .cindex "options" "transport &-- extracting"
3198 .cindex "options" "authenticator &-- extracting"
3199 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3200 followed by the name of an appropriate driver instance, the option settings for
3201 that driver are output. For example:
3202 .code
3203 exim -bP transport local_delivery
3204 .endd
3205 The generic driver options are output first, followed by the driver's private
3206 options. A list of the names of drivers of a particular type can be obtained by
3207 using one of the words &%router_list%&, &%transport_list%&, or
3208 &%authenticator_list%&, and a complete list of all drivers with their option
3209 settings can be obtained by using &%routers%&, &%transports%&, or
3210 &%authenticators%&.
3211
3212 .cindex "environment"
3213 If &%environment%& is given as an argument, the set of environment
3214 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3215 variables.
3216
3217 .cindex "options" "macro &-- extracting"
3218 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3219 are available, similarly to the drivers.  Because macros are sometimes used
3220 for storing passwords, this option is restricted.
3221 The output format is one item per line.
3222 For the "-bP macro <name>" form, if no such macro is found
3223 the exit status will be nonzero.
3224
3225 .cmdopt -bp
3226 .cindex "queue" "listing messages in"
3227 .cindex "listing" "messages in the queue"
3228 This option requests a listing of the contents of the mail queue on the
3229 standard output. If the &%-bp%& option is followed by a list of message ids,
3230 just those messages are listed. By default, this option can be used only by an
3231 admin user. However, the &%queue_list_requires_admin%& option can be set false
3232 to allow any user to see the queue.
3233
3234 Each message in the queue is displayed as in the following example:
3235 .code
3236 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3237           red.king@looking-glass.fict.example
3238           <other addresses>
3239 .endd
3240 .cindex "message" "size in queue listing"
3241 .cindex "size" "of message"
3242 The first line contains the length of time the message has been in the queue
3243 (in this case 25 minutes), the size of the message (2.9K), the unique local
3244 identifier for the message, and the message sender, as contained in the
3245 envelope. For bounce messages, the sender address is empty, and appears as
3246 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3247 the default sender address, the user's login name is shown in parentheses
3248 before the sender address.
3249
3250 .cindex "frozen messages" "in queue listing"
3251 If the message is frozen (attempts to deliver it are suspended) then the text
3252 &"*** frozen ***"& is displayed at the end of this line.
3253
3254 The recipients of the message (taken from the envelope, not the headers) are
3255 displayed on subsequent lines. Those addresses to which the message has already
3256 been delivered are marked with the letter D. If an original address gets
3257 expanded into several addresses via an alias or forward file, the original is
3258 displayed with a D only when deliveries for all of its child addresses are
3259 complete.
3260
3261
3262 .cmdopt -bpa
3263 This option operates like &%-bp%&, but in addition it shows delivered addresses
3264 that were generated from the original top level address(es) in each message by
3265 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3266 of just &"D"&.
3267
3268
3269 .cmdopt -bpc
3270 .cindex "queue" "count of messages on"
3271 This option counts the number of messages in the queue, and writes the total
3272 to the standard output. It is restricted to admin users, unless
3273 &%queue_list_requires_admin%& is set false.
3274
3275
3276 .cmdopt -bpi
3277 .cindex queue "list of message IDs"
3278 This option operates like &%-bp%&, but only outputs message ids
3279 (one per line).
3280
3281
3282 .cmdopt -bpr
3283 This option operates like &%-bp%&, but the output is not sorted into
3284 chronological order of message arrival. This can speed it up when there are
3285 lots of messages in the queue, and is particularly useful if the output is
3286 going to be post-processed in a way that doesn't need the sorting.
3287
3288 .cmdopt -bpra
3289 This option is a combination of &%-bpr%& and &%-bpa%&.
3290
3291 .cmdopt -bpri
3292 This option is a combination of &%-bpr%& and &%-bpi%&.
3293
3294 .cmdopt -bpru
3295 This option is a combination of &%-bpr%& and &%-bpu%&.
3296
3297
3298 .cmdopt -bpu
3299 This option operates like &%-bp%& but shows only undelivered top-level
3300 addresses for each message displayed. Addresses generated by aliasing or
3301 forwarding are not shown, unless the message was deferred after processing by a
3302 router with the &%one_time%& option set.
3303
3304
3305 .cmdopt -brt
3306 .cindex "testing" "retry configuration"
3307 .cindex "retry" "configuration testing"
3308 This option is for testing retry rules, and it must be followed by up to three
3309 arguments. It causes Exim to look for a retry rule that matches the values
3310 and to write it to the standard output. For example:
3311 .code
3312 exim -brt bach.comp.mus.example
3313 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3314 .endd
3315 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3316 argument, which is required, can be a complete address in the form
3317 &'local_part@domain'&, or it can be just a domain name. If the second argument
3318 contains a dot, it is interpreted as an optional second domain name; if no
3319 retry rule is found for the first argument, the second is tried. This ties in
3320 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3321 rule is found that matches the host, one that matches the mail domain is
3322 sought. Finally, an argument that is the name of a specific delivery error, as
3323 used in setting up retry rules, can be given. For example:
3324 .code
3325 exim -brt haydn.comp.mus.example quota_3d
3326 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3327 .endd
3328
3329 .cmdopt -brw
3330 .cindex "testing" "rewriting"
3331 .cindex "rewriting" "testing"
3332 This option is for testing address rewriting rules, and it must be followed by
3333 a single argument, consisting of either a local part without a domain, or a
3334 complete address with a fully qualified domain. Exim outputs how this address
3335 would be rewritten for each possible place it might appear. See chapter
3336 &<<CHAPrewrite>>& for further details.
3337
3338 .cmdopt -bS
3339 .cindex "SMTP" "batched incoming"
3340 .cindex "batched SMTP input"
3341 This option is used for batched SMTP input, which is an alternative interface
3342 for non-interactive local message submission. A number of messages can be
3343 submitted in a single run. However, despite its name, this is not really SMTP
3344 input. Exim reads each message's envelope from SMTP commands on the standard
3345 input, but generates no responses. If the caller is trusted, or
3346 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3347 believed; otherwise the sender is always the caller of Exim.
3348
3349 The message itself is read from the standard input, in SMTP format (leading
3350 dots doubled), terminated by a line containing just a single dot. An error is
3351 provoked if the terminating dot is missing. A further message may then follow.
3352
3353 As for other local message submissions, the contents of incoming batch SMTP
3354 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3355 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3356 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3357
3358 Some other SMTP commands are recognized in the input. HELO and EHLO act
3359 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3360 QUIT quits, ignoring the rest of the standard input.
3361
3362 .cindex "return code" "for &%-bS%&"
3363 If any error is encountered, reports are written to the standard output and
3364 error streams, and Exim gives up immediately. The return code is 0 if no error
3365 was detected; it is 1 if one or more messages were accepted before the error
3366 was detected; otherwise it is 2.
3367
3368 More details of input using batched SMTP are given in section
3369 &<<SECTincomingbatchedSMTP>>&.
3370
3371 .cmdopt -bs
3372 .cindex "SMTP" "local input"
3373 .cindex "local SMTP input"
3374 This option causes Exim to accept one or more messages by reading SMTP commands
3375 on the standard input, and producing SMTP replies on the standard output. SMTP
3376 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3377 Some user agents use this interface as a way of passing locally-generated
3378 messages to the MTA.
3379
3380 In
3381 .cindex "sender" "source of"
3382 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3383 set, the senders of messages are taken from the SMTP MAIL commands.
3384 Otherwise the content of these commands is ignored and the sender is set up as
3385 the calling user. Unqualified addresses are automatically qualified using
3386 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3387 &%-bnq%& option is used.
3388
3389 .cindex "inetd"
3390 The
3391 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3392 using a listening daemon. Exim can distinguish the two cases by checking
3393 whether the standard input is a TCP/IP socket. When Exim is called from
3394 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3395 above concerning senders and qualification do not apply. In this situation,
3396 Exim behaves in exactly the same way as it does when receiving a message via
3397 the listening daemon.
3398
3399 .cmdopt -bt
3400 .cindex "testing" "addresses"
3401 .cindex "address" "testing"
3402 This option runs Exim in address testing mode, in which each argument is taken
3403 as a recipient address to be tested for deliverability. The results are
3404 written to the standard output. If a test fails, and the caller is not an admin
3405 user, no details of the failure are output, because these might contain
3406 sensitive information such as usernames and passwords for database lookups.
3407
3408 If no arguments are given, Exim runs in an interactive manner, prompting with a
3409 right angle bracket for addresses to be tested.
3410
3411 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3412 &[readline()]& function, because it is running as &'root'& and there are
3413 security issues.
3414
3415 Each address is handled as if it were the recipient address of a message
3416 (compare the &%-bv%& option). It is passed to the routers and the result is
3417 written to the standard output. However, any router that has
3418 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3419 genuine routing tests if your first router passes everything to a scanner
3420 program.
3421
3422 .cindex "return code" "for &%-bt%&"
3423 The return code is 2 if any address failed outright; it is 1 if no address
3424 failed outright but at least one could not be resolved for some reason. Return
3425 code 0 is given only when all addresses succeed.
3426
3427 .cindex "duplicate addresses"
3428 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3429 addresses after routing is complete, so that only one delivery takes place.
3430 This does not happen when testing with &%-bt%&; the full results of routing are
3431 always shown.
3432
3433 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3434 routers in the configuration makes any tests on the sender address of a
3435 message,
3436 .oindex "&%-f%&" "for address testing"
3437 you can use the &%-f%& option to set an appropriate sender when running
3438 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3439 default qualifying domain. However, if you have set up (for example) routers
3440 whose behaviour depends on the contents of an incoming message, you cannot test
3441 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3442 doing such tests.
3443
3444 .cmdopt -bV
3445 .cindex "version number of Exim"
3446 This option causes Exim to write the current version number, compilation
3447 number, and compilation date of the &'exim'& binary to the standard output.
3448 It also lists the DBM library that is being used, the optional modules (such as
3449 specific lookup types), the drivers that are included in the binary, and the
3450 name of the runtime configuration file that is in use.
3451
3452 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3453 configuration file. However, this is a static check only. It cannot check
3454 values that are to be expanded. For example, although a misspelt ACL verb is
3455 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3456 alone to discover (for example) all the typos in the configuration; some
3457 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3458 dynamic testing facilities.
3459
3460 .cmdopt -bv
3461 .cindex "verifying address" "using &%-bv%&"
3462 .cindex "address" "verification"
3463 This option runs Exim in address verification mode, in which each argument is
3464 taken as a recipient address to be verified by the routers. (This does
3465 not involve any verification callouts). During normal operation, verification
3466 happens mostly as a consequence processing a &%verify%& condition in an ACL
3467 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3468 including callouts, see the &%-bh%& and &%-bhc%& options.
3469
3470 If verification fails, and the caller is not an admin user, no details of the
3471 failure are output, because these might contain sensitive information such as
3472 usernames and passwords for database lookups.
3473
3474 If no arguments are given, Exim runs in an interactive manner, prompting with a
3475 right angle bracket for addresses to be verified.
3476
3477 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3478 &[readline()]& function, because it is running as &'exim'& and there are
3479 security issues.
3480
3481 Verification differs from address testing (the &%-bt%& option) in that routers
3482 that have &%no_verify%& set are skipped, and if the address is accepted by a
3483 router that has &%fail_verify%& set, verification fails. The address is
3484 verified as a recipient if &%-bv%& is used; to test verification for a sender
3485 address, &%-bvs%& should be used.
3486
3487 If the &%-v%& option is not set, the output consists of a single line for each
3488 address, stating whether it was verified or not, and giving a reason in the
3489 latter case. Without &%-v%&, generating more than one address by redirection
3490 causes verification to end successfully, without considering the generated
3491 addresses. However, if just one address is generated, processing continues,
3492 and the generated address must verify successfully for the overall verification
3493 to succeed.
3494
3495 When &%-v%& is set, more details are given of how the address has been handled,
3496 and in the case of address redirection, all the generated addresses are also
3497 considered. Verification may succeed for some and fail for others.
3498
3499 The
3500 .cindex "return code" "for &%-bv%&"
3501 return code is 2 if any address failed outright; it is 1 if no address
3502 failed outright but at least one could not be resolved for some reason. Return
3503 code 0 is given only when all addresses succeed.
3504
3505 If any of the routers in the configuration makes any tests on the sender
3506 address of a message, you should use the &%-f%& option to set an appropriate
3507 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3508 calling user at the default qualifying domain.
3509
3510 .cmdopt -bvs
3511 This option acts like &%-bv%&, but verifies the address as a sender rather
3512 than a recipient address. This affects any rewriting and qualification that
3513 might happen.
3514
3515 .cmdopt -bw
3516 .cindex "daemon"
3517 .cindex "inetd"
3518 .cindex "inetd" "wait mode"
3519 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3520 similarly to the &%-bd%& option.  All port specifications on the command-line
3521 and in the configuration file are ignored.  Queue-running may not be specified.
3522
3523 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3524 listening for connections.  This permits the system to start up and have
3525 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3526 each port only when the first connection is received.
3527
3528 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3529 which the daemon will exit, which should cause inetd to listen once more.
3530
3531 .cmdopt -C <&'filelist'&>
3532 .cindex "configuration file" "alternate"
3533 .cindex "CONFIGURE_FILE"
3534 .cindex "alternate configuration file"
3535 This option causes Exim to find the runtime configuration file from the given
3536 list instead of from the list specified by the CONFIGURE_FILE
3537 compile-time setting. Usually, the list will consist of just a single filename,
3538 but it can be a colon-separated list of names. In this case, the first
3539 file that exists is used. Failure to open an existing file stops Exim from
3540 proceeding any further along the list, and an error is generated.
3541
3542 When this option is used by a caller other than root, and the list is different
3543 from the compiled-in list, Exim gives up its root privilege immediately, and
3544 runs with the real and effective uid and gid set to those of the caller.
3545 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3546 file contains a list of full pathnames, one per line, for configuration files
3547 which are trusted. Root privilege is retained for any configuration file so
3548 listed, as long as the caller is the Exim user (or the user specified in the
3549 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3550 not writeable by inappropriate users or groups.
3551
3552 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3553 configuration using &%-C%& right through message reception and delivery,
3554 even if the caller is root. The reception works, but by that time, Exim is
3555 running as the Exim user, so when it re-executes to regain privilege for the
3556 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3557 test reception and delivery using two separate commands (one to put a message
3558 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3559
3560 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3561 prefix string with which any file named in a &%-C%& command line option
3562 must start. In addition, the filename must not contain the sequence &`/../`&.
3563 However, if the value of the &%-C%& option is identical to the value of
3564 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3565 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3566 unset, any filename can be used with &%-C%&.
3567
3568 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3569 to a directory to which only root has access. This prevents someone who has
3570 broken into the Exim account from running a privileged Exim with an arbitrary
3571 configuration file.
3572
3573 The &%-C%& facility is useful for ensuring that configuration files are
3574 syntactically correct, but cannot be used for test deliveries, unless the
3575 caller is privileged, or unless it is an exotic configuration that does not
3576 require privilege. No check is made on the owner or group of the files
3577 specified by this option.
3578
3579
3580 .vitem &%-D%&<&'macro'&>=<&'value'&>
3581 .oindex "&%-D%&"
3582 .cindex "macro" "setting on command line"
3583 This option can be used to override macro definitions in the configuration file
3584 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3585 unprivileged caller, it causes Exim to give up its root privilege.
3586 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3587 completely disabled, and its use causes an immediate error exit.
3588
3589 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3590 colon-separated list of macros which are considered safe and, if &%-D%& only
3591 supplies macros from this list, and the values are acceptable, then Exim will
3592 not give up root privilege if the caller is root, the Exim run-time user, or
3593 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3594 to be removed in the future.  Acceptable values for the macros satisfy the
3595 regexp: &`^[A-Za-z0-9_/.-]*$`&
3596
3597 The entire option (including equals sign if present) must all be within one
3598 command line item. &%-D%& can be used to set the value of a macro to the empty
3599 string, in which case the equals sign is optional. These two commands are
3600 synonymous:
3601 .code
3602 exim -DABC  ...
3603 exim -DABC= ...
3604 .endd
3605 To include spaces in a macro definition item, quotes must be used. If you use
3606 quotes, spaces are permitted around the macro name and the equals sign. For
3607 example:
3608 .code
3609 exim '-D ABC = something' ...
3610 .endd
3611 &%-D%& may be repeated up to 10 times on a command line.
3612 Only macro names up to 22 letters long can be set.
3613
3614
3615 .vitem &%-d%&<&'debug&~options'&>
3616 .oindex "&%-d%&"
3617 .cindex "debugging" "list of selectors"
3618 .cindex "debugging" "&%-d%& option"
3619 This option causes debugging information to be written to the standard
3620 error stream. It is restricted to admin users because debugging output may show
3621 database queries that contain password information. Also, the details of users'
3622 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3623 writes an error message to the standard error stream and exits with a non-zero
3624 return code.
3625
3626 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3627 standard debugging data is output. This can be reduced, or increased to include
3628 some more rarely needed information, by directly following &%-d%& with a string
3629 made up of names preceded by plus or minus characters. These add or remove sets
3630 of debugging data, respectively. For example, &%-d+filter%& adds filter
3631 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3632 no spaces are allowed in the debug setting. The available debugging categories
3633 are:
3634 .itable none 0 0 2 20* left 80* left
3635 .irow acl            "ACL interpretation"
3636 .irow auth           "authenticators"
3637 .irow deliver        "general delivery logic"
3638 .irow dns            "DNS lookups (see also resolver)"
3639 .irow dnsbl          "DNS black list (aka RBL) code"
3640 .irow exec           "arguments for &[execv()]& calls"
3641 .irow expand         "detailed debugging for string expansions"
3642 .irow filter         "filter handling"
3643 .irow hints_lookup   "hints data lookups"
3644 .irow host_lookup    "all types of name-to-IP address handling"
3645 .irow ident          "ident lookup"
3646 .irow interface      "lists of local interfaces"
3647 .irow lists          "matching things in lists"
3648 .irow load           "system load checks"
3649 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3650                     &<<CHAPlocalscan>>&)"
3651 .irow lookup         "general lookup code and all lookups"
3652 .irow memory         "memory handling"
3653 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3654 .irow pid            "modifier: add pid to debug output lines"
3655 .irow process_info   "setting info for the process log"
3656 .irow queue_run      "queue runs"
3657 .irow receive        "general message reception logic"
3658 .irow resolver       "turn on the DNS resolver's debugging output"
3659 .irow retry          "retry handling"
3660 .irow rewrite        "address rewriting""
3661 .irow route          "address routing"
3662 .irow timestamp      "modifier: add timestamp to debug output lines"
3663 .irow tls            "TLS logic"
3664 .irow transport      "transports"
3665 .irow uid            "changes of uid/gid and looking up uid/gid"
3666 .irow verify         "address verification logic"
3667 .irow all            "almost all of the above (see below), and also &%-v%&"
3668 .endtable
3669 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3670 for &`-all`&. The reason for this is that &`+all`& is something that people
3671 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3672 is included, an awful lot of output that is very rarely of interest is
3673 generated, so it now has to be explicitly requested. However, &`-all`& does
3674 turn everything off.
3675
3676 .cindex "resolver, debugging output"
3677 .cindex "DNS resolver, debugging output"
3678 The &`resolver`& option produces output only if the DNS resolver was compiled
3679 with DEBUG enabled. This is not the case in some operating systems. Also,
3680 unfortunately, debugging output from the DNS resolver is written to stdout
3681 rather than stderr.
3682
3683 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3684 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3685 However, the &`pid`& selector is forced when debugging is turned on for a
3686 daemon, which then passes it on to any re-executed Exims. Exim also
3687 automatically adds the pid to debug lines when several remote deliveries are
3688 run in parallel.
3689
3690 The &`timestamp`& selector causes the current time to be inserted at the start
3691 of all debug output lines. This can be useful when trying to track down delays
3692 in processing.
3693
3694 .cindex debugging "UTF-8 in"
3695 .cindex UTF-8 "in debug output"
3696 The &`noutf8`& selector disables the use of
3697 UTF-8 line-drawing characters to group related information.
3698 When disabled. ascii-art is used instead.
3699 Using the &`+all`& option does not set this modifier,
3700
3701 If the &%debug_print%& option is set in any driver, it produces output whenever
3702 any debugging is selected, or if &%-v%& is used.
3703
3704 .vitem &%-dd%&<&'debug&~options'&>
3705 .oindex "&%-dd%&"
3706 This option behaves exactly like &%-d%& except when used on a command that
3707 starts a daemon process. In that case, debugging is turned off for the
3708 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3709 behaviour of the daemon without creating as much output as full debugging does.
3710
3711 .cmdopt -dropcr
3712 This is an obsolete option that is now a no-op. It used to affect the way Exim
3713 handled CR and LF characters in incoming messages. What happens now is
3714 described in section &<<SECTlineendings>>&.
3715
3716 .cmdopt -E
3717 .cindex "bounce message" "generating"
3718 This option specifies that an incoming message is a locally-generated delivery
3719 failure report. It is used internally by Exim when handling delivery failures
3720 and is not intended for external use. Its only effect is to stop Exim
3721 generating certain messages to the postmaster, as otherwise message cascades
3722 could occur in some situations. As part of the same option, a message id may
3723 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3724 new message contains the id, following &"R="&, as a cross-reference.
3725
3726 .vitem &%-e%&&'x'&
3727 .oindex "&%-e%&&'x'&"
3728 There are a number of Sendmail options starting with &%-oe%& which seem to be
3729 called by various programs without the leading &%o%& in the option. For
3730 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3731 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3732
3733 .cmdopt -F <&'string'&>
3734 .cindex "sender" "name"
3735 .cindex "name" "of sender"
3736 This option sets the sender's full name for use when a locally-generated
3737 message is being accepted. In the absence of this option, the user's &'gecos'&
3738 entry from the password data is used. As users are generally permitted to alter
3739 their &'gecos'& entries, no security considerations are involved. White space
3740 between &%-F%& and the <&'string'&> is optional.
3741
3742 .cmdopt -f <&'address'&>
3743 .cindex "sender" "address"
3744 .cindex "address" "sender"
3745 .cindex "trusted users"
3746 .cindex "envelope from"
3747 .cindex "envelope sender"
3748 .cindex "user" "trusted"
3749 This option sets the address of the envelope sender of a locally-generated
3750 message (also known as the return path). The option can normally be used only
3751 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3752 users to use it.
3753
3754 Processes running as root or the Exim user are always trusted. Other
3755 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3756 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3757 of a local message is set to the caller's login name at the default qualify
3758 domain.
3759
3760 There is one exception to the restriction on the use of &%-f%&: an empty sender
3761 can be specified by any user, trusted or not, to create a message that can
3762 never provoke a bounce. An empty sender can be specified either as an empty
3763 string, or as a pair of angle brackets with nothing between them, as in these
3764 examples of shell commands:
3765 .code
3766 exim -f '<>' user@domain
3767 exim -f "" user@domain
3768 .endd
3769 In addition, the use of &%-f%& is not restricted when testing a filter file
3770 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3771 &%-bv%& options.
3772
3773 Allowing untrusted users to change the sender address does not of itself make
3774 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3775 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3776 though this can be overridden by setting &%no_local_from_check%&.
3777
3778 White
3779 .cindex "&""From""& line"
3780 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3781 given as two arguments or one combined argument). The sender of a
3782 locally-generated message can also be set (when permitted) by an initial
3783 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3784 if &%-f%& is also present, it overrides &"From&~"&.
3785
3786 .cmdopt -G
3787 .cindex "submission fixups, suppressing (command-line)"
3788 This option is equivalent to an ACL applying:
3789 .code
3790 control = suppress_local_fixups
3791 .endd
3792 for every message received.  Note that Sendmail will complain about such
3793 bad formatting, where Exim silently just does not fix it up.  This may change
3794 in future.
3795
3796 As this affects audit information, the caller must be a trusted user to use
3797 this option.
3798
3799 .cmdopt -h <&'number'&>
3800 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3801 This option is accepted for compatibility with Sendmail, but has no effect. (In
3802 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3803 headers.)
3804
3805 .cmdopt -i
3806 .cindex "Solaris" "&'mail'& command"
3807 .cindex "dot" "in incoming non-SMTP message"
3808 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3809 line by itself should not terminate an incoming, non-SMTP message.
3810 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3811 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3812 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3813 by its &'mailx'& command.
3814
3815 .cmdopt -L <&'tag'&>
3816 .cindex "syslog" "process name; set with flag"
3817 This option is equivalent to setting &%syslog_processname%& in the config
3818 file and setting &%log_file_path%& to &`syslog`&.
3819 Its use is restricted to administrators.  The configuration file has to be
3820 read and parsed, to determine access rights, before this is set and takes
3821 effect, so early configuration file errors will not honour this flag.
3822
3823 The tag should not be longer than 32 characters.
3824
3825 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3826 .cindex "forcing delivery"
3827 .cindex "delivery" "forcing attempt"
3828 .cindex "frozen messages" "forcing delivery"
3829 This option requests Exim to run a delivery attempt on each message in turn. If
3830 any of the messages are frozen, they are automatically thawed before the
3831 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3832 and &%hold_domains%& are ignored.
3833
3834 Retry
3835 .cindex "hints database" "overriding retry hints"
3836 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3837 the normal retry time has not yet been reached. This option requires the caller
3838 to be an admin user. However, there is an option called &%prod_requires_admin%&
3839 which can be set false to relax this restriction (and also the same requirement
3840 for the &%-q%&, &%-R%&, and &%-S%& options).
3841
3842 The deliveries happen synchronously, that is, the original Exim process does
3843 not terminate until all the delivery attempts have finished. No output is
3844 produced unless there is a serious error. If you want to see what is happening,
3845 use the &%-v%& option as well, or inspect Exim's main log.
3846
3847 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3848 .cindex "message" "adding recipients"
3849 .cindex "recipient" "adding"
3850 This option requests Exim to add the addresses to the list of recipients of the
3851 message (&"ar"& for &"add recipients"&). The first argument must be a message
3852 id, and the remaining ones must be email addresses. However, if the message is
3853 active (in the middle of a delivery attempt), it is not altered. This option
3854 can be used only by an admin user.
3855
3856 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3857         &~<&'host&~IP'&>&&&
3858         &~<&'sequence&~number'&>&&&
3859         &~<&'message&~id'&>"
3860 .oindex "&%-MC%&"
3861 .cindex "SMTP" "passed connection"
3862 .cindex "SMTP" "multiple deliveries"
3863 .cindex "multiple SMTP deliveries"
3864 This option is not intended for use by external callers. It is used internally
3865 by Exim to invoke another instance of itself to deliver a waiting message using
3866 an existing SMTP connection, which is passed as the standard input. Details are
3867 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3868 must be root or the Exim user in order to use it.
3869
3870 .cmdopt -MCA
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that the
3873 connection to the remote host has been authenticated.
3874
3875 .cmdopt -MCD
3876 This option is not intended for use by external callers. It is used internally
3877 by Exim in conjunction with the &%-MC%& option. It signifies that the
3878 remote host supports the ESMTP &_DSN_& extension.
3879
3880 .cmdopt -MCd
3881 This option is not intended for use by external callers. It is used internally
3882 by Exim in conjunction with the &%-d%& option
3883 to pass on an information string on the purpose of the process.
3884
3885 .cmdopt -MCG <&'queue&~name'&>
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option. It signifies that an
3888 alternate queue is used, named by the following argument.
3889
3890 .cmdopt -MCK
3891 This option is not intended for use by external callers. It is used internally
3892 by Exim in conjunction with the &%-MC%& option. It signifies that a
3893 remote host supports the ESMTP &_CHUNKING_& extension.
3894
3895 .cmdopt -MCL
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3898 which Exim is connected advertised limits on numbers of mails, recipients or
3899 recipient domains.
3900 The limits are given by the following three arguments.
3901
3902 .cmdopt -MCP
3903 This option is not intended for use by external callers. It is used internally
3904 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3905 which Exim is connected supports pipelining.
3906
3907 .cmdopt -MCp
3908 This option is not intended for use by external callers. It is used internally
3909 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3910 t a remote server is via a SOCKS proxy, using addresses and ports given by
3911 the following four arguments.
3912
3913 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3914 This option is not intended for use by external callers. It is used internally
3915 by Exim in conjunction with the &%-MC%& option when the original delivery was
3916 started by a queue runner. It passes on the process id of the queue runner,
3917 together with the file descriptor number of an open pipe. Closure of the pipe
3918 signals the final completion of the sequence of processes that are passing
3919 messages through the same SMTP connection.
3920
3921 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3922 This option is not intended for use by external callers. It is used internally
3923 by Exim to implement quota checking for local users.
3924
3925 .cmdopt -MCS
3926 This option is not intended for use by external callers. It is used internally
3927 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3928 ESMTP SIZE option should be used on messages delivered down the existing
3929 connection.
3930
3931 .cmdopt -MCT
3932 This option is not intended for use by external callers. It is used internally
3933 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3934 host to which Exim is connected supports TLS encryption.
3935
3936 .vitem &%-MCr%&&~<&'SNI'&> &&&
3937        &%-MCs%&&~<&'SNI'&>
3938 .oindex "&%-MCs%&"
3939 .oindex "&%-MCr%&"
3940 These options are not intended for use by external callers. It is used internally
3941 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3942 a TLS Server Name Indication was sent as part of the channel establishment.
3943 The argument gives the SNI string.
3944 The "r" variant indicates a DANE-verified connection.
3945
3946 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3947 This option is not intended for use by external callers. It is used internally
3948 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3949 connection is being proxied by a parent process for handling TLS encryption.
3950 The arguments give the local address and port being proxied, and the TLS cipher.
3951
3952 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3953 .cindex "hints database" "not overridden by &%-Mc%&"
3954 .cindex "delivery" "manually started &-- not forced"
3955 This option requests Exim to run a delivery attempt on each message, in turn,
3956 but unlike the &%-M%& option, it does check for retry hints, and respects any
3957 that are found. This option is not very useful to external callers. It is
3958 provided mainly for internal use by Exim when it needs to re-invoke itself in
3959 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3960 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3961 respects retry times and other options such as &%hold_domains%& that are
3962 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3963 If you want to run a specific delivery as if in a queue run, you should use
3964 &%-q%& with a message id argument. A distinction between queue run deliveries
3965 and other deliveries is made in one or two places.
3966
3967 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3968 .cindex "message" "changing sender"
3969 .cindex "sender" "changing"
3970 This option requests Exim to change the sender address in the message to the
3971 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3972 &"edit sender"&). There must be exactly two arguments. The first argument must
3973 be a message id, and the second one an email address. However, if the message
3974 is active (in the middle of a delivery attempt), its status is not altered.
3975 This option can be used only by an admin user.
3976
3977 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
3978 .cindex "freezing messages"
3979 .cindex "message" "manually freezing"
3980 This option requests Exim to mark each listed message as &"frozen"&. This
3981 prevents any delivery attempts taking place until the message is &"thawed"&,
3982 either manually or as a result of the &%auto_thaw%& configuration option.
3983 However, if any of the messages are active (in the middle of a delivery
3984 attempt), their status is not altered. This option can be used only by an admin
3985 user.
3986
3987 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
3988 .cindex "giving up on messages"
3989 .cindex "message" "abandoning delivery attempts"
3990 .cindex "delivery" "abandoning further attempts"
3991 This option requests Exim to give up trying to deliver the listed messages,
3992 including any that are frozen. However, if any of the messages are active,
3993 their status is not altered. For non-bounce messages, a delivery error message
3994 is sent to the sender, containing the text &"cancelled by administrator"&.
3995 Bounce messages are just discarded. This option can be used only by an admin
3996 user.
3997
3998 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3999 .cindex queue named
4000 .cindex "named queues" "moving messages"
4001 .cindex "queue" "moving messages"
4002 This option requests that each listed message be moved from its current
4003 queue to the given named queue.
4004 The destination queue name argument is required, but can be an empty
4005 string to define the default queue.
4006 If the messages are not currently located in the default queue,
4007 a &%-qG<name>%& option will be required to define the source queue.
4008
4009 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4010 .cindex "delivery" "cancelling all"
4011 This option requests Exim to mark all the recipient addresses in the messages
4012 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4013 message is active (in the middle of a delivery attempt), its status is not
4014 altered. This option can be used only by an admin user.
4015
4016 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4017 .cindex "delivery" "cancelling by address"
4018 .cindex "recipient" "removing"
4019 .cindex "removing recipients"
4020 This option requests Exim to mark the given addresses as already delivered
4021 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4022 the remaining ones must be email addresses. These are matched to recipient
4023 addresses in the message in a case-sensitive manner. If the message is active
4024 (in the middle of a delivery attempt), its status is not altered. This option
4025 can be used only by an admin user.
4026
4027 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4028 .cindex "removing messages"
4029 .cindex "abandoning mail"
4030 .cindex "message" "manually discarding"
4031 This option requests Exim to remove the given messages from the queue. No
4032 bounce messages are sent; each message is simply forgotten. However, if any of
4033 the messages are active, their status is not altered. This option can be used
4034 only by an admin user or by the user who originally caused the message to be
4035 placed in the queue.
4036
4037 . .new
4038 . .vitem &%-MS%&
4039 . .oindex "&%-MS%&"
4040 . .cindex REQUIRETLS
4041 . This option is used to request REQUIRETLS processing on the message.
4042 . It is used internally by Exim in conjunction with -E when generating
4043 . a bounce message.
4044 . .wen
4045
4046 .cmdopt -Mset <&'message&~id'&>
4047 .cindex "testing" "string expansion"
4048 .cindex "expansion" "testing"
4049 This option is useful only in conjunction with &%-be%& (that is, when testing
4050 string expansions). Exim loads the given message from its spool before doing
4051 the test expansions, thus setting message-specific variables such as
4052 &$message_size$& and the header variables. The &$recipients$& variable is made
4053 available. This feature is provided to make it easier to test expansions that
4054 make use of these variables. However, this option can be used only by an admin
4055 user. See also &%-bem%&.
4056
4057 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4058 .cindex "thawing messages"
4059 .cindex "unfreezing messages"
4060 .cindex "frozen messages" "thawing"
4061 .cindex "message" "thawing frozen"
4062 This option requests Exim to &"thaw"& any of the listed messages that are
4063 &"frozen"&, so that delivery attempts can resume. However, if any of the
4064 messages are active, their status is not altered. This option can be used only
4065 by an admin user.
4066
4067 .cmdopt -Mvb <&'message&~id'&>
4068 .cindex "listing" "message body"
4069 .cindex "message" "listing body of"
4070 This option causes the contents of the message body (-D) spool file to be
4071 written to the standard output. This option can be used only by an admin user.
4072
4073 .cmdopt -Mvc <&'message&~id'&>
4074 .cindex "message" "listing in RFC 2822 format"
4075 .cindex "listing" "message in RFC 2822 format"
4076 This option causes a copy of the complete message (header lines plus body) to
4077 be written to the standard output in RFC 2822 format. This option can be used
4078 only by an admin user.
4079
4080 .cmdopt -Mvh <&'message&~id'&>
4081 .cindex "listing" "message headers"
4082 .cindex "header lines" "listing"
4083 .cindex "message" "listing header lines"
4084 This option causes the contents of the message headers (-H) spool file to be
4085 written to the standard output. This option can be used only by an admin user.
4086
4087 .cmdopt -Mvl <&'message&~id'&>
4088 .cindex "listing" "message log"
4089 .cindex "message" "listing message log"
4090 This option causes the contents of the message log spool file to be written to
4091 the standard output. This option can be used only by an admin user.
4092
4093 .cmdopt -m
4094 This is a synonym for &%-om%& that is accepted by Sendmail
4095 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4096 p. 1M-258), so Exim treats it that way too.
4097
4098 .cmdopt -N
4099 .cindex "debugging" "&%-N%& option"
4100 .cindex "debugging" "suppressing delivery"
4101 This is a debugging option that inhibits delivery of a message at the transport
4102 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4103 it just doesn't actually transport the message, but instead behaves as if it
4104 had successfully done so. However, it does not make any updates to the retry
4105 database, and the log entries for deliveries are flagged with &"*>"& rather
4106 than &"=>"&.
4107
4108 Because &%-N%& discards any message to which it applies, only root or the Exim
4109 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4110 words, an ordinary user can use it only when supplying an incoming message to
4111 which it will apply. Although transportation never fails when &%-N%& is set, an
4112 address may be deferred because of a configuration problem on a transport, or a
4113 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4114 the message, and applies to any subsequent delivery attempts that may happen
4115 for that message.
4116
4117 .cmdopt -n
4118 This option is interpreted by Sendmail to mean &"no aliasing"&.
4119 For normal modes of operation, it is ignored by Exim.
4120 When combined with &%-bP%& it makes the output more terse (suppresses
4121 option names, environment values and config pretty printing).
4122
4123 .cmdopt -O <&'data'&>
4124 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4125 Exim.
4126
4127 .cmdopt -oA <&'file&~name'&>
4128 .cindex "Sendmail compatibility" "&%-oA%& option"
4129 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4130 alternative alias filename. Exim handles &%-bi%& differently; see the
4131 description above.
4132
4133 .cmdopt -oB <&'n'&>
4134 .cindex "SMTP" "passed connection"
4135 .cindex "SMTP" "multiple deliveries"
4136 .cindex "multiple SMTP deliveries"
4137 This is a debugging option which limits the maximum number of messages that can
4138 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4139 transport. If <&'n'&> is omitted, the limit is set to 1.
4140
4141 .cmdopt -odb
4142 .cindex "background delivery"
4143 .cindex "delivery" "in the background"
4144 This option applies to all modes in which Exim accepts incoming messages,
4145 including the listening daemon. It requests &"background"& delivery of such
4146 messages, which means that the accepting process automatically starts a
4147 delivery process for each message received, but does not wait for the delivery
4148 processes to finish.
4149
4150 When all the messages have been received, the reception process exits,
4151 leaving the delivery processes to finish in their own time. The standard output
4152 and error streams are closed at the start of each delivery process.
4153 This is the default action if none of the &%-od%& options are present.
4154
4155 If one of the queueing options in the configuration file
4156 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4157 overrides it if &%queue_only_override%& is set true, which is the default
4158 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4159
4160 .cmdopt -odf
4161 .cindex "foreground delivery"
4162 .cindex "delivery" "in the foreground"
4163 This option requests &"foreground"& (synchronous) delivery when Exim has
4164 accepted a locally-generated message. (For the daemon it is exactly the same as
4165 &%-odb%&.) A delivery process is automatically started to deliver the message,
4166 and Exim waits for it to complete before proceeding.
4167
4168 The original Exim reception process does not finish until the delivery
4169 process for the final message has ended. The standard error stream is left open
4170 during deliveries.
4171
4172 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4173 false and one of the queueing options in the configuration file is in effect.
4174
4175 If there is a temporary delivery error during foreground delivery, the
4176 message is left in the queue for later delivery, and the original reception
4177 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4178 restricted configuration that never queues messages.
4179
4180
4181 .cmdopt -odi
4182 This option is synonymous with &%-odf%&. It is provided for compatibility with
4183 Sendmail.
4184
4185 .cmdopt -odq
4186 .cindex "non-immediate delivery"
4187 .cindex "delivery" "suppressing immediate"
4188 .cindex "queueing incoming messages"
4189 This option applies to all modes in which Exim accepts incoming messages,
4190 including the listening daemon. It specifies that the accepting process should
4191 not automatically start a delivery process for each message received. Messages
4192 are placed in the queue, and remain there until a subsequent queue runner
4193 process encounters them. There are several configuration options (such as
4194 &%queue_only%&) that can be used to queue incoming messages under certain
4195 conditions. This option overrides all of them and also &%-odqs%&. It always
4196 forces queueing.
4197
4198 .cmdopt -odqs
4199 .cindex "SMTP" "delaying delivery"
4200 .cindex "first pass routing"
4201 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4202 However, like &%-odb%& and &%-odi%&, this option has no effect if
4203 &%queue_only_override%& is false and one of the queueing options in the
4204 configuration file is in effect.
4205
4206 When &%-odqs%& does operate, a delivery process is started for each incoming
4207 message, in the background by default, but in the foreground if &%-odi%& is
4208 also present. The recipient addresses are routed, and local deliveries are done
4209 in the normal way. However, if any SMTP deliveries are required, they are not
4210 done at this time, so the message remains in the queue until a subsequent queue
4211 runner process encounters it. Because routing was done, Exim knows which
4212 messages are waiting for which hosts, and so a number of messages for the same
4213 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4214 configuration option has the same effect for specific domains. See also the
4215 &%-qq%& option.
4216
4217 .cmdopt -oee
4218 .cindex "error" "reporting"
4219 If an error is detected while a non-SMTP message is being received (for
4220 example, a malformed address), the error is reported to the sender in a mail
4221 message.
4222
4223 .cindex "return code" "for &%-oee%&"
4224 Provided
4225 this error message is successfully sent, the Exim receiving process
4226 exits with a return code of zero. If not, the return code is 2 if the problem
4227 is that the original message has no recipients, or 1 for any other error.
4228 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4229
4230 .cmdopt -oem
4231 .cindex "error" "reporting"
4232 .cindex "return code" "for &%-oem%&"
4233 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4234 return code, whether or not the error message was successfully sent.
4235 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4236
4237 .cmdopt -oep
4238 .cindex "error" "reporting"
4239 If an error is detected while a non-SMTP message is being received, the
4240 error is reported by writing a message to the standard error file (stderr).
4241 .cindex "return code" "for &%-oep%&"
4242 The return code is 1 for all errors.
4243
4244 .cmdopt -oeq
4245 .cindex "error" "reporting"
4246 This option is supported for compatibility with Sendmail, but has the same
4247 effect as &%-oep%&.
4248
4249 .cmdopt -oew
4250 .cindex "error" "reporting"
4251 This option is supported for compatibility with Sendmail, but has the same
4252 effect as &%-oem%&.
4253
4254 .cmdopt -oi
4255 .cindex "dot" "in incoming non-SMTP message"
4256 This option, which has the same effect as &%-i%&, specifies that a dot on a
4257 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4258 single dot does terminate, though Exim does no special processing for other
4259 lines that start with a dot. This option is set by default if Exim is called as
4260 &'rmail'&. See also &%-ti%&.
4261
4262 .cmdopt -oitrue
4263 This option is treated as synonymous with &%-oi%&.
4264
4265 .cmdopt -oMa <&'host&~address'&>
4266 .cindex "sender" "host address, specifying for local message"
4267 A number of options starting with &%-oM%& can be used to set values associated
4268 with remote hosts on locally-submitted messages (that is, messages not received
4269 over TCP/IP). These options can be used by any caller in conjunction with the
4270 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4271 other circumstances, they are ignored unless the caller is trusted.
4272
4273 The &%-oMa%& option sets the sender host address. This may include a port
4274 number at the end, after a full stop (period). For example:
4275 .code
4276 exim -bs -oMa 10.9.8.7.1234
4277 .endd
4278 An alternative syntax is to enclose the IP address in square brackets,
4279 followed by a colon and the port number:
4280 .code
4281 exim -bs -oMa [10.9.8.7]:1234
4282 .endd
4283 The IP address is placed in the &$sender_host_address$& variable, and the
4284 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4285 are present on the command line, the sender host IP address is taken from
4286 whichever one is last.
4287
4288 .cmdopt -oMaa <&'name'&>
4289 .cindex "authentication" "name, specifying for local message"
4290 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4291 option sets the value of &$sender_host_authenticated$& (the authenticator
4292 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4293 This option can be used with &%-bh%& and &%-bs%& to set up an
4294 authenticated SMTP session without actually using the SMTP AUTH command.
4295
4296 .cmdopt -oMai <&'string'&>
4297 .cindex "authentication" "id, specifying for local message"
4298 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4299 option sets the value of &$authenticated_id$& (the id that was authenticated).
4300 This overrides the default value (the caller's login id, except with &%-bh%&,
4301 where there is no default) for messages from local sources. See chapter
4302 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4303
4304 .cmdopt -oMas <&'address'&>
4305 .cindex "authentication" "sender, specifying for local message"
4306 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4307 option sets the authenticated sender value in &$authenticated_sender$&. It
4308 overrides the sender address that is created from the caller's login id for
4309 messages from local sources, except when &%-bh%& is used, when there is no
4310 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4311 specified on a MAIL command overrides this value. See chapter
4312 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4313
4314 .cmdopt -oMi <&'interface&~address'&>
4315 .cindex "interface" "address, specifying for local message"
4316 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4317 option sets the IP interface address value. A port number may be included,
4318 using the same syntax as for &%-oMa%&. The interface address is placed in
4319 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4320
4321 .cmdopt -oMm <&'message&~reference'&>
4322 .cindex "message reference" "message reference, specifying for local message"
4323 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4324 option sets the message reference, e.g. message-id, and is logged during
4325 delivery. This is useful when some kind of audit trail is required to tie
4326 messages together. The format of the message reference is checked and will
4327 abort if the format is invalid. The option will only be accepted if exim is
4328 running in trusted mode, not as any regular user.
4329
4330 The best example of a message reference is when Exim sends a bounce message.
4331 The message reference is the message-id of the original message for which Exim
4332 is sending the bounce.
4333
4334 .cmdopt -oMr <&'protocol&~name'&>
4335 .cindex "protocol, specifying for local message"
4336 .vindex "&$received_protocol$&"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4338 option sets the received protocol value that is stored in
4339 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4340 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4341 SMTP protocol names (see the description of &$received_protocol$& in section
4342 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4343 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4344 be set by &%-oMr%&. Repeated use of this option is not supported.
4345
4346 .cmdopt -oMs <&'host&~name'&>
4347 .cindex "sender" "host name, specifying for local message"
4348 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4349 option sets the sender host name in &$sender_host_name$&. When this option is
4350 present, Exim does not attempt to look up a host name from an IP address; it
4351 uses the name it is given.
4352
4353 .cmdopt -oMt <&'ident&~string'&>
4354 .cindex "sender" "ident string, specifying for local message"
4355 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4356 option sets the sender ident value in &$sender_ident$&. The default setting for
4357 local callers is the login id of the calling process, except when &%-bh%& is
4358 used, when there is no default.
4359
4360 .cmdopt -om
4361 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4362 In Sendmail, this option means &"me too"&, indicating that the sender of a
4363 message should receive a copy of the message if the sender appears in an alias
4364 expansion. Exim always does this, so the option does nothing.
4365
4366 .cmdopt -oo
4367 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4368 This option is ignored. In Sendmail it specifies &"old style headers"&,
4369 whatever that means.
4370
4371 .cmdopt -oP <&'path'&>
4372 .cindex "pid (process id)" "of daemon"
4373 .cindex "daemon" "process id (pid)"
4374 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4375 value. The option specifies the file to which the process id of the daemon is
4376 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4377 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4378 because in those cases, the normal pid file is not used.
4379
4380 .cmdopt -oPX
4381 .cindex "pid (process id)" "of daemon"
4382 .cindex "daemon" "process id (pid)"
4383 This option is not intended for general use.
4384 The daemon uses it when terminating due to a SIGTEM, possibly in
4385 combination with &%-oP%&&~<&'path'&>.
4386 It causes the pid file to be removed.
4387
4388 .cmdopt -or <&'time'&>
4389 .cindex "timeout" "for non-SMTP input"
4390 This option sets a timeout value for incoming non-SMTP messages. If it is not
4391 set, Exim will wait forever for the standard input. The value can also be set
4392 by the &%receive_timeout%& option. The format used for specifying times is
4393 described in section &<<SECTtimeformat>>&.
4394
4395 .cmdopt -os <&'time'&>
4396 .cindex "timeout" "for SMTP input"
4397 .cindex "SMTP" "input timeout"
4398 This option sets a timeout value for incoming SMTP messages. The timeout
4399 applies to each SMTP command and block of data. The value can also be set by
4400 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4401 for specifying times is described in section &<<SECTtimeformat>>&.
4402
4403 .cmdopt -ov
4404 This option has exactly the same effect as &%-v%&.
4405
4406 .cmdopt -oX <&'number&~or&~string'&>
4407 .cindex "TCP/IP" "setting listening ports"
4408 .cindex "TCP/IP" "setting listening interfaces"
4409 .cindex "port" "receiving TCP/IP"
4410 This option is relevant only when the &%-bd%& (start listening daemon) option
4411 is also given. It controls which ports and interfaces the daemon uses. Details
4412 of the syntax, and how it interacts with configuration file options, are given
4413 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4414 file is written unless &%-oP%& is also present to specify a pid filename.
4415
4416 .cmdopt -oY
4417 .cindex "daemon notifier socket"
4418 This option controls the creation of an inter-process communications endpoint
4419 by the Exim daemon.
4420 It is only relevant when the &%-bd%& (start listening daemon) option is also
4421 given.
4422 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4423 option is also present.
4424 .new
4425 If this option is given then the socket will not be created.  This is required
4426 if the system is running multiple daemons, in which case it should
4427 be used on all.
4428 The features supported by the socket will not be available in such cases.
4429
4430 The socket is currently used for
4431 .ilist
4432 fast ramp-up of queue runner processes
4433 .next
4434 caching compiled regexes
4435 .next
4436 obtaining a current queue size
4437 .endlist
4438 .wen
4439
4440 .cmdopt -pd
4441 .cindex "Perl" "starting the interpreter"
4442 This option applies when an embedded Perl interpreter is linked with Exim (see
4443 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4444 option, forcing the starting of the interpreter to be delayed until it is
4445 needed.
4446
4447 .cmdopt -ps
4448 .cindex "Perl" "starting the interpreter"
4449 This option applies when an embedded Perl interpreter is linked with Exim (see
4450 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4451 option, forcing the starting of the interpreter to occur as soon as Exim is
4452 started.
4453
4454 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4455 .oindex "&%-p%&"
4456 For compatibility with Sendmail, this option is equivalent to
4457 .display
4458 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4459 .endd
4460 It sets the incoming protocol and host name (for trusted callers). The
4461 host name and its colon can be omitted when only the protocol is to be set.
4462 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4463 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4464 or &`s`& using this option (but that does not seem a real limitation).
4465 Repeated use of this option is not supported.
4466
4467 .cmdopt -q
4468 .cindex "queue runner" "starting manually"
4469 This option is normally restricted to admin users. However, there is a
4470 configuration option called &%prod_requires_admin%& which can be set false to
4471 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4472 and &%-S%& options).
4473
4474 .cindex "queue runner" "description of operation"
4475 If other commandline options do not specify an action,
4476 the &%-q%& option starts one queue runner process. This scans the queue of
4477 waiting messages, and runs a delivery process for each one in turn. It waits
4478 for each delivery process to finish before starting the next one. A delivery
4479 process may not actually do any deliveries if the retry times for the addresses
4480 have not been reached. Use &%-qf%& (see below) if you want to override this.
4481
4482 If
4483 .cindex "SMTP" "passed connection"
4484 .cindex "SMTP" "multiple deliveries"
4485 .cindex "multiple SMTP deliveries"
4486 the delivery process spawns other processes to deliver other messages down
4487 passed SMTP connections, the queue runner waits for these to finish before
4488 proceeding.
4489
4490 When all the queued messages have been considered, the original queue runner
4491 process terminates. In other words, a single pass is made over the waiting
4492 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4493 this to be repeated periodically.
4494
4495 Exim processes the waiting messages in an unpredictable order. It isn't very
4496 random, but it is likely to be different each time, which is all that matters.
4497 If one particular message screws up a remote MTA, other messages to the same
4498 MTA have a chance of getting through if they get tried first.
4499
4500 It is possible to cause the messages to be processed in lexical message id
4501 order, which is essentially the order in which they arrived, by setting the
4502 &%queue_run_in_order%& option, but this is not recommended for normal use.
4503
4504 .vitem &%-q%&<&'qflags'&>
4505 The &%-q%& option may be followed by one or more flag letters that change its
4506 behaviour. They are all optional, but if more than one is present, they must
4507 appear in the correct order. Each flag is described in a separate item below.
4508
4509 .vitem &%-qq...%&
4510 .oindex "&%-qq%&"
4511 .cindex "queue" "double scanning"
4512 .cindex "queue" "routing"
4513 .cindex "routing" "whole queue before delivery"
4514 .cindex "first pass routing"
4515 .cindex "queue runner" "two phase"
4516 An option starting with &%-qq%& requests a two-stage queue run. In the first
4517 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4518 every domain. Addresses are routed, local deliveries happen, but no remote
4519 transports are run.
4520
4521 Performance will be best if the &%queue_run_in_order%& option is false.
4522 If that is so and
4523 the &%queue_fast_ramp%& option is true
4524 and a daemon-notifier socket is available
4525 then in the first phase of the run,
4526 once a threshold number of messages are routed for a given host,
4527 a delivery process is forked in parallel with the rest of the scan.
4528
4529 .cindex "hints database" "remembering routing"
4530 The hints database that remembers which messages are waiting for specific hosts
4531 is updated, as if delivery to those hosts had been deferred.
4532
4533 After the first queue scan complete,
4534 a second, normal queue scan is done, with routing and delivery taking
4535 place as normal.
4536 Messages that are routed to the same host should mostly be
4537 delivered down a single SMTP
4538 .cindex "SMTP" "passed connection"
4539 .cindex "SMTP" "multiple deliveries"
4540 .cindex "multiple SMTP deliveries"
4541 connection because of the hints that were set up during the first queue scan.
4542
4543 .new
4544 Two-phase queue runs should be used on systems which, even intermittently,
4545 have a large queue (such as mailing-list operators).
4546 They may also be useful for hosts that are connected to the Internet
4547 intermittently.
4548 .wen
4549
4550 .vitem &%-q[q]i...%&
4551 .oindex "&%-qi%&"
4552 .cindex "queue" "initial delivery"
4553 If the &'i'& flag is present, the queue runner runs delivery processes only for
4554 those messages that haven't previously been tried. (&'i'& stands for &"initial
4555 delivery"&.) This can be helpful if you are putting messages in the queue using
4556 &%-odq%& and want a queue runner just to process the new messages.
4557
4558 .vitem &%-q[q][i]f...%&
4559 .oindex "&%-qf%&"
4560 .cindex "queue" "forcing delivery"
4561 .cindex "delivery" "forcing in queue run"
4562 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4563 message, whereas without &'f'& only those non-frozen addresses that have passed
4564 their retry times are tried.
4565
4566 .vitem &%-q[q][i]ff...%&
4567 .oindex "&%-qff%&"
4568 .cindex "frozen messages" "forcing delivery"
4569 If &'ff'& is present, a delivery attempt is forced for every message, whether
4570 frozen or not.
4571
4572 .vitem &%-q[q][i][f[f]]l%&
4573 .oindex "&%-ql%&"
4574 .cindex "queue" "local deliveries only"
4575 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4576 be done. If a message requires any remote deliveries, it remains in the queue
4577 for later delivery.
4578
4579 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4580 .oindex "&%-qG%&"
4581 .cindex queue named
4582 .cindex "named queues"  "deliver from"
4583 .cindex "queue" "delivering specific messages"
4584 If the &'G'& flag and a name is present, the queue runner operates on the
4585 queue with the given name rather than the default queue.
4586 The name should not contain a &'/'& character.
4587 For a periodic queue run (see below)
4588 append to the name a slash and a time value.
4589
4590 If other commandline options specify an action, a &'-qG<name>'& option
4591 will specify a queue to operate on.
4592 For example:
4593 .code
4594 exim -bp -qGquarantine
4595 mailq -qGquarantine
4596 exim -qGoffpeak -Rf @special.domain.example
4597 .endd
4598
4599 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4600 When scanning the queue, Exim can be made to skip over messages whose ids are
4601 lexically less than a given value by following the &%-q%& option with a
4602 starting message id. For example:
4603 .code
4604 exim -q 0t5C6f-0000c8-00
4605 .endd
4606 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4607 second message id is given, messages whose ids are lexically greater than it
4608 are also skipped. If the same id is given twice, for example,
4609 .code
4610 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4611 .endd
4612 just one delivery process is started, for that message. This differs from
4613 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4614 that it counts as a delivery from a queue run. Note that the selection
4615 mechanism does not affect the order in which the messages are scanned. There
4616 are also other ways of selecting specific sets of messages for delivery in a
4617 queue run &-- see &%-R%& and &%-S%&.
4618
4619 .vitem &%-q%&<&'qflags'&><&'time'&>
4620 .cindex "queue runner" "starting periodically"
4621 .cindex "periodic queue running"
4622 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4623 starting a queue runner process at intervals specified by the given time value
4624 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4625 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4626 single daemon process handles both functions. A common way of starting up a
4627 combined daemon at system boot time is to use a command such as
4628 .code
4629 /usr/exim/bin/exim -bd -q30m
4630 .endd
4631 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4632 process every 30 minutes.
4633
4634 .new
4635 .cindex "named queues" "queue runners"
4636 It is possible to set up runners for multiple named queues within one daemon,
4637 For example:
4638 .code
4639 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4640 .endd
4641 .wen
4642
4643 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4644 pid file is written unless one is explicitly requested by the &%-oP%& option.
4645
4646 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4647 .oindex "&%-qR%&"
4648 This option is synonymous with &%-R%&. It is provided for Sendmail
4649 compatibility.
4650
4651 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4652 .oindex "&%-qS%&"
4653 This option is synonymous with &%-S%&.
4654
4655 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4656 .oindex "&%-R%&"
4657 .cindex "queue runner" "for specific recipients"
4658 .cindex "delivery" "to given domain"
4659 .cindex "domain" "delivery to"
4660 The <&'rsflags'&> may be empty, in which case the white space before the string
4661 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4662 which are the possible values for <&'rsflags'&>. White space is required if
4663 <&'rsflags'&> is not empty.
4664
4665 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4666 perform a single queue run, except that, when scanning the messages on the
4667 queue, Exim processes only those that have at least one undelivered recipient
4668 address containing the given string, which is checked in a case-independent
4669 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4670 regular expression; otherwise it is a literal string.
4671
4672 If you want to do periodic queue runs for messages with specific recipients,
4673 you can combine &%-R%& with &%-q%& and a time value. For example:
4674 .code
4675 exim -q25m -R @special.domain.example
4676 .endd
4677 This example does a queue run for messages with recipients in the given domain
4678 every 25 minutes. Any additional flags that are specified with &%-q%& are
4679 applied to each queue run.
4680
4681 Once a message is selected for delivery by this mechanism, all its addresses
4682 are processed. For the first selected message, Exim overrides any retry
4683 information and forces a delivery attempt for each undelivered address. This
4684 means that if delivery of any address in the first message is successful, any
4685 existing retry information is deleted, and so delivery attempts for that
4686 address in subsequently selected messages (which are processed without forcing)
4687 will run. However, if delivery of any address does not succeed, the retry
4688 information is updated, and in subsequently selected messages, the failing
4689 address will be skipped.
4690
4691 .cindex "frozen messages" "forcing delivery"
4692 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4693 all selected messages, not just the first; frozen messages are included when
4694 &'ff'& is present.
4695
4696 The &%-R%& option makes it straightforward to initiate delivery of all messages
4697 to a given domain after a host has been down for some time. When the SMTP
4698 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4699 effect is to run Exim with the &%-R%& option, but it can be configured to run
4700 an arbitrary command instead.
4701
4702 .cmdopt -r
4703 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4704
4705 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4706 .oindex "&%-S%&"
4707 .cindex "delivery" "from given sender"
4708 .cindex "queue runner" "for specific senders"
4709 This option acts like &%-R%& except that it checks the string against each
4710 message's sender instead of against the recipients. If &%-R%& is also set, both
4711 conditions must be met for a message to be selected. If either of the options
4712 has &'f'& or &'ff'& in its flags, the associated action is taken.
4713
4714 .cmdopt -Tqt <&'times'&>
4715 This is an option that is exclusively for use by the Exim testing suite. It is not
4716 recognized when Exim is run normally. It allows for the setting up of explicit
4717 &"queue times"& so that various warning/retry features can be tested.
4718
4719 .cmdopt -t
4720 .cindex "recipient" "extracting from header lines"
4721 .chindex Bcc:
4722 .chindex Cc:
4723 .chindex To:
4724 When Exim is receiving a locally-generated, non-SMTP message on its standard
4725 input, the &%-t%& option causes the recipients of the message to be obtained
4726 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4727 from the command arguments. The addresses are extracted before any rewriting
4728 takes place and the &'Bcc:'& header line, if present, is then removed.
4729
4730 .cindex "Sendmail compatibility" "&%-t%& option"
4731 If the command has any arguments, they specify addresses to which the message
4732 is &'not'& to be delivered. That is, the argument addresses are removed from
4733 the recipients list obtained from the headers. This is compatible with Smail 3
4734 and in accordance with the documented behaviour of several versions of
4735 Sendmail, as described in man pages on a number of operating systems (e.g.
4736 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4737 argument addresses to those obtained from the headers, and the O'Reilly
4738 Sendmail book documents it that way. Exim can be made to add argument addresses
4739 instead of subtracting them by setting the option
4740 &%extract_addresses_remove_arguments%& false.
4741
4742 .cindex "&%Resent-%& header lines" "with &%-t%&"
4743 If there are any &%Resent-%& header lines in the message, Exim extracts
4744 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4745 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4746 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4747 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4748
4749 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4750 message is resent several times). The RFC also specifies that they should be
4751 added at the front of the message, and separated by &'Received:'& lines. It is
4752 not at all clear how &%-t%& should operate in the present of multiple sets,
4753 nor indeed exactly what constitutes a &"set"&.
4754 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4755 are often added at the end of the header, and if a message is resent more than
4756 once, it is common for the original set of &%Resent-%& headers to be renamed as
4757 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4758
4759 .cmdopt -ti
4760 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4761 compatibility with Sendmail.
4762
4763 .cmdopt -tls-on-connect
4764 .cindex "TLS" "use without STARTTLS"
4765 .cindex "TLS" "automatic start"
4766 This option is available when Exim is compiled with TLS support. It forces all
4767 incoming SMTP connections to behave as if the incoming port is listed in the
4768 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4769 &<<CHAPTLS>>& for further details.
4770
4771
4772 .cmdopt -U
4773 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4774 Sendmail uses this option for &"initial message submission"&, and its
4775 documentation states that in future releases, it may complain about
4776 syntactically invalid messages rather than fixing them when this flag is not
4777 set. Exim ignores this option.
4778
4779 .cmdopt -v
4780 This option causes Exim to write information to the standard error stream,
4781 describing what it is doing. In particular, it shows the log lines for
4782 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4783 dialogue is shown. Some of the log lines shown may not actually be written to
4784 the log if the setting of &%log_selector%& discards them. Any relevant
4785 selectors are shown with each log line. If none are shown, the logging is
4786 unconditional.
4787
4788 .cmdopt -x
4789 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4790 National Language Support extended characters in the body of the mail item"&).
4791 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4792 this option.
4793
4794 .cmdopt -X <&'logfile'&>
4795 This option is interpreted by Sendmail to cause debug information to be sent
4796 to the named file.  It is ignored by Exim.
4797
4798 .cmdopt -z <&'log-line'&>
4799 This option writes its argument to Exim's logfile.
4800 Use is restricted to administrators; the intent is for operational notes.
4801 Quotes should be used to maintain a multi-word item as a single argument,
4802 under most shells.
4803 .endlist
4804
4805 .ecindex IIDclo1
4806 .ecindex IIDclo2
4807
4808
4809 . ////////////////////////////////////////////////////////////////////////////
4810 . Insert a stylized DocBook comment here, to identify the end of the command
4811 . line options. This is for the benefit of the Perl script that automatically
4812 . creates a man page for the options.
4813 . ////////////////////////////////////////////////////////////////////////////
4814
4815 .literal xml
4816 <!-- === End of command line options === -->
4817 .literal off
4818
4819
4820
4821
4822
4823 . ////////////////////////////////////////////////////////////////////////////
4824 . ////////////////////////////////////////////////////////////////////////////
4825
4826
4827 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4828          "The runtime configuration file"
4829
4830 .cindex "runtime configuration"
4831 .cindex "configuration file" "general description"
4832 .cindex "CONFIGURE_FILE"
4833 .cindex "configuration file" "errors in"
4834 .cindex "error" "in configuration file"
4835 .cindex "return code" "for bad configuration"
4836 Exim uses a single runtime configuration file that is read whenever an Exim
4837 binary is executed. Note that in normal operation, this happens frequently,
4838 because Exim is designed to operate in a distributed manner, without central
4839 control.
4840
4841 If a syntax error is detected while reading the configuration file, Exim
4842 writes a message on the standard error, and exits with a non-zero return code.
4843 The message is also written to the panic log. &*Note*&: Only simple syntax
4844 errors can be detected at this time. The values of any expanded options are
4845 not checked until the expansion happens, even when the expansion does not
4846 actually alter the string.
4847
4848 The name of the configuration file is compiled into the binary for security
4849 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4850 most configurations, this specifies a single file. However, it is permitted to
4851 give a colon-separated list of filenames, in which case Exim uses the first
4852 existing file in the list.
4853
4854 .cindex "EXIM_USER"
4855 .cindex "EXIM_GROUP"
4856 .cindex "CONFIGURE_OWNER"
4857 .cindex "CONFIGURE_GROUP"
4858 .cindex "configuration file" "ownership"
4859 .cindex "ownership" "configuration file"
4860 The runtime configuration file must be owned by root or by the user that is
4861 specified at compile time by the CONFIGURE_OWNER option (if set). The
4862 configuration file must not be world-writeable, or group-writeable unless its
4863 group is the root group or the one specified at compile time by the
4864 CONFIGURE_GROUP option.
4865
4866 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4867 to root, anybody who is able to edit the runtime configuration file has an
4868 easy way to run commands as root. If you specify a user or group in the
4869 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4870 who are members of that group will trivially be able to obtain root privileges.
4871
4872 Up to Exim version 4.72, the runtime configuration file was also permitted to
4873 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4874 since it offered a simple privilege escalation for any attacker who managed to
4875 compromise the Exim user account.
4876
4877 A default configuration file, which will work correctly in simple situations,
4878 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4879 defines just one filename, the installation process copies the default
4880 configuration to a new file of that name if it did not previously exist. If
4881 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4882 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4883 configuration.
4884
4885
4886
4887 .section "Using a different configuration file" "SECID40"
4888 .cindex "configuration file" "alternate"
4889 A one-off alternate configuration can be specified by the &%-C%& command line
4890 option, which may specify a single file or a list of files. However, when
4891 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4892 unless the argument for &%-C%& is identical to the built-in value from
4893 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4894 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4895 is useful mainly for checking the syntax of configuration files before
4896 installing them. No owner or group checks are done on a configuration file
4897 specified by &%-C%&, if root privilege has been dropped.
4898
4899 Even the Exim user is not trusted to specify an arbitrary configuration file
4900 with the &%-C%& option to be used with root privileges, unless that file is
4901 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4902 testing a configuration using &%-C%& right through message reception and
4903 delivery, even if the caller is root. The reception works, but by that time,
4904 Exim is running as the Exim user, so when it re-execs to regain privilege for
4905 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4906 can test reception and delivery using two separate commands (one to put a
4907 message in the queue, using &%-odq%&, and another to do the delivery, using
4908 &%-M%&).
4909
4910 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4911 prefix string with which any file named in a &%-C%& command line option must
4912 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4913 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4914 filename can be used with &%-C%&.
4915
4916 One-off changes to a configuration can be specified by the &%-D%& command line
4917 option, which defines and overrides values for macros used inside the
4918 configuration file. However, like &%-C%&, the use of this option by a
4919 non-privileged user causes Exim to discard its root privilege.
4920 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4921 completely disabled, and its use causes an immediate error exit.
4922
4923 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4924 to declare certain macro names trusted, such that root privilege will not
4925 necessarily be discarded.
4926 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4927 considered safe and, if &%-D%& only supplies macros from this list, and the
4928 values are acceptable, then Exim will not give up root privilege if the caller
4929 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4930 transition mechanism and is expected to be removed in the future.  Acceptable
4931 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4932
4933 Some sites may wish to use the same Exim binary on different machines that
4934 share a file system, but to use different configuration files on each machine.
4935 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4936 looks for a file whose name is the configuration filename followed by a dot
4937 and the machine's node name, as obtained from the &[uname()]& function. If this
4938 file does not exist, the standard name is tried. This processing occurs for
4939 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4940
4941 In some esoteric situations different versions of Exim may be run under
4942 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4943 help with this. See the comments in &_src/EDITME_& for details.
4944
4945
4946
4947 .section "Configuration file format" "SECTconffilfor"
4948 .cindex "configuration file" "format of"
4949 .cindex "format" "configuration file"
4950 Exim's configuration file is divided into a number of different parts. General
4951 option settings must always appear at the start of the file. The other parts
4952 are all optional, and may appear in any order. Each part other than the first
4953 is introduced by the word &"begin"& followed by at least one literal
4954 space, and the name of the part. The optional parts are:
4955
4956 .ilist
4957 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4958 &<<CHAPACL>>&).
4959 .next
4960 .cindex "AUTH" "configuration"
4961 &'authenticators'&: Configuration settings for the authenticator drivers. These
4962 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4963 .next
4964 &'routers'&: Configuration settings for the router drivers. Routers process
4965 addresses and determine how the message is to be delivered (see chapters
4966 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4967 .next
4968 &'transports'&: Configuration settings for the transport drivers. Transports
4969 define mechanisms for copying messages to destinations (see chapters
4970 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4971 .next
4972 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4973 If there is no retry section, or if it is empty (that is, no retry rules are
4974 defined), Exim will not retry deliveries. In this situation, temporary errors
4975 are treated the same as permanent errors. Retry rules are discussed in chapter
4976 &<<CHAPretry>>&.
4977 .next
4978 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4979 when new addresses are generated during delivery. Rewriting is discussed in
4980 chapter &<<CHAPrewrite>>&.
4981 .next
4982 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4983 want to use this feature, you must set
4984 .code
4985 LOCAL_SCAN_HAS_OPTIONS=yes
4986 .endd
4987 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4988 facility are given in chapter &<<CHAPlocalscan>>&.
4989 .endlist
4990
4991 .cindex "configuration file" "leading white space in"
4992 .cindex "configuration file" "trailing white space in"
4993 .cindex "white space" "in configuration file"
4994 Leading and trailing white space in configuration lines is always ignored.
4995
4996 Blank lines in the file, and lines starting with a # character (ignoring
4997 leading white space) are treated as comments and are ignored. &*Note*&: A
4998 # character other than at the beginning of a line is not treated specially,
4999 and does not introduce a comment.
5000
5001 Any non-comment line can be continued by ending it with a backslash. Note that
5002 the general rule for white space means that trailing white space after the
5003 backslash and leading white space at the start of continuation
5004 lines is ignored. Comment lines beginning with # (but not empty lines) may
5005 appear in the middle of a sequence of continuation lines.
5006
5007 A convenient way to create a configuration file is to start from the
5008 default, which is supplied in &_src/configure.default_&, and add, delete, or
5009 change settings as required.
5010
5011 The ACLs, retry rules, and rewriting rules have their own syntax which is
5012 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5013 respectively. The other parts of the configuration file have some syntactic
5014 items in common, and these are described below, from section &<<SECTcos>>&
5015 onwards. Before that, the inclusion, macro, and conditional facilities are
5016 described.
5017
5018
5019
5020 .section "File inclusions in the configuration file" "SECID41"
5021 .cindex "inclusions in configuration file"
5022 .cindex "configuration file" "including other files"
5023 .cindex "&`.include`& in configuration file"
5024 .cindex "&`.include_if_exists`& in configuration file"
5025 You can include other files inside Exim's runtime configuration file by
5026 using this syntax:
5027 .display
5028 &`.include`& <&'filename'&>
5029 &`.include_if_exists`& <&'filename'&>
5030 .endd
5031 on a line by itself. Double quotes round the filename are optional. If you use
5032 the first form, a configuration error occurs if the file does not exist; the
5033 second form does nothing for non-existent files.
5034 The first form allows a relative name. It is resolved relative to
5035 the directory of the including file. For the second form an absolute filename
5036 is required.
5037
5038 Includes may be nested to any depth, but remember that Exim reads its
5039 configuration file often, so it is a good idea to keep them to a minimum.
5040 If you change the contents of an included file, you must HUP the daemon,
5041 because an included file is read only when the configuration itself is read.
5042
5043 The processing of inclusions happens early, at a physical line level, so, like
5044 comment lines, an inclusion can be used in the middle of an option setting,
5045 for example:
5046 .code
5047 hosts_lookup = a.b.c \
5048                .include /some/file
5049 .endd
5050 Include processing happens after macro processing (see below). Its effect is to
5051 process the lines of the included file as if they occurred inline where the
5052 inclusion appears.
5053
5054
5055
5056 .section "Macros in the configuration file" "SECTmacrodefs"
5057 .cindex "macro" "description of"
5058 .cindex "configuration file" "macros"
5059 If a line in the main part of the configuration (that is, before the first
5060 &"begin"& line) begins with an upper case letter, it is taken as a macro
5061 definition, and must be of the form
5062 .display
5063 <&'name'&> = <&'rest of line'&>
5064 .endd
5065 The name must consist of letters, digits, and underscores, and need not all be
5066 in upper case, though that is recommended. The rest of the line, including any
5067 continuations, is the replacement text, and has leading and trailing white
5068 space removed. Quotes are not removed. The replacement text can never end with
5069 a backslash character, but this doesn't seem to be a serious limitation.
5070
5071 Macros may also be defined between router, transport, authenticator, or ACL
5072 definitions. They may not, however, be defined within an individual driver or
5073 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5074
5075 .section "Macro substitution" "SECID42"
5076 Once a macro is defined, all subsequent lines in the file (and any included
5077 files) are scanned for the macro name; if there are several macros, the line is
5078 scanned for each, in turn, in the order in which the macros are defined. The
5079 replacement text is not re-scanned for the current macro, though it is scanned
5080 for subsequently defined macros. For this reason, a macro name may not contain
5081 the name of a previously defined macro as a substring. You could, for example,
5082 define
5083 .display
5084 &`ABCD_XYZ = `&<&'something'&>
5085 &`ABCD = `&<&'something else'&>
5086 .endd
5087 but putting the definitions in the opposite order would provoke a configuration
5088 error. Macro expansion is applied to individual physical lines from the file,
5089 before checking for line continuation or file inclusion (see above). If a line
5090 consists solely of a macro name, and the expansion of the macro is empty, the
5091 line is ignored. A macro at the start of a line may turn the line into a
5092 comment line or a &`.include`& line.
5093
5094
5095 .section "Redefining macros" "SECID43"
5096 Once defined, the value of a macro can be redefined later in the configuration
5097 (or in an included file). Redefinition is specified by using &'=='& instead of
5098 &'='&. For example:
5099 .code
5100 MAC =  initial value
5101 ...
5102 MAC == updated value
5103 .endd
5104 Redefinition does not alter the order in which the macros are applied to the
5105 subsequent lines of the configuration file. It is still the same order in which
5106 the macros were originally defined. All that changes is the macro's value.
5107 Redefinition makes it possible to accumulate values. For example:
5108 .code
5109 MAC =  initial value
5110 ...
5111 MAC == MAC and something added
5112 .endd
5113 This can be helpful in situations where the configuration file is built
5114 from a number of other files.
5115
5116 .section "Overriding macro values" "SECID44"
5117 The values set for macros in the configuration file can be overridden by the
5118 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5119 used, unless called by root or the Exim user. A definition on the command line
5120 using the &%-D%& option causes all definitions and redefinitions within the
5121 file to be ignored.
5122
5123
5124
5125 .section "Example of macro usage" "SECID45"
5126 As an example of macro usage, consider a configuration where aliases are looked
5127 up in a MySQL database. It helps to keep the file less cluttered if long
5128 strings such as SQL statements are defined separately as macros, for example:
5129 .code
5130 ALIAS_QUERY = select mailbox from user where \
5131               login='${quote_mysql:$local_part}';
5132 .endd
5133 This can then be used in a &(redirect)& router setting like this:
5134 .code
5135 data = ${lookup mysql{ALIAS_QUERY}}
5136 .endd
5137 In earlier versions of Exim macros were sometimes used for domain, host, or
5138 address lists. In Exim 4 these are handled better by named lists &-- see
5139 section &<<SECTnamedlists>>&.
5140
5141
5142 .section "Builtin macros" "SECTbuiltinmacros"
5143 Exim defines some macros depending on facilities available, which may
5144 differ due to build-time definitions and from one release to another.
5145 All of these macros start with an underscore.
5146 They can be used to conditionally include parts of a configuration
5147 (see below).
5148
5149 The following classes of macros are defined:
5150 .display
5151 &` _HAVE_*                    `&  build-time defines
5152 &` _DRIVER_ROUTER_*           `&  router drivers
5153 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5154 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5155 &` _EXP_COND_*                `&  expansion conditions
5156 &` _EXP_ITEM_*                `&  expansion items
5157 &` _EXP_OP_*                  `&  expansion operators
5158 &` _EXP_VAR_*                 `&  expansion variables
5159 &` _LOG_*                     `&  log_selector values
5160 &` _OPT_MAIN_*                `&  main config options
5161 &` _OPT_ROUTERS_*             `&  generic router options
5162 &` _OPT_TRANSPORTS_*          `&  generic transport options
5163 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5164 &` _OPT_ROUTER_*_*            `&  private router options
5165 &` _OPT_TRANSPORT_*_*         `&  private transport options
5166 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5167 .endd
5168
5169 Use an &"exim -bP macros"& command to get the list of macros.
5170
5171
5172 .section "Conditional skips in the configuration file" "SECID46"
5173 .cindex "configuration file" "conditional skips"
5174 .cindex "&`.ifdef`&"
5175 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5176 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5177 portions of the configuration file. The processing happens whenever the file is
5178 read (that is, when an Exim binary starts to run).
5179
5180 The implementation is very simple. Instances of the first four directives must
5181 be followed by text that includes the names of one or macros. The condition
5182 that is tested is whether or not any macro substitution has taken place in the
5183 line. Thus:
5184 .code
5185 .ifdef AAA
5186 message_size_limit = 50M
5187 .else
5188 message_size_limit = 100M
5189 .endif
5190 .endd
5191 sets a message size limit of 50M if the macro &`AAA`& is defined
5192 (or &`A`& or &`AA`&), and 100M
5193 otherwise. If there is more than one macro named on the line, the condition
5194 is true if any of them are defined. That is, it is an &"or"& condition. To
5195 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5196
5197 Although you can use a macro expansion to generate one of these directives,
5198 it is not very useful, because the condition &"there was a macro substitution
5199 in this line"& will always be true.
5200
5201 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5202 to clarify complicated nestings.
5203
5204
5205
5206 .section "Common option syntax" "SECTcos"
5207 .cindex "common option syntax"
5208 .cindex "syntax of common options"
5209 .cindex "configuration file" "common option syntax"
5210 For the main set of options, driver options, and &[local_scan()]& options,
5211 each setting is on a line by itself, and starts with a name consisting of
5212 lower-case letters and underscores. Many options require a data value, and in
5213 these cases the name must be followed by an equals sign (with optional white
5214 space) and then the value. For example:
5215 .code
5216 qualify_domain = mydomain.example.com
5217 .endd
5218 .cindex "hiding configuration option values"
5219 .cindex "configuration options" "hiding value of"
5220 .cindex "options" "hiding value of"
5221 Some option settings may contain sensitive data, for example, passwords for
5222 accessing databases. To stop non-admin users from using the &%-bP%& command
5223 line option to read these values, you can precede the option settings with the
5224 word &"hide"&. For example:
5225 .code
5226 hide mysql_servers = localhost/users/admin/secret-password
5227 .endd
5228 For non-admin users, such options are displayed like this:
5229 .code
5230 mysql_servers = <value not displayable>
5231 .endd
5232 If &"hide"& is used on a driver option, it hides the value of that option on
5233 all instances of the same driver.
5234
5235 The following sections describe the syntax used for the different data types
5236 that are found in option settings.
5237
5238
5239 .section "Boolean options" "SECID47"
5240 .cindex "format" "boolean"
5241 .cindex "boolean configuration values"
5242 .oindex "&%no_%&&'xxx'&"
5243 .oindex "&%not_%&&'xxx'&"
5244 Options whose type is given as boolean are on/off switches. There are two
5245 different ways of specifying such options: with and without a data value. If
5246 the option name is specified on its own without data, the switch is turned on;
5247 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5248 boolean options may be followed by an equals sign and one of the words
5249 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5250 the following two settings have exactly the same effect:
5251 .code
5252 queue_only
5253 queue_only = true
5254 .endd
5255 The following two lines also have the same (opposite) effect:
5256 .code
5257 no_queue_only
5258 queue_only = false
5259 .endd
5260 You can use whichever syntax you prefer.
5261
5262
5263
5264
5265 .section "Integer values" "SECID48"
5266 .cindex "integer configuration values"
5267 .cindex "format" "integer"
5268 If an option's type is given as &"integer"&, the value can be given in decimal,
5269 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5270 number is assumed. Otherwise, it is treated as an octal number unless it starts
5271 with the characters &"0x"&, in which case the remainder is interpreted as a
5272 hexadecimal number.
5273
5274 If an integer value is followed by the letter K, it is multiplied by 1024; if
5275 it is followed by the letter M, it is multiplied by 1024x1024;
5276 if by the letter G, 1024x1024x1024.
5277 When the values
5278 of integer option settings are output, values which are an exact multiple of
5279 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5280 and M. The printing style is independent of the actual input format that was
5281 used.
5282
5283
5284 .section "Octal integer values" "SECID49"
5285 .cindex "integer format"
5286 .cindex "format" "octal integer"
5287 If an option's type is given as &"octal integer"&, its value is always
5288 interpreted as an octal number, whether or not it starts with the digit zero.
5289 Such options are always output in octal.
5290
5291
5292 .section "Fixed point numbers" "SECID50"
5293 .cindex "fixed point configuration values"
5294 .cindex "format" "fixed point"
5295 If an option's type is given as &"fixed-point"&, its value must be a decimal
5296 integer, optionally followed by a decimal point and up to three further digits.
5297
5298
5299
5300 .section "Time intervals" "SECTtimeformat"
5301 .cindex "time interval" "specifying in configuration"
5302 .cindex "format" "time interval"
5303 A time interval is specified as a sequence of numbers, each followed by one of
5304 the following letters, with no intervening white space:
5305
5306 .table2 30pt
5307 .irow &%s%& seconds
5308 .irow &%m%& minutes
5309 .irow &%h%& hours
5310 .irow &%d%& days
5311 .irow &%w%& weeks
5312 .endtable
5313
5314 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5315 intervals are output in the same format. Exim does not restrict the values; it
5316 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5317
5318
5319
5320 .section "String values" "SECTstrings"
5321 .cindex "string" "format of configuration values"
5322 .cindex "format" "string"
5323 If an option's type is specified as &"string"&, the value can be specified with
5324 or without double-quotes. If it does not start with a double-quote, the value
5325 consists of the remainder of the line plus any continuation lines, starting at
5326 the first character after any leading white space, with trailing white space
5327 removed, and with no interpretation of the characters in the string. Because
5328 Exim removes comment lines (those beginning with #) at an early stage, they can
5329 appear in the middle of a multi-line string. The following two settings are
5330 therefore equivalent:
5331 .code
5332 trusted_users = uucp:mail
5333 trusted_users = uucp:\
5334                 # This comment line is ignored
5335                 mail
5336 .endd
5337 .cindex "string" "quoted"
5338 .cindex "escape characters in quoted strings"
5339 If a string does start with a double-quote, it must end with a closing
5340 double-quote, and any backslash characters other than those used for line
5341 continuation are interpreted as escape characters, as follows:
5342
5343 .table2 100pt
5344 .irow &`\\`&                     "single backslash"
5345 .irow &`\n`&                     "newline"
5346 .irow &`\r`&                     "carriage return"
5347 .irow &`\t`&                     "tab"
5348 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5349 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5350                                    character"
5351 .endtable
5352
5353 If a backslash is followed by some other character, including a double-quote
5354 character, that character replaces the pair.
5355
5356 Quoting is necessary only if you want to make use of the backslash escapes to
5357 insert special characters, or if you need to specify a value with leading or
5358 trailing spaces. These cases are rare, so quoting is almost never needed in
5359 current versions of Exim. In versions of Exim before 3.14, quoting was required
5360 in order to continue lines, so you may come across older configuration files
5361 and examples that apparently quote unnecessarily.
5362
5363
5364 .section "Expanded strings" "SECID51"
5365 .cindex "expansion" "definition of"
5366 Some strings in the configuration file are subjected to &'string expansion'&,
5367 by which means various parts of the string may be changed according to the
5368 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5369 is as just described; in particular, the handling of backslashes in quoted
5370 strings is done as part of the input process, before expansion takes place.
5371 However, backslash is also an escape character for the expander, so any
5372 backslashes that are required for that reason must be doubled if they are
5373 within a quoted configuration string.
5374
5375
5376 .section "User and group names" "SECID52"
5377 .cindex "user name" "format of"
5378 .cindex "format" "user name"
5379 .cindex "groups" "name format"
5380 .cindex "format" "group name"
5381 User and group names are specified as strings, using the syntax described
5382 above, but the strings are interpreted specially. A user or group name must
5383 either consist entirely of digits, or be a name that can be looked up using the
5384 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5385
5386
5387 .section "List construction" "SECTlistconstruct"
5388 .cindex "list" "syntax of in configuration"
5389 .cindex "format" "list item in configuration"
5390 .cindex "string" "list, definition of"
5391 The data for some configuration options is a list of items, with colon as the
5392 default separator. Many of these options are shown with type &"string list"& in
5393 the descriptions later in this document. Others are listed as &"domain list"&,
5394 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5395 are all the same; however, those other than &"string list"& are subject to
5396 particular kinds of interpretation, as described in chapter
5397 &<<CHAPdomhosaddlists>>&.
5398
5399 In all these cases, the entire list is treated as a single string as far as the
5400 input syntax is concerned. The &%trusted_users%& setting in section
5401 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5402 in a list, it must be entered as two colons. Leading and trailing white space
5403 on each item in a list is ignored. This makes it possible to include items that
5404 start with a colon, and in particular, certain forms of IPv6 address. For
5405 example, the list
5406 .code
5407 local_interfaces = 127.0.0.1 : ::::1
5408 .endd
5409 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5410
5411 &*Note*&: Although leading and trailing white space is ignored in individual
5412 list items, it is not ignored when parsing the list. The spaces around the first
5413 colon in the example above are necessary. If they were not there, the list would
5414 be interpreted as the two items 127.0.0.1:: and 1.
5415
5416 .section "Changing list separators" "SECTlistsepchange"
5417 .cindex "list separator" "changing"
5418 .cindex "IPv6" "addresses in lists"
5419 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5420 introduced to allow the separator character to be changed. If a list begins
5421 with a left angle bracket, followed by any punctuation character, that
5422 character is used instead of colon as the list separator. For example, the list
5423 above can be rewritten to use a semicolon separator like this:
5424 .code
5425 local_interfaces = <; 127.0.0.1 ; ::1
5426 .endd
5427 This facility applies to all lists, with the exception of the list in
5428 &%log_file_path%&. It is recommended that the use of non-colon separators be
5429 confined to circumstances where they really are needed.
5430
5431 .cindex "list separator" "newline as"
5432 .cindex "newline" "as list separator"
5433 It is also possible to use newline and other control characters (those with
5434 code values less than 32, plus DEL) as separators in lists. Such separators
5435 must be provided literally at the time the list is processed. For options that
5436 are string-expanded, you can write the separator using a normal escape
5437 sequence. This will be processed by the expander before the string is
5438 interpreted as a list. For example, if a newline-separated list of domains is
5439 generated by a lookup, you can process it directly by a line such as this:
5440 .code
5441 domains = <\n ${lookup mysql{.....}}
5442 .endd
5443 This avoids having to change the list separator in such data. You are unlikely
5444 to want to use a control character as a separator in an option that is not
5445 expanded, because the value is literal text. However, it can be done by giving
5446 the value in quotes. For example:
5447 .code
5448 local_interfaces = "<\n 127.0.0.1 \n ::1"
5449 .endd
5450 Unlike printing character separators, which can be included in list items by
5451 doubling, it is not possible to include a control character as data when it is
5452 set as the separator. Two such characters in succession are interpreted as
5453 enclosing an empty list item.
5454
5455
5456
5457 .section "Empty items in lists" "SECTempitelis"
5458 .cindex "list" "empty item in"
5459 An empty item at the end of a list is always ignored. In other words, trailing
5460 separator characters are ignored. Thus, the list in
5461 .code
5462 senders = user@domain :
5463 .endd
5464 contains only a single item. If you want to include an empty string as one item
5465 in a list, it must not be the last item. For example, this list contains three
5466 items, the second of which is empty:
5467 .code
5468 senders = user1@domain : : user2@domain
5469 .endd
5470 &*Note*&: There must be white space between the two colons, as otherwise they
5471 are interpreted as representing a single colon data character (and the list
5472 would then contain just one item). If you want to specify a list that contains
5473 just one, empty item, you can do it as in this example:
5474 .code
5475 senders = :
5476 .endd
5477 In this case, the first item is empty, and the second is discarded because it
5478 is at the end of the list.
5479
5480
5481
5482
5483 .section "Format of driver configurations" "SECTfordricon"
5484 .cindex "drivers" "configuration format"
5485 There are separate parts in the configuration for defining routers, transports,
5486 and authenticators. In each part, you are defining a number of driver
5487 instances, each with its own set of options. Each driver instance is defined by
5488 a sequence of lines like this:
5489 .display
5490 <&'instance name'&>:
5491   <&'option'&>
5492   ...
5493   <&'option'&>
5494 .endd
5495 In the following example, the instance name is &(localuser)&, and it is
5496 followed by three options settings:
5497 .code
5498 localuser:
5499   driver = accept
5500   check_local_user
5501   transport = local_delivery
5502 .endd
5503 For each driver instance, you specify which Exim code module it uses &-- by the
5504 setting of the &%driver%& option &-- and (optionally) some configuration
5505 settings. For example, in the case of transports, if you want a transport to
5506 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5507 a local file you would use the &(appendfile)& driver. Each of the drivers is
5508 described in detail in its own separate chapter later in this manual.
5509
5510 You can have several routers, transports, or authenticators that are based on
5511 the same underlying driver (each must have a different instance name).
5512
5513 The order in which routers are defined is important, because addresses are
5514 passed to individual routers one by one, in order. The order in which
5515 transports are defined does not matter at all. The order in which
5516 authenticators are defined is used only when Exim, as a client, is searching
5517 them to find one that matches an authentication mechanism offered by the
5518 server.
5519
5520 .cindex "generic options"
5521 .cindex "options" "generic &-- definition of"
5522 Within a driver instance definition, there are two kinds of option: &'generic'&
5523 and &'private'&. The generic options are those that apply to all drivers of the
5524 same type (that is, all routers, all transports or all authenticators). The
5525 &%driver%& option is a generic option that must appear in every definition.
5526 .cindex "private options"
5527 The private options are special for each driver, and none need appear, because
5528 they all have default values.
5529
5530 The options may appear in any order, except that the &%driver%& option must
5531 precede any private options, since these depend on the particular driver. For
5532 this reason, it is recommended that &%driver%& always be the first option.
5533
5534 Driver instance names, which are used for reference in log entries and
5535 elsewhere, can be any sequence of letters, digits, and underscores (starting
5536 with a letter) and must be unique among drivers of the same type. A router and
5537 a transport (for example) can each have the same name, but no two router
5538 instances can have the same name. The name of a driver instance should not be
5539 confused with the name of the underlying driver module. For example, the
5540 configuration lines:
5541 .code
5542 remote_smtp:
5543   driver = smtp
5544 .endd
5545 create an instance of the &(smtp)& transport driver whose name is
5546 &(remote_smtp)&. The same driver code can be used more than once, with
5547 different instance names and different option settings each time. A second
5548 instance of the &(smtp)& transport, with different options, might be defined
5549 thus:
5550 .code
5551 special_smtp:
5552   driver = smtp
5553   port = 1234
5554   command_timeout = 10s
5555 .endd
5556 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5557 these transport instances from routers, and these names would appear in log
5558 lines.
5559
5560 Comment lines may be present in the middle of driver specifications. The full
5561 list of option settings for any particular driver instance, including all the
5562 defaulted values, can be extracted by making use of the &%-bP%& command line
5563 option.
5564
5565
5566
5567
5568
5569
5570 . ////////////////////////////////////////////////////////////////////////////
5571 . ////////////////////////////////////////////////////////////////////////////
5572
5573 .chapter "The default configuration file" "CHAPdefconfil"
5574 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5575 .cindex "default" "configuration file &""walk through""&"
5576 The default configuration file supplied with Exim as &_src/configure.default_&
5577 is sufficient for a host with simple mail requirements. As an introduction to
5578 the way Exim is configured, this chapter &"walks through"& the default
5579 configuration, giving brief explanations of the settings. Detailed descriptions
5580 of the options are given in subsequent chapters. The default configuration file
5581 itself contains extensive comments about ways you might want to modify the
5582 initial settings. However, note that there are many options that are not
5583 mentioned at all in the default configuration.
5584
5585
5586
5587 .section "Macros" "SECTdefconfmacros"
5588 All macros should be defined before any options.
5589
5590 One macro is specified, but commented out, in the default configuration:
5591 .code
5592 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5593 .endd
5594 If all off-site mail is expected to be delivered to a "smarthost", then set the
5595 hostname here and uncomment the macro.  This will affect which router is used
5596 later on.  If this is left commented out, then Exim will perform direct-to-MX
5597 deliveries using a &(dnslookup)& router.
5598
5599 In addition to macros defined here, Exim includes a number of built-in macros
5600 to enable configuration to be guarded by a binary built with support for a
5601 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5602
5603
5604 .section "Main configuration settings" "SECTdefconfmain"
5605 The main (global) configuration option settings section must always come first
5606 in the file, after the macros.
5607 The first thing you'll see in the file, after some initial comments, is the line
5608 .code
5609 # primary_hostname =
5610 .endd
5611 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5612 to know the official, fully qualified name of your host, and this is where you
5613 can specify it. However, in most cases you do not need to set this option. When
5614 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5615
5616 The first three non-comment configuration lines are as follows:
5617 .code
5618 domainlist local_domains    = @
5619 domainlist relay_to_domains =
5620 hostlist   relay_from_hosts = 127.0.0.1
5621 .endd
5622 These are not, in fact, option settings. They are definitions of two named
5623 domain lists and one named host list. Exim allows you to give names to lists of
5624 domains, hosts, and email addresses, in order to make it easier to manage the
5625 configuration file (see section &<<SECTnamedlists>>&).
5626
5627 The first line defines a domain list called &'local_domains'&; this is used
5628 later in the configuration to identify domains that are to be delivered
5629 on the local host.
5630
5631 .cindex "@ in a domain list"
5632 There is just one item in this list, the string &"@"&. This is a special form
5633 of entry which means &"the name of the local host"&. Thus, if the local host is
5634 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5635 be delivered locally. Because the local host's name is referenced indirectly,
5636 the same configuration file can be used on different hosts.
5637
5638 The second line defines a domain list called &'relay_to_domains'&, but the
5639 list itself is empty. Later in the configuration we will come to the part that
5640 controls mail relaying through the local host; it allows relaying to any
5641 domains in this list. By default, therefore, no relaying on the basis of a mail
5642 domain is permitted.
5643
5644 The third line defines a host list called &'relay_from_hosts'&. This list is
5645 used later in the configuration to permit relaying from any host or IP address
5646 that matches the list. The default contains just the IP address of the IPv4
5647 loopback interface, which means that processes on the local host are able to
5648 submit mail for relaying by sending it over TCP/IP to that interface. No other
5649 hosts are permitted to submit messages for relaying.
5650
5651 Just to be sure there's no misunderstanding: at this point in the configuration
5652 we aren't actually setting up any controls. We are just defining some domains
5653 and hosts that will be used in the controls that are specified later.
5654
5655 The next two configuration lines are genuine option settings:
5656 .code
5657 acl_smtp_rcpt = acl_check_rcpt
5658 acl_smtp_data = acl_check_data
5659 .endd
5660 These options specify &'Access Control Lists'& (ACLs) that are to be used
5661 during an incoming SMTP session for every recipient of a message (every RCPT
5662 command), and after the contents of the message have been received,
5663 respectively. The names of the lists are &'acl_check_rcpt'& and
5664 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5665 section of the configuration. The RCPT ACL controls which recipients are
5666 accepted for an incoming message &-- if a configuration does not provide an ACL
5667 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5668 contents of a message to be checked.
5669
5670 Two commented-out option settings are next:
5671 .code
5672 # av_scanner = clamd:/tmp/clamd
5673 # spamd_address = 127.0.0.1 783
5674 .endd
5675 These are example settings that can be used when Exim is compiled with the
5676 content-scanning extension. The first specifies the interface to the virus
5677 scanner, and the second specifies the interface to SpamAssassin. Further
5678 details are given in chapter &<<CHAPexiscan>>&.
5679
5680 Three more commented-out option settings follow:
5681 .code
5682 # tls_advertise_hosts = *
5683 # tls_certificate = /etc/ssl/exim.crt
5684 # tls_privatekey = /etc/ssl/exim.pem
5685 .endd
5686 These are example settings that can be used when Exim is compiled with
5687 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5688 first one specifies the list of clients that are allowed to use TLS when
5689 connecting to this server; in this case, the wildcard means all clients. The
5690 other options specify where Exim should find its TLS certificate and private
5691 key, which together prove the server's identity to any clients that connect.
5692 More details are given in chapter &<<CHAPTLS>>&.
5693
5694 Another two commented-out option settings follow:
5695 .code
5696 # daemon_smtp_ports = 25 : 465 : 587
5697 # tls_on_connect_ports = 465
5698 .endd
5699 .cindex "port" "465 and 587"
5700 .cindex "port" "for message submission"
5701 .cindex "message" "submission, ports for"
5702 .cindex "submissions protocol"
5703 .cindex "smtps protocol"
5704 .cindex "ssmtp protocol"
5705 .cindex "SMTP" "submissions protocol"
5706 .cindex "SMTP" "ssmtp protocol"
5707 .cindex "SMTP" "smtps protocol"
5708 These options provide better support for roaming users who wish to use this
5709 server for message submission. They are not much use unless you have turned on
5710 TLS (as described in the previous paragraph) and authentication (about which
5711 more in section &<<SECTdefconfauth>>&).
5712 Mail submission from mail clients (MUAs) should be separate from inbound mail
5713 to your domain (MX delivery) for various good reasons (eg, ability to impose
5714 much saner TLS protocol and ciphersuite requirements without unintended
5715 consequences).
5716 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5717 which uses STARTTLS, so this is the &"submission"& port.
5718 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5719 which should be used in preference to 587.
5720 You should also consider deploying SRV records to help clients find
5721 these ports.
5722 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5723
5724 Two more commented-out options settings follow:
5725 .code
5726 # qualify_domain =
5727 # qualify_recipient =
5728 .endd
5729 The first of these specifies a domain that Exim uses when it constructs a
5730 complete email address from a local login name. This is often needed when Exim
5731 receives a message from a local process. If you do not set &%qualify_domain%&,
5732 the value of &%primary_hostname%& is used. If you set both of these options,
5733 you can have different qualification domains for sender and recipient
5734 addresses. If you set only the first one, its value is used in both cases.
5735
5736 .cindex "domain literal" "recognizing format"
5737 The following line must be uncommented if you want Exim to recognize
5738 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5739 (an IP address within square brackets) instead of a named domain.
5740 .code
5741 # allow_domain_literals
5742 .endd
5743 The RFCs still require this form, but many people think that in the modern
5744 Internet it makes little sense to permit mail to be sent to specific hosts by
5745 quoting their IP addresses. This ancient format has been used by people who
5746 try to abuse hosts by using them for unwanted relaying. However, some
5747 people believe there are circumstances (for example, messages addressed to
5748 &'postmaster'&) where domain literals are still useful.
5749
5750 The next configuration line is a kind of trigger guard:
5751 .code
5752 never_users = root
5753 .endd
5754 It specifies that no delivery must ever be run as the root user. The normal
5755 convention is to set up &'root'& as an alias for the system administrator. This
5756 setting is a guard against slips in the configuration.
5757 The list of users specified by &%never_users%& is not, however, the complete
5758 list; the build-time configuration in &_Local/Makefile_& has an option called
5759 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5760 contents of &%never_users%& are added to this list. By default
5761 FIXED_NEVER_USERS also specifies root.
5762
5763 When a remote host connects to Exim in order to send mail, the only information
5764 Exim has about the host's identity is its IP address. The next configuration
5765 line,
5766 .code
5767 host_lookup = *
5768 .endd
5769 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5770 in order to get a host name. This improves the quality of the logging
5771 information, but if you feel it is too expensive, you can remove it entirely,
5772 or restrict the lookup to hosts on &"nearby"& networks.
5773 Note that it is not always possible to find a host name from an IP address,
5774 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5775 unreachable.
5776
5777 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5778 1413 (hence their names):
5779 .code
5780 rfc1413_hosts = *
5781 rfc1413_query_timeout = 0s
5782 .endd
5783 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5784 Few hosts offer RFC1413 service these days; calls have to be
5785 terminated by a timeout and this needlessly delays the startup
5786 of an incoming SMTP connection.
5787 If you have hosts for which you trust RFC1413 and need this
5788 information, you can change this.
5789
5790 This line enables an efficiency SMTP option.  It is negotiated by clients
5791 and not expected to cause problems but can be disabled if needed.
5792 .code
5793 prdr_enable = true
5794 .endd
5795
5796 When Exim receives messages over SMTP connections, it expects all addresses to
5797 be fully qualified with a domain, as required by the SMTP definition. However,
5798 if you are running a server to which simple clients submit messages, you may
5799 find that they send unqualified addresses. The two commented-out options:
5800 .code
5801 # sender_unqualified_hosts =
5802 # recipient_unqualified_hosts =
5803 .endd
5804 show how you can specify hosts that are permitted to send unqualified sender
5805 and recipient addresses, respectively.
5806
5807 The &%log_selector%& option is used to increase the detail of logging
5808 over the default:
5809 .code
5810 log_selector = +smtp_protocol_error +smtp_syntax_error \
5811                +tls_certificate_verified
5812 .endd
5813
5814 The &%percent_hack_domains%& option is also commented out:
5815 .code
5816 # percent_hack_domains =
5817 .endd
5818 It provides a list of domains for which the &"percent hack"& is to operate.
5819 This is an almost obsolete form of explicit email routing. If you do not know
5820 anything about it, you can safely ignore this topic.
5821
5822 The next two settings in the main part of the default configuration are
5823 concerned with messages that have been &"frozen"& on Exim's queue. When a
5824 message is frozen, Exim no longer continues to try to deliver it. Freezing
5825 occurs when a bounce message encounters a permanent failure because the sender
5826 address of the original message that caused the bounce is invalid, so the
5827 bounce cannot be delivered. This is probably the most common case, but there
5828 are also other conditions that cause freezing, and frozen messages are not
5829 always bounce messages.
5830 .code
5831 ignore_bounce_errors_after = 2d
5832 timeout_frozen_after = 7d
5833 .endd
5834 The first of these options specifies that failing bounce messages are to be
5835 discarded after 2 days in the queue. The second specifies that any frozen
5836 message (whether a bounce message or not) is to be timed out (and discarded)
5837 after a week. In this configuration, the first setting ensures that no failing
5838 bounce message ever lasts a week.
5839
5840 Exim queues it's messages in a spool directory. If you expect to have
5841 large queues, you may consider using this option. It splits the spool
5842 directory into subdirectories to avoid file system degradation from
5843 many files in a single directory, resulting in better performance.
5844 Manual manipulation of queued messages becomes more complex (though fortunately
5845 not often needed).
5846 .code
5847 # split_spool_directory = true
5848 .endd
5849
5850 In an ideal world everybody follows the standards. For non-ASCII
5851 messages RFC 2047 is a standard, allowing a maximum line length of 76
5852 characters. Exim adheres that standard and won't process messages which
5853 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5854 In particular, the Exim maintainers have had multiple reports of
5855 problems from Russian administrators of issues until they disable this
5856 check, because of some popular, yet buggy, mail composition software.
5857 .code
5858 # check_rfc2047_length = false
5859 .endd
5860
5861 If you need to be strictly RFC compliant you may wish to disable the
5862 8BITMIME advertisement. Use this, if you exchange mails with systems
5863 that are not 8-bit clean.
5864 .code
5865 # accept_8bitmime = false
5866 .endd
5867
5868 Libraries you use may depend on specific environment settings.  This
5869 imposes a security risk (e.g. PATH). There are two lists:
5870 &%keep_environment%& for the variables to import as they are, and
5871 &%add_environment%& for variables we want to set to a fixed value.
5872 Note that TZ is handled separately, by the &%timezone%& runtime
5873 option and by the TIMEZONE_DEFAULT buildtime option.
5874 .code
5875 # keep_environment = ^LDAP
5876 # add_environment = PATH=/usr/bin::/bin
5877 .endd
5878
5879
5880 .section "ACL configuration" "SECID54"
5881 .cindex "default" "ACLs"
5882 .cindex "&ACL;" "default configuration"
5883 In the default configuration, the ACL section follows the main configuration.
5884 It starts with the line
5885 .code
5886 begin acl
5887 .endd
5888 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5889 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5890 and &%acl_smtp_data%& above.
5891
5892 .cindex "RCPT" "ACL for"
5893 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5894 RCPT command specifies one of the message's recipients. The ACL statements
5895 are considered in order, until the recipient address is either accepted or
5896 rejected. The RCPT command is then accepted or rejected, according to the
5897 result of the ACL processing.
5898 .code
5899 acl_check_rcpt:
5900 .endd
5901 This line, consisting of a name terminated by a colon, marks the start of the
5902 ACL, and names it.
5903 .code
5904 accept  hosts = :
5905 .endd
5906 This ACL statement accepts the recipient if the sending host matches the list.
5907 But what does that strange list mean? It doesn't actually contain any host
5908 names or IP addresses. The presence of the colon puts an empty item in the
5909 list; Exim matches this only if the incoming message did not come from a remote
5910 host, because in that case, the remote hostname is empty. The colon is
5911 important. Without it, the list itself is empty, and can never match anything.
5912
5913 What this statement is doing is to accept unconditionally all recipients in
5914 messages that are submitted by SMTP from local processes using the standard
5915 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5916 manner.
5917 .code
5918 deny    domains       = +local_domains
5919         local_parts   = ^[.] : ^.*[@%!/|]
5920         message       = Restricted characters in address
5921
5922 deny    domains       = !+local_domains
5923         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5924         message       = Restricted characters in address
5925 .endd
5926 These statements are concerned with local parts that contain any of the
5927 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5928 Although these characters are entirely legal in local parts (in the case of
5929 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5930 in Internet mail addresses.
5931
5932 The first three have in the past been associated with explicitly routed
5933 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5934 option). Addresses containing these characters are regularly tried by spammers
5935 in an attempt to bypass relaying restrictions, and also by open relay testing
5936 programs. Unless you really need them it is safest to reject these characters
5937 at this early stage. This configuration is heavy-handed in rejecting these
5938 characters for all messages it accepts from remote hosts. This is a deliberate
5939 policy of being as safe as possible.
5940
5941 The first rule above is stricter, and is applied to messages that are addressed
5942 to one of the local domains handled by this host. This is implemented by the
5943 first condition, which restricts it to domains that are listed in the
5944 &'local_domains'& domain list. The &"+"& character is used to indicate a
5945 reference to a named list. In this configuration, there is just one domain in
5946 &'local_domains'&, but in general there may be many.
5947
5948 The second condition on the first statement uses two regular expressions to
5949 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5950 or &"|"&. If you have local accounts that include these characters, you will
5951 have to modify this rule.
5952
5953 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5954 allows them because they have been encountered in practice. (Consider the
5955 common convention of local parts constructed as
5956 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5957 the author of Exim, who has no second initial.) However, a local part starting
5958 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5959 filename (for example, for a mailing list). This is also true for local parts
5960 that contain slashes. A pipe symbol can also be troublesome if the local part
5961 is incorporated unthinkingly into a shell command line.
5962
5963 The second rule above applies to all other domains, and is less strict. This
5964 allows your own users to send outgoing messages to sites that use slashes
5965 and vertical bars in their local parts. It blocks local parts that begin
5966 with a dot, slash, or vertical bar, but allows these characters within the
5967 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5968 and &"!"& is blocked, as before. The motivation here is to prevent your users
5969 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5970 .code
5971 accept  local_parts   = postmaster
5972         domains       = +local_domains
5973 .endd
5974 This statement, which has two conditions, accepts an incoming address if the
5975 local part is &'postmaster'& and the domain is one of those listed in the
5976 &'local_domains'& domain list. The &"+"& character is used to indicate a
5977 reference to a named list. In this configuration, there is just one domain in
5978 &'local_domains'&, but in general there may be many.
5979
5980 The presence of this statement means that mail to postmaster is never blocked
5981 by any of the subsequent tests. This can be helpful while sorting out problems
5982 in cases where the subsequent tests are incorrectly denying access.
5983 .code
5984 require verify        = sender
5985 .endd
5986 This statement requires the sender address to be verified before any subsequent
5987 ACL statement can be used. If verification fails, the incoming recipient
5988 address is refused. Verification consists of trying to route the address, to
5989 see if a bounce message could be delivered to it. In the case of remote
5990 addresses, basic verification checks only the domain, but &'callouts'& can be
5991 used for more verification if required. Section &<<SECTaddressverification>>&
5992 discusses the details of address verification.
5993 .code
5994 accept  hosts         = +relay_from_hosts
5995         control       = submission
5996 .endd
5997 This statement accepts the address if the message is coming from one of the
5998 hosts that are defined as being allowed to relay through this host. Recipient
5999 verification is omitted here, because in many cases the clients are dumb MUAs
6000 that do not cope well with SMTP error responses. For the same reason, the
6001 second line specifies &"submission mode"& for messages that are accepted. This
6002 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6003 messages that are deficient in some way, for example, because they lack a
6004 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6005 probably add recipient verification here, and disable submission mode.
6006 .code
6007 accept  authenticated = *
6008         control       = submission
6009 .endd
6010 This statement accepts the address if the client host has authenticated itself.
6011 Submission mode is again specified, on the grounds that such messages are most
6012 likely to come from MUAs. The default configuration does not define any
6013 authenticators, though it does include some nearly complete commented-out
6014 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6015 fact authenticate until you complete the authenticator definitions.
6016 .code
6017 require message = relay not permitted
6018         domains = +local_domains : +relay_to_domains
6019 .endd
6020 This statement rejects the address if its domain is neither a local domain nor
6021 one of the domains for which this host is a relay.
6022 .code
6023 require verify = recipient
6024 .endd
6025 This statement requires the recipient address to be verified; if verification
6026 fails, the address is rejected.
6027 .code
6028 # deny    dnslists    = black.list.example
6029 #         message     = rejected because $sender_host_address \
6030 #                       is in a black list at $dnslist_domain\n\
6031 #                       $dnslist_text
6032 #
6033 # warn    dnslists    = black.list.example
6034 #         add_header  = X-Warning: $sender_host_address is in \
6035 #                       a black list at $dnslist_domain
6036 #         log_message = found in $dnslist_domain
6037 .endd
6038 These commented-out lines are examples of how you could configure Exim to check
6039 sending hosts against a DNS black list. The first statement rejects messages
6040 from blacklisted hosts, whereas the second just inserts a warning header
6041 line.
6042 .code
6043 # require verify = csa
6044 .endd
6045 This commented-out line is an example of how you could turn on client SMTP
6046 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6047 records.
6048 .code
6049 accept
6050 .endd
6051 The final statement in the first ACL unconditionally accepts any recipient
6052 address that has successfully passed all the previous tests.
6053 .code
6054 acl_check_data:
6055 .endd
6056 This line marks the start of the second ACL, and names it. Most of the contents
6057 of this ACL are commented out:
6058 .code
6059 # deny    malware   = *
6060 #         message   = This message contains a virus \
6061 #                     ($malware_name).
6062 .endd
6063 These lines are examples of how to arrange for messages to be scanned for
6064 viruses when Exim has been compiled with the content-scanning extension, and a
6065 suitable virus scanner is installed. If the message is found to contain a
6066 virus, it is rejected with the given custom error message.
6067 .code
6068 # warn    spam      = nobody
6069 #         message   = X-Spam_score: $spam_score\n\
6070 #                     X-Spam_score_int: $spam_score_int\n\
6071 #                     X-Spam_bar: $spam_bar\n\
6072 #                     X-Spam_report: $spam_report
6073 .endd
6074 These lines are an example of how to arrange for messages to be scanned by
6075 SpamAssassin when Exim has been compiled with the content-scanning extension,
6076 and SpamAssassin has been installed. The SpamAssassin check is run with
6077 &`nobody`& as its user parameter, and the results are added to the message as a
6078 series of extra header line. In this case, the message is not rejected,
6079 whatever the spam score.
6080 .code
6081 accept
6082 .endd
6083 This final line in the DATA ACL accepts the message unconditionally.
6084
6085
6086 .section "Router configuration" "SECID55"
6087 .cindex "default" "routers"
6088 .cindex "routers" "default"
6089 The router configuration comes next in the default configuration, introduced
6090 by the line
6091 .code
6092 begin routers
6093 .endd
6094 Routers are the modules in Exim that make decisions about where to send
6095 messages. An address is passed to each router, in turn, until it is either
6096 accepted, or failed. This means that the order in which you define the routers
6097 matters. Each router is fully described in its own chapter later in this
6098 manual. Here we give only brief overviews.
6099 .code
6100 # domain_literal:
6101 #   driver = ipliteral
6102 #   domains = !+local_domains
6103 #   transport = remote_smtp
6104 .endd
6105 .cindex "domain literal" "default router"
6106 This router is commented out because the majority of sites do not want to
6107 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6108 you uncomment this router, you also need to uncomment the setting of
6109 &%allow_domain_literals%& in the main part of the configuration.
6110
6111 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6112 macro has been defined, per
6113 .code
6114 .ifdef ROUTER_SMARTHOST
6115 smarthost:
6116 #...
6117 .else
6118 dnslookup:
6119 #...
6120 .endif
6121 .endd
6122
6123 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6124 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6125 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6126 skip these routers because of the &%domains%& option.
6127
6128 .code
6129 smarthost:
6130   driver = manualroute
6131   domains = ! +local_domains
6132   transport = smarthost_smtp
6133   route_data = ROUTER_SMARTHOST
6134   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6135   no_more
6136 .endd
6137 This router only handles mail which is not to any local domains; this is
6138 specified by the line
6139 .code
6140 domains = ! +local_domains
6141 .endd
6142 The &%domains%& option lists the domains to which this router applies, but the
6143 exclamation mark is a negation sign, so the router is used only for domains
6144 that are not in the domain list called &'local_domains'& (which was defined at
6145 the start of the configuration). The plus sign before &'local_domains'&
6146 indicates that it is referring to a named list. Addresses in other domains are
6147 passed on to the following routers.
6148
6149 The name of the router driver is &(manualroute)& because we are manually
6150 specifying how mail should be routed onwards, instead of using DNS MX.
6151 While the name of this router instance is arbitrary, the &%driver%& option must
6152 be one of the driver modules that is in the Exim binary.
6153
6154 With no pre-conditions other than &%domains%&, all mail for non-local domains
6155 will be handled by this router, and the &%no_more%& setting will ensure that no
6156 other routers will be used for messages matching the pre-conditions.  See
6157 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6158 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6159 and the macro supplies the value; the address is then queued for the
6160 &(smarthost_smtp)& transport.
6161
6162 .code
6163 dnslookup:
6164   driver = dnslookup
6165   domains = ! +local_domains
6166   transport = remote_smtp
6167   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6168   no_more
6169 .endd
6170 The &%domains%& option behaves as per smarthost, above.
6171
6172 The name of the router driver is &(dnslookup)&,
6173 and is specified by the &%driver%& option. Do not be confused by the fact that
6174 the name of this router instance is the same as the name of the driver. The
6175 instance name is arbitrary, but the name set in the &%driver%& option must be
6176 one of the driver modules that is in the Exim binary.
6177
6178 The &(dnslookup)& router routes addresses by looking up their domains in the
6179 DNS in order to obtain a list of hosts to which the address is routed. If the
6180 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6181 specified by the &%transport%& option. If the router does not find the domain
6182 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6183 the address fails and is bounced.
6184
6185 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6186 be entirely ignored. This option is present because a number of cases have been
6187 encountered where MX records in the DNS point to host names
6188 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6189 Completely ignoring these IP addresses causes Exim to fail to route the
6190 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6191 continue to try to deliver the message periodically until the address timed
6192 out.
6193 .code
6194 system_aliases:
6195   driver = redirect
6196   allow_fail
6197   allow_defer
6198   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6199 # user = exim
6200   file_transport = address_file
6201   pipe_transport = address_pipe
6202 .endd
6203 Control reaches this and subsequent routers only for addresses in the local
6204 domains. This router checks to see whether the local part is defined as an
6205 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6206 data that it looks up from that file. If no data is found for the local part,
6207 the value of the &%data%& option is empty, causing the address to be passed to
6208 the next router.
6209
6210 &_/etc/aliases_& is a conventional name for the system aliases file that is
6211 often used. That is why it is referenced by from the default configuration
6212 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6213 &_Local/Makefile_& before building Exim.
6214 .code
6215 userforward:
6216   driver = redirect
6217   check_local_user
6218 # local_part_suffix = +* : -*
6219 # local_part_suffix_optional
6220   file = $home/.forward
6221 # allow_filter
6222   no_verify
6223   no_expn
6224   check_ancestor
6225   file_transport = address_file
6226   pipe_transport = address_pipe
6227   reply_transport = address_reply
6228 .endd
6229 This is the most complicated router in the default configuration. It is another
6230 redirection router, but this time it is looking for forwarding data set up by
6231 individual users. The &%check_local_user%& setting specifies a check that the
6232 local part of the address is the login name of a local user. If it is not, the
6233 router is skipped. The two commented options that follow &%check_local_user%&,
6234 namely:
6235 .code
6236 # local_part_suffix = +* : -*
6237 # local_part_suffix_optional
6238 .endd
6239 .vindex "&$local_part_suffix$&"
6240 show how you can specify the recognition of local part suffixes. If the first
6241 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6242 by any sequence of characters, is removed from the local part and placed in the
6243 variable &$local_part_suffix$&. The second suffix option specifies that the
6244 presence of a suffix in the local part is optional. When a suffix is present,
6245 the check for a local login uses the local part with the suffix removed.
6246
6247 When a local user account is found, the file called &_.forward_& in the user's
6248 home directory is consulted. If it does not exist, or is empty, the router
6249 declines. Otherwise, the contents of &_.forward_& are interpreted as
6250 redirection data (see chapter &<<CHAPredirect>>& for more details).
6251
6252 .cindex "Sieve filter" "enabling in default router"
6253 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6254 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6255 is commented out by default), the contents of the file are interpreted as a set
6256 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6257 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6258 separate document entitled &'Exim's interfaces to mail filtering'&.
6259
6260 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6261 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6262 There are two reasons for doing this:
6263
6264 .olist
6265 Whether or not a local user has a &_.forward_& file is not really relevant when
6266 checking an address for validity; it makes sense not to waste resources doing
6267 unnecessary work.
6268 .next
6269 More importantly, when Exim is verifying addresses or handling an EXPN
6270 command during an SMTP session, it is running as the Exim user, not as root.
6271 The group is the Exim group, and no additional groups are set up.
6272 It may therefore not be possible for Exim to read users' &_.forward_& files at
6273 this time.
6274 .endlist
6275
6276 The setting of &%check_ancestor%& prevents the router from generating a new
6277 address that is the same as any previous address that was redirected. (This
6278 works round a problem concerning a bad interaction between aliasing and
6279 forwarding &-- see section &<<SECTredlocmai>>&).
6280
6281 The final three option settings specify the transports that are to be used when
6282 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6283 auto-reply, respectively. For example, if a &_.forward_& file contains
6284 .code
6285 a.nother@elsewhere.example, /home/spqr/archive
6286 .endd
6287 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6288 transport.
6289 .code
6290 localuser:
6291   driver = accept
6292   check_local_user
6293 # local_part_suffix = +* : -*
6294 # local_part_suffix_optional
6295   transport = local_delivery
6296 .endd
6297 The final router sets up delivery into local mailboxes, provided that the local
6298 part is the name of a local login, by accepting the address and assigning it to
6299 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6300 routers, so the address is bounced. The commented suffix settings fulfil the
6301 same purpose as they do for the &(userforward)& router.
6302
6303
6304 .section "Transport configuration" "SECID56"
6305 .cindex "default" "transports"
6306 .cindex "transports" "default"
6307 Transports define mechanisms for actually delivering messages. They operate
6308 only when referenced from routers, so the order in which they are defined does
6309 not matter. The transports section of the configuration starts with
6310 .code
6311 begin transports
6312 .endd
6313 Two remote transports and four local transports are defined.
6314 .code
6315 remote_smtp:
6316   driver = smtp
6317   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6318 .ifdef _HAVE_PRDR
6319   hosts_try_prdr = *
6320 .endif
6321 .endd
6322 This transport is used for delivering messages over SMTP connections.
6323 The list of remote hosts comes from the router.
6324 The &%message_size_limit%& usage is a hack to avoid sending on messages
6325 with over-long lines.
6326
6327 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6328 negotiated between client and server and not expected to cause problems
6329 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6330 use of the &%hosts_try_prdr%& configuration option.
6331
6332 The other remote transport is used when delivering to a specific smarthost
6333 with whom there must be some kind of existing relationship, instead of the
6334 usual federated system.
6335
6336 .code
6337 smarthost_smtp:
6338   driver = smtp
6339   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6340   multi_domain
6341   #
6342 .ifdef _HAVE_TLS
6343   # Comment out any of these which you have to, then file a Support
6344   # request with your smarthost provider to get things fixed:
6345   hosts_require_tls = *
6346   tls_verify_hosts = *
6347   # As long as tls_verify_hosts is enabled, this this will have no effect,
6348   # but if you have to comment it out then this will at least log whether
6349   # you succeed or not:
6350   tls_try_verify_hosts = *
6351   #
6352   # The SNI name should match the name which we'll expect to verify;
6353   # many mail systems don't use SNI and this doesn't matter, but if it does,
6354   # we need to send a name which the remote site will recognize.
6355   # This _should_ be the name which the smarthost operators specified as
6356   # the hostname for sending your mail to.
6357   tls_sni = ROUTER_SMARTHOST
6358   #
6359 .ifdef _HAVE_OPENSSL
6360   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6361 .endif
6362 .ifdef _HAVE_GNUTLS
6363   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6364 .endif
6365 .endif
6366 .ifdef _HAVE_PRDR
6367   hosts_try_prdr = *
6368 .endif
6369 .endd
6370 After the same &%message_size_limit%& hack, we then specify that this Transport
6371 can handle messages to multiple domains in one run.  The assumption here is
6372 that you're routing all non-local mail to the same place and that place is
6373 happy to take all messages from you as quickly as possible.
6374 All other options depend upon built-in macros; if Exim was built without TLS support
6375 then no other options are defined.
6376 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6377 and versions using the &%tls_require_ciphers%& option, where the value to be
6378 used depends upon the library providing TLS.
6379 Beyond that, the options adopt the stance that you should have TLS support available
6380 from your smarthost on today's Internet, so we turn on requiring TLS for the
6381 mail to be delivered, and requiring that the certificate be valid, and match
6382 the expected hostname.  The &%tls_sni%& option can be used by service providers
6383 to select an appropriate certificate to present to you and here we re-use the
6384 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6385 You want to specify the hostname which you'll expect to validate for, and that
6386 should not be subject to insecure tampering via DNS results.
6387
6388 For the &%hosts_try_prdr%& option see the previous transport.
6389
6390 All other options are defaulted.
6391 .code
6392 local_delivery:
6393   driver = appendfile
6394   file = /var/mail/$local_part_data
6395   delivery_date_add
6396   envelope_to_add
6397   return_path_add
6398 # group = mail
6399 # mode = 0660
6400 .endd
6401 This &(appendfile)& transport is used for local delivery to user mailboxes in
6402 traditional BSD mailbox format.
6403
6404 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6405 as it is provided by a potential bad actor.
6406 Instead we use &$local_part_data$&,
6407 the result of looking up &$local_part$& in the user database
6408 (done by using &%check_local_user%& in the the router).
6409
6410 By default &(appendfile)& runs under the uid and gid of the
6411 local user, which requires the sticky bit to be set on the &_/var/mail_&
6412 directory. Some systems use the alternative approach of running mail deliveries
6413 under a particular group instead of using the sticky bit. The commented options
6414 show how this can be done.
6415
6416 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6417 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6418 similarly-named options above.
6419 .code
6420 address_pipe:
6421   driver = pipe
6422   return_output
6423 .endd
6424 This transport is used for handling deliveries to pipes that are generated by
6425 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6426 option specifies that any output on stdout or stderr generated by the pipe is to
6427 be returned to the sender.
6428 .code
6429 address_file:
6430   driver = appendfile
6431   delivery_date_add
6432   envelope_to_add
6433   return_path_add
6434 .endd
6435 This transport is used for handling deliveries to files that are generated by
6436 redirection. The name of the file is not specified in this instance of
6437 &(appendfile)&, because it comes from the &(redirect)& router.
6438 .code
6439 address_reply:
6440   driver = autoreply
6441 .endd
6442 This transport is used for handling automatic replies generated by users'
6443 filter files.
6444
6445
6446
6447 .section "Default retry rule" "SECID57"
6448 .cindex "retry" "default rule"
6449 .cindex "default" "retry rule"
6450 The retry section of the configuration file contains rules which affect the way
6451 Exim retries deliveries that cannot be completed at the first attempt. It is
6452 introduced by the line
6453 .code
6454 begin retry
6455 .endd
6456 In the default configuration, there is just one rule, which applies to all
6457 errors:
6458 .code
6459 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6460 .endd
6461 This causes any temporarily failing address to be retried every 15 minutes for
6462 2 hours, then at intervals starting at one hour and increasing by a factor of
6463 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6464 is not delivered after 4 days of temporary failure, it is bounced. The time is
6465 measured from first failure, not from the time the message was received.
6466
6467 If the retry section is removed from the configuration, or is empty (that is,
6468 if no retry rules are defined), Exim will not retry deliveries. This turns
6469 temporary errors into permanent errors.
6470
6471
6472 .section "Rewriting configuration" "SECID58"
6473 The rewriting section of the configuration, introduced by
6474 .code
6475 begin rewrite
6476 .endd
6477 contains rules for rewriting addresses in messages as they arrive. There are no
6478 rewriting rules in the default configuration file.
6479
6480
6481
6482 .section "Authenticators configuration" "SECTdefconfauth"
6483 .cindex "AUTH" "configuration"
6484 The authenticators section of the configuration, introduced by
6485 .code
6486 begin authenticators
6487 .endd
6488 defines mechanisms for the use of the SMTP AUTH command. The default
6489 configuration file contains two commented-out example authenticators
6490 which support plaintext username/password authentication using the
6491 standard PLAIN mechanism and the traditional but non-standard LOGIN
6492 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6493 to support most MUA software.
6494
6495 The example PLAIN authenticator looks like this:
6496 .code
6497 #PLAIN:
6498 #  driver                  = plaintext
6499 #  server_set_id           = $auth2
6500 #  server_prompts          = :
6501 #  server_condition        = Authentication is not yet configured
6502 #  server_advertise_condition = ${if def:tls_in_cipher }
6503 .endd
6504 And the example LOGIN authenticator looks like this:
6505 .code
6506 #LOGIN:
6507 #  driver                  = plaintext
6508 #  server_set_id           = $auth1
6509 #  server_prompts          = <| Username: | Password:
6510 #  server_condition        = Authentication is not yet configured
6511 #  server_advertise_condition = ${if def:tls_in_cipher }
6512 .endd
6513
6514 The &%server_set_id%& option makes Exim remember the authenticated username
6515 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6516 &%server_prompts%& option configures the &(plaintext)& authenticator so
6517 that it implements the details of the specific authentication mechanism,
6518 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6519 when Exim offers authentication to clients; in the examples, this is only
6520 when TLS or SSL has been started, so to enable the authenticators you also
6521 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6522
6523 The &%server_condition%& setting defines how to verify that the username and
6524 password are correct. In the examples it just produces an error message.
6525 To make the authenticators work, you can use a string expansion
6526 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6527
6528 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6529 usercode and password are in different positions.
6530 Chapter &<<CHAPplaintext>>& covers both.
6531
6532 .ecindex IIDconfiwal
6533
6534
6535
6536 . ////////////////////////////////////////////////////////////////////////////
6537 . ////////////////////////////////////////////////////////////////////////////
6538
6539 .chapter "Regular expressions" "CHAPregexp"
6540
6541 .cindex "regular expressions" "library"
6542 .cindex "PCRE2"
6543 Exim supports the use of regular expressions in many of its options. It
6544 uses the PCRE2 regular expression library; this provides regular expression
6545 matching that is compatible with Perl 5. The syntax and semantics of
6546 regular expressions is discussed in
6547 online Perl manpages, in
6548 many Perl reference books, and also in
6549 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6550 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6551 . --- the http: URL here redirects to another page with the ISBN in the URL
6552 . --- where trying to use https: just redirects back to http:, so sticking
6553 . --- to the old URL for now.  2018-09-07.
6554
6555 The documentation for the syntax and semantics of the regular expressions that
6556 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6557 description is included here. The PCRE2 functions are called from Exim using
6558 the default option settings (that is, with no PCRE2 options set), except that
6559 the PCRE2_CASELESS option is set when the matching is required to be
6560 case-insensitive.
6561
6562 In most cases, when a regular expression is required in an Exim configuration,
6563 it has to start with a circumflex, in order to distinguish it from plain text
6564 or an &"ends with"& wildcard. In this example of a configuration setting, the
6565 second item in the colon-separated list is a regular expression.
6566 .code
6567 domains = a.b.c : ^\\d{3} : *.y.z : ...
6568 .endd
6569 The doubling of the backslash is required because of string expansion that
6570 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6571 of this issue, and a way of avoiding the need for doubling backslashes. The
6572 regular expression that is eventually used in this example contains just one
6573 backslash. The circumflex is included in the regular expression, and has the
6574 normal effect of &"anchoring"& it to the start of the string that is being
6575 matched.
6576
6577 There are, however, two cases where a circumflex is not required for the
6578 recognition of a regular expression: these are the &%match%& condition in a
6579 string expansion, and the &%matches%& condition in an Exim filter file. In
6580 these cases, the relevant string is always treated as a regular expression; if
6581 it does not start with a circumflex, the expression is not anchored, and can
6582 match anywhere in the subject string.
6583
6584 In all cases, if you want a regular expression to match at the end of a string,
6585 you must code the $ metacharacter to indicate this. For example:
6586 .code
6587 domains = ^\\d{3}\\.example
6588 .endd
6589 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6590 You need to use:
6591 .code
6592 domains = ^\\d{3}\\.example\$
6593 .endd
6594 if you want &'example'& to be the top-level domain. The backslash before the
6595 $ is needed because string expansion also interprets dollar characters.
6596
6597
6598
6599 . ////////////////////////////////////////////////////////////////////////////
6600 . ////////////////////////////////////////////////////////////////////////////
6601
6602 .chapter "File and database lookups" "CHAPfdlookup"
6603 .scindex IIDfidalo1 "file" "lookups"
6604 .scindex IIDfidalo2 "database" "lookups"
6605 .cindex "lookup" "description of"
6606 Exim can be configured to look up data in files or databases as it processes
6607 messages. Two different kinds of syntax are used:
6608
6609 .olist
6610 A string that is to be expanded may contain explicit lookup requests. These
6611 cause parts of the string to be replaced by data that is obtained from the
6612 lookup. Lookups of this type are conditional expansion items. Different results
6613 can be defined for the cases of lookup success and failure. See chapter
6614 &<<CHAPexpand>>&, where string expansions are described in detail.
6615 The key for the lookup is &*specified*& as part of the string to be expanded.
6616 .next
6617 Lists of domains, hosts, and email addresses can contain lookup requests as a
6618 way of avoiding excessively long linear lists. In this case, the data that is
6619 returned by the lookup is often (but not always) discarded; whether the lookup
6620 succeeds or fails is what really counts. These kinds of list are described in
6621 chapter &<<CHAPdomhosaddlists>>&.
6622 Depending on the lookup type (see below)
6623 the key for the lookup may need to be &*specified*& as above
6624 or may be &*implicit*&,
6625 given by the context in which the list is being checked.
6626 .endlist
6627
6628 String expansions, lists, and lookups interact with each other in such a way
6629 that there is no order in which to describe any one of them that does not
6630 involve references to the others. Each of these three chapters makes more sense
6631 if you have read the other two first. If you are reading this for the first
6632 time, be aware that some of it will make a lot more sense after you have read
6633 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6634
6635 .section "Examples of different lookup syntax" "SECID60"
6636 It is easy to confuse the two different kinds of lookup, especially as the
6637 lists that may contain the second kind are always expanded before being
6638 processed as lists. Therefore, they may also contain lookups of the first kind.
6639 Be careful to distinguish between the following two examples:
6640 .code
6641 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6642 domains = lsearch;/some/file
6643 .endd
6644 .ilist
6645 The first uses a string expansion, the result of which must be a domain list.
6646 The key for an expansion-style lookup must be given explicitly.
6647 No strings have been specified for a successful or a failing lookup; the
6648 defaults in this case are the looked-up data and an empty string, respectively.
6649 The expansion takes place before the string is processed as a list, and the
6650 file that is searched could contain lines like this:
6651 .code
6652 192.168.3.4: domain1:domain2:...
6653 192.168.1.9: domain3:domain4:...
6654 .endd
6655 When the lookup succeeds, the result of the expansion is a list of domains (and
6656 possibly other types of item that are allowed in domain lists).
6657 .cindex "tainted data" "de-tainting"
6658 .cindex "de-tainting" "using a lookup expansion"
6659 The result of the expansion is not tainted.
6660
6661 .next
6662 In the second example, the lookup is a single item in a domain list. It causes
6663 Exim to use a lookup to see if the domain that is being processed can be found
6664 in the file.
6665 The file could contains lines like this:
6666 .code
6667 domain1:
6668 domain2:
6669 .endd
6670 Any data that follows the keys is not relevant when checking that the domain
6671 matches the list item.
6672
6673 The key for a list-style lookup is implicit, from the lookup context, if
6674 the lookup is a single-key type (see below).
6675 For query-style lookup types the query must be given explicitly.
6676 .endlist
6677
6678 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6679 Consider a file containing lines like this:
6680 .code
6681 192.168.5.6: lsearch;/another/file
6682 .endd
6683 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6684 first &%domains%& setting above generates the second setting, which therefore
6685 causes a second lookup to occur.
6686
6687 The lookup type may optionally be followed by a comma
6688 and a comma-separated list of options.
6689 Each option is a &"name=value"& pair.
6690 Whether an option is meaningful depends on the lookup type.
6691
6692 All lookups support the option &"cache=no_rd"&.
6693 If this is given then the cache that Exim manages for lookup results
6694 is not checked before doing the lookup.
6695 The result of the lookup is still written to the cache.
6696
6697 The rest of this chapter describes the different lookup types that are
6698 available. Any of them can be used in any part of the configuration where a
6699 lookup is permitted.
6700
6701
6702 .section "Lookup types" "SECID61"
6703 .cindex "lookup" "types of"
6704 .cindex "single-key lookup" "definition of"
6705 Two different types of data lookup are implemented:
6706
6707 .ilist
6708 The &'single-key'& type requires the specification of a file in which to look,
6709 and a single key to search for. The key must be a non-empty string for the
6710 lookup to succeed. The lookup type determines how the file is searched.
6711 .cindex "tainted data" "single-key lookups"
6712 The file string may not be tainted.
6713
6714 .cindex "tainted data" "de-tainting"
6715 .cindex "de-tainting" "using a single-key lookup"
6716 All single-key lookups support the option &"ret=key"&.
6717 If this is given and the lookup
6718 (either underlying implementation or cached value)
6719 returns data, the result is replaced with a non-tainted
6720 version of the lookup key.
6721
6722 .next
6723 .cindex "query-style lookup" "definition of"
6724 The &'query-style'& type accepts a generalized database query. No particular
6725 key value is assumed by Exim for query-style lookups. You can use whichever
6726 Exim variables you need to construct the database query.
6727
6728 For the string-expansion kind of lookups, the query is given in the first
6729 bracketed argument of the &${lookup ...}$& expansion.
6730 For the list-argument kind of lookup the quury is given by the remainder of the
6731 list item after the first semicolon.
6732
6733 .cindex "tainted data" "quoting for lookups"
6734 If tainted data is used in the query then it should be quuted by
6735 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6736 appropriate for the lookup.
6737 .endlist
6738
6739 The code for each lookup type is in a separate source file that is included in
6740 the binary of Exim only if the corresponding compile-time option is set. The
6741 default settings in &_src/EDITME_& are:
6742 .code
6743 LOOKUP_DBM=yes
6744 LOOKUP_LSEARCH=yes
6745 .endd
6746 which means that only linear searching and DBM lookups are included by default.
6747 For some types of lookup (e.g. SQL databases), you need to install appropriate
6748 libraries and header files before building Exim.
6749
6750
6751
6752
6753 .section "Single-key lookup types" "SECTsinglekeylookups"
6754 .cindex "lookup" "single-key types"
6755 .cindex "single-key lookup" "list of types"
6756 The following single-key lookup types are implemented:
6757
6758 .subsection cdb
6759 .cindex "cdb" "description of"
6760 .cindex "lookup" "cdb"
6761 .cindex "binary zero" "in lookup key"
6762 The given file is searched as a Constant DataBase file, using the key
6763 string without a terminating binary zero. The cdb format is designed for
6764 indexed files that are read frequently and never updated, except by total
6765 re-creation. As such, it is particularly suitable for large files containing
6766 aliases or other indexed data referenced by an MTA. Information about cdb and
6767 tools for building the files can be found in several places:
6768 .display
6769 &url(https://cr.yp.to/cdb.html)
6770 &url(https://www.corpit.ru/mjt/tinycdb.html)
6771 &url(https://packages.debian.org/stable/utils/freecdb)
6772 &url(https://github.com/philpennock/cdbtools) (in Go)
6773 .endd
6774 A cdb distribution is not needed in order to build Exim with cdb support,
6775 because the code for reading cdb files is included directly in Exim itself.
6776 However, no means of building or testing cdb files is provided with Exim, so
6777 you need to obtain a cdb distribution in order to do this.
6778
6779 .subsection dbm
6780 .cindex "DBM" "lookup type"
6781 .cindex "lookup" "dbm"
6782 .cindex "binary zero" "in lookup key"
6783 Calls to DBM library functions are used to extract data from the given
6784 DBM file by looking up the record with the given key. A terminating binary
6785 zero is included in the key that is passed to the DBM library. See section
6786 &<<SECTdb>>& for a discussion of DBM libraries.
6787
6788 .cindex "Berkeley DB library" "file format"
6789 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6790 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6791 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6792 the DB_UNKNOWN option. This enables it to handle any of the types of database
6793 that the library supports, and can be useful for accessing DBM files created by
6794 other applications. (For earlier DB versions, DB_HASH is always used.)
6795
6796 .subsection dbmjz
6797 .cindex "lookup" "dbmjz"
6798 .cindex "lookup" "dbm &-- embedded NULs"
6799 .cindex "sasldb2"
6800 .cindex "dbmjz lookup type"
6801 This is the same as &(dbm)&, except that the lookup key is
6802 interpreted as an Exim list; the elements of the list are joined together with
6803 ASCII NUL characters to form the lookup key.  An example usage would be to
6804 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6805 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6806 &(cram_md5)& authenticator.
6807
6808 .subsection dbmnz
6809 .cindex "lookup" "dbmnz"
6810 .cindex "lookup" "dbm &-- terminating zero"
6811 .cindex "binary zero" "in lookup key"
6812 .cindex "Courier"
6813 .cindex "&_/etc/userdbshadow.dat_&"
6814 .cindex "dbmnz lookup type"
6815 This is the same as &(dbm)&, except that a terminating binary zero
6816 is not included in the key that is passed to the DBM library. You may need this
6817 if you want to look up data in files that are created by or shared with some
6818 other application that does not use terminating zeros. For example, you need to
6819 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6820 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6821 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6822 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6823
6824 .subsection dsearch
6825 .cindex "lookup" "dsearch"
6826 .cindex "dsearch lookup type"
6827 The given file must be an absolute directory path; this is searched for an entry
6828 whose name is the key by calling the &[lstat()]& function.
6829 The key may not contain any forward slash characters.
6830 If &[lstat()]& succeeds then so does the lookup.
6831 .cindex "tainted data" "dsearch result"
6832 The result is regarded as untainted.
6833
6834 Options for the lookup can be given by appending them after the word "dsearch",
6835 separated by a comma.  Options, if present, are a comma-separated list having
6836 each element starting with a tag name and an equals.
6837
6838 Two options are supported, for the return value and for filtering match
6839 candidates.
6840 The "ret" option requests an alternate result value of
6841 the entire path for the entry. Example:
6842 .code
6843 ${lookup {passwd} dsearch,ret=full {/etc}}
6844 .endd
6845 The default result is just the requested entry.
6846 The "filter" option requests that only directory entries of a given type
6847 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6848 not matching "." or ".."). Example:
6849 .code
6850 ${lookup {passwd} dsearch,filter=file {/etc}}
6851 .endd
6852 The default matching is for any entry type, including directories
6853 and symlinks.
6854
6855 An example of how this
6856 lookup can be used to support virtual domains is given in section
6857 &<<SECTvirtualdomains>>&.
6858
6859 .subsection iplsearch
6860 .cindex "lookup" "iplsearch"
6861 .cindex "iplsearch lookup type"
6862 The given file is a text file containing keys and data. A key is
6863 terminated by a colon or white space or the end of the line. The keys in the
6864 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6865 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6866 being interpreted as a key terminator. For example:
6867 .code
6868 1.2.3.4:           data for 1.2.3.4
6869 192.168.0.0/16:    data for 192.168.0.0/16
6870 "abcd::cdab":      data for abcd::cdab
6871 "abcd:abcd::/32"   data for abcd:abcd::/32
6872 .endd
6873 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6874 file is searched linearly, using the CIDR masks where present, until a matching
6875 key is found. The first key that matches is used; there is no attempt to find a
6876 &"best"& match. Apart from the way the keys are matched, the processing for
6877 &(iplsearch)& is the same as for &(lsearch)&.
6878
6879 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6880 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6881 lookup types support only literal keys.
6882
6883 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6884 the implicit key is the host's IP address rather than its name (see section
6885 &<<SECThoslispatsikey>>&).
6886
6887 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6888 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6889 notation before executing the lookup.)
6890
6891 One option is supported, "ret=full", to request the return of the entire line
6892 rather than omitting the key portion.
6893 Note however that the key portion will have been de-quoted.
6894
6895 .subsection json
6896 .cindex lookup json
6897 .cindex json "lookup type"
6898 .cindex JSON expansions
6899 The given file is a text file with a JSON structure.
6900 An element of the structure is extracted, defined by the search key.
6901 The key is a list of subelement selectors
6902 (colon-separated by default but changeable in the usual way)
6903 which are applied in turn to select smaller and smaller portions
6904 of the JSON structure.
6905 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6906 nunbered array element is selected.
6907 Otherwise it must apply to a JSON object; the named element is selected.
6908 The final resulting element can be a simple JSON type or a JSON object
6909 or array; for the latter two a string-representation of the JSON
6910 is returned.
6911 For elements of type string, the returned value is de-quoted.
6912
6913
6914 .subsection lmdb
6915 .cindex LMDB
6916 .cindex lookup lmdb
6917 .cindex database lmdb
6918 The given file is an LMDB database.
6919 LMDB is a memory-mapped key-value store,
6920 with API modeled loosely on that of BerkeleyDB.
6921 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6922 for the feature set and operation modes.
6923
6924 Exim provides read-only access via the LMDB C library.
6925 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6926 or your operating system package repository.
6927 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6928
6929 You will need to separately create the LMDB database file,
6930 possibly using the &"mdb_load"& utility.
6931
6932
6933 .subsection lsearch
6934 .cindex "linear search"
6935 .cindex "lookup" "lsearch"
6936 .cindex "lsearch lookup type"
6937 .cindex "case sensitivity" "in lsearch lookup"
6938 The given file is a text file that is searched linearly for a
6939 line beginning with the search key, terminated by a colon or white space or the
6940 end of the line. The search is case-insensitive; that is, upper and lower case
6941 letters are treated as the same. The first occurrence of the key that is found
6942 in the file is used.
6943
6944 White space between the key and the colon is permitted. The remainder of the
6945 line, with leading and trailing white space removed, is the data. This can be
6946 continued onto subsequent lines by starting them with any amount of white
6947 space, but only a single space character is included in the data at such a
6948 junction. If the data begins with a colon, the key must be terminated by a
6949 colon, for example:
6950 .code
6951 baduser:  :fail:
6952 .endd
6953 Empty lines and lines beginning with # are ignored, even if they occur in the
6954 middle of an item. This is the traditional textual format of alias files. Note
6955 that the keys in an &(lsearch)& file are literal strings. There is no
6956 wildcarding of any kind.
6957
6958 .cindex "lookup" "lsearch &-- colons in keys"
6959 .cindex "white space" "in lsearch key"
6960 In most &(lsearch)& files, keys are not required to contain colons or #
6961 characters, or white space. However, if you need this feature, it is available.
6962 If a key begins with a doublequote character, it is terminated only by a
6963 matching quote (or end of line), and the normal escaping rules apply to its
6964 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6965 quoted keys (exactly as for unquoted keys). There is no special handling of
6966 quotes for the data part of an &(lsearch)& line.
6967
6968 .subsection nis
6969 .cindex "NIS lookup type"
6970 .cindex "lookup" "NIS"
6971 .cindex "binary zero" "in lookup key"
6972 The given file is the name of a NIS map, and a NIS lookup is done with
6973 the given key, without a terminating binary zero. There is a variant called
6974 &(nis0)& which does include the terminating binary zero in the key. This is
6975 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6976 aliases; the full map names must be used.
6977
6978 .subsection (n)wildlsearch
6979 .cindex "wildlsearch lookup type"
6980 .cindex "lookup" "wildlsearch"
6981 .cindex "nwildlsearch lookup type"
6982 .cindex "lookup" "nwildlsearch"
6983 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6984 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6985 the file may be wildcarded. The difference between these two lookup types is
6986 that for &(wildlsearch)&, each key in the file is string-expanded before being
6987 used, whereas for &(nwildlsearch)&, no expansion takes place.
6988
6989 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6990 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6991 file that are regular expressions can be made case-sensitive by the use of
6992 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6993
6994 .olist
6995 The string may begin with an asterisk to mean &"ends with"&. For example:
6996 .code
6997 *.a.b.c       data for anything.a.b.c
6998 *fish         data for anythingfish
6999 .endd
7000 .next
7001 The string may begin with a circumflex to indicate a regular expression. For
7002 example, for &(wildlsearch)&:
7003 .code
7004 ^\N\d+\.a\.b\N    data for <digits>.a.b
7005 .endd
7006 Note the use of &`\N`& to disable expansion of the contents of the regular
7007 expression. If you are using &(nwildlsearch)&, where the keys are not
7008 string-expanded, the equivalent entry is:
7009 .code
7010 ^\d+\.a\.b        data for <digits>.a.b
7011 .endd
7012 The case-insensitive flag is set at the start of compiling the regular
7013 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7014 For example, to make the entire pattern case-sensitive:
7015 .code
7016 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7017 .endd
7018
7019 If the regular expression contains white space or colon characters, you must
7020 either quote it (see &(lsearch)& above), or represent these characters in other
7021 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7022 colon. This may be easier than quoting, because if you quote, you have to
7023 escape all the backslashes inside the quotes.
7024
7025 &*Note*&: It is not possible to capture substrings in a regular expression
7026 match for later use, because the results of all lookups are cached. If a lookup
7027 is repeated, the result is taken from the cache, and no actual pattern matching
7028 takes place. The values of all the numeric variables are unset after a
7029 &((n)wildlsearch)& match.
7030
7031 .next
7032 Although I cannot see it being of much use, the general matching function that
7033 is used to implement &((n)wildlsearch)& means that the string may begin with a
7034 lookup name terminated by a semicolon, and followed by lookup data. For
7035 example:
7036 .code
7037 cdb;/some/file  data for keys that match the file
7038 .endd
7039 The data that is obtained from the nested lookup is discarded.
7040 .endlist olist
7041
7042 Keys that do not match any of these patterns are interpreted literally. The
7043 continuation rules for the data are the same as for &(lsearch)&, and keys may
7044 be followed by optional colons.
7045
7046 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7047 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7048 lookup types support only literal keys.
7049
7050 .subsection spf
7051 .cindex "spf lookup type"
7052 .cindex "lookup" "spf"
7053 If Exim is built with SPF support, manual lookups can be done
7054 (as opposed to the standard ACL condition method).
7055 For details see section &<<SECSPF>>&.
7056
7057
7058 .section "Query-style lookup types" "SECTquerystylelookups"
7059 .cindex "lookup" "query-style types"
7060 .cindex "query-style lookup" "list of types"
7061 The supported query-style lookup types are listed below. Further details about
7062 many of them are given in later sections.
7063
7064 .subsection dnsdb
7065 .cindex "DNS" "as a lookup type"
7066 .cindex "lookup" "DNS"
7067 This does a DNS search for one or more records whose domain names
7068 are given in the supplied query. The resulting data is the contents of the
7069 records. See section &<<SECTdnsdb>>&.
7070
7071 .subsection ibase
7072 .cindex "InterBase lookup type"
7073 .cindex "lookup" "InterBase"
7074 This does a lookup in an InterBase database.
7075
7076 .subsection ldap
7077 .cindex "LDAP" "lookup type"
7078 .cindex "lookup" "LDAP"
7079 This does an LDAP lookup using a query in the form of a URL, and
7080 returns attributes from a single entry. There is a variant called &(ldapm)&
7081 that permits values from multiple entries to be returned. A third variant
7082 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7083 any attribute values. See section &<<SECTldap>>&.
7084
7085 .subsection mysql
7086 .cindex "MySQL" "lookup type"
7087 .cindex "lookup" "MySQL"
7088 The format of the query is an SQL statement that is passed to a
7089 MySQL database. See section &<<SECTsql>>&.
7090
7091 .subsection nisplus
7092 .cindex "NIS+ lookup type"
7093 .cindex "lookup" "NIS+"
7094 This does a NIS+ lookup using a query that can specify the name of
7095 the field to be returned. See section &<<SECTnisplus>>&.
7096
7097 .subsection oracle
7098 .cindex "Oracle" "lookup type"
7099 .cindex "lookup" "Oracle"
7100 The format of the query is an SQL statement that is passed to an
7101 Oracle database. See section &<<SECTsql>>&.
7102
7103 .subsection passwd
7104 .cindex "lookup" "passwd"
7105 .cindex "passwd lookup type"
7106 .cindex "&_/etc/passwd_&"
7107 This is a query-style lookup with queries that are just user names. The
7108 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7109 success, the result string is the same as you would get from an &(lsearch)&
7110 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7111 password value. For example:
7112 .code
7113 *:42:42:King Rat:/home/kr:/bin/bash
7114 .endd
7115
7116 .subsection pgsql
7117 .cindex "PostgreSQL lookup type"
7118 .cindex "lookup" "PostgreSQL"
7119 The format of the query is an SQL statement that is passed to a
7120 PostgreSQL database. See section &<<SECTsql>>&.
7121
7122 .subsection redis
7123 .cindex "Redis lookup type"
7124 .cindex lookup Redis
7125 The format of the query is either a simple get or simple set,
7126 passed to a Redis database. See section &<<SECTsql>>&.
7127
7128 .subsection sqlite
7129 .cindex "sqlite lookup type"
7130 .cindex "lookup" "sqlite"
7131 The format of the query is
7132 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7133
7134 .subsection testdb
7135 This is a lookup type that is used for testing Exim. It is
7136 not likely to be useful in normal operation.
7137
7138 .subsection whoson
7139 .cindex "whoson lookup type"
7140 .cindex "lookup" "whoson"
7141 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7142 allows a server to check whether a particular (dynamically allocated) IP
7143 address is currently allocated to a known (trusted) user and, optionally, to
7144 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7145 at one time for &"POP before SMTP"& authentication, but that approach has been
7146 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7147 &"POP before SMTP"& checking using ACL statements such as
7148 .code
7149 require condition = \
7150   ${lookup whoson {$sender_host_address}{yes}{no}}
7151 .endd
7152 The query consists of a single IP address. The value returned is the name of
7153 the authenticated user, which is stored in the variable &$value$&. However, in
7154 this example, the data in &$value$& is not used; the result of the lookup is
7155 one of the fixed strings &"yes"& or &"no"&.
7156
7157
7158
7159 .section "Temporary errors in lookups" "SECID63"
7160 .cindex "lookup" "temporary error in"
7161 Lookup functions can return temporary error codes if the lookup cannot be
7162 completed. For example, an SQL or LDAP database might be unavailable. For this
7163 reason, it is not advisable to use a lookup that might do this for critical
7164 options such as a list of local domains.
7165
7166 When a lookup cannot be completed in a router or transport, delivery
7167 of the message (to the relevant address) is deferred, as for any other
7168 temporary error. In other circumstances Exim may assume the lookup has failed,
7169 or may give up altogether.
7170
7171
7172
7173 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7174 .cindex "wildcard lookups"
7175 .cindex "lookup" "default values"
7176 .cindex "lookup" "wildcard"
7177 .cindex "lookup" "* added to type"
7178 .cindex "default" "in single-key lookups"
7179 In this context, a &"default value"& is a value specified by the administrator
7180 that is to be used if a lookup fails.
7181
7182 &*Note:*& This section applies only to single-key lookups. For query-style
7183 lookups, the facilities of the query language must be used. An attempt to
7184 specify a default for a query-style lookup provokes an error.
7185
7186 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7187 and the initial lookup fails, the key &"*"& is looked up in the file to
7188 provide a default value. See also the section on partial matching below.
7189
7190 .cindex "*@ with single-key lookup"
7191 .cindex "lookup" "*@ added to type"
7192 .cindex "alias file" "per-domain default"
7193 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7194 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7195 character, a second lookup is done with everything before the last @ replaced
7196 by *. This makes it possible to provide per-domain defaults in alias files
7197 that include the domains in the keys. If the second lookup fails (or doesn't
7198 take place because there is no @ in the key), &"*"& is looked up.
7199 For example, a &(redirect)& router might contain:
7200 .code
7201 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7202 .endd
7203 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7204 looks up these keys, in this order:
7205 .code
7206 jane@eyre.example
7207 *@eyre.example
7208 *
7209 .endd
7210 The data is taken from whichever key it finds first. &*Note*&: In an
7211 &(lsearch)& file, this does not mean the first of these keys in the file. A
7212 complete scan is done for each key, and only if it is not found at all does
7213 Exim move on to try the next key.
7214
7215
7216
7217 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7218 .cindex "partial matching"
7219 .cindex "wildcard lookups"
7220 .cindex "lookup" "partial matching"
7221 .cindex "lookup" "wildcard"
7222 .cindex "asterisk" "in search type"
7223 The normal operation of a single-key lookup is to search the file for an exact
7224 match with the given key. However, in a number of situations where domains are
7225 being looked up, it is useful to be able to do partial matching. In this case,
7226 information in the file that has a key starting with &"*."& is matched by any
7227 domain that ends with the components that follow the full stop. For example, if
7228 a key in a DBM file is
7229 .code
7230 *.dates.fict.example
7231 .endd
7232 then when partial matching is enabled this is matched by (amongst others)
7233 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7234 by &'dates.fict.example'&, if that does not appear as a separate key in the
7235 file.
7236
7237 &*Note*&: Partial matching is not available for query-style lookups. It is
7238 also not available for any lookup items in address lists (see section
7239 &<<SECTaddresslist>>&).
7240
7241 Partial matching is implemented by doing a series of separate lookups using
7242 keys constructed by modifying the original subject key. This means that it can
7243 be used with any of the single-key lookup types, provided that
7244 partial matching keys
7245 beginning with a special prefix (default &"*."&) are included in the data file.
7246 Keys in the file that do not begin with the prefix are matched only by
7247 unmodified subject keys when partial matching is in use.
7248
7249 Partial matching is requested by adding the string &"partial-"& to the front of
7250 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7251 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7252 is added at the start of the subject key, and it is looked up again. If that
7253 fails, further lookups are tried with dot-separated components removed from the
7254 start of the subject key, one-by-one, and &"*."& added on the front of what
7255 remains.
7256
7257 A minimum number of two non-* components are required. This can be adjusted
7258 by including a number before the hyphen in the search type. For example,
7259 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7260 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7261 subject key is &'2250.dates.fict.example'& then the following keys are looked
7262 up when the minimum number of non-* components is two:
7263 .code
7264 2250.dates.fict.example
7265 *.2250.dates.fict.example
7266 *.dates.fict.example
7267 *.fict.example
7268 .endd
7269 As soon as one key in the sequence is successfully looked up, the lookup
7270 finishes.
7271
7272 .cindex "lookup" "partial matching &-- changing prefix"
7273 .cindex "prefix" "for partial matching"
7274 The use of &"*."& as the partial matching prefix is a default that can be
7275 changed. The motivation for this feature is to allow Exim to operate with file
7276 formats that are used by other MTAs. A different prefix can be supplied in
7277 parentheses instead of the hyphen after &"partial"&. For example:
7278 .code
7279 domains = partial(.)lsearch;/some/file
7280 .endd
7281 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7282 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7283 components is unchanged). The prefix may consist of any punctuation characters
7284 other than a closing parenthesis. It may be empty, for example:
7285 .code
7286 domains = partial1()cdb;/some/file
7287 .endd
7288 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7289 &`a.b.c`&, &`b.c`&, and &`c`&.
7290
7291 If &"partial0"& is specified, what happens at the end (when the lookup with
7292 just one non-wild component has failed, and the original key is shortened right
7293 down to the null string) depends on the prefix:
7294
7295 .ilist
7296 If the prefix has zero length, the whole lookup fails.
7297 .next
7298 If the prefix has length 1, a lookup for just the prefix is done. For
7299 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7300 .next
7301 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7302 remainder is looked up. With the default prefix, therefore, the final lookup is
7303 for &"*"& on its own.
7304 .next
7305 Otherwise, the whole prefix is looked up.
7306 .endlist
7307
7308
7309 If the search type ends in &"*"& or &"*@"& (see section
7310 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7311 this implies happens after all partial lookups have failed. If &"partial0"& is
7312 specified, adding &"*"& to the search type has no effect with the default
7313 prefix, because the &"*"& key is already included in the sequence of partial
7314 lookups. However, there might be a use for lookup types such as
7315 &"partial0(.)lsearch*"&.
7316
7317 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7318 in domain lists and the like. Partial matching works only in terms of
7319 dot-separated components; a key such as &`*fict.example`&
7320 in a database file is useless, because the asterisk in a partial matching
7321 subject key is always followed by a dot.
7322
7323
7324
7325
7326 .section "Lookup caching" "SECID64"
7327 .cindex "lookup" "caching"
7328 .cindex "caching" "lookup data"
7329 Exim caches all lookup results in order to avoid needless repetition of
7330 lookups. However, because (apart from the daemon) Exim operates as a collection
7331 of independent, short-lived processes, this caching applies only within a
7332 single Exim process. There is no inter-process lookup caching facility.
7333
7334 If an option &"cache=no_rd"& is used on the lookup then
7335 the cache is only written to, cached data is not used for the operation
7336 and a real lookup is done.
7337
7338 For single-key lookups, Exim keeps the relevant files open in case there is
7339 another lookup that needs them. In some types of configuration this can lead to
7340 many files being kept open for messages with many recipients. To avoid hitting
7341 the operating system limit on the number of simultaneously open files, Exim
7342 closes the least recently used file when it needs to open more files than its
7343 own internal limit, which can be changed via the &%lookup_open_max%& option.
7344
7345 The single-key lookup files are closed and the lookup caches are flushed at
7346 strategic points during delivery &-- for example, after all routing is
7347 complete.
7348
7349
7350
7351
7352 .section "Quoting lookup data" "SECID65"
7353 .cindex "lookup" "quoting"
7354 .cindex "quoting" "in lookups"
7355 When data from an incoming message is included in a query-style lookup, there
7356 is the possibility of special characters in the data messing up the syntax of
7357 the query. For example, a NIS+ query that contains
7358 .code
7359 [name=$local_part]
7360 .endd
7361 will be broken if the local part happens to contain a closing square bracket.
7362 For NIS+, data can be enclosed in double quotes like this:
7363 .code
7364 [name="$local_part"]
7365 .endd
7366 but this still leaves the problem of a double quote in the data. The rule for
7367 NIS+ is that double quotes must be doubled. Other lookup types have different
7368 rules, and to cope with the differing requirements, an expansion operator
7369 of the following form is provided:
7370 .code
7371 ${quote_<lookup-type>:<string>}
7372 .endd
7373 For example, the safest way to write the NIS+ query is
7374 .code
7375 [name="${quote_nisplus:$local_part}"]
7376 .endd
7377 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7378 operator can be used for all lookup types, but has no effect for single-key
7379 lookups, since no quoting is ever needed in their key strings.
7380
7381
7382
7383
7384 .section "More about dnsdb" "SECTdnsdb"
7385 .cindex "dnsdb lookup"
7386 .cindex "lookup" "dnsdb"
7387 .cindex "DNS" "as a lookup type"
7388 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7389 of a record type and a domain name, separated by an equals sign. For example,
7390 an expansion string could contain:
7391 .code
7392 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7393 .endd
7394 If the lookup succeeds, the result is placed in &$value$&, which in this case
7395 is used on its own as the result. If the lookup does not succeed, the
7396 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7397 &<<SECTforexpfai>>& for an explanation of what this means.
7398
7399 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7400 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7401 If no type is given, TXT is assumed.
7402
7403 For any record type, if multiple records are found, the data is returned as a
7404 concatenation, with newline as the default separator. The order, of course,
7405 depends on the DNS resolver. You can specify a different separator character
7406 between multiple records by putting a right angle-bracket followed immediately
7407 by the new separator at the start of the query. For example:
7408 .code
7409 ${lookup dnsdb{>: a=host1.example}}
7410 .endd
7411 It is permitted to specify a space as the separator character. Further
7412 white space is ignored.
7413 For lookup types that return multiple fields per record,
7414 an alternate field separator can be specified using a comma after the main
7415 separator character, followed immediately by the field separator.
7416
7417 .cindex "PTR record" "in &(dnsdb)& lookup"
7418 When the type is PTR,
7419 the data can be an IP address, written as normal; inversion and the addition of
7420 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7421 .code
7422 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7423 .endd
7424 If the data for a PTR record is not a syntactically valid IP address, it is not
7425 altered and nothing is added.
7426
7427 .cindex "MX record" "in &(dnsdb)& lookup"
7428 .cindex "SRV record" "in &(dnsdb)& lookup"
7429 For an MX lookup, both the preference value and the host name are returned for
7430 each record, separated by a space. For an SRV lookup, the priority, weight,
7431 port, and host name are returned for each record, separated by spaces.
7432 The field separator can be modified as above.
7433
7434 .cindex "TXT record" "in &(dnsdb)& lookup"
7435 .cindex "SPF record" "in &(dnsdb)& lookup"
7436 For TXT records with multiple items of data, only the first item is returned,
7437 unless a field separator is specified.
7438 To concatenate items without a separator, use a semicolon instead.
7439 For SPF records the
7440 default behaviour is to concatenate multiple items without using a separator.
7441 .code
7442 ${lookup dnsdb{>\n,: txt=a.b.example}}
7443 ${lookup dnsdb{>\n; txt=a.b.example}}
7444 ${lookup dnsdb{spf=example.org}}
7445 .endd
7446 It is permitted to specify a space as the separator character. Further
7447 white space is ignored.
7448
7449 .cindex "SOA record" "in &(dnsdb)& lookup"
7450 For an SOA lookup, while no result is obtained the lookup is redone with
7451 successively more leading components dropped from the given domain.
7452 Only the primary-nameserver field is returned unless a field separator is
7453 specified.
7454 .code
7455 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7456 .endd
7457
7458 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7459 .cindex "dnsdb modifiers"
7460 .cindex "modifiers" "dnsdb"
7461 .cindex "options" "dnsdb"
7462 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7463 each followed by a comma,
7464 that may appear before the record type.
7465
7466 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7467 temporary DNS error for any of them, the behaviour is controlled by
7468 a defer-option modifier.
7469 The possible keywords are
7470 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7471 With &"strict"& behaviour, any temporary DNS error causes the
7472 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7473 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7474 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7475 error causes the whole lookup to defer only if none of the other lookups
7476 succeed. The default is &"lax"&, so the following lookups are equivalent:
7477 .code
7478 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7479 ${lookup dnsdb{a=one.host.com:two.host.com}}
7480 .endd
7481 Thus, in the default case, as long as at least one of the DNS lookups
7482 yields some data, the lookup succeeds.
7483
7484 .cindex "DNSSEC" "dns lookup"
7485 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7486 The possible keywords are
7487 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7488 With &"strict"& or &"lax"& DNSSEC information is requested
7489 with the lookup.
7490 With &"strict"& a response from the DNS resolver that
7491 is not labelled as authenticated data
7492 is treated as equivalent to a temporary DNS error.
7493 The default is &"lax"&.
7494
7495 See also the &$lookup_dnssec_authenticated$& variable.
7496
7497 .cindex timeout "dns lookup"
7498 .cindex "DNS" timeout
7499 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7500 The form is &"retrans_VAL"& where VAL is an Exim time specification
7501 (e.g. &"5s"&).
7502 The default value is set by the main configuration option &%dns_retrans%&.
7503
7504 Retries for the dnsdb lookup can be controlled by a retry modifier.
7505 The form if &"retry_VAL"& where VAL is an integer.
7506 The default count is set by the main configuration option &%dns_retry%&.
7507
7508 .cindex caching "of dns lookup"
7509 .cindex TTL "of dns lookup"
7510 .cindex DNS TTL
7511 Dnsdb lookup results are cached within a single process (and its children).
7512 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7513 value of the set of returned DNS records.
7514
7515
7516 .subsection "Pseudo dnsdb record types" SECID66
7517 .cindex "MX record" "in &(dnsdb)& lookup"
7518 By default, both the preference value and the host name are returned for
7519 each MX record, separated by a space. If you want only host names, you can use
7520 the pseudo-type MXH:
7521 .code
7522 ${lookup dnsdb{mxh=a.b.example}}
7523 .endd
7524 In this case, the preference values are omitted, and just the host names are
7525 returned.
7526
7527 .cindex "name server for enclosing domain"
7528 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7529 records on the given domain, but if none are found, it removes the first
7530 component of the domain name, and tries again. This process continues until NS
7531 records are found or there are no more components left (or there is a DNS
7532 error). In other words, it may return the name servers for a top-level domain,
7533 but it never returns the root name servers. If there are no NS records for the
7534 top-level domain, the lookup fails. Consider these examples:
7535 .code
7536 ${lookup dnsdb{zns=xxx.quercite.com}}
7537 ${lookup dnsdb{zns=xxx.edu}}
7538 .endd
7539 Assuming that in each case there are no NS records for the full domain name,
7540 the first returns the name servers for &%quercite.com%&, and the second returns
7541 the name servers for &%edu%&.
7542
7543 You should be careful about how you use this lookup because, unless the
7544 top-level domain does not exist, the lookup always returns some host names. The
7545 sort of use to which this might be put is for seeing if the name servers for a
7546 given domain are on a blacklist. You can probably assume that the name servers
7547 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7548 such a list.
7549
7550 .cindex "CSA" "in &(dnsdb)& lookup"
7551 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7552 records according to the CSA rules, which are described in section
7553 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7554 not sufficient because of the extra parent domain search behaviour of CSA. The
7555 result of a successful lookup such as:
7556 .code
7557 ${lookup dnsdb {csa=$sender_helo_name}}
7558 .endd
7559 has two space-separated fields: an authorization code and a target host name.
7560 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7561 authorization required but absent, or &"?"& for unknown.
7562
7563 .cindex "A+" "in &(dnsdb)& lookup"
7564 The pseudo-type A+ performs an AAAA
7565 and then an A lookup.  All results are returned; defer processing
7566 (see below) is handled separately for each lookup.  Example:
7567 .code
7568 ${lookup dnsdb {>; a+=$sender_helo_name}}
7569 .endd
7570
7571
7572 .subsection "Multiple dnsdb lookups" SECID67
7573 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7574 However, you can specify a list of domains or IP addresses in a single
7575 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7576 the default separator, but with the ability to change this. For example:
7577 .code
7578 ${lookup dnsdb{one.domain.com:two.domain.com}}
7579 ${lookup dnsdb{a=one.host.com:two.host.com}}
7580 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7581 .endd
7582 In order to retain backwards compatibility, there is one special case: if
7583 the lookup type is PTR and no change of separator is specified, Exim looks
7584 to see if the rest of the string is precisely one IPv6 address. In this
7585 case, it does not treat it as a list.
7586
7587 The data from each lookup is concatenated, with newline separators by default,
7588 in the same way that multiple DNS records for a single item are handled. A
7589 different separator can be specified, as described above.
7590
7591
7592
7593
7594 .section "More about LDAP" "SECTldap"
7595 .cindex "LDAP" "lookup, more about"
7596 .cindex "lookup" "LDAP"
7597 .cindex "Solaris" "LDAP"
7598 The original LDAP implementation came from the University of Michigan; this has
7599 become &"Open LDAP"&, and there are now two different releases. Another
7600 implementation comes from Netscape, and Solaris 7 and subsequent releases
7601 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7602 the lookup function level, their error handling is different. For this reason
7603 it is necessary to set a compile-time variable when building Exim with LDAP, to
7604 indicate which LDAP library is in use. One of the following should appear in
7605 your &_Local/Makefile_&:
7606 .code
7607 LDAP_LIB_TYPE=UMICHIGAN
7608 LDAP_LIB_TYPE=OPENLDAP1
7609 LDAP_LIB_TYPE=OPENLDAP2
7610 LDAP_LIB_TYPE=NETSCAPE
7611 LDAP_LIB_TYPE=SOLARIS
7612 .endd
7613 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7614 same interface as the University of Michigan version.
7615
7616 There are three LDAP lookup types in Exim. These behave slightly differently in
7617 the way they handle the results of a query:
7618
7619 .ilist
7620 &(ldap)& requires the result to contain just one entry; if there are more, it
7621 gives an error.
7622 .next
7623 &(ldapdn)& also requires the result to contain just one entry, but it is the
7624 Distinguished Name that is returned rather than any attribute values.
7625 .next
7626 &(ldapm)& permits the result to contain more than one entry; the attributes
7627 from all of them are returned.
7628 .endlist
7629
7630
7631 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7632 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7633 the data returned by a successful lookup is described in the next section.
7634 First we explain how LDAP queries are coded.
7635
7636
7637 .subsection "Format of LDAP queries" SECTforldaque
7638 .cindex "LDAP" "query format"
7639 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7640 the configuration of a &(redirect)& router one might have this setting:
7641 .code
7642 data = ${lookup ldap \
7643   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7644   c=UK?mailbox?base?}}
7645 .endd
7646 .cindex "LDAP" "with TLS"
7647 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7648 secure (encrypted) LDAP connections. The second of these ensures that an
7649 encrypted TLS connection is used.
7650
7651 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7652 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7653 See the &%ldap_start_tls%& option.
7654
7655 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7656 controlled. Every part of the TLS configuration can be configured by settings in
7657 &_exim.conf_&. Depending on the version of the client libraries installed on
7658 your system, some of the initialization may have required setting options in
7659 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7660 certificates. This revealed a nuance where the current UID that exim was
7661 running as could affect which config files it read. With Exim 4.83, these
7662 methods become optional, only taking effect if not specifically set in
7663 &_exim.conf_&.
7664
7665
7666 .subsection "LDAP quoting" SECID68
7667 .cindex "LDAP" "quoting"
7668 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7669 and the second because the LDAP query is represented as a URL. Furthermore,
7670 within an LDAP query, two different kinds of quoting are required. For this
7671 reason, there are two different LDAP-specific quoting operators.
7672
7673 The &%quote_ldap%& operator is designed for use on strings that are part of
7674 filter specifications. Conceptually, it first does the following conversions on
7675 the string:
7676 .code
7677 *   =>   \2A
7678 (   =>   \28
7679 )   =>   \29
7680 \   =>   \5C
7681 .endd
7682 in accordance with RFC 2254. The resulting string is then quoted according
7683 to the rules for URLs, that is, all non-alphanumeric characters except
7684 .code
7685 ! $ ' - . _ ( ) * +
7686 .endd
7687 are converted to their hex values, preceded by a percent sign. For example:
7688 .code
7689 ${quote_ldap: a(bc)*, a<yz>; }
7690 .endd
7691 yields
7692 .code
7693 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7694 .endd
7695 Removing the URL quoting, this is (with a leading and a trailing space):
7696 .code
7697 a\28bc\29\2A, a<yz>;
7698 .endd
7699 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7700 base DN specifications in queries. Conceptually, it first converts the string
7701 by inserting a backslash in front of any of the following characters:
7702 .code
7703 , + " \ < > ;
7704 .endd
7705 It also inserts a backslash before any leading spaces or # characters, and
7706 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7707 is then quoted according to the rules for URLs. For example:
7708 .code
7709 ${quote_ldap_dn: a(bc)*, a<yz>; }
7710 .endd
7711 yields
7712 .code
7713 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7714 .endd
7715 Removing the URL quoting, this is (with a trailing space):
7716 .code
7717 \ a(bc)*\, a\<yz\>\;\
7718 .endd
7719 There are some further comments about quoting in the section on LDAP
7720 authentication below.
7721
7722
7723 .subsection "LDAP connections" SECID69
7724 .cindex "LDAP" "connections"
7725 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7726 is in use, via a Unix domain socket. The example given above does not specify
7727 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7728 by starting it with
7729 .code
7730 ldap://<hostname>:<port>/...
7731 .endd
7732 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7733 used. When no server is specified in a query, a list of default servers is
7734 taken from the &%ldap_default_servers%& configuration option. This supplies a
7735 colon-separated list of servers which are tried in turn until one successfully
7736 handles a query, or there is a serious error. Successful handling either
7737 returns the requested data, or indicates that it does not exist. Serious errors
7738 are syntactical, or multiple values when only a single value is expected.
7739 Errors which cause the next server to be tried are connection failures, bind
7740 failures, and timeouts.
7741
7742 For each server name in the list, a port number can be given. The standard way
7743 of specifying a host and port is to use a colon separator (RFC 1738). Because
7744 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7745 doubled. For example
7746 .code
7747 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7748 .endd
7749 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7750 to the LDAP library with no server name, and the library's default (normally
7751 the local host) is used.
7752
7753 If you are using the OpenLDAP library, you can connect to an LDAP server using
7754 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7755 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7756 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7757 not available.
7758
7759 For this type of connection, instead of a host name for the server, a pathname
7760 for the socket is required, and the port number is not relevant. The pathname
7761 can be specified either as an item in &%ldap_default_servers%&, or inline in
7762 the query. In the former case, you can have settings such as
7763 .code
7764 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7765 .endd
7766 When the pathname is given in the query, you have to escape the slashes as
7767 &`%2F`& to fit in with the LDAP URL syntax. For example:
7768 .code
7769 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7770 .endd
7771 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7772 a pathname, it uses the Unix domain socket code, even if the query actually
7773 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7774 socket connection. This behaviour means that you can use a setting of
7775 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7776 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7777 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7778 backup host.
7779
7780 If an explicit &`ldapi`& type is given in a query when a host name is
7781 specified, an error is diagnosed. However, if there are more items in
7782 &%ldap_default_servers%&, they are tried. In other words:
7783
7784 .ilist
7785 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7786 interface.
7787 .next
7788 Using &`ldapi`& with a host name causes an error.
7789 .endlist
7790
7791
7792 Using &`ldapi`& with no host or path in the query, and no setting of
7793 &%ldap_default_servers%&, does whatever the library does by default.
7794
7795
7796
7797 .subsection "LDAP authentication and control information" SECID70
7798 .cindex "LDAP" "authentication"
7799 The LDAP URL syntax provides no way of passing authentication and other control
7800 information to the server. To make this possible, the URL in an LDAP query may
7801 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7802 spaces. If a value contains spaces it must be enclosed in double quotes, and
7803 when double quotes are used, backslash is interpreted in the usual way inside
7804 them. The following names are recognized:
7805 .itable none 0 0 2 20* left 80* left
7806 .irow DEREFERENCE "set the dereferencing parameter"
7807 .irow NETTIME     "set a timeout for a network operation"
7808 .irow USER        "set the DN, for authenticating the LDAP bind"
7809 .irow PASS        "set the password, likewise"
7810 .irow REFERRALS   "set the referrals parameter"
7811 .irow SERVERS     "set alternate server list for this query only"
7812 .irow SIZE        "set the limit for the number of entries returned"
7813 .irow TIME        "set the maximum waiting time for a query"
7814 .endtable
7815 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7816 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7817 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7818 library from trying to follow referrals issued by the LDAP server.
7819
7820 .cindex LDAP timeout
7821 .cindex timeout "LDAP lookup"
7822 The name CONNECT is an obsolete name for NETTIME, retained for
7823 backwards compatibility. This timeout (specified as a number of seconds) is
7824 enforced from the client end for operations that can be carried out over a
7825 network. Specifically, it applies to network connections and calls to the
7826 &'ldap_result()'& function. If the value is greater than zero, it is used if
7827 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7828 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7829 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7830 Netscape SDK; for OpenLDAP no action is taken.
7831
7832 The TIME parameter (also a number of seconds) is passed to the server to
7833 set a server-side limit on the time taken to complete a search.
7834
7835 The SERVERS parameter allows you to specify an alternate list of ldap servers
7836 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7837 default list of ldap servers, and a single lookup can specify a single ldap
7838 server to use.  But when you need to do a lookup with a list of servers that is
7839 different than the default list (maybe different order, maybe a completely
7840 different set of servers), the SERVERS parameter allows you to specify this
7841 alternate list (colon-separated).
7842
7843 Here is an example of an LDAP query in an Exim lookup that uses some of these
7844 values. This is a single line, folded to fit on the page:
7845 .code
7846 ${lookup ldap
7847   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7848   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7849   {$value}fail}
7850 .endd
7851 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7852 any of the auxiliary data. Exim configuration settings that include lookups
7853 which contain password information should be preceded by &"hide"& to prevent
7854 non-admin users from using the &%-bP%& option to see their values.
7855
7856 The auxiliary data items may be given in any order. The default is no
7857 connection timeout (the system timeout is used), no user or password, no limit
7858 on the number of entries returned, and no time limit on queries.
7859
7860 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7861 removes any URL quoting that it may contain before passing it to the LDAP library.
7862 Apparently
7863 some libraries do this for themselves, but some do not. Removing the URL
7864 quoting has two advantages:
7865
7866 .ilist
7867 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7868 DNs as with DNs inside actual queries.
7869 .next
7870 It permits spaces inside USER= DNs.
7871 .endlist
7872
7873 For example, a setting such as
7874 .code
7875 USER=cn=${quote_ldap_dn:$1}
7876 .endd
7877 should work even if &$1$& contains spaces.
7878
7879 Expanded data for the PASS= value should be quoted using the &%quote%&
7880 expansion operator, rather than the LDAP quote operators. The only reason this
7881 field needs quoting is to ensure that it conforms to the Exim syntax, which
7882 does not allow unquoted spaces. For example:
7883 .code
7884 PASS=${quote:$3}
7885 .endd
7886 The LDAP authentication mechanism can be used to check passwords as part of
7887 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7888 &<<CHAPexpand>>&.
7889
7890
7891
7892 .subsection "Format of data returned by LDAP" SECID71
7893 .cindex "LDAP" "returned data formats"
7894 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7895 as a sequence of values, for example
7896 .code
7897 cn=manager,o=University of Cambridge,c=UK
7898 .endd
7899 The &(ldap)& lookup type generates an error if more than one entry matches the
7900 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7901 the result between the data from different entries. It is possible for multiple
7902 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7903 you know that whatever values are returned all came from a single entry in the
7904 directory.
7905
7906 In the common case where you specify a single attribute in your LDAP query, the
7907 result is not quoted, and does not contain the attribute name. If the attribute
7908 has multiple values, they are separated by commas. Any comma that is
7909 part of an attribute's value is doubled.
7910
7911 If you specify multiple attributes, the result contains space-separated, quoted
7912 strings, each preceded by the attribute name and an equals sign. Within the
7913 quotes, the quote character, backslash, and newline are escaped with
7914 backslashes, and commas are used to separate multiple values for the attribute.
7915 Any commas in attribute values are doubled
7916 (permitting treatment of the values as a comma-separated list).
7917 Apart from the escaping, the string within quotes takes the same form as the
7918 output when a single attribute is requested. Specifying no attributes is the
7919 same as specifying all of an entry's attributes.
7920
7921 Here are some examples of the output format. The first line of each pair is an
7922 LDAP query, and the second is the data that is returned. The attribute called
7923 &%attr1%& has two values, one of them with an embedded comma, whereas
7924 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7925 (they have SUP &%attr%& in their schema definitions).
7926
7927 .code
7928 ldap:///o=base?attr1?sub?(uid=fred)
7929 value1.1,value1,,2
7930
7931 ldap:///o=base?attr2?sub?(uid=fred)
7932 value two
7933
7934 ldap:///o=base?attr?sub?(uid=fred)
7935 value1.1,value1,,2,value two
7936
7937 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7938 attr1="value1.1,value1,,2" attr2="value two"
7939
7940 ldap:///o=base??sub?(uid=fred)
7941 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7942 .endd
7943 You can
7944 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7945 results of LDAP lookups.
7946 The &%extract%& operator in string expansions can be used to pick out
7947 individual fields from data that consists of &'key'&=&'value'& pairs.
7948 The &%listextract%& operator should be used to pick out individual values
7949 of attributes, even when only a single value is expected.
7950 The doubling of embedded commas allows you to use the returned data as a
7951 comma separated list (using the "<," syntax for changing the input list separator).
7952
7953
7954
7955
7956 .section "More about NIS+" "SECTnisplus"
7957 .cindex "NIS+ lookup type"
7958 .cindex "lookup" "NIS+"
7959 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7960 and field name. If this is given, the result of a successful query is the
7961 contents of the named field; otherwise the result consists of a concatenation
7962 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7963 values containing spaces are quoted. For example, the query
7964 .code
7965 [name=mg1456],passwd.org_dir
7966 .endd
7967 might return the string
7968 .code
7969 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7970 home=/home/mg1456 shell=/bin/bash shadow=""
7971 .endd
7972 (split over two lines here to fit on the page), whereas
7973 .code
7974 [name=mg1456],passwd.org_dir:gcos
7975 .endd
7976 would just return
7977 .code
7978 Martin Guerre
7979 .endd
7980 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7981 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7982 operator is to double any quote characters within the text.
7983
7984
7985
7986 .section "SQL lookups" "SECTsql"
7987 .cindex "SQL lookup types"
7988 .cindex "MySQL" "lookup type"
7989 .cindex "PostgreSQL lookup type"
7990 .cindex "lookup" "MySQL"
7991 .cindex "lookup" "PostgreSQL"
7992 .cindex "Oracle" "lookup type"
7993 .cindex "lookup" "Oracle"
7994 .cindex "InterBase lookup type"
7995 .cindex "lookup" "InterBase"
7996 .cindex "Redis lookup type"
7997 .cindex lookup Redis
7998 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7999 and SQLite
8000 databases. Queries for these databases contain SQL statements, so an example
8001 might be
8002 .code
8003 ${lookup mysql{select mailbox from users where id='userx'}\
8004   {$value}fail}
8005 .endd
8006 If the result of the query contains more than one field, the data for each
8007 field in the row is returned, preceded by its name, so the result of
8008 .code
8009 ${lookup pgsql{select home,name from users where id='userx'}\
8010   {$value}}
8011 .endd
8012 might be
8013 .code
8014 home=/home/userx name="Mister X"
8015 .endd
8016 Empty values and values containing spaces are double quoted, with embedded
8017 quotes escaped by a backslash. If the result of the query contains just one
8018 field, the value is passed back verbatim, without a field name, for example:
8019 .code
8020 Mister X
8021 .endd
8022 If the result of the query yields more than one row, it is all concatenated,
8023 with a newline between the data for each row.
8024
8025
8026 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
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 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8038 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8039 or &%redis_servers%&
8040 option (as appropriate) must be set to a colon-separated list of server
8041 information.
8042 .oindex &%mysql_servers%&
8043 .oindex &%pgsql_servers%&
8044 .oindex &%oracle_servers%&
8045 .oindex &%ibase_servers%&
8046 .oindex &%redis_servers%&
8047 (For MySQL and PostgreSQL, the global option need not be set if all
8048 queries contain their own server information &-- see section
8049 &<<SECTspeserque>>&.)
8050 For all but Redis
8051 each item in the list is a slash-separated list of four
8052 items: host name, database name, user name, and password. In the case of
8053 Oracle, the host name field is used for the &"service name"&, and the database
8054 name field is not used and should be empty. For example:
8055 .code
8056 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8057 .endd
8058 Because password data is sensitive, you should always precede the setting with
8059 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8060 option. Here is an example where two MySQL servers are listed:
8061 .code
8062 hide mysql_servers = localhost/users/root/secret:\
8063                      otherhost/users/root/othersecret
8064 .endd
8065 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8066 because this is a colon-separated list, the colon has to be doubled. For each
8067 query, these parameter groups are tried in order until a connection is made and
8068 a query is successfully processed. The result of a query may be that no data is
8069 found, but that is still a successful query. In other words, the list of
8070 servers provides a backup facility, not a list of different places to look.
8071
8072 For Redis the global option need not be specified if all queries contain their
8073 own server information &-- see section &<<SECTspeserque>>&.
8074 If specified, the option must be set to a colon-separated list of server
8075 information.
8076 Each item in the list is a slash-separated list of three items:
8077 host, database number, and password.
8078 .olist
8079 The host is required and may be either an IPv4 address and optional
8080 port number (separated by a colon, which needs doubling due to the
8081 higher-level list), or a Unix socket pathname enclosed in parentheses
8082 .next
8083 The database number is optional; if present that number is selected in the backend
8084 .next
8085 The password is optional; if present it is used to authenticate to the backend
8086 .endlist
8087
8088 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8089 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8090 respectively, and the characters single-quote, double-quote, and backslash
8091 itself are escaped with backslashes.
8092
8093 The &%quote_redis%& expansion operator
8094 escapes whitespace and backslash characters with a backslash.
8095
8096 .subsection "Specifying the server in the query" SECTspeserque
8097 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8098 it is possible to specify a list of servers with an individual query. This is
8099 done by appending a comma-separated option to the query type:
8100 .display
8101 &`,servers=`&&'server1:server2:server3:...'&
8102 .endd
8103 Each item in the list may take one of two forms:
8104 .olist
8105 If it contains no slashes it is assumed to be just a host name. The appropriate
8106 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8107 of the same name, and the remaining parameters (database, user, password) are
8108 taken from there.
8109 .next
8110 If it contains any slashes, it is taken as a complete parameter set.
8111 .endlist
8112 The list of servers is used in exactly the same way as the global list.
8113 Once a connection to a server has happened and a query has been
8114 successfully executed, processing of the lookup ceases.
8115
8116 This feature is intended for use in master/slave situations where updates
8117 are occurring and you want to update the master rather than a slave. If the
8118 master is in the list as a backup for reading, you might have a global setting
8119 like this:
8120 .code
8121 mysql_servers = slave1/db/name/pw:\
8122                 slave2/db/name/pw:\
8123                 master/db/name/pw
8124 .endd
8125 In an updating lookup, you could then write:
8126 .code
8127 ${lookup mysql,servers=master {UPDATE ...} }
8128 .endd
8129 That query would then be sent only to the master server. If, on the other hand,
8130 the master is not to be used for reading, and so is not present in the global
8131 option, you can still update it by a query of this form:
8132 .code
8133 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8134 .endd
8135
8136 An older syntax places the servers specification before the query,
8137 semicolon separated:
8138 .code
8139 ${lookup mysql{servers=master; UPDATE ...} }
8140 .endd
8141 The new version avoids potential issues with tainted
8142 arguments in the query, for explicit expansion.
8143 &*Note*&: server specifications in list-style lookups are still problematic.
8144
8145
8146 .subsection "Special MySQL features" SECID73
8147 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8148 causes a connection to the server on the local host by means of a Unix domain
8149 socket. An alternate socket can be specified in parentheses.
8150 An option group name for MySQL option files can be specified in square brackets;
8151 the default value is &"exim"&.
8152 The full syntax of each item in &%mysql_servers%& is:
8153 .display
8154 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8155   <&'database'&>/<&'user'&>/<&'password'&>
8156 .endd
8157 Any of the four sub-parts of the first field can be omitted. For normal use on
8158 the local host it can be left blank or set to just &"localhost"&.
8159
8160 No database need be supplied &-- but if it is absent here, it must be given in
8161 the queries.
8162
8163 If a MySQL query is issued that does not request any data (an insert, update,
8164 or delete command), the result of the lookup is the number of rows affected.
8165
8166 &*Warning*&: This can be misleading. If an update does not actually change
8167 anything (for example, setting a field to the value it already has), the result
8168 is zero because no rows are affected.
8169
8170
8171 .subsection "Special PostgreSQL features" SECID74
8172 PostgreSQL lookups can also use Unix domain socket connections to the database.
8173 This is usually faster and costs less CPU time than a TCP/IP connection.
8174 However it can be used only if the mail server runs on the same machine as the
8175 database server. A configuration line for PostgreSQL via Unix domain sockets
8176 looks like this:
8177 .code
8178 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8179 .endd
8180 In other words, instead of supplying a host name, a path to the socket is
8181 given. The path name is enclosed in parentheses so that its slashes aren't
8182 visually confused with the delimiters for the other server parameters.
8183
8184 If a PostgreSQL query is issued that does not request any data (an insert,
8185 update, or delete command), the result of the lookup is the number of rows
8186 affected.
8187
8188 .subsection "More about SQLite" SECTsqlite
8189 .cindex "lookup" "SQLite"
8190 .cindex "sqlite lookup type"
8191 SQLite is different to the other SQL lookups because a filename is required in
8192 addition to the SQL query. An SQLite database is a single file, and there is no
8193 daemon as in the other SQL databases.
8194
8195 .oindex &%sqlite_dbfile%&
8196 There are two ways of
8197 specifying the file.
8198 The first is is by using the &%sqlite_dbfile%& main option.
8199 The second, which allows separate files for each query,
8200 is to use an option appended, comma-separated, to the &"sqlite"&
8201 lookup type word.  The option is the word &"file"&, then an equals,
8202 then the filename.
8203 The filename in this case cannot contain whitespace or open-brace charachters.
8204
8205 A deprecated method is available, prefixing the query with the filename
8206 separated by white space.
8207 This means that
8208 .cindex "tainted data" "sqlite file"
8209 the query cannot use any tainted values, as that taints
8210 the entire query including the filename - resulting in a refusal to open
8211 the file.
8212
8213 In all the above cases the filename must be an absolute path.
8214
8215 Here is a lookup expansion example:
8216 .code
8217 sqlite_dbfile = /some/thing/sqlitedb
8218 ...
8219 ${lookup sqlite {select name from aliases where id='userx';}}
8220 .endd
8221 In a list, the syntax is similar. For example:
8222 .code
8223 domainlist relay_to_domains = sqlite;\
8224    select * from relays where ip='$sender_host_address';
8225 .endd
8226 The only character affected by the &%quote_sqlite%& operator is a single
8227 quote, which it doubles.
8228
8229 .cindex timeout SQLite
8230 .cindex sqlite "lookup timeout"
8231 The SQLite library handles multiple simultaneous accesses to the database
8232 internally. Multiple readers are permitted, but only one process can
8233 update at once. Attempts to access the database while it is being updated
8234 are rejected after a timeout period, during which the SQLite library
8235 waits for the lock to be released. In Exim, the default timeout is set
8236 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8237 option.
8238
8239 .subsection "More about Redis" SECTredis
8240 .cindex "lookup" "Redis"
8241 .cindex "redis lookup type"
8242 Redis is a non-SQL database. Commands are simple get and set.
8243 Examples:
8244 .code
8245 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8246 ${lookup redis{get keyname}}
8247 .endd
8248
8249 As of release 4.91, "lightweight" support for Redis Cluster is available.
8250 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8251 of which must be reachable from the running exim instance. If the cluster has
8252 master/slave replication, the list must contain all the master and slave
8253 servers.
8254
8255 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8256 immediately follow the redirection but treats the response as a DEFER, moving on
8257 to the next server in the &%redis_servers%& list until the correct server is
8258 reached.
8259
8260 .ecindex IIDfidalo1
8261 .ecindex IIDfidalo2
8262
8263
8264 . ////////////////////////////////////////////////////////////////////////////
8265 . ////////////////////////////////////////////////////////////////////////////
8266
8267 .chapter "Domain, host, address, and local part lists" &&&
8268          "CHAPdomhosaddlists" &&&
8269          "Domain, host, and address lists"
8270 .scindex IIDdohoadli "lists of domains; hosts; etc."
8271 A number of Exim configuration options contain lists of domains, hosts,
8272 email addresses, or local parts. For example, the &%hold_domains%& option
8273 contains a list of domains whose delivery is currently suspended. These lists
8274 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8275 arguments to expansion conditions such as &%match_domain%&.
8276
8277 Each item in one of these lists is a pattern to be matched against a domain,
8278 host, email address, or local part, respectively. In the sections below, the
8279 different types of pattern for each case are described, but first we cover some
8280 general facilities that apply to all four kinds of list.
8281
8282 Note that other parts of Exim use a &'string list'& which does not
8283 support all the complexity available in
8284 domain, host, address and local part lists.
8285
8286
8287
8288 .section "Results of list checking" SECTlistresults
8289 The primary result of doing a list check is a truth value.
8290 In some contexts additional information is stored
8291 about the list element that matched:
8292 .vlist
8293 .vitem hosts
8294 A &%hosts%& ACL condition
8295 will store a result in the &$host_data$& variable.
8296 .vitem local_parts
8297 A &%local_parts%& router option or &%local_parts%& ACL condition
8298 will store a result in the &$local_part_data$& variable.
8299 .vitem domains
8300 A &%domains%& router option or &%domains%& ACL condition
8301 will store a result in the &$domain_data$& variable.
8302 .vitem senders
8303 A &%senders%& router option or &%senders%& ACL condition
8304 will store a result in the &$sender_data$& variable.
8305 .vitem recipients
8306 A &%recipients%& ACL condition
8307 will store a result in the &$recipient_data$& variable.
8308 .endlist
8309
8310 The detail of the additional information depends on the
8311 type of match and is given below as the &*value*& information.
8312
8313
8314
8315
8316 .section "Expansion of lists" "SECTlistexpand"
8317 .cindex "expansion" "of lists"
8318 Each list is expanded as a single string before it is used.
8319
8320 &'Exception: the router headers_remove option, where list-item
8321 splitting is done before string-expansion.'&
8322
8323 The result of
8324 expansion must be a list, possibly containing empty items, which is split up
8325 into separate items for matching. By default, colon is the separator character,
8326 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8327 &<<SECTempitelis>>& for details of the list syntax; the second of these
8328 discusses the way to specify empty list items.
8329
8330
8331 If the string expansion is forced to fail, Exim behaves as if the item it is
8332 testing (domain, host, address, or local part) is not in the list. Other
8333 expansion failures cause temporary errors.
8334
8335 If an item in a list is a regular expression, backslashes, dollars and possibly
8336 other special characters in the expression must be protected against
8337 misinterpretation by the string expander. The easiest way to do this is to use
8338 the &`\N`& expansion feature to indicate that the contents of the regular
8339 expression should not be expanded. For example, in an ACL you might have:
8340 .code
8341 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8342                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8343 .endd
8344 The first item is a regular expression that is protected from expansion by
8345 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8346 senders based on the receiving domain.
8347
8348
8349
8350
8351 .subsection "Negated items in lists" SECID76
8352 .cindex "list" "negation"
8353 .cindex "negation" "in lists"
8354 Items in a list may be positive or negative. Negative items are indicated by a
8355 leading exclamation mark, which may be followed by optional white space. A list
8356 defines a set of items (domains, etc). When Exim processes one of these lists,
8357 it is trying to find out whether a domain, host, address, or local part
8358 (respectively) is in the set that is defined by the list. It works like this:
8359
8360 The list is scanned from left to right. If a positive item is matched, the
8361 subject that is being checked is in the set; if a negative item is matched, the
8362 subject is not in the set. If the end of the list is reached without the
8363 subject having matched any of the patterns, it is in the set if the last item
8364 was a negative one, but not if it was a positive one. For example, the list in
8365 .code
8366 domainlist relay_to_domains = !a.b.c : *.b.c
8367 .endd
8368 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8369 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8370 list is positive. However, if the setting were
8371 .code
8372 domainlist relay_to_domains = !a.b.c
8373 .endd
8374 then all domains other than &'a.b.c'& would match because the last item in the
8375 list is negative. In other words, a list that ends with a negative item behaves
8376 as if it had an extra item &`:*`& on the end.
8377
8378 Another way of thinking about positive and negative items in lists is to read
8379 the connector as &"or"& after a positive item and as &"and"& after a negative
8380 item.
8381
8382
8383
8384 .subsection "File names in lists" SECTfilnamlis
8385 .cindex "list" "filename in"
8386 If an item in a domain, host, address, or local part list is an absolute
8387 filename (beginning with a slash character), each line of the file is read and
8388 processed as if it were an independent item in the list, except that further
8389 filenames are not allowed,
8390 and no expansion of the data from the file takes place.
8391 Empty lines in the file are ignored, and the file may also contain comment
8392 lines:
8393
8394 .ilist
8395 For domain and host lists, if a # character appears anywhere in a line of the
8396 file, it and all following characters are ignored.
8397 .next
8398 Because local parts may legitimately contain # characters, a comment in an
8399 address list or local part list file is recognized only if # is preceded by
8400 white space or the start of the line. For example:
8401 .code
8402 not#comment@x.y.z   # but this is a comment
8403 .endd
8404 .endlist
8405
8406 Putting a filename in a list has the same effect as inserting each line of the
8407 file as an item in the list (blank lines and comments excepted). However, there
8408 is one important difference: the file is read each time the list is processed,
8409 so if its contents vary over time, Exim's behaviour changes.
8410
8411 If a filename is preceded by an exclamation mark, the sense of any match
8412 within the file is inverted. For example, if
8413 .code
8414 hold_domains = !/etc/nohold-domains
8415 .endd
8416 and the file contains the lines
8417 .code
8418 !a.b.c
8419 *.b.c
8420 .endd
8421 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8422 any domain matching &`*.b.c`& is not.
8423
8424
8425
8426 .subsection "An lsearch file is not an out-of-line list" SECID77
8427 As will be described in the sections that follow, lookups can be used in lists
8428 to provide indexed methods of checking list membership. There has been some
8429 confusion about the way &(lsearch)& lookups work in lists. Because
8430 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8431 sometimes thought that it is allowed to contain wild cards and other kinds of
8432 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8433 always fixed strings, just as for any other single-key lookup type.
8434
8435 If you want to use a file to contain wild-card patterns that form part of a
8436 list, just give the filename on its own, without a search type, as described
8437 in the previous section. You could also use the &(wildlsearch)& or
8438 &(nwildlsearch)&, but there is no advantage in doing this.
8439
8440
8441
8442
8443 .subsection "Named lists" SECTnamedlists
8444 .cindex "named lists"
8445 .cindex "list" "named"
8446 A list of domains, hosts, email addresses, or local parts can be given a name
8447 which is then used to refer to the list elsewhere in the configuration. This is
8448 particularly convenient if the same list is required in several different
8449 places. It also allows lists to be given meaningful names, which can improve
8450 the readability of the configuration. For example, it is conventional to define
8451 a domain list called &'local_domains'& for all the domains that are handled
8452 locally on a host, using a configuration line such as
8453 .code
8454 domainlist local_domains = localhost:my.dom.example
8455 .endd
8456 Named lists are referenced by giving their name preceded by a plus sign, so,
8457 for example, a router that is intended to handle local domains would be
8458 configured with the line
8459 .code
8460 domains = +local_domains
8461 .endd
8462 The first router in a configuration is often one that handles all domains
8463 except the local ones, using a configuration with a negated item like this:
8464 .code
8465 dnslookup:
8466   driver = dnslookup
8467   domains = ! +local_domains
8468   transport = remote_smtp
8469   no_more
8470 .endd
8471 The four kinds of named list are created by configuration lines starting with
8472 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8473 respectively. Then there follows the name that you are defining, followed by an
8474 equals sign and the list itself. For example:
8475 .code
8476 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8477 addresslist bad_senders = cdb;/etc/badsenders
8478 .endd
8479 A named list may refer to other named lists:
8480 .code
8481 domainlist  dom1 = first.example : second.example
8482 domainlist  dom2 = +dom1 : third.example
8483 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8484 .endd
8485 &*Warning*&: If the last item in a referenced list is a negative one, the
8486 effect may not be what you intended, because the negation does not propagate
8487 out to the higher level. For example, consider:
8488 .code
8489 domainlist  dom1 = !a.b
8490 domainlist  dom2 = +dom1 : *.b
8491 .endd
8492 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8493 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8494 means it matches the second list as well. The effect is not the same as
8495 .code
8496 domainlist  dom2 = !a.b : *.b
8497 .endd
8498 where &'x.y'& does not match. It's best to avoid negation altogether in
8499 referenced lists if you can.
8500
8501 .cindex "hiding named list values"
8502 .cindex "named lists" "hiding value of"
8503 Some named list definitions may contain sensitive data, for example, passwords for
8504 accessing databases. To stop non-admin users from using the &%-bP%& command
8505 line option to read these values, you can precede the definition with the
8506 word &"hide"&. For example:
8507 .code
8508 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8509 .endd
8510
8511
8512 Named lists may have a performance advantage. When Exim is routing an
8513 address or checking an incoming message, it caches the result of tests on named
8514 lists. So, if you have a setting such as
8515 .code
8516 domains = +local_domains
8517 .endd
8518 on several of your routers
8519 or in several ACL statements,
8520 the actual test is done only for the first one. However, the caching works only
8521 if there are no expansions within the list itself or any sublists that it
8522 references. In other words, caching happens only for lists that are known to be
8523 the same each time they are referenced.
8524
8525 By default, there may be up to 16 named lists of each type. This limit can be
8526 extended by changing a compile-time variable. The use of domain and host lists
8527 is recommended for concepts such as local domains, relay domains, and relay
8528 hosts. The default configuration is set up like this.
8529
8530
8531
8532 .subsection "Named lists compared with macros" SECID78
8533 .cindex "list" "named compared with macro"
8534 .cindex "macro" "compared with named list"
8535 At first sight, named lists might seem to be no different from macros in the
8536 configuration file. However, macros are just textual substitutions. If you
8537 write
8538 .code
8539 ALIST = host1 : host2
8540 auth_advertise_hosts = !ALIST
8541 .endd
8542 it probably won't do what you want, because that is exactly the same as
8543 .code
8544 auth_advertise_hosts = !host1 : host2
8545 .endd
8546 Notice that the second host name is not negated. However, if you use a host
8547 list, and write
8548 .code
8549 hostlist alist = host1 : host2
8550 auth_advertise_hosts = ! +alist
8551 .endd
8552 the negation applies to the whole list, and so that is equivalent to
8553 .code
8554 auth_advertise_hosts = !host1 : !host2
8555 .endd
8556
8557
8558 .subsection "Named list caching" SECID79
8559 .cindex "list" "caching of named"
8560 .cindex "caching" "named lists"
8561 While processing a message, Exim caches the result of checking a named list if
8562 it is sure that the list is the same each time. In practice, this means that
8563 the cache operates only if the list contains no $ characters, which guarantees
8564 that it will not change when it is expanded. Sometimes, however, you may have
8565 an expanded list that you know will be the same each time within a given
8566 message. For example:
8567 .code
8568 domainlist special_domains = \
8569            ${lookup{$sender_host_address}cdb{/some/file}}
8570 .endd
8571 This provides a list of domains that depends only on the sending host's IP
8572 address. If this domain list is referenced a number of times (for example,
8573 in several ACL lines, or in several routers) the result of the check is not
8574 cached by default, because Exim does not know that it is going to be the
8575 same list each time.
8576
8577 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8578 cache the result anyway. For example:
8579 .code
8580 domainlist_cache special_domains = ${lookup{...
8581 .endd
8582 If you do this, you should be absolutely sure that caching is going to do
8583 the right thing in all cases. When in doubt, leave it out.
8584
8585
8586
8587 .section "Domain lists" "SECTdomainlist"
8588 .cindex "domain list" "patterns for"
8589 .cindex "list" "domain list"
8590 Domain lists contain patterns that are to be matched against a mail domain.
8591 The following types of item may appear in domain lists:
8592
8593 .ilist
8594 .cindex "primary host name"
8595 .cindex "host name" "matched in domain list"
8596 .oindex "&%primary_hostname%&"
8597 .cindex "domain list" "matching primary host name"
8598 .cindex "@ in a domain list"
8599 If a pattern consists of a single @ character, it matches the local host name,
8600 as set by the &%primary_hostname%& option (or defaulted). This makes it
8601 possible to use the same configuration file on several different hosts that
8602 differ only in their names.
8603
8604 The value for a match will be the primary host name.
8605
8606
8607 .next
8608 .cindex "@[] in a domain list"
8609 .cindex "domain list" "matching local IP interfaces"
8610 .cindex "domain literal"
8611 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8612 in square brackets (as in an email address that contains a domain literal), but
8613 only if that IP address is recognized as local for email routing purposes. The
8614 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8615 control which of a host's several IP addresses are treated as local.
8616 In today's Internet, the use of domain literals is controversial;
8617 see the &%allow_domain_literals%& main option.
8618
8619 The value for a match will be the string &`@[]`&.
8620
8621
8622 .next
8623 .cindex "@mx_any"
8624 .cindex "@mx_primary"
8625 .cindex "@mx_secondary"
8626 .cindex "domain list" "matching MX pointers to local host"
8627 If a pattern consists of the string &`@mx_any`& it matches any domain that
8628 has an MX record pointing to the local host or to any host that is listed in
8629 .oindex "&%hosts_treat_as_local%&"
8630 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8631 are similar, except that the first matches only when a primary MX target is the
8632 local host, and the second only when no primary MX target is the local host,
8633 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8634 preference value &-- there may of course be more than one of them.
8635
8636 The MX lookup that takes place when matching a pattern of this type is
8637 performed with the resolver options for widening names turned off. Thus, for
8638 example, a single-component domain will &'not'& be expanded by adding the
8639 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8640 options of the &(dnslookup)& router for a discussion of domain widening.
8641
8642 Sometimes you may want to ignore certain IP addresses when using one of these
8643 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8644 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8645 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8646 on a router). For example:
8647 .code
8648 domains = @mx_any/ignore=127.0.0.1
8649 .endd
8650 This example matches any domain that has an MX record pointing to one of
8651 the local host's IP addresses other than 127.0.0.1.
8652
8653 The list of IP addresses is in fact processed by the same code that processes
8654 host lists, so it may contain CIDR-coded network specifications and it may also
8655 contain negative items.
8656
8657 Because the list of IP addresses is a sublist within a domain list, you have to
8658 be careful about delimiters if there is more than one address. Like any other
8659 list, the default delimiter can be changed. Thus, you might have:
8660 .code
8661 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8662           an.other.domain : ...
8663 .endd
8664 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8665 involved, it is easiest to change the delimiter for the main list as well:
8666 .code
8667 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8668           an.other.domain ? ...
8669 .endd
8670 The value for a match will be the list element string (starting &`@mx_`&).
8671
8672
8673 .next
8674 .cindex "asterisk" "in domain list"
8675 .cindex "domain list" "asterisk in"
8676 .cindex "domain list" "matching &""ends with""&"
8677 If a pattern starts with an asterisk, the remaining characters of the pattern
8678 are compared with the terminating characters of the domain. The use of &"*"& in
8679 domain lists differs from its use in partial matching lookups. In a domain
8680 list, the character following the asterisk need not be a dot, whereas partial
8681 matching works only in terms of dot-separated components. For example, a domain
8682 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8683 &'cipher.key.ex'&.
8684
8685 The value for a match will be the list element string (starting with the asterisk).
8686 Additionally, &$0$& will be set to the matched string
8687 and &$1$& to the variable portion which the asterisk matched.
8688
8689 .next
8690 .cindex "regular expressions" "in domain list"
8691 .cindex "domain list" "matching regular expression"
8692 If a pattern starts with a circumflex character, it is treated as a regular
8693 expression, and matched against the domain using a regular expression matching
8694 function. The circumflex is treated as part of the regular expression.
8695 Email domains are case-independent, so this regular expression match is by
8696 default case-independent, but you can make it case-dependent by starting it
8697 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8698 are given in chapter &<<CHAPregexp>>&.
8699
8700 &*Warning*&: Because domain lists are expanded before being processed, you
8701 must escape any backslash and dollar characters in the regular expression, or
8702 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8703 it is not to be expanded (unless you really do want to build a regular
8704 expression by expansion, of course).
8705
8706 The value for a match will be the list element string (starting with the circumflex).
8707 Additionally, &$0$& will be set to the string matching the regular expression,
8708 and &$1$& (onwards) to any submatches identified by parentheses.
8709
8710
8711
8712 .next
8713 .cindex "lookup" "in domain list"
8714 .cindex "domain list" "matching by lookup"
8715 If a pattern starts with the name of a single-key lookup type followed by a
8716 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8717 must be a filename in a suitable format for the lookup type. For example, for
8718 &"cdb;"& it must be an absolute path:
8719 .code
8720 domains = cdb;/etc/mail/local_domains.cdb
8721 .endd
8722 The appropriate type of lookup is done on the file using the domain name as the
8723 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8724 only in whether or not the key is present in the file. However, when a lookup
8725 is used for the &%domains%& option on a router
8726 or a &%domains%& condition in an ACL statement, the value is preserved in the
8727 &$domain_data$& variable and can be referred to in other router options or
8728 other statements in the same ACL.
8729 .cindex "tainted data" "de-tainting"
8730 .cindex "de-tainting" "using ACL domains condition"
8731 The value will be untainted.
8732
8733 &*Note*&: If the data result of the lookup (as opposed to the key)
8734 is empty, then this empty value is stored in &$domain_data$&.
8735 The option to return the key for the lookup, as the value,
8736 may be what is wanted.
8737
8738
8739 .next
8740 Any of the single-key lookup type names may be preceded by
8741 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8742 .code
8743 domains = partial-dbm;/partial/domains
8744 .endd
8745 This causes partial matching logic to be invoked; a description of how this
8746 works is given in section &<<SECTpartiallookup>>&.
8747
8748 .next
8749 .cindex "asterisk" "in lookup type"
8750 Any of the single-key lookup types may be followed by an asterisk. This causes
8751 a default lookup for a key consisting of a single asterisk to be done if the
8752 original lookup fails. This is not a useful feature when using a domain list to
8753 select particular domains (because any domain would match), but it might have
8754 value if the result of the lookup is being used via the &$domain_data$&
8755 expansion variable.
8756
8757 .next
8758 If the pattern starts with the name of a query-style lookup type followed by a
8759 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8760 pattern must be an appropriate query for the lookup type, as described in
8761 chapter &<<CHAPfdlookup>>&. For example:
8762 .code
8763 hold_domains = mysql;select domain from holdlist \
8764   where domain = '${quote_mysql:$domain}';
8765 .endd
8766 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8767 example, it doesn't matter what field you select). Exim is interested only in
8768 whether or not the query succeeds. However, when a lookup is used for the
8769 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8770 variable and can be referred to in other options.
8771 .cindex "tainted data" "de-tainting"
8772 .cindex "de-tainting" "using router domains option"
8773 The value will be untainted.
8774
8775 .next
8776 If the pattern starts with the name of a lookup type
8777 of either kind (single-key or query-style) it may be
8778 followed by a comma and options,
8779 The options are lookup-type specific and consist of a comma-separated list.
8780 Each item starts with a tag and and equals "=" sign.
8781
8782 .next
8783 .cindex "domain list" "matching literal domain name"
8784 If none of the above cases apply, a caseless textual comparison is made
8785 between the pattern and the domain.
8786
8787 The value for a match will be the list element string.
8788 .cindex "tainted data" "de-tainting"
8789 Note that this is commonly untainted
8790 (depending on the way the list was created).
8791 Specifically, explicit text in the configuration file in not tainted.
8792 This is a useful way of obtaining an untainted equivalent to
8793 the domain, for later operations.
8794
8795 However if the list (including one-element lists)
8796 is created by expanding a variable containing tainted data,
8797 it is tainted and so will the match value be.
8798 .endlist
8799
8800
8801 Here is an example that uses several different kinds of pattern:
8802 .code
8803 domainlist funny_domains = \
8804   @ : \
8805   lib.unseen.edu : \
8806   *.foundation.fict.example : \
8807   \N^[1-2]\d{3}\.fict\.example$\N : \
8808   partial-dbm;/opt/data/penguin/book : \
8809   nis;domains.byname : \
8810   nisplus;[name=$domain,status=local],domains.org_dir
8811 .endd
8812 There are obvious processing trade-offs among the various matching modes. Using
8813 an asterisk is faster than a regular expression, and listing a few names
8814 explicitly probably is too. The use of a file or database lookup is expensive,
8815 but may be the only option if hundreds of names are required. Because the
8816 patterns are tested in order, it makes sense to put the most commonly matched
8817 patterns earlier.
8818
8819
8820
8821 .section "Host lists" "SECThostlist"
8822 .cindex "host list" "patterns in"
8823 .cindex "list" "host list"
8824 Host lists are used to control what remote hosts are allowed to do. For
8825 example, some hosts may be allowed to use the local host as a relay, and some
8826 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8827 two different ways, by name or by IP address. In a host list, some types of
8828 pattern are matched to a host name, and some are matched to an IP address.
8829 You need to be particularly careful with this when single-key lookups are
8830 involved, to ensure that the right value is being used as the key.
8831
8832
8833 .subsection "Special host list patterns" SECID80
8834 .cindex "empty item in hosts list"
8835 .cindex "host list" "empty string in"
8836 If a host list item is the empty string, it matches only when no remote host is
8837 involved. This is the case when a message is being received from a local
8838 process using SMTP on the standard input, that is, when a TCP/IP connection is
8839 not used.
8840
8841 .cindex "asterisk" "in host list"
8842 The special pattern &"*"& in a host list matches any host or no host. Neither
8843 the IP address nor the name is actually inspected.
8844
8845
8846
8847 .subsection "Host list patterns that match by IP address" SECThoslispatip
8848 .cindex "host list" "matching IP addresses"
8849 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8850 the incoming address actually appears in the IPv6 host as
8851 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8852 list, it is converted into a traditional IPv4 address first. (Not all operating
8853 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8854 concerns.)
8855
8856 The following types of pattern in a host list check the remote host by
8857 inspecting its IP address:
8858
8859 .ilist
8860 If the pattern is a plain domain name (not a regular expression, not starting
8861 with *, not a lookup of any kind), Exim calls the operating system function
8862 to find the associated IP address(es). Exim uses the newer
8863 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8864 This typically causes a forward DNS lookup of the name. The result is compared
8865 with the IP address of the subject host.
8866
8867 If there is a temporary problem (such as a DNS timeout) with the host name
8868 lookup, a temporary error occurs. For example, if the list is being used in an
8869 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8870 temporary SMTP error code. If no IP address can be found for the host name,
8871 what happens is described in section &<<SECTbehipnot>>& below.
8872
8873 .next
8874 .cindex "@ in a host list"
8875 If the pattern is &"@"&, the primary host name is substituted and used as a
8876 domain name, as just described.
8877
8878 .next
8879 If the pattern is an IP address, it is matched against the IP address of the
8880 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8881 IPv6 addresses can be given in colon-separated format, but the colons have to
8882 be doubled so as not to be taken as item separators when the default list
8883 separator is used. IPv6 addresses are recognized even when Exim is compiled
8884 without IPv6 support. This means that if they appear in a host list on an
8885 IPv4-only host, Exim will not treat them as host names. They are just addresses
8886 that can never match a client host.
8887
8888 .next
8889 .cindex "@[] in a host list"
8890 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8891 the local host. For example, if the local host is an IPv4 host with one
8892 interface address 10.45.23.56, these two ACL statements have the same effect:
8893 .code
8894 accept hosts = 127.0.0.1 : 10.45.23.56
8895 accept hosts = @[]
8896 .endd
8897 .next
8898 .cindex "CIDR notation"
8899 If the pattern is an IP address followed by a slash and a mask length, for
8900 example
8901 .code
8902 10.11.42.0/24
8903 .endd
8904 , it is matched against the IP address of the subject
8905 host under the given mask. This allows an entire network of hosts to be
8906 included (or excluded) by a single item. The mask uses CIDR notation; it
8907 specifies the number of address bits that must match, starting from the most
8908 significant end of the address.
8909
8910 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8911 of a range of addresses. It is the number of bits in the network portion of the
8912 address. The above example specifies a 24-bit netmask, so it matches all 256
8913 addresses in the 10.11.42.0 network. An item such as
8914 .code
8915 192.168.23.236/31
8916 .endd
8917 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8918 32 for an IPv4 address is the same as no mask at all; just a single address
8919 matches.
8920
8921 Here is another example which shows an IPv4 and an IPv6 network:
8922 .code
8923 recipient_unqualified_hosts = 192.168.0.0/16: \
8924                               3ffe::ffff::836f::::/48
8925 .endd
8926 The doubling of list separator characters applies only when these items
8927 appear inline in a host list. It is not required when indirecting via a file.
8928 For example:
8929 .code
8930 recipient_unqualified_hosts = /opt/exim/unqualnets
8931 .endd
8932 could make use of a file containing
8933 .code
8934 172.16.0.0/12
8935 3ffe:ffff:836f::/48
8936 .endd
8937 to have exactly the same effect as the previous example. When listing IPv6
8938 addresses inline, it is usually more convenient to use the facility for
8939 changing separator characters. This list contains the same two networks:
8940 .code
8941 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8942                                  3ffe:ffff:836f::/48
8943 .endd
8944 The separator is changed to semicolon by the leading &"<;"& at the start of the
8945 list.
8946 .endlist
8947
8948
8949
8950 .subsection "Host list patterns for single-key lookups by host address" &&&
8951          SECThoslispatsikey
8952 .cindex "host list" "lookup of IP address"
8953 When a host is to be identified by a single-key lookup of its complete IP
8954 address, the pattern takes this form:
8955 .display
8956 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8957 .endd
8958 For example:
8959 .code
8960 hosts_lookup = net-cdb;/hosts-by-ip.db
8961 .endd
8962 The text form of the IP address of the subject host is used as the lookup key.
8963 IPv6 addresses are converted to an unabbreviated form, using lower case
8964 letters, with dots as separators because colon is the key terminator in
8965 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8966 quoting the keys, but this is a facility that was added later.] The data
8967 returned by the lookup is not used.
8968
8969 .cindex "IP address" "masking"
8970 .cindex "host list" "masked IP address"
8971 Single-key lookups can also be performed using masked IP addresses, using
8972 patterns of this form:
8973 .display
8974 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8975 .endd
8976 For example:
8977 .code
8978 net24-dbm;/networks.db
8979 .endd
8980 The IP address of the subject host is masked using <&'number'&> as the mask
8981 length. A textual string is constructed from the masked value, followed by the
8982 mask, and this is used as the lookup key. For example, if the host's IP address
8983 is 192.168.34.6, the key that is looked up for the above example is
8984 &"192.168.34.0/24"&.
8985
8986 When an IPv6 address is converted to a string, dots are normally used instead
8987 of colons, so that keys in &(lsearch)& files need not contain colons (which
8988 terminate &(lsearch)& keys). This was implemented some time before the ability
8989 to quote keys was made available in &(lsearch)& files. However, the more
8990 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8991 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8992 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8993 converted using colons and not dots.
8994 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8995 addresses are always used.
8996 The latter are converted to IPv4 addresses, in dotted-quad form.
8997
8998 Ideally, it would be nice to tidy up this anomalous situation by changing to
8999 colons in all cases, given that quoting is now available for &(lsearch)&.
9000 However, this would be an incompatible change that might break some existing
9001 configurations.
9002
9003 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9004 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9005 the former case the key strings include the mask value, whereas in the latter
9006 case the IP address is used on its own.
9007
9008
9009
9010 .subsection "Host list patterns that match by host name" SECThoslispatnam
9011 .cindex "host" "lookup failures"
9012 .cindex "unknown host name"
9013 .cindex "host list" "matching host name"
9014 There are several types of pattern that require Exim to know the name of the
9015 remote host. These are either wildcard patterns or lookups by name. (If a
9016 complete hostname is given without any wildcarding, it is used to find an IP
9017 address to match against, as described in section &<<SECThoslispatip>>&
9018 above.)
9019
9020 If the remote host name is not already known when Exim encounters one of these
9021 patterns, it has to be found from the IP address.
9022 Although many sites on the Internet are conscientious about maintaining reverse
9023 DNS data for their hosts, there are also many that do not do this.
9024 Consequently, a name cannot always be found, and this may lead to unwanted
9025 effects. Take care when configuring host lists with wildcarded name patterns.
9026 Consider what will happen if a name cannot be found.
9027
9028 Because of the problems of determining host names from IP addresses, matching
9029 against host names is not as common as matching against IP addresses.
9030
9031 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9032 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9033 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9034 are done can be changed by setting the &%host_lookup_order%& option. For
9035 security, once Exim has found one or more names, it looks up the IP addresses
9036 for these names and compares them with the IP address that it started with.
9037 Only those names whose IP addresses match are accepted. Any other names are
9038 discarded. If no names are left, Exim behaves as if the host name cannot be
9039 found. In the most common case there is only one name and one IP address.
9040
9041 There are some options that control what happens if a host name cannot be
9042 found. These are described in section &<<SECTbehipnot>>& below.
9043
9044 .cindex "host" "alias for"
9045 .cindex "alias for host"
9046 As a result of aliasing, hosts may have more than one name. When processing any
9047 of the following types of pattern, all the host's names are checked:
9048
9049 .ilist
9050 .cindex "asterisk" "in host list"
9051 If a pattern starts with &"*"& the remainder of the item must match the end of
9052 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9053 &'.b.c'&. This special simple form is provided because this is a very common
9054 requirement. Other kinds of wildcarding require the use of a regular
9055 expression.
9056 .next
9057 .cindex "regular expressions" "in host list"
9058 .cindex "host list" "regular expression in"
9059 If the item starts with &"^"& it is taken to be a regular expression which is
9060 matched against the host name. Host names are case-independent, so this regular
9061 expression match is by default case-independent, but you can make it
9062 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9063 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9064 example,
9065 .code
9066 ^(a|b)\.c\.d$
9067 .endd
9068 is a regular expression that matches either of the two hosts &'a.c.d'& or
9069 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9070 that backslash and dollar characters are not misinterpreted as part of the
9071 string expansion. The simplest way to do this is to use &`\N`& to mark that
9072 part of the string as non-expandable. For example:
9073 .code
9074 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9075 .endd
9076 &*Warning*&: If you want to match a complete host name, you must include the
9077 &`$`& terminating metacharacter in the regular expression, as in the above
9078 example. Without it, a match at the start of the host name is all that is
9079 required.
9080 .endlist
9081
9082
9083
9084
9085 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9086 .cindex "host" "lookup failures, permanent"
9087 While processing a host list, Exim may need to look up an IP address from a
9088 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9089 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9090 behaviour when it fails to find the information it is seeking is the same.
9091
9092 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9093 apply to temporary DNS errors, whose handling is described in the next section.
9094
9095 .cindex "&`+include_unknown`&"
9096 .cindex "&`+ignore_unknown`&"
9097 Exim parses a host list from left to right. If it encounters a permanent
9098 lookup failure in any item in the host list before it has found a match,
9099 Exim treats it as a failure and the default behavior is as if the host
9100 does not match the list. This may not always be what you want to happen.
9101 To change Exim's behaviour, the special items &`+include_unknown`& or
9102 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9103 not recognized in an indirected file).
9104
9105 .ilist
9106 If any item that follows &`+include_unknown`& requires information that
9107 cannot found, Exim behaves as if the host does match the list. For example,
9108 .code
9109 host_reject_connection = +include_unknown:*.enemy.ex
9110 .endd
9111 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9112 any hosts whose name it cannot find.
9113
9114 .next
9115 If any item that follows &`+ignore_unknown`& requires information that cannot
9116 be found, Exim ignores that item and proceeds to the rest of the list. For
9117 example:
9118 .code
9119 accept hosts = +ignore_unknown : friend.example : \
9120                192.168.4.5
9121 .endd
9122 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9123 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9124 name can be found for 192.168.4.5, it is rejected.
9125 .endlist
9126
9127 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9128 list. The effect of each one lasts until the next, or until the end of the
9129 list.
9130
9131 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9132          SECTmixwilhos
9133 .cindex "host list" "mixing names and addresses in"
9134
9135 This section explains the host/ip processing logic with the same concepts
9136 as the previous section, but specifically addresses what happens when a
9137 wildcarded hostname is one of the items in the hostlist.
9138
9139 .ilist
9140 If you have name lookups or wildcarded host names and
9141 IP addresses in the same host list, you should normally put the IP
9142 addresses first. For example, in an ACL you could have:
9143 .code
9144 accept hosts = 10.9.8.7 : *.friend.example
9145 .endd
9146 The reason you normally would order it this way lies in the
9147 left-to-right way that Exim processes lists.  It can test IP addresses
9148 without doing any DNS lookups, but when it reaches an item that requires
9149 a host name, it fails if it cannot find a host name to compare with the
9150 pattern. If the above list is given in the opposite order, the
9151 &%accept%& statement fails for a host whose name cannot be found, even
9152 if its IP address is 10.9.8.7.
9153
9154 .next
9155 If you really do want to do the name check first, and still recognize the IP
9156 address, you can rewrite the ACL like this:
9157 .code
9158 accept hosts = *.friend.example
9159 accept hosts = 10.9.8.7
9160 .endd
9161 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9162 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9163 &`+ignore_unknown`&, which was discussed in depth in the first example in
9164 this section.
9165 .endlist
9166
9167
9168 .subsection "Temporary DNS errors when looking up host information" &&&
9169          SECTtemdnserr
9170 .cindex "host" "lookup failures, temporary"
9171 .cindex "&`+include_defer`&"
9172 .cindex "&`+ignore_defer`&"
9173 A temporary DNS lookup failure normally causes a defer action (except when
9174 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9175 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9176 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9177 section. These options should be used with care, probably only in non-critical
9178 host lists such as whitelists.
9179
9180
9181
9182 .subsection "Host list patterns for single-key lookups by host name" &&&
9183          SECThoslispatnamsk
9184 .cindex "unknown host name"
9185 .cindex "host list" "matching host name"
9186 If a pattern is of the form
9187 .display
9188 <&'single-key-search-type'&>;<&'search-data'&>
9189 .endd
9190 for example
9191 .code
9192 dbm;/host/accept/list
9193 .endd
9194 a single-key lookup is performed, using the host name as its key. If the
9195 lookup succeeds, the host matches the item. The actual data that is looked up
9196 is not used.
9197
9198 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9199 keys in the file, not IP addresses. If you want to do lookups based on IP
9200 addresses, you must precede the search type with &"net-"& (see section
9201 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9202 two items in the same list, one doing an address lookup and one doing a name
9203 lookup, both using the same file.
9204
9205
9206
9207 .subsection "Host list patterns for query-style lookups" SECID81
9208 If a pattern is of the form
9209 .display
9210 <&'query-style-search-type'&>;<&'query'&>
9211 .endd
9212 the query is obeyed, and if it succeeds, the host matches the item. The actual
9213 data that is looked up is not used. The variables &$sender_host_address$& and
9214 &$sender_host_name$& can be used in the query. For example:
9215 .code
9216 hosts_lookup = pgsql;\
9217   select ip from hostlist where ip='$sender_host_address'
9218 .endd
9219 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9220 can use the &%sg%& expansion item to change this if you need to. If you want to
9221 use masked IP addresses in database queries, you can use the &%mask%& expansion
9222 operator.
9223
9224 If the query contains a reference to &$sender_host_name$&, Exim automatically
9225 looks up the host name if it has not already done so. (See section
9226 &<<SECThoslispatnam>>& for comments on finding host names.)
9227
9228 Historical note: prior to release 4.30, Exim would always attempt to find a
9229 host name before running the query, unless the search type was preceded by
9230 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9231 still recognized for query-style lookups, but its presence or absence has no
9232 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9233 See section &<<SECThoslispatsikey>>&.)
9234
9235
9236
9237
9238
9239 .section "Address lists" "SECTaddresslist"
9240 .cindex "list" "address list"
9241 .cindex "address list" "empty item"
9242 .cindex "address list" "patterns"
9243 Address lists contain patterns that are matched against mail addresses. There
9244 is one special case to be considered: the sender address of a bounce message is
9245 always empty. You can test for this by providing an empty item in an address
9246 list. For example, you can set up a router to process bounce messages by
9247 using this option setting:
9248 .code
9249 senders = :
9250 .endd
9251 The presence of the colon creates an empty item. If you do not provide any
9252 data, the list is empty and matches nothing. The empty sender can also be
9253 detected by a regular expression that matches an empty string,
9254 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9255
9256 Non-empty items in an address list can be straightforward email addresses. For
9257 example:
9258 .code
9259 senders = jbc@askone.example : hs@anacreon.example
9260 .endd
9261 A certain amount of wildcarding is permitted. If a pattern contains an @
9262 character, but is not a regular expression and does not begin with a
9263 semicolon-terminated lookup type (described below), the local part of the
9264 subject address is compared with the local part of the pattern, which may start
9265 with an asterisk. If the local parts match, the domain is checked in exactly
9266 the same way as for a pattern in a domain list. For example, the domain can be
9267 wildcarded, refer to a named list, or be a lookup:
9268 .code
9269 deny senders = *@*.spamming.site:\
9270                *@+hostile_domains:\
9271                bozo@partial-lsearch;/list/of/dodgy/sites:\
9272                *@dbm;/bad/domains.db
9273 .endd
9274 .cindex "local part" "starting with !"
9275 .cindex "address list" "local part starting with !"
9276 If a local part that begins with an exclamation mark is required, it has to be
9277 specified using a regular expression, because otherwise the exclamation mark is
9278 treated as a sign of negation, as is standard in lists.
9279
9280 If a non-empty pattern that is not a regular expression or a lookup does not
9281 contain an @ character, it is matched against the domain part of the subject
9282 address. The only two formats that are recognized this way are a literal
9283 domain, or a domain pattern that starts with *. In both these cases, the effect
9284 is the same as if &`*@`& preceded the pattern. For example:
9285 .code
9286 deny senders = enemy.domain : *.enemy.domain
9287 .endd
9288
9289 The following kinds of more complicated address list pattern can match any
9290 address, including the empty address that is characteristic of bounce message
9291 senders:
9292
9293 .ilist
9294 .cindex "regular expressions" "in address list"
9295 .cindex "address list" "regular expression in"
9296 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9297 done against the complete address, with the pattern as the regular expression.
9298 You must take care that backslash and dollar characters are not misinterpreted
9299 as part of the string expansion. The simplest way to do this is to use &`\N`&
9300 to mark that part of the string as non-expandable. For example:
9301 .code
9302 deny senders = \N^.*this.*@example\.com$\N : \
9303                \N^\d{8}.+@spamhaus.example$\N : ...
9304 .endd
9305 The &`\N`& sequences are removed by the expansion, so these items do indeed
9306 start with &"^"& by the time they are being interpreted as address patterns.
9307
9308 .next
9309 .cindex "address list" "lookup for complete address"
9310 Complete addresses can be looked up by using a pattern that starts with a
9311 lookup type terminated by a semicolon, followed by the data for the lookup. For
9312 example:
9313 .code
9314 deny senders = cdb;/etc/blocked.senders : \
9315   mysql;select address from blocked where \
9316   address='${quote_mysql:$sender_address}'
9317 .endd
9318 Both query-style and single-key lookup types can be used. For a single-key
9319 lookup type, Exim uses the complete address as the key. However, empty keys are
9320 not supported for single-key lookups, so a match against the empty address
9321 always fails. This restriction does not apply to query-style lookups.
9322
9323 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9324 cannot be used, and is ignored if specified, with an entry being written to the
9325 panic log.
9326 .cindex "*@ with single-key lookup"
9327 However, you can configure lookup defaults, as described in section
9328 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9329 default. For example, with this lookup:
9330 .code
9331 accept senders = lsearch*@;/some/file
9332 .endd
9333 the file could contains lines like this:
9334 .code
9335 user1@domain1.example
9336 *@domain2.example
9337 .endd
9338 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9339 that are tried is:
9340 .code
9341 nimrod@jaeger.example
9342 *@jaeger.example
9343 *
9344 .endd
9345 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9346 would mean that every address matches, thus rendering the test useless.
9347
9348 &*Warning 2*&: Do not confuse these two kinds of item:
9349 .code
9350 deny recipients = dbm*@;/some/file
9351 deny recipients = *@dbm;/some/file
9352 .endd
9353 The first does a whole address lookup, with defaulting, as just described,
9354 because it starts with a lookup type. The second matches the local part and
9355 domain independently, as described in a bullet point below.
9356 .endlist
9357
9358
9359 The following kinds of address list pattern can match only non-empty addresses.
9360 If the subject address is empty, a match against any of these pattern types
9361 always fails.
9362
9363
9364 .ilist
9365 .cindex "@@ with single-key lookup"
9366 .cindex "address list" "@@ lookup type"
9367 .cindex "address list" "split local part and domain"
9368 If a pattern starts with &"@@"& followed by a single-key lookup item
9369 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9370 split into a local part and a domain. The domain is looked up in the file. If
9371 it is not found, there is no match. If it is found, the data that is looked up
9372 from the file is treated as a colon-separated list of local part patterns, each
9373 of which is matched against the subject local part in turn.
9374
9375 .cindex "asterisk" "in address list"
9376 The lookup may be a partial one, and/or one involving a search for a default
9377 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9378 patterns that are looked up can be regular expressions or begin with &"*"&, or
9379 even be further lookups. They may also be independently negated. For example,
9380 with
9381 .code
9382 deny senders = @@dbm;/etc/reject-by-domain
9383 .endd
9384 the data from which the DBM file is built could contain lines like
9385 .code
9386 baddomain.com:  !postmaster : *
9387 .endd
9388 to reject all senders except &%postmaster%& from that domain.
9389
9390 .cindex "local part" "starting with !"
9391 If a local part that actually begins with an exclamation mark is required, it
9392 has to be specified using a regular expression. In &(lsearch)& files, an entry
9393 may be split over several lines by indenting the second and subsequent lines,
9394 but the separating colon must still be included at line breaks. White space
9395 surrounding the colons is ignored. For example:
9396 .code
9397 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9398   spammer3 : spammer4
9399 .endd
9400 As in all colon-separated lists in Exim, a colon can be included in an item by
9401 doubling.
9402
9403 If the last item in the list starts with a right angle-bracket, the remainder
9404 of the item is taken as a new key to look up in order to obtain a continuation
9405 list of local parts. The new key can be any sequence of characters. Thus one
9406 might have entries like
9407 .code
9408 aol.com: spammer1 : spammer 2 : >*
9409 xyz.com: spammer3 : >*
9410 *:       ^\d{8}$
9411 .endd
9412 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9413 local parts for all domains, in addition to the specific local parts listed for
9414 each domain. Of course, using this feature costs another lookup each time a
9415 chain is followed, but the effort needed to maintain the data is reduced.
9416
9417 .cindex "loop" "in lookups"
9418 It is possible to construct loops using this facility, and in order to catch
9419 them, the chains may be no more than fifty items long.
9420
9421 .next
9422 The @@<&'lookup'&> style of item can also be used with a query-style
9423 lookup, but in this case, the chaining facility is not available. The lookup
9424 can only return a single list of local parts.
9425 .endlist
9426
9427 &*Warning*&: There is an important difference between the address list items
9428 in these two examples:
9429 .code
9430 senders = +my_list
9431 senders = *@+my_list
9432 .endd
9433 In the first one, &`my_list`& is a named address list, whereas in the second
9434 example it is a named domain list.
9435
9436
9437
9438
9439 .subsection "Case of letters in address lists" SECTcasletadd
9440 .cindex "case of local parts"
9441 .cindex "address list" "case forcing"
9442 .cindex "case forcing in address lists"
9443 Domains in email addresses are always handled caselessly, but for local parts
9444 case may be significant on some systems (see &%caseful_local_part%& for how
9445 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9446 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9447 blocking lists should be done in a case-independent manner. Since most address
9448 lists in Exim are used for this kind of control, Exim attempts to do this by
9449 default.
9450
9451 The domain portion of an address is always lowercased before matching it to an
9452 address list. The local part is lowercased by default, and any string
9453 comparisons that take place are done caselessly. This means that the data in
9454 the address list itself, in files included as plain filenames, and in any file
9455 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9456 keys in files that are looked up by a search type other than &(lsearch)& (which
9457 works caselessly) must be in lower case, because these lookups are not
9458 case-independent.
9459
9460 .cindex "&`+caseful`&"
9461 To allow for the possibility of caseful address list matching, if an item in
9462 an address list is the string &"+caseful"&, the original case of the local
9463 part is restored for any comparisons that follow, and string comparisons are no
9464 longer case-independent. This does not affect the domain, which remains in
9465 lower case. However, although independent matches on the domain alone are still
9466 performed caselessly, regular expressions that match against an entire address
9467 become case-sensitive after &"+caseful"& has been seen.
9468
9469
9470
9471 .section "Local part lists" "SECTlocparlis"
9472 .cindex "list" "local part list"
9473 .cindex "local part" "list"
9474 These behave in the same way as domain and host lists, with the following
9475 changes:
9476
9477 Case-sensitivity in local part lists is handled in the same way as for address
9478 lists, as just described. The &"+caseful"& item can be used if required. In a
9479 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9480 set false, the subject is lowercased and the matching is initially
9481 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9482 matching in the local part list, but not elsewhere in the router. If
9483 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9484 option is case-sensitive from the start.
9485
9486 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9487 comments are handled in the same way as address lists &-- they are recognized
9488 only if the # is preceded by white space or the start of the line.
9489 Otherwise, local part lists are matched in the same way as domain lists, except
9490 that the special items that refer to the local host (&`@`&, &`@[]`&,
9491 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9492 Refer to section &<<SECTdomainlist>>& for details of the other available item
9493 types.
9494 .ecindex IIDdohoadli
9495
9496
9497
9498
9499 . ////////////////////////////////////////////////////////////////////////////
9500 . ////////////////////////////////////////////////////////////////////////////
9501
9502 .chapter "String expansions" "CHAPexpand"
9503 .scindex IIDstrexp "expansion" "of strings"
9504 Many strings in Exim's runtime configuration are expanded before use. Some of
9505 them are expanded every time they are used; others are expanded only once.
9506
9507 When a string is being expanded it is copied verbatim from left to right except
9508 .cindex expansion "string concatenation"
9509 when a dollar or backslash character is encountered. A dollar specifies the
9510 start of a portion of the string that is interpreted and replaced as described
9511 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9512 escape character, as described in the following section.
9513
9514 Whether a string is expanded depends upon the context.  Usually this is solely
9515 dependent upon the option for which a value is sought; in this documentation,
9516 options for which string expansion is performed are marked with &dagger; after
9517 the data type.  ACL rules always expand strings.  A couple of expansion
9518 conditions do not expand some of the brace-delimited branches, for security
9519 reasons,
9520 .cindex "tainted data" expansion
9521 .cindex "tainted data" definition
9522 .cindex expansion "tainted data"
9523 and expansion of data deriving from the sender (&"tainted data"&)
9524 is not permitted (including acessing a file using a tainted name).
9525
9526 Common ways of obtaining untainted equivalents of variables with
9527 tainted values
9528 .cindex "tainted data" "de-tainting"
9529 come down to using the tainted value as a lookup key in a trusted database.
9530 This database could be the filesystem structure,
9531 or the password file,
9532 or accessed via a DBMS.
9533 Specific methods are indexed under &"de-tainting"&.
9534
9535
9536
9537 .section "Literal text in expanded strings" "SECTlittext"
9538 .cindex "expansion" "including literal text"
9539 An uninterpreted dollar can be included in an expanded string by putting a
9540 backslash in front of it. A backslash can be used to prevent any special
9541 character being treated specially in an expansion, including backslash itself.
9542 If the string appears in quotes in the configuration file, two backslashes are
9543 required because the quotes themselves cause interpretation of backslashes when
9544 the string is read in (see section &<<SECTstrings>>&).
9545
9546 .cindex "expansion" "non-expandable substrings"
9547 A portion of the string can specified as non-expandable by placing it between
9548 two occurrences of &`\N`&. This is particularly useful for protecting regular
9549 expressions, which often contain backslashes and dollar signs. For example:
9550 .code
9551 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9552 .endd
9553 On encountering the first &`\N`&, the expander copies subsequent characters
9554 without interpretation until it reaches the next &`\N`& or the end of the
9555 string.
9556
9557
9558
9559 .section "Character escape sequences in expanded strings" "SECID82"
9560 .cindex "expansion" "escape sequences"
9561 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9562 expanded string is recognized as an escape sequence for the character newline,
9563 carriage return, or tab, respectively. A backslash followed by up to three
9564 octal digits is recognized as an octal encoding for a single character, and a
9565 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9566 encoding.
9567
9568 These escape sequences are also recognized in quoted strings when they are read
9569 in. Their interpretation in expansions as well is useful for unquoted strings,
9570 and for other cases such as looked-up strings that are then expanded.
9571
9572
9573 .section "Testing string expansions" "SECID83"
9574 .cindex "expansion" "testing"
9575 .cindex "testing" "string expansion"
9576 .oindex "&%-be%&"
9577 Many expansions can be tested by calling Exim with the &%-be%& option. This
9578 takes the command arguments, or lines from the standard input if there are no
9579 arguments, runs them through the string expansion code, and writes the results
9580 to the standard output. Variables based on configuration values are set up, but
9581 since no message is being processed, variables such as &$local_part$& have no
9582 value. Nevertheless the &%-be%& option can be useful for checking out file and
9583 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9584 and &%nhash%&.
9585
9586 .new
9587 When reading lines from the standard input,
9588 macros can be defined and ACL variables can be set.
9589 For example:
9590 .code
9591 MY_MACRO = foo
9592 set acl_m_myvar = bar
9593 .endd
9594 Such macros and variables can then be used in later input lines.
9595 .wen
9596
9597 Exim gives up its root privilege when it is called with the &%-be%& option, and
9598 instead runs under the uid and gid it was called with, to prevent users from
9599 using &%-be%& for reading files to which they do not have access.
9600
9601 .oindex "&%-bem%&"
9602 If you want to test expansions that include variables whose values are taken
9603 from a message, there are two other options that can be used. The &%-bem%&
9604 option is like &%-be%& except that it is followed by a filename. The file is
9605 read as a message before doing the test expansions. For example:
9606 .code
9607 exim -bem /tmp/test.message '$h_subject:'
9608 .endd
9609 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9610 Exim message identifier. For example:
9611 .code
9612 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9613 .endd
9614 This loads the message from Exim's spool before doing the test expansions, and
9615 is therefore restricted to admin users.
9616
9617
9618 .section "Forced expansion failure" "SECTforexpfai"
9619 .cindex "expansion" "forced failure"
9620 A number of expansions that are described in the following section have
9621 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9622 (which are sometimes called &"curly brackets"&). Which of the two strings is
9623 used depends on some condition that is evaluated as part of the expansion. If,
9624 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9625 the entire string expansion fails in a way that can be detected by the code
9626 that requested the expansion. This is called &"forced expansion failure"&, and
9627 its consequences depend on the circumstances. In some cases it is no different
9628 from any other expansion failure, but in others a different action may be
9629 taken. Such variations are mentioned in the documentation of the option that is
9630 being expanded.
9631
9632
9633
9634
9635 .section "Expansion items" "SECTexpansionitems"
9636 The following items are recognized in expanded strings. White space may be used
9637 between sub-items that are keywords or substrings enclosed in braces inside an
9638 outer set of braces, to improve readability. &*Warning*&: Within braces,
9639 white space is significant.
9640
9641 .vlist
9642 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9643 .cindex "expansion" "variables"
9644 Substitute the contents of the named variable, for example:
9645 .code
9646 $local_part
9647 ${domain}
9648 .endd
9649 The second form can be used to separate the name from subsequent alphanumeric
9650 characters. This form (using braces) is available only for variables; it does
9651 &'not'& apply to message headers. The names of the variables are given in
9652 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9653 given, the expansion fails.
9654
9655 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9656 .cindex "expansion" "operators"
9657 The string is first itself expanded, and then the operation specified by
9658 <&'op'&> is applied to it. For example:
9659 .code
9660 ${lc:$local_part}
9661 .endd
9662 The string starts with the first character after the colon, which may be
9663 leading white space. A list of operators is given in section &<<SECTexpop>>&
9664 below. The operator notation is used for simple expansion items that have just
9665 one argument, because it reduces the number of braces and therefore makes the
9666 string easier to understand.
9667
9668 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9669 This item inserts &"basic"& header lines. It is described with the &%header%&
9670 expansion item below.
9671
9672
9673 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9674 .cindex "expansion" "calling an acl"
9675 .cindex "&%acl%&" "call from expansion"
9676 The name and zero to nine argument strings are first expanded separately.  The expanded
9677 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9678 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9679 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9680 and may use the variables; if another acl expansion is used the values
9681 are restored after it returns.  If the ACL sets
9682 a value using a "message =" modifier and returns accept or deny, the value becomes
9683 the result of the expansion.
9684 If no message is set and the ACL returns accept or deny
9685 the expansion result is an empty string.
9686 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9687
9688
9689 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9690 .cindex authentication "results header"
9691 .chindex Authentication-Results:
9692 .cindex authentication "expansion item"
9693 This item returns a string suitable for insertion as an
9694 &'Authentication-Results:'&
9695 header line.
9696 The given <&'authserv-id'&> is included in the result; typically this
9697 will be a domain name identifying the system performing the authentications.
9698 Methods that might be present in the result include:
9699 .code
9700 none
9701 iprev
9702 auth
9703 spf
9704 dkim
9705 .endd
9706
9707 Example use (as an ACL modifier):
9708 .code
9709       add_header = :at_start:${authresults {$primary_hostname}}
9710 .endd
9711 This is safe even if no authentication results are available
9712 .new
9713 and would generally be placed in the DATA ACL.
9714 .wen
9715
9716
9717 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9718        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9719 .cindex "expansion" "extracting certificate fields"
9720 .cindex "&%certextract%&" "certificate fields"
9721 .cindex "certificate" "extracting fields"
9722 The <&'certificate'&> must be a variable of type certificate.
9723 The field name is expanded and used to retrieve the relevant field from
9724 the certificate.  Supported fields are:
9725 .display
9726 &`version        `&
9727 &`serial_number  `&
9728 &`subject        `& RFC4514 DN
9729 &`issuer         `& RFC4514 DN
9730 &`notbefore      `& time
9731 &`notafter       `& time
9732 &`sig_algorithm  `&
9733 &`signature      `&
9734 &`subj_altname   `& tagged list
9735 &`ocsp_uri       `& list
9736 &`crl_uri        `& list
9737 .endd
9738 If the field is found,
9739 <&'string2'&> is expanded, and replaces the whole item;
9740 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9741 variable &$value$& contains the value that has been extracted. Afterwards, it
9742 is restored to any previous value it might have had.
9743
9744 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9745 key is not found. If {<&'string2'&>} is also omitted, the value that was
9746 extracted is used.
9747
9748 Some field names take optional modifiers, appended and separated by commas.
9749
9750 The field selectors marked as "RFC4514" above
9751 output a Distinguished Name string which is
9752 not quite
9753 parseable by Exim as a comma-separated tagged list
9754 (the exceptions being elements containing commas).
9755 RDN elements of a single type may be selected by
9756 a modifier of the type label; if so the expansion
9757 result is a list (newline-separated by default).
9758 The separator may be changed by another modifier of
9759 a right angle-bracket followed immediately by the new separator.
9760 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9761
9762 The field selectors marked as "time" above
9763 take an optional modifier of "int"
9764 for which the result is the number of seconds since epoch.
9765 Otherwise the result is a human-readable string
9766 in the timezone selected by the main "timezone" option.
9767
9768 The field selectors marked as "list" above return a list,
9769 newline-separated by default,
9770 (embedded separator characters in elements are doubled).
9771 The separator may be changed by a modifier of
9772 a right angle-bracket followed immediately by the new separator.
9773
9774 The field selectors marked as "tagged" above
9775 prefix each list element with a type string and an equals sign.
9776 Elements of only one type may be selected by a modifier
9777 which is one of "dns", "uri" or "mail";
9778 if so the element tags are omitted.
9779
9780 If not otherwise noted field values are presented in human-readable form.
9781
9782 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9783        {*&<&'arg'&>&*}...}*&"
9784 .cindex &%dlfunc%&
9785 This expansion dynamically loads and then calls a locally-written C function.
9786 This functionality is available only if Exim is compiled with
9787 .code
9788 EXPAND_DLFUNC=yes
9789 .endd
9790 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9791 object so that it doesn't reload the same object file in the same Exim process
9792 (but of course Exim does start new processes frequently).
9793
9794 There may be from zero to eight arguments to the function.
9795
9796 When compiling
9797 a local function that is to be called in this way,
9798 first &_DLFUNC_IMPL_& should be defined,
9799 and second &_local_scan.h_& should be included.
9800 The Exim variables and functions that are defined by that API
9801 are also available for dynamically loaded functions. The function itself
9802 must have the following type:
9803 .code
9804 int dlfunction(uschar **yield, int argc, uschar *argv[])
9805 .endd
9806 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9807 function should return one of the following values:
9808
9809 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9810 into the expanded string that is being built.
9811
9812 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9813 from &'yield'&, if it is set.
9814
9815 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9816 taken from &'yield'& if it is set.
9817
9818 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9819
9820 When compiling a function that is to be used in this way with gcc,
9821 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9822 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9823
9824
9825 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9826 .cindex "expansion" "extracting value from environment"
9827 .cindex "environment" "values from"
9828 The key is first expanded separately, and leading and trailing white space
9829 removed.
9830 This is then searched for as a name in the environment.
9831 If a variable is found then its value is placed in &$value$&
9832 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9833
9834 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9835 appear, for example:
9836 .code
9837 ${env{USER}{$value} fail }
9838 .endd
9839 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9840 {<&'string1'&>} must be present for &"fail"& to be recognized.
9841
9842 If {<&'string2'&>} is omitted an empty string is substituted on
9843 search failure.
9844 If {<&'string1'&>} is omitted the search result is substituted on
9845 search success.
9846
9847 The environment is adjusted by the &%keep_environment%& and
9848 &%add_environment%& main section options.
9849
9850
9851 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9852        {*&<&'string3'&>&*}}*&"
9853 .cindex "expansion" "extracting substrings by key"
9854 .cindex "&%extract%&" "substrings by key"
9855 The key and <&'string1'&> are first expanded separately. Leading and trailing
9856 white space is removed from the key (but not from any of the strings). The key
9857 must not be empty and must not consist entirely of digits.
9858 The expanded <&'string1'&> must be of the form:
9859 .display
9860 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9861 .endd
9862 .vindex "&$value$&"
9863 where the equals signs and spaces (but not both) are optional. If any of the
9864 values contain white space, they must be enclosed in double quotes, and any
9865 values that are enclosed in double quotes are subject to escape processing as
9866 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9867 for the value that corresponds to the key. The search is case-insensitive. If
9868 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9869 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9870 variable &$value$& contains the value that has been extracted. Afterwards, it
9871 is restored to any previous value it might have had.
9872
9873 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9874 key is not found. If {<&'string2'&>} is also omitted, the value that was
9875 extracted is used. Thus, for example, these two expansions are identical, and
9876 yield &"2001"&:
9877 .code
9878 ${extract{gid}{uid=1984 gid=2001}}
9879 ${extract{gid}{uid=1984 gid=2001}{$value}}
9880 .endd
9881 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9882 appear, for example:
9883 .code
9884 ${extract{Z}{A=... B=...}{$value} fail }
9885 .endd
9886 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9887 {<&'string2'&>} must be present for &"fail"& to be recognized.
9888
9889 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9890        {*&<&'string3'&>&*}}*&" &&&
9891        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9892        {*&<&'string3'&>&*}}*&"
9893 .cindex "expansion" "extracting from JSON object"
9894 .cindex JSON expansions
9895 The key and <&'string1'&> are first expanded separately. Leading and trailing
9896 white space is removed from the key (but not from any of the strings). The key
9897 must not be empty and must not consist entirely of digits.
9898 The expanded <&'string1'&> must be of the form:
9899 .display
9900 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9901 .endd
9902 .vindex "&$value$&"
9903 The braces, commas and colons, and the quoting of the member name are required;
9904 the spaces are optional.
9905 Matching of the key against the member names is done case-sensitively.
9906 For the &"json"& variant,
9907 if a returned value is a JSON string, it retains its leading and
9908 trailing quotes.
9909 For the &"jsons"& variant, which is intended for use with JSON strings, the
9910 leading and trailing quotes are removed from the returned value.
9911 . XXX should be a UTF-8 compare
9912
9913 The results of matching are handled as above.
9914
9915
9916 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9917         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9918 .cindex "expansion" "extracting substrings by number"
9919 .cindex "&%extract%&" "substrings by number"
9920 The <&'number'&> argument must consist entirely of decimal digits,
9921 apart from leading and trailing white space, which is ignored.
9922 This is what distinguishes this form of &%extract%& from the previous kind. It
9923 behaves in the same way, except that, instead of extracting a named field, it
9924 extracts from <&'string1'&> the field whose number is given as the first
9925 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9926 <&'string3'&> as before.
9927
9928 The fields in the string are separated by any one of the characters in the
9929 separator string. These may include space or tab characters.
9930 The first field is numbered one. If the number is negative, the fields are
9931 counted from the end of the string, with the rightmost one numbered -1. If the
9932 number given is zero, the entire string is returned. If the modulus of the
9933 number is greater than the number of fields in the string, the result is the
9934 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9935 provided. For example:
9936 .code
9937 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9938 .endd
9939 yields &"42"&, and
9940 .code
9941 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9942 .endd
9943 yields &"99"&. Two successive separators mean that the field between them is
9944 empty (for example, the fifth field above).
9945
9946
9947 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9948         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9949        "&*${extract jsons{*&<&'number'&>&*}}&&&
9950         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9951 .cindex "expansion" "extracting from JSON array"
9952 .cindex JSON expansions
9953 The <&'number'&> argument must consist entirely of decimal digits,
9954 apart from leading and trailing white space, which is ignored.
9955
9956 Field selection and result handling is as above;
9957 there is no choice of field separator.
9958 For the &"json"& variant,
9959 if a returned value is a JSON string, it retains its leading and
9960 trailing quotes.
9961 For the &"jsons"& variant, which is intended for use with JSON strings, the
9962 leading and trailing quotes are removed from the returned value.
9963
9964
9965 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9966 .cindex "list" "selecting by condition"
9967 .cindex "expansion" "selecting from list by condition"
9968 .vindex "&$item$&"
9969 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9970 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9971 For each item
9972 in this list, its value is placed in &$item$&, and then the condition is
9973 evaluated.
9974 .new
9975 Any modification of &$value$& by this evaluation is discarded.
9976 .wen
9977 If the condition is true, &$item$& is added to the output as an
9978 item in a new list; if the condition is false, the item is discarded. The
9979 separator used for the output list is the same as the one used for the
9980 input, but a separator setting is not included in the output. For example:
9981 .code
9982 ${filter{a:b:c}{!eq{$item}{b}}}
9983 .endd
9984 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9985 to what it was before.
9986 See also the &%map%& and &%reduce%& expansion items.
9987
9988
9989 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9990 .cindex "hash function" "textual"
9991 .cindex "expansion" "textual hash"
9992 This is a textual hashing function, and was the first to be implemented in
9993 early versions of Exim. In current releases, there are other hashing functions
9994 (numeric, MD5, and SHA-1), which are described below.
9995
9996 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9997 <&'n'&>. If you are using fixed values for these numbers, that is, if
9998 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9999 use the simpler operator notation that avoids some of the braces:
10000 .code
10001 ${hash_<n>_<m>:<string>}
10002 .endd
10003 The second number is optional (in both notations). If <&'n'&> is greater than
10004 or equal to the length of the string, the expansion item returns the string.
10005 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10006 function to the string. The new string consists of characters taken from the
10007 first <&'m'&> characters of the string
10008 .code
10009 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10010 .endd
10011 If <&'m'&> is not present the value 26 is used, so that only lower case
10012 letters appear. For example:
10013 .display
10014 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10015 &`$hash{5}{monty}}           `&   yields  &`monty`&
10016 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10017 .endd
10018
10019 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10020         &*$h_*&<&'header&~name'&>&*:*&" &&&
10021        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10022         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10023        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10024         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10025        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10026         &*$rh_*&<&'header&~name'&>&*:*&"
10027 .cindex "expansion" "header insertion"
10028 .vindex "&$header_$&"
10029 .vindex "&$bheader_$&"
10030 .vindex "&$lheader_$&"
10031 .vindex "&$rheader_$&"
10032 .cindex "header lines" "in expansion strings"
10033 .cindex "header lines" "character sets"
10034 .cindex "header lines" "decoding"
10035 Substitute the contents of the named message header line, for example
10036 .code
10037 $header_reply-to:
10038 .endd
10039 The newline that terminates a header line is not included in the expansion, but
10040 internal newlines (caused by splitting the header line over several physical
10041 lines) may be present.
10042
10043 The difference between the four pairs of expansions is in the way
10044 the data in the header line is interpreted.
10045
10046 .ilist
10047 .cindex "white space" "in header lines"
10048 &%rheader%& gives the original &"raw"& content of the header line, with no
10049 processing at all, and without the removal of leading and trailing white space.
10050
10051 .next
10052 .cindex "list" "of header lines"
10053 &%lheader%& gives a colon-separated list, one element per header when there
10054 are multiple headers with a given name.
10055 Any embedded colon characters within an element are doubled, so normal Exim
10056 list-processing facilities can be used.
10057 The terminating newline of each element is removed; in other respects
10058 the content is &"raw"&.
10059
10060 .next
10061 .cindex "base64 encoding" "in header lines"
10062 &%bheader%& removes leading and trailing white space, and then decodes base64
10063 or quoted-printable MIME &"words"& within the header text, but does no
10064 character set translation. If decoding of what looks superficially like a MIME
10065 &"word"& fails, the raw string is returned. If decoding
10066 .cindex "binary zero" "in header line"
10067 produces a binary zero character, it is replaced by a question mark &-- this is
10068 what Exim does for binary zeros that are actually received in header lines.
10069
10070 .next
10071 &%header%& tries to translate the string as decoded by &%bheader%& to a
10072 standard character set. This is an attempt to produce the same string as would
10073 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10074 returned. Translation is attempted only on operating systems that support the
10075 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10076 a system Makefile or in &_Local/Makefile_&.
10077 .endlist ilist
10078
10079 In a filter file, the target character set for &%header%& can be specified by a
10080 command of the following form:
10081 .code
10082 headers charset "UTF-8"
10083 .endd
10084 This command affects all references to &$h_$& (or &$header_$&) expansions in
10085 subsequently obeyed filter commands. In the absence of this command, the target
10086 character set in a filter is taken from the setting of the &%headers_charset%&
10087 option in the runtime configuration. The value of this option defaults to the
10088 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10089 ISO-8859-1.
10090
10091 Header names follow the syntax of RFC 2822, which states that they may contain
10092 any printing characters except space and colon. Consequently, curly brackets
10093 &'do not'& terminate header names, and should not be used to enclose them as
10094 if they were variables. Attempting to do so causes a syntax error.
10095
10096 Only header lines that are common to all copies of a message are visible to
10097 this mechanism. These are the original header lines that are received with the
10098 message, and any that are added by an ACL statement or by a system
10099 filter. Header lines that are added to a particular copy of a message by a
10100 router or transport are not accessible.
10101
10102 For incoming SMTP messages, no header lines are visible in
10103 ACLs that are obeyed before the data phase completes,
10104 because the header structure is not set up until the message is received.
10105 They are visible in DKIM, PRDR and DATA ACLs.
10106 Header lines that are added in a RCPT ACL (for example)
10107 are saved until the message's incoming header lines are available, at which
10108 point they are added.
10109 When any of the above ACLs are
10110 running, however, header lines added by earlier ACLs are visible.
10111
10112 Upper case and lower case letters are synonymous in header names. If the
10113 following character is white space, the terminating colon may be omitted, but
10114 this is not recommended, because you may then forget it when it is needed. When
10115 white space terminates the header name, this white space is included in the
10116 expanded string.  If the message does not contain the given header, the
10117 expansion item is replaced by an empty string. (See the &%def%& condition in
10118 section &<<SECTexpcond>>& for a means of testing for the existence of a
10119 header.)
10120
10121 If there is more than one header with the same name, they are all concatenated
10122 to form the substitution string, up to a maximum length of 64K. Unless
10123 &%rheader%& is being used, leading and trailing white space is removed from
10124 each header before concatenation, and a completely empty header is ignored. A
10125 newline character is then inserted between non-empty headers, but there is no
10126 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10127 those headers that contain lists of addresses, a comma is also inserted at the
10128 junctions between headers. This does not happen for the &%rheader%& expansion.
10129
10130 .cindex "tainted data" "message headers"
10131 When the headers are from an incoming message,
10132 the result of expanding any of these variables is tainted.
10133
10134
10135 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10136 .cindex "expansion" "hmac hashing"
10137 .cindex &%hmac%&
10138 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10139 shared secret and some text into a message authentication code, as specified in
10140 RFC 2104. This differs from &`${md5:secret_text...}`& or
10141 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10142 cryptographic hash, allowing for authentication that is not possible with MD5
10143 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10144 present. For example:
10145 .code
10146 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10147 .endd
10148 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10149 produces:
10150 .code
10151 dd97e3ba5d1a61b5006108f8c8252953
10152 .endd
10153 As an example of how this might be used, you might put in the main part of
10154 an Exim configuration:
10155 .code
10156 SPAMSCAN_SECRET=cohgheeLei2thahw
10157 .endd
10158 In a router or a transport you could then have:
10159 .code
10160 headers_add = \
10161   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10162   ${hmac{md5}{SPAMSCAN_SECRET}\
10163   {${primary_hostname},${message_exim_id},$h_message-id:}}
10164 .endd
10165 Then given a message, you can check where it was scanned by looking at the
10166 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10167 this header line is authentic by recomputing the authentication code from the
10168 host name, message ID and the &'Message-id:'& header line. This can be done
10169 using Exim's &%-be%& option, or by other means, for example, by using the
10170 &'hmac_md5_hex()'& function in Perl.
10171
10172
10173 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10174 .cindex "expansion" "conditional"
10175 .cindex "&%if%&, expansion item"
10176 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10177 item; otherwise <&'string2'&> is used. The available conditions are described
10178 in section &<<SECTexpcond>>& below. For example:
10179 .code
10180 ${if eq {$local_part}{postmaster} {yes}{no} }
10181 .endd
10182 The second string need not be present; if it is not and the condition is not
10183 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10184 be present instead of the second string (without any curly brackets). In this
10185 case, the expansion is forced to fail if the condition is not true (see section
10186 &<<SECTforexpfai>>&).
10187
10188 If both strings are omitted, the result is the string &`true`& if the condition
10189 is true, and the empty string if the condition is false. This makes it less
10190 cumbersome to write custom ACL and router conditions. For example, instead of
10191 .code
10192 condition = ${if >{$acl_m4}{3}{true}{false}}
10193 .endd
10194 you can use
10195 .code
10196 condition = ${if >{$acl_m4}{3}}
10197 .endd
10198
10199
10200
10201 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10202 .cindex expansion "imap folder"
10203 .cindex "&%imapfolder%& expansion item"
10204 This item converts a (possibly multilevel, or with non-ASCII characters)
10205 folder specification to a Maildir name for filesystem use.
10206 For information on internationalisation support see &<<SECTi18nMDA>>&.
10207
10208
10209
10210 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10211 .cindex "expansion" "string truncation"
10212 .cindex "&%length%& expansion item"
10213 The &%length%& item is used to extract the initial portion of a string. Both
10214 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10215 you are using a fixed value for the number, that is, if <&'string1'&> does not
10216 change when expanded, you can use the simpler operator notation that avoids
10217 some of the braces:
10218 .code
10219 ${length_<n>:<string>}
10220 .endd
10221 The result of this item is either the first <&'n'&> bytes or the whole
10222 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10223 &%strlen%&, which gives the length of a string.
10224 All measurement is done in bytes and is not UTF-8 aware.
10225
10226
10227 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10228         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10229 .cindex "expansion" "extracting list elements by number"
10230 .cindex "&%listextract%&" "extract list elements by number"
10231 .cindex "list" "extracting elements by number"
10232 The <&'number'&> argument must consist entirely of decimal digits,
10233 apart from an optional leading minus,
10234 and leading and trailing white space (which is ignored).
10235
10236 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10237 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10238
10239 The first field of the list is numbered one.
10240 If the number is negative, the fields are
10241 counted from the end of the list, with the rightmost one numbered -1.
10242 The numbered element of the list is extracted and placed in &$value$&,
10243 then <&'string2'&> is expanded as the result.
10244
10245 If the modulus of the
10246 number is zero or greater than the number of fields in the string,
10247 the result is the expansion of <&'string3'&>.
10248
10249 For example:
10250 .code
10251 ${listextract{2}{x:42:99}}
10252 .endd
10253 yields &"42"&, and
10254 .code
10255 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10256 .endd
10257 yields &"result: 42"&.
10258
10259 If {<&'string3'&>} is omitted, an empty string is used for string3.
10260 If {<&'string2'&>} is also omitted, the value that was
10261 extracted is used.
10262 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10263
10264
10265 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10266 .cindex quoting "for list"
10267 .cindex list quoting
10268 This item doubles any occurrence of the separator character
10269 in the given string.
10270 An empty string is replaced with a single space.
10271 This converts the string into a safe form for use as a list element,
10272 in a list using the given separator.
10273
10274
10275 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10276         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10277        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10278         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10279 .cindex "expansion" "lookup in"
10280 .cindex "file" "lookups"
10281 .cindex "lookup" "in expanded string"
10282 The two forms of lookup item specify data lookups in files and databases, as
10283 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10284 lookups, and the second is used for query-style lookups. The <&'key'&>,
10285 <&'file'&>, and <&'query'&> strings are expanded before use.
10286
10287 If there is any white space in a lookup item which is part of a filter command,
10288 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10289 other place where white space is significant, the lookup item must be enclosed
10290 in double quotes. The use of data lookups in users' filter files may be locked
10291 out by the system administrator.
10292
10293 .vindex "&$value$&"
10294 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10295 During its expansion, the variable &$value$& contains the data returned by the
10296 lookup. Afterwards it reverts to the value it had previously (at the outer
10297 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10298 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10299 string on failure. If <&'string2'&> is provided, it can itself be a nested
10300 lookup, thus providing a mechanism for looking up a default value when the
10301 original lookup fails.
10302
10303 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10304 data for the outer lookup while the parameters of the second lookup are
10305 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10306 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10307 appear, and in this case, if the lookup fails, the entire expansion is forced
10308 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10309 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10310 successful lookup, and nothing in the case of failure.
10311
10312 For single-key lookups, the string &"partial"& is permitted to precede the
10313 search type in order to do partial matching, and * or *@ may follow a search
10314 type to request default lookups if the key does not match (see sections
10315 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10316
10317 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10318 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10319 and non-wild parts of the key during the expansion of the replacement text.
10320 They return to their previous values at the end of the lookup item.
10321
10322 This example looks up the postmaster alias in the conventional alias file:
10323 .code
10324 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10325 .endd
10326 This example uses NIS+ to look up the full name of the user corresponding to
10327 the local part of an address, forcing the expansion to fail if it is not found:
10328 .code
10329 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10330   {$value}fail}
10331 .endd
10332
10333
10334 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10335 .cindex "expansion" "list creation"
10336 .vindex "&$item$&"
10337 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10338 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10339 For each item
10340 in this list, its value is place in &$item$&, and then <&'string2'&> is
10341 expanded and added to the output as an item in a new list. The separator used
10342 for the output list is the same as the one used for the input, but a separator
10343 setting is not included in the output. For example:
10344 .code
10345 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10346 .endd
10347 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10348 value of &$item$& is restored to what it was before. See also the &%filter%&
10349 and &%reduce%& expansion items.
10350
10351 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10352 .cindex "expansion" "numeric hash"
10353 .cindex "hash function" "numeric"
10354 The three strings are expanded; the first two must yield numbers. Call them
10355 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10356 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10357 can use the simpler operator notation that avoids some of the braces:
10358 .code
10359 ${nhash_<n>_<m>:<string>}
10360 .endd
10361 The second number is optional (in both notations). If there is only one number,
10362 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10363 processed by a div/mod hash function that returns two numbers, separated by a
10364 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10365 example,
10366 .code
10367 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10368 .endd
10369 returns the string &"6/33"&.
10370
10371
10372
10373 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10374 .cindex "Perl" "use in expanded string"
10375 .cindex "expansion" "calling Perl from"
10376 This item is available only if Exim has been built to include an embedded Perl
10377 interpreter. The subroutine name and the arguments are first separately
10378 expanded, and then the Perl subroutine is called with those arguments. No
10379 additional arguments need be given; the maximum number permitted, including the
10380 name of the subroutine, is nine.
10381
10382 The return value of the subroutine is inserted into the expanded string, unless
10383 the return value is &%undef%&. In that case, the entire expansion is
10384 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10385 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10386 in a scalar context, thus the return value is a scalar.  For example, if you
10387 return a Perl vector, the return value is the size of the vector,
10388 not its contents.
10389
10390 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10391 with the error message that was passed to &%die%&. More details of the embedded
10392 Perl facility are given in chapter &<<CHAPperl>>&.
10393
10394 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10395 out the use of this expansion item in filter files.
10396
10397
10398 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10399 .cindex "&%prvs%& expansion item"
10400 The first argument is a complete email address and the second is secret
10401 keystring. The third argument, specifying a key number, is optional. If absent,
10402 it defaults to 0. The result of the expansion is a prvs-signed email address,
10403 to be typically used with the &%return_path%& option on an &(smtp)& transport
10404 as part of a bounce address tag validation (BATV) scheme. For more discussion
10405 and an example, see section &<<SECTverifyPRVS>>&.
10406
10407 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10408         {*&<&'string'&>&*}}*&"
10409 .cindex "&%prvscheck%& expansion item"
10410 This expansion item is the complement of the &%prvs%& item. It is used for
10411 checking prvs-signed addresses. If the expansion of the first argument does not
10412 yield a syntactically valid prvs-signed address, the whole item expands to the
10413 empty string. When the first argument does expand to a syntactically valid
10414 prvs-signed address, the second argument is expanded, with the prvs-decoded
10415 version of the address and the key number extracted from the address in the
10416 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10417
10418 These two variables can be used in the expansion of the second argument to
10419 retrieve the secret. The validity of the prvs-signed address is then checked
10420 against the secret. The result is stored in the variable &$prvscheck_result$&,
10421 which is empty for failure or &"1"& for success.
10422
10423 The third argument is optional; if it is missing, it defaults to an empty
10424 string. This argument is now expanded. If the result is an empty string, the
10425 result of the expansion is the decoded version of the address. This is the case
10426 whether or not the signature was valid. Otherwise, the result of the expansion
10427 is the expansion of the third argument.
10428
10429 All three variables can be used in the expansion of the third argument.
10430 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10431 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10432
10433 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10434 .cindex "expansion" "inserting an entire file"
10435 .cindex "file" "inserting into expansion"
10436 .cindex "&%readfile%& expansion item"
10437 The filename and end-of-line (eol) string are first expanded separately. The file is
10438 then read, and its contents replace the entire item. All newline characters in
10439 the file are replaced by the end-of-line string if it is present. Otherwise,
10440 newlines are left in the string.
10441 String expansion is not applied to the contents of the file. If you want this,
10442 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10443 the string expansion fails.
10444
10445 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10446 locks out the use of this expansion item in filter files.
10447
10448
10449
10450 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10451         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10452 .cindex "expansion" "inserting from a socket"
10453 .cindex "socket, use of in expansion"
10454 .cindex "&%readsocket%& expansion item"
10455 This item inserts data from a Unix domain or TCP socket into the expanded
10456 string. The minimal way of using it uses just two arguments, as in these
10457 examples:
10458 .code
10459 ${readsocket{/socket/name}{request string}}
10460 ${readsocket{inet:some.host:1234}{request string}}
10461 .endd
10462 For a Unix domain socket, the first substring must be the path to the socket.
10463 For an Internet socket, the first substring must contain &`inet:`& followed by
10464 a host name or IP address, followed by a colon and a port, which can be a
10465 number or the name of a TCP port in &_/etc/services_&. An IP address may
10466 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10467 example:
10468 .code
10469 ${readsocket{inet:[::1]:1234}{request string}}
10470 .endd
10471 Only a single host name may be given, but if looking it up yields more than
10472 one IP address, they are each tried in turn until a connection is made. For
10473 both kinds of socket, Exim makes a connection, writes the request string
10474 (unless it is an empty string; no terminating NUL is ever sent)
10475 and reads from the socket until an end-of-file
10476 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10477 extend what can be done. Firstly, you can vary the timeout. For example:
10478 .code
10479 ${readsocket{/socket/name}{request string}{3s}}
10480 .endd
10481
10482 The third argument is a list of options, of which the first element is the timeout
10483 and must be present if any options are given.
10484 Further elements are options of form &'name=value'&.
10485 Example:
10486 .code
10487 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10488 .endd
10489
10490 The following option names are recognised:
10491 .ilist
10492 &*cache*&
10493 Defines if the result data can be cached for use by a later identical
10494 request in the same process.
10495 Values are &"yes"& or &"no"& (the default).
10496 If not, all cached results for this connection specification
10497 will be invalidated.
10498
10499 .next
10500 &*shutdown*&
10501 Defines whether or not a write-shutdown is done on the connection after
10502 sending the request. Values are &"yes"& (the default) or &"no"&
10503 (preferred, eg. by some webservers).
10504
10505 .next
10506 &*sni*&
10507 Controls the use of Server Name Identification on the connection.
10508 Any nonempty value will be the SNI sent; TLS will be forced.
10509
10510 .next
10511 &*tls*&
10512 Controls the use of TLS on the connection.
10513 Values are &"yes"& or &"no"& (the default).
10514 If it is enabled, a shutdown as described above is never done.
10515 .endlist
10516
10517
10518 A fourth argument allows you to change any newlines that are in the data
10519 that is read, in the same way as for &%readfile%& (see above). This example
10520 turns them into spaces:
10521 .code
10522 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10523 .endd
10524 As with all expansions, the substrings are expanded before the processing
10525 happens. Errors in these sub-expansions cause the expansion to fail. In
10526 addition, the following errors can occur:
10527
10528 .ilist
10529 Failure to create a socket file descriptor;
10530 .next
10531 Failure to connect the socket;
10532 .next
10533 Failure to write the request string;
10534 .next
10535 Timeout on reading from the socket.
10536 .endlist
10537
10538 By default, any of these errors causes the expansion to fail. However, if
10539 you supply a fifth substring, it is expanded and used when any of the above
10540 errors occurs. For example:
10541 .code
10542 ${readsocket{/socket/name}{request string}{3s}{\n}\
10543   {socket failure}}
10544 .endd
10545 You can test for the existence of a Unix domain socket by wrapping this
10546 expansion in &`${if exists`&, but there is a race condition between that test
10547 and the actual opening of the socket, so it is safer to use the fifth argument
10548 if you want to be absolutely sure of avoiding an expansion error for a
10549 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10550
10551 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10552 locks out the use of this expansion item in filter files.
10553
10554
10555 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10556 .cindex "expansion" "reducing a list to a scalar"
10557 .cindex "list" "reducing to a scalar"
10558 .vindex "&$value$&"
10559 .vindex "&$item$&"
10560 This operation reduces a list to a single, scalar string. After expansion,
10561 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10562 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10563 Then <&'string2'&> is expanded and
10564 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10565 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10566 them. The result of that expansion is assigned to &$value$& before the next
10567 iteration. When the end of the list is reached, the final value of &$value$& is
10568 added to the expansion output. The &%reduce%& expansion item can be used in a
10569 number of ways. For example, to add up a list of numbers:
10570 .code
10571 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10572 .endd
10573 The result of that expansion would be &`6`&. The maximum of a list of numbers
10574 can be found:
10575 .code
10576 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10577 .endd
10578 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10579 restored to what they were before. See also the &%filter%& and &%map%&
10580 expansion items.
10581
10582 . A bit of a special-case logic error in writing an expansion;
10583 . probably not worth including in the mainline of documentation.
10584 . If only we had footnotes (the html output variant is the problem).
10585 .
10586 . .new
10587 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10588 . and that condition modifies &$value$&,
10589 . then the string expansions dependent on the condition cannot use
10590 . the &$value$& of the reduce iteration.
10591 . .wen
10592
10593 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10594 This item inserts &"raw"& header lines. It is described with the &%header%&
10595 expansion item in section &<<SECTexpansionitems>>& above.
10596
10597 .vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10598         {*&<&'string2'&>&*}}*&"
10599 .cindex "expansion" "running a command"
10600 .cindex "&%run%& expansion item"
10601 This item runs an external command, as a subprocess.
10602 One option is supported after the word &'run'&, comma-separated
10603 and without whitespace.
10604
10605 If the option &'preexpand'& is not used,
10606 the command string is split into individual arguments by spaces
10607 and then each argument is expanded.
10608 Then the command is run
10609 in a separate process, but under the same uid and gid.  As in other command
10610 executions from Exim, a shell is not used by default. If the command requires
10611 a shell, you must explicitly code it.
10612 The command name may not be tainted, but the remaining arguments can be.
10613
10614 &*Note*&: if tainted arguments are used, they are supplied by a
10615 potential attacker;
10616 a careful assessment for security vulnerabilities should be done.
10617
10618 If the option &'preexpand'& is used,
10619 the command and its arguments are first expanded as one string. The result is
10620 split apart into individual arguments by spaces, and then the command is run
10621 as above.
10622 Since the arguments are split by spaces, when there is a variable expansion
10623 which has an empty result, it will cause the situation that the argument will
10624 simply be omitted when the program is actually executed by Exim. If the
10625 script/program requires a specific number of arguments and the expanded
10626 variable could possibly result in this empty expansion, the variable must be
10627 quoted. This is more difficult if the expanded variable itself could result
10628 in a string containing quotes, because it would interfere with the quotes
10629 around the command arguments. A possible guard against this is to wrap the
10630 variable in the &%sg%& operator to change any quote marks to some other
10631 character.
10632 Neither the command nor any argument may be tainted.
10633
10634 The standard input for the command exists, but is empty. The standard output
10635 and standard error are set to the same file descriptor.
10636 .cindex "return code" "from &%run%& expansion"
10637 .vindex "&$value$&"
10638 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10639 and replaces the entire item; during this expansion, the standard output/error
10640 from the command is in the variable &$value$&. If the command fails,
10641 <&'string2'&>, if present, is expanded and used. Once again, during the
10642 expansion, the standard output/error from the command is in the variable
10643 &$value$&.
10644
10645 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10646 can be the word &"fail"& (not in braces) to force expansion failure if the
10647 command does not succeed. If both strings are omitted, the result is contents
10648 of the standard output/error on success, and nothing on failure.
10649
10650 .vindex "&$run_in_acl$&"
10651 The standard output/error of the command is put in the variable &$value$&.
10652 In this ACL example, the output of a command is logged for the admin to
10653 troubleshoot:
10654 .code
10655 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10656       log_message  = Output of id: $value
10657 .endd
10658 If the command requires shell idioms, such as the > redirect operator, the
10659 shell must be invoked directly, such as with:
10660 .code
10661 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10662 .endd
10663
10664 .vindex "&$runrc$&"
10665 The return code from the command is put in the variable &$runrc$&, and this
10666 remains set afterwards, so in a filter file you can do things like this:
10667 .code
10668 if "${run{x y z}{}}$runrc" is 1 then ...
10669   elif $runrc is 2 then ...
10670   ...
10671 endif
10672 .endd
10673 If execution of the command fails (for example, the command does not exist),
10674 the return code is 127 &-- the same code that shells use for non-existent
10675 commands.
10676
10677 &*Warning*&: In a router or transport, you cannot assume the order in which
10678 option values are expanded, except for those preconditions whose order of
10679 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10680 by the expansion of one option, and use it in another.
10681
10682 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10683 out the use of this expansion item in filter files.
10684
10685
10686 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10687 .cindex "expansion" "string substitution"
10688 .cindex "&%sg%& expansion item"
10689 This item works like Perl's substitution operator (s) with the global (/g)
10690 option; hence its name. However, unlike the Perl equivalent, Exim does not
10691 modify the subject string; instead it returns the modified string for insertion
10692 into the overall expansion. The item takes three arguments: the subject string,
10693 a regular expression, and a substitution string. For example:
10694 .code
10695 ${sg{abcdefabcdef}{abc}{xyz}}
10696 .endd
10697 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10698 if any $, } or \ characters are required in the regular expression or in the
10699 substitution string, they have to be escaped. For example:
10700 .code
10701 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10702 .endd
10703 yields &"defabc"&, and
10704 .code
10705 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10706 .endd
10707 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10708 the regular expression from string expansion.
10709
10710 The regular expression is compiled in 8-bit mode, working against bytes
10711 rather than any Unicode-aware character handling.
10712
10713
10714 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10715 .cindex sorting "a list"
10716 .cindex list sorting
10717 .cindex expansion "list sorting"
10718 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10719 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10720 The <&'comparator'&> argument is interpreted as the operator
10721 of a two-argument expansion condition.
10722 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10723 The comparison should return true when applied to two values
10724 if the first value should sort before the second value.
10725 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10726 the element being placed in &$item$&,
10727 to give values for comparison.
10728
10729 The item result is a sorted list,
10730 with the original list separator,
10731 of the list elements (in full) of the original.
10732
10733 Examples:
10734 .code
10735 ${sort{3:2:1:4}{<}{$item}}
10736 .endd
10737 sorts a list of numbers, and
10738 .code
10739 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10740 .endd
10741 will sort an MX lookup into priority order.
10742
10743
10744
10745 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10746 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10747
10748
10749
10750 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10751 .cindex "&%substr%& expansion item"
10752 .cindex "substring extraction"
10753 .cindex "expansion" "substring extraction"
10754 The three strings are expanded; the first two must yield numbers. Call them
10755 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10756 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10757 can use the simpler operator notation that avoids some of the braces:
10758 .code
10759 ${substr_<n>_<m>:<subject>}
10760 .endd
10761 The second number is optional (in both notations).
10762 If it is absent in the simpler format, the preceding underscore must also be
10763 omitted.
10764
10765 The &%substr%& item can be used to extract more general substrings than
10766 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10767 length required. For example
10768 .code
10769 ${substr{3}{2}{$local_part}}
10770 .endd
10771 If the starting offset is greater than the string length the result is the
10772 null string; if the length plus starting offset is greater than the string
10773 length, the result is the right-hand part of the string, starting from the
10774 given offset. The first byte (character) in the string has offset zero.
10775
10776 The &%substr%& expansion item can take negative offset values to count
10777 from the right-hand end of its operand. The last byte (character) is offset -1,
10778 the second-last is offset -2, and so on. Thus, for example,
10779 .code
10780 ${substr{-5}{2}{1234567}}
10781 .endd
10782 yields &"34"&. If the absolute value of a negative offset is greater than the
10783 length of the string, the substring starts at the beginning of the string, and
10784 the length is reduced by the amount of overshoot. Thus, for example,
10785 .code
10786 ${substr{-5}{2}{12}}
10787 .endd
10788 yields an empty string, but
10789 .code
10790 ${substr{-3}{2}{12}}
10791 .endd
10792 yields &"1"&.
10793
10794 When the second number is omitted from &%substr%&, the remainder of the string
10795 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10796 string preceding the offset point are taken. For example, an offset of -1 and
10797 no length, as in these semantically identical examples:
10798 .code
10799 ${substr_-1:abcde}
10800 ${substr{-1}{abcde}}
10801 .endd
10802 yields all but the last character of the string, that is, &"abcd"&.
10803
10804 All measurement is done in bytes and is not UTF-8 aware.
10805
10806
10807
10808 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10809         {*&<&'replacements'&>&*}}*&"
10810 .cindex "expansion" "character translation"
10811 .cindex "&%tr%& expansion item"
10812 This item does single-character (in bytes) translation on its subject string. The second
10813 argument is a list of characters to be translated in the subject string. Each
10814 matching character is replaced by the corresponding character from the
10815 replacement list. For example
10816 .code
10817 ${tr{abcdea}{ac}{13}}
10818 .endd
10819 yields &`1b3de1`&. If there are duplicates in the second character string, the
10820 last occurrence is used. If the third string is shorter than the second, its
10821 last character is replicated. However, if it is empty, no translation takes
10822 place.
10823
10824 All character handling is done in bytes and is not UTF-8 aware.
10825
10826 .endlist
10827
10828
10829
10830 .section "Expansion operators" "SECTexpop"
10831 .cindex "expansion" "operators"
10832 For expansion items that perform transformations on a single argument string,
10833 the &"operator"& notation is used because it is simpler and uses fewer braces.
10834 The substring is first expanded before the operation is applied to it. The
10835 following operations can be performed:
10836
10837 .vlist
10838 .vitem &*${address:*&<&'string'&>&*}*&
10839 .cindex "expansion" "RFC 2822 address handling"
10840 .cindex "&%address%& expansion item"
10841 The string is interpreted as an RFC 2822 address, as it might appear in a
10842 header line, and the effective address is extracted from it. If the string does
10843 not parse successfully, the result is empty.
10844
10845 The parsing correctly handles SMTPUTF8 Unicode in the string.
10846
10847
10848 .vitem &*${addresses:*&<&'string'&>&*}*&
10849 .cindex "expansion" "RFC 2822 address handling"
10850 .cindex "&%addresses%& expansion item"
10851 The string (after expansion) is interpreted as a list of addresses in RFC
10852 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10853 operative address (&'local-part@domain'&) is extracted from each item, and the
10854 result of the expansion is a colon-separated list, with appropriate
10855 doubling of colons should any happen to be present in the email addresses.
10856 Syntactically invalid RFC2822 address items are omitted from the output.
10857
10858 It is possible to specify a character other than colon for the output
10859 separator by starting the string with > followed by the new separator
10860 character. For example:
10861 .code
10862 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10863 .endd
10864 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10865 first, so if the expanded string starts with >, it may change the output
10866 separator unintentionally. This can be avoided by setting the output
10867 separator explicitly:
10868 .code
10869 ${addresses:>:$h_from:}
10870 .endd
10871
10872 Compare the &%address%& (singular)
10873 expansion item, which extracts the working address from a single RFC2822
10874 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10875 processing lists.
10876
10877 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10878 a strict interpretation of header line formatting.  Exim parses the bare,
10879 unquoted portion of an email address and if it finds a comma, treats it as an
10880 email address separator. For the example header line:
10881 .code
10882 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10883 .endd
10884 The first example below demonstrates that Q-encoded email addresses are parsed
10885 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10886 It does not see the comma because it's still encoded as "=2C".  The second
10887 example below is passed the contents of &`$header_from:`&, meaning it gets
10888 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10889 The third example shows that the presence of a comma is skipped when it is
10890 quoted.  The fourth example shows SMTPUTF8 handling.
10891 .code
10892 # exim -be '${addresses:From: \
10893 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10894 user@example.com
10895 # exim -be '${addresses:From: Last, First <user@example.com>}'
10896 Last:user@example.com
10897 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10898 user@example.com
10899 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10900 フィリップ@example.jp
10901 .endd
10902
10903 .vitem &*${base32:*&<&'digits'&>&*}*&
10904 .cindex "&%base32%& expansion item"
10905 .cindex "expansion" "conversion to base 32"
10906 The string must consist entirely of decimal digits. The number is converted to
10907 base 32 and output as a (empty, for zero) string of characters.
10908 Only lowercase letters are used.
10909
10910 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10911 .cindex "&%base32d%& expansion item"
10912 .cindex "expansion" "conversion to base 32"
10913 The string must consist entirely of base-32 digits.
10914 The number is converted to decimal and output as a string.
10915
10916 .vitem &*${base62:*&<&'digits'&>&*}*&
10917 .cindex "&%base62%& expansion item"
10918 .cindex "expansion" "conversion to base 62"
10919 The string must consist entirely of decimal digits. The number is converted to
10920 base 62 and output as a string of six characters, including leading zeros. In
10921 the few operating environments where Exim uses base 36 instead of base 62 for
10922 its message identifiers (because those systems do not have case-sensitive
10923 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10924 to be absolutely clear: this is &'not'& base64 encoding.
10925
10926 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10927 .cindex "&%base62d%& expansion item"
10928 .cindex "expansion" "conversion to base 62"
10929 The string must consist entirely of base-62 digits, or, in operating
10930 environments where Exim uses base 36 instead of base 62 for its message
10931 identifiers, base-36 digits. The number is converted to decimal and output as a
10932 string.
10933
10934 .vitem &*${base64:*&<&'string'&>&*}*&
10935 .cindex "expansion" "base64 encoding"
10936 .cindex "base64 encoding" "in string expansion"
10937 .cindex "&%base64%& expansion item"
10938 .cindex certificate "base64 of DER"
10939 This operator converts a string into one that is base64 encoded.
10940
10941 If the string is a single variable of type certificate,
10942 returns the base64 encoding of the DER form of the certificate.
10943
10944
10945 .vitem &*${base64d:*&<&'string'&>&*}*&
10946 .cindex "expansion" "base64 decoding"
10947 .cindex "base64 decoding" "in string expansion"
10948 .cindex "&%base64d%& expansion item"
10949 This operator converts a base64-encoded string into the un-coded form.
10950
10951
10952 .vitem &*${domain:*&<&'string'&>&*}*&
10953 .cindex "domain" "extraction"
10954 .cindex "expansion" "domain extraction"
10955 The string is interpreted as an RFC 2822 address and the domain is extracted
10956 from it. If the string does not parse successfully, the result is empty.
10957
10958
10959 .vitem &*${escape:*&<&'string'&>&*}*&
10960 .cindex "expansion" "escaping non-printing characters"
10961 .cindex "&%escape%& expansion item"
10962 If the string contains any non-printing characters, they are converted to
10963 escape sequences starting with a backslash. Whether characters with the most
10964 significant bit set (so-called &"8-bit characters"&) count as printing or not
10965 is controlled by the &%print_topbitchars%& option.
10966
10967 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10968 .cindex "expansion" "escaping 8-bit characters"
10969 .cindex "&%escape8bit%& expansion item"
10970 If the string contains any characters with the most significant bit set,
10971 they are converted to escape sequences starting with a backslash.
10972 Backslashes and DEL characters are also converted.
10973
10974
10975 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10976 .cindex "expansion" "expression evaluation"
10977 .cindex "expansion" "arithmetic expression"
10978 .cindex "&%eval%& expansion item"
10979 These items supports simple arithmetic and bitwise logical operations in
10980 expansion strings. The string (after expansion) must be a conventional
10981 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10982 logical operators, and parentheses. All operations are carried out using
10983 integer arithmetic. The operator priorities are as follows (the same as in the
10984 C programming language):
10985 .table2 70pt 300pt
10986 .irow &'highest:'& "not (~), negate (-)"
10987 .irow ""   "multiply (*), divide (/), remainder (%)"
10988 .irow ""   "plus (+), minus (-)"
10989 .irow ""   "shift-left (<<), shift-right (>>)"
10990 .irow ""   "and (&&)"
10991 .irow ""   "xor (^)"
10992 .irow &'lowest:'&  "or (|)"
10993 .endtable
10994 Binary operators with the same priority are evaluated from left to right. White
10995 space is permitted before or after operators.
10996
10997 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10998 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10999 decimal, even if they start with a leading zero; hexadecimal numbers are not
11000 permitted. This can be useful when processing numbers extracted from dates or
11001 times, which often do have leading zeros.
11002
11003 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11004 or 1024*1024*1024,
11005 respectively. Negative numbers are supported. The result of the computation is
11006 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11007
11008 .display
11009 &`${eval:1+1}            `&  yields 2
11010 &`${eval:1+2*3}          `&  yields 7
11011 &`${eval:(1+2)*3}        `&  yields 9
11012 &`${eval:2+42%5}         `&  yields 4
11013 &`${eval:0xc&amp;5}          `&  yields 4
11014 &`${eval:0xc|5}          `&  yields 13
11015 &`${eval:0xc^5}          `&  yields 9
11016 &`${eval:0xc>>1}         `&  yields 6
11017 &`${eval:0xc<<1}         `&  yields 24
11018 &`${eval:~255&amp;0x1234}    `&  yields 4608
11019 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11020 .endd
11021
11022 As a more realistic example, in an ACL you might have
11023 .code
11024 deny   condition =                    \
11025          ${if and {                   \
11026            {>{$rcpt_count}{10}}       \
11027            {                          \
11028            <                          \
11029              {$recipients_count}      \
11030              {${eval:$rcpt_count/2}}  \
11031            }                          \
11032          }{yes}{no}}
11033        message = Too many bad recipients
11034 .endd
11035 The condition is true if there have been more than 10 RCPT commands and
11036 fewer than half of them have resulted in a valid recipient.
11037
11038
11039 .vitem &*${expand:*&<&'string'&>&*}*&
11040 .cindex "expansion" "re-expansion of substring"
11041 The &%expand%& operator causes a string to be expanded for a second time. For
11042 example,
11043 .code
11044 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11045 .endd
11046 first looks up a string in a file while expanding the operand for &%expand%&,
11047 and then re-expands what it has found.
11048
11049
11050 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11051 .cindex "Unicode"
11052 .cindex "UTF-8" "conversion from"
11053 .cindex "expansion" "UTF-8 conversion"
11054 .cindex "&%from_utf8%& expansion item"
11055 The world is slowly moving towards Unicode, although there are no standards for
11056 email yet. However, other applications (including some databases) are starting
11057 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11058 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11059 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11060 the result is an undefined sequence of bytes.
11061
11062 Unicode code points with values less than 256 are compatible with ASCII and
11063 ISO-8859-1 (also known as Latin-1).
11064 For example, character 169 is the copyright symbol in both cases, though the
11065 way it is encoded is different. In UTF-8, more than one byte is needed for
11066 characters with code values greater than 127, whereas ISO-8859-1 is a
11067 single-byte encoding (but thereby limited to 256 characters). This makes
11068 translation from UTF-8 to ISO-8859-1 straightforward.
11069
11070
11071 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11072 .cindex "hash function" "textual"
11073 .cindex "expansion" "textual hash"
11074 The &%hash%& operator is a simpler interface to the hashing function that can
11075 be used when the two parameters are fixed numbers (as opposed to strings that
11076 change when expanded). The effect is the same as
11077 .code
11078 ${hash{<n>}{<m>}{<string>}}
11079 .endd
11080 See the description of the general &%hash%& item above for details. The
11081 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11082
11083
11084
11085 .new
11086 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11087 .cindex header "wrapping operator"
11088 .cindex expansion "header wrapping"
11089 This operator line-wraps its argument in a way useful for headers.
11090 The &'cols'& value gives the column number to wrap after,
11091 the &'limit'& gives a limit number of result characters to truncate at.
11092 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11093 the defaults are 80 and 998.
11094 Wrapping will be inserted at a space if possible before the
11095 column number is reached.
11096 Whitespace at a chosen wrap point is removed.
11097 A line-wrap consists of a newline followed by a tab,
11098 and the tab is counted as 8 columns.
11099 .wen
11100
11101
11102
11103 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11104 .cindex "base64 encoding" "conversion from hex"
11105 .cindex "expansion" "hex to base64"
11106 .cindex "&%hex2b64%& expansion item"
11107 This operator converts a hex string into one that is base64 encoded. This can
11108 be useful for processing the output of the various hashing functions.
11109
11110
11111
11112 .vitem &*${hexquote:*&<&'string'&>&*}*&
11113 .cindex "quoting" "hex-encoded unprintable characters"
11114 .cindex "&%hexquote%& expansion item"
11115 This operator converts non-printable characters in a string into a hex
11116 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11117 as is, and other byte values are converted to &`\xNN`&, for example, a
11118 byte value 127 is converted to &`\x7f`&.
11119
11120
11121 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11122 .cindex "&%ipv6denorm%& expansion item"
11123 .cindex "IP address" normalisation
11124 This expands an IPv6 address to a full eight-element colon-separated set
11125 of hex digits including leading zeroes.
11126 A trailing ipv4-style dotted-decimal set is converted to hex.
11127 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11128
11129 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11130 .cindex "&%ipv6norm%& expansion item"
11131 .cindex "IP address" normalisation
11132 .cindex "IP address" "canonical form"
11133 This converts an IPv6 address to canonical form.
11134 Leading zeroes of groups are omitted, and the longest
11135 set of zero-valued groups is replaced with a double colon.
11136 A trailing ipv4-style dotted-decimal set is converted to hex.
11137 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11138
11139
11140 .vitem &*${lc:*&<&'string'&>&*}*&
11141 .cindex "case forcing in strings"
11142 .cindex "string" "case forcing"
11143 .cindex "lower casing"
11144 .cindex "expansion" "case forcing"
11145 .cindex "&%lc%& expansion item"
11146 This forces the letters in the string into lower-case, for example:
11147 .code
11148 ${lc:$local_part}
11149 .endd
11150 Case is defined per the system C locale.
11151
11152 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11153 .cindex "expansion" "string truncation"
11154 .cindex "&%length%& expansion item"
11155 The &%length%& operator is a simpler interface to the &%length%& function that
11156 can be used when the parameter is a fixed number (as opposed to a string that
11157 changes when expanded). The effect is the same as
11158 .code
11159 ${length{<number>}{<string>}}
11160 .endd
11161 See the description of the general &%length%& item above for details. Note that
11162 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11163 when &%length%& is used as an operator.
11164 All measurement is done in bytes and is not UTF-8 aware.
11165
11166
11167 .vitem &*${listcount:*&<&'string'&>&*}*&
11168 .cindex "expansion" "list item count"
11169 .cindex "list" "item count"
11170 .cindex "list" "count of items"
11171 .cindex "&%listcount%& expansion item"
11172 The string is interpreted as a list and the number of items is returned.
11173
11174
11175 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11176 .cindex "expansion" "named list"
11177 .cindex "&%listnamed%& expansion item"
11178 The name is interpreted as a named list and the content of the list is returned,
11179 expanding any referenced lists, re-quoting as needed for colon-separation.
11180 If the optional type is given it must be one of "a", "d", "h" or "l"
11181 and selects address-, domain-, host- or localpart- lists to search among respectively.
11182 Otherwise all types are searched in an undefined order and the first
11183 matching list is returned.
11184 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11185 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11186
11187
11188 .vitem &*${local_part:*&<&'string'&>&*}*&
11189 .cindex "expansion" "local part extraction"
11190 .cindex "&%local_part%& expansion item"
11191 The string is interpreted as an RFC 2822 address and the local part is
11192 extracted from it. If the string does not parse successfully, the result is
11193 empty.
11194 The parsing correctly handles SMTPUTF8 Unicode in the string.
11195
11196
11197 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11198        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11199 .cindex "masked IP address"
11200 .cindex "IP address" "masking"
11201 .cindex "CIDR notation"
11202 .cindex "expansion" "IP address masking"
11203 .cindex "&%mask%& expansion item"
11204 If the form of the string to be operated on is not an IP address followed by a
11205 slash and an integer (that is, a network address in CIDR notation), the
11206 expansion fails. Otherwise, this operator converts the IP address to binary,
11207 masks off the least significant bits according to the bit count, and converts
11208 the result back to text, with mask appended. For example,
11209 .code
11210 ${mask:10.111.131.206/28}
11211 .endd
11212 returns the string &"10.111.131.192/28"&.
11213
11214 Since this operation is expected to
11215 be mostly used for looking up masked addresses in files, the
11216 normal
11217 result for an IPv6
11218 address uses dots to separate components instead of colons, because colon
11219 terminates a key string in lsearch files. So, for example,
11220 .code
11221 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11222 .endd
11223 returns the string
11224 .code
11225 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11226 .endd
11227 If the optional form &*mask_n*& is used, IPv6 address result are instead
11228 returned in normailsed form, using colons and with zero-compression.
11229 Letters in IPv6 addresses are always output in lower case.
11230
11231
11232 .vitem &*${md5:*&<&'string'&>&*}*&
11233 .cindex "MD5 hash"
11234 .cindex "expansion" "MD5 hash"
11235 .cindex certificate fingerprint
11236 .cindex "&%md5%& expansion item"
11237 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11238 as a 32-digit hexadecimal number, in which any letters are in lower case.
11239
11240 If the string is a single variable of type certificate,
11241 returns the MD5 hash fingerprint of the certificate.
11242
11243
11244 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11245 .cindex "expansion" "numeric hash"
11246 .cindex "hash function" "numeric"
11247 The &%nhash%& operator is a simpler interface to the numeric hashing function
11248 that can be used when the two parameters are fixed numbers (as opposed to
11249 strings that change when expanded). The effect is the same as
11250 .code
11251 ${nhash{<n>}{<m>}{<string>}}
11252 .endd
11253 See the description of the general &%nhash%& item above for details.
11254
11255
11256 .vitem &*${quote:*&<&'string'&>&*}*&
11257 .cindex "quoting" "in string expansions"
11258 .cindex "expansion" "quoting"
11259 .cindex "&%quote%& expansion item"
11260 The &%quote%& operator puts its argument into double quotes if it
11261 is an empty string or
11262 contains anything other than letters, digits, underscores, dots, and hyphens.
11263 Any occurrences of double quotes and backslashes are escaped with a backslash.
11264 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11265 respectively For example,
11266 .code
11267 ${quote:ab"*"cd}
11268 .endd
11269 becomes
11270 .code
11271 "ab\"*\"cd"
11272 .endd
11273 The place where this is useful is when the argument is a substitution from a
11274 variable or a message header.
11275
11276 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11277 .cindex "&%quote_local_part%& expansion item"
11278 This operator is like &%quote%&, except that it quotes the string only if
11279 required to do so by the rules of RFC 2822 for quoting local parts. For
11280 example, a plus sign would not cause quoting (but it would for &%quote%&).
11281 If you are creating a new email address from the contents of &$local_part$&
11282 (or any other unknown data), you should always use this operator.
11283
11284 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11285 will likely use the quoting form.
11286 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11287
11288
11289 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11290 .cindex "quoting" "lookup-specific"
11291 This operator applies lookup-specific quoting rules to the string. Each
11292 query-style lookup type has its own quoting rules which are described with
11293 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11294 .code
11295 ${quote_ldap:two * two}
11296 .endd
11297 returns
11298 .code
11299 two%20%5C2A%20two
11300 .endd
11301 For single-key lookup types, no quoting is ever necessary and this operator
11302 yields an unchanged string.
11303
11304
11305 .vitem &*${randint:*&<&'n'&>&*}*&
11306 .cindex "random number"
11307 This operator returns a somewhat random number which is less than the
11308 supplied number and is at least 0.  The quality of this randomness depends
11309 on how Exim was built; the values are not suitable for keying material.
11310 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11311 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11312 for versions of GnuTLS with that function.
11313 Otherwise, the implementation may be arc4random(), random() seeded by
11314 srandomdev() or srandom(), or a custom implementation even weaker than
11315 random().
11316
11317
11318 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11319 .cindex "expansion" "IP address"
11320 This operator reverses an IP address; for IPv4 addresses, the result is in
11321 dotted-quad decimal form, while for IPv6 addresses the result is in
11322 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11323 for DNS.  For example,
11324 .code
11325 ${reverse_ip:192.0.2.4}
11326 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11327 .endd
11328 returns
11329 .code
11330 4.2.0.192
11331 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
11332 .endd
11333
11334
11335 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11336 .cindex "expansion" "RFC 2047"
11337 .cindex "RFC 2047" "expansion operator"
11338 .cindex "&%rfc2047%& expansion item"
11339 This operator encodes text according to the rules of RFC 2047. This is an
11340 encoding that is used in header lines to encode non-ASCII characters. It is
11341 assumed that the input string is in the encoding specified by the
11342 &%headers_charset%& option, which gets its default at build time. If the string
11343 contains only characters in the range 33&--126, and no instances of the
11344 characters
11345 .code
11346 ? = ( ) < > @ , ; : \ " . [ ] _
11347 .endd
11348 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11349 string, using as many &"encoded words"& as necessary to encode all the
11350 characters.
11351
11352
11353 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11354 .cindex "expansion" "RFC 2047"
11355 .cindex "RFC 2047" "decoding"
11356 .cindex "&%rfc2047d%& expansion item"
11357 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11358 bytes are replaced by question marks. Characters are converted into the
11359 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11360 not recognized unless &%check_rfc2047_length%& is set false.
11361
11362 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11363 access a header line, RFC 2047 decoding is done automatically. You do not need
11364 to use this operator as well.
11365
11366
11367
11368 .vitem &*${rxquote:*&<&'string'&>&*}*&
11369 .cindex "quoting" "in regular expressions"
11370 .cindex "regular expressions" "quoting"
11371 .cindex "&%rxquote%& expansion item"
11372 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11373 characters in its argument. This is useful when substituting the values of
11374 variables or headers inside regular expressions.
11375
11376
11377 .vitem &*${sha1:*&<&'string'&>&*}*&
11378 .cindex "SHA-1 hash"
11379 .cindex "expansion" "SHA-1 hashing"
11380 .cindex certificate fingerprint
11381 .cindex "&%sha1%& expansion item"
11382 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11383 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11384
11385 If the string is a single variable of type certificate,
11386 returns the SHA-1 hash fingerprint of the certificate.
11387
11388
11389 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11390        &*${sha2:*&<&'string'&>&*}*& &&&
11391        &*${sha2_<n>:*&<&'string'&>&*}*&
11392 .cindex "SHA-256 hash"
11393 .cindex "SHA-2 hash"
11394 .cindex certificate fingerprint
11395 .cindex "expansion" "SHA-256 hashing"
11396 .cindex "&%sha256%& expansion item"
11397 .cindex "&%sha2%& expansion item"
11398 The &%sha256%& operator computes the SHA-256 hash value of the string
11399 and returns
11400 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11401
11402 If the string is a single variable of type certificate,
11403 returns the SHA-256 hash fingerprint of the certificate.
11404
11405 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11406 (except for certificates, which are not supported).
11407 Finally, if an underbar
11408 and a number is appended it specifies the output length, selecting a
11409 member of the SHA-2 family of hash functions.
11410 Values of 256, 384 and 512 are accepted, with 256 being the default.
11411
11412
11413 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11414        &*${sha3_<n>:*&<&'string'&>&*}*&
11415 .cindex "SHA3 hash"
11416 .cindex "expansion" "SHA3 hashing"
11417 .cindex "&%sha3%& expansion item"
11418 The &%sha3%& operator computes the SHA3-256 hash value of the string
11419 and returns
11420 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11421
11422 If a number is appended, separated by an underbar, it specifies
11423 the output length.  Values of 224, 256, 384 and 512 are accepted;
11424 with 256 being the default.
11425
11426 The &%sha3%& expansion item is only supported if Exim has been
11427 compiled with GnuTLS 3.5.0 or later,
11428 or OpenSSL 1.1.1 or later.
11429 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11430
11431
11432 .vitem &*${stat:*&<&'string'&>&*}*&
11433 .cindex "expansion" "statting a file"
11434 .cindex "file" "extracting characteristics"
11435 .cindex "&%stat%& expansion item"
11436 The string, after expansion, must be a file path. A call to the &[stat()]&
11437 function is made for this path. If &[stat()]& fails, an error occurs and the
11438 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11439 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11440 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11441 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11442 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11443 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11444 can extract individual fields using the &%extract%& expansion item.
11445
11446 The use of the &%stat%& expansion in users' filter files can be locked out by
11447 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11448 systems for files larger than 2GB.
11449
11450 .vitem &*${str2b64:*&<&'string'&>&*}*&
11451 .cindex "&%str2b64%& expansion item"
11452 Now deprecated, a synonym for the &%base64%& expansion operator.
11453
11454
11455
11456 .vitem &*${strlen:*&<&'string'&>&*}*&
11457 .cindex "expansion" "string length"
11458 .cindex "string" "length in expansion"
11459 .cindex "&%strlen%& expansion item"
11460 The item is replaced by the length of the expanded string, expressed as a
11461 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11462 All measurement is done in bytes and is not UTF-8 aware.
11463
11464
11465 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11466 .cindex "&%substr%& expansion item"
11467 .cindex "substring extraction"
11468 .cindex "expansion" "substring expansion"
11469 The &%substr%& operator is a simpler interface to the &%substr%& function that
11470 can be used when the two parameters are fixed numbers (as opposed to strings
11471 that change when expanded). The effect is the same as
11472 .code
11473 ${substr{<start>}{<length>}{<string>}}
11474 .endd
11475 See the description of the general &%substr%& item above for details. The
11476 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11477 All measurement is done in bytes and is not UTF-8 aware.
11478
11479 .vitem &*${time_eval:*&<&'string'&>&*}*&
11480 .cindex "&%time_eval%& expansion item"
11481 .cindex "time interval" "decoding"
11482 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11483 seconds.
11484
11485 .vitem &*${time_interval:*&<&'string'&>&*}*&
11486 .cindex "&%time_interval%& expansion item"
11487 .cindex "time interval" "formatting"
11488 The argument (after sub-expansion) must be a sequence of decimal digits that
11489 represents an interval of time as a number of seconds. It is converted into a
11490 number of larger units and output in Exim's normal time format, for example,
11491 &`1w3d4h2m6s`&.
11492
11493 .vitem &*${uc:*&<&'string'&>&*}*&
11494 .cindex "case forcing in strings"
11495 .cindex "string" "case forcing"
11496 .cindex "upper casing"
11497 .cindex "expansion" "case forcing"
11498 .cindex "&%uc%& expansion item"
11499 This forces the letters in the string into upper-case.
11500 Case is defined per the system C locale.
11501
11502 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11503 .cindex "correction of invalid utf-8 sequences in strings"
11504 .cindex "utf-8" "utf-8 sequences"
11505 .cindex "incorrect utf-8"
11506 .cindex "expansion" "utf-8 forcing"
11507 .cindex "&%utf8clean%& expansion item"
11508 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11509 In versions of Exim before 4.92, this did not correctly do so for a truncated
11510 final codepoint's encoding, and the character would be silently dropped.
11511 If you must handle detection of this scenario across both sets of Exim behavior,
11512 the complexity will depend upon the task.
11513 For instance, to detect if the first character is multibyte and a 1-byte
11514 extraction can be successfully used as a path component (as is common for
11515 dividing up delivery folders), you might use:
11516 .code
11517 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11518 .endd
11519 (which will false-positive if the first character of the local part is a
11520 literal question mark).
11521
11522 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11523        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11524        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11525        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11526 .cindex expansion UTF-8
11527 .cindex UTF-8 expansion
11528 .cindex EAI
11529 .cindex internationalisation
11530 .cindex "&%utf8_domain_to_alabel%& expansion item"
11531 .cindex "&%utf8_domain_from_alabel%& expansion item"
11532 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11533 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11534 These convert EAI mail name components between UTF-8 and a-label forms.
11535 For information on internationalisation support see &<<SECTi18nMTA>>&.
11536 .endlist
11537
11538
11539
11540
11541
11542
11543 .section "Expansion conditions" "SECTexpcond"
11544 .scindex IIDexpcond "expansion" "conditions"
11545 The following conditions are available for testing by the &%${if%& construct
11546 while expanding strings:
11547
11548 .vlist
11549 .vitem &*!*&<&'condition'&>
11550 .cindex "expansion" "negating a condition"
11551 .cindex "negation" "in expansion condition"
11552 Preceding any condition with an exclamation mark negates the result of the
11553 condition.
11554
11555 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11556 .cindex "numeric comparison"
11557 .cindex "expansion" "numeric comparison"
11558 There are a number of symbolic operators for doing numeric comparisons. They
11559 are:
11560 .itable none 0 0 2 10* left 90* left
11561 .irow "=   " "equal"
11562 .irow "==  " "equal"
11563 .irow ">   " "greater"
11564 .irow ">=  " "greater or equal"
11565 .irow "<   " "less"
11566 .irow "<=  " "less or equal"
11567 .endtable
11568 For example:
11569 .code
11570 ${if >{$message_size}{10M} ...
11571 .endd
11572 Note that the general negation operator provides for inequality testing. The
11573 two strings must take the form of optionally signed decimal integers,
11574 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11575 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11576 As a special case, the numerical value of an empty string is taken as
11577 zero.
11578
11579 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11580 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11581 10M, not if 10M is larger than &$message_size$&.
11582
11583
11584 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11585         {*&<&'arg2'&>&*}...}*&
11586 .cindex "expansion" "calling an acl"
11587 .cindex "&%acl%&" "expansion condition"
11588 The name and zero to nine argument strings are first expanded separately.  The expanded
11589 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11590 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11591 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11592 and may use the variables; if another acl expansion is used the values
11593 are restored after it returns.  If the ACL sets
11594 a value using a "message =" modifier the variable $value becomes
11595 the result of the expansion, otherwise it is empty.
11596 If the ACL returns accept the condition is true; if deny, false.
11597 If the ACL returns defer the result is a forced-fail.
11598
11599 .vitem &*bool&~{*&<&'string'&>&*}*&
11600 .cindex "expansion" "boolean parsing"
11601 .cindex "&%bool%& expansion condition"
11602 This condition turns a string holding a true or false representation into
11603 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11604 (case-insensitively); also integer numbers map to true if non-zero,
11605 false if zero.
11606 An empty string is treated as false.
11607 Leading and trailing whitespace is ignored;
11608 thus a string consisting only of whitespace is false.
11609 All other string values will result in expansion failure.
11610
11611 When combined with ACL variables, this expansion condition will let you
11612 make decisions in one place and act on those decisions in another place.
11613 For example:
11614 .code
11615 ${if bool{$acl_m_privileged_sender} ...
11616 .endd
11617
11618
11619 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11620 .cindex "expansion" "boolean parsing"
11621 .cindex "&%bool_lax%& expansion condition"
11622 Like &%bool%&, this condition turns a string into a boolean state.  But
11623 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11624 loose definition that the Router &%condition%& option uses.  The empty string
11625 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11626 true.  Leading and trailing whitespace is ignored.
11627
11628 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11629
11630 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11631 .cindex "expansion" "encrypted comparison"
11632 .cindex "encrypted strings, comparing"
11633 .cindex "&%crypteq%& expansion condition"
11634 This condition is included in the Exim binary if it is built to support any
11635 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11636 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11637 included in the binary.
11638
11639 The &%crypteq%& condition has two arguments. The first is encrypted and
11640 compared against the second, which is already encrypted. The second string may
11641 be in the LDAP form for storing encrypted strings, which starts with the
11642 encryption type in curly brackets, followed by the data. If the second string
11643 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11644 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11645 Typically this will be a field from a password file. An example of an encrypted
11646 string in LDAP form is:
11647 .code
11648 {md5}CY9rzUYh03PK3k6DJie09g==
11649 .endd
11650 If such a string appears directly in an expansion, the curly brackets have to
11651 be quoted, because they are part of the expansion syntax. For example:
11652 .code
11653 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11654 .endd
11655 The following encryption types (whose names are matched case-independently) are
11656 supported:
11657
11658 .ilist
11659 .cindex "MD5 hash"
11660 .cindex "base64 encoding" "in encrypted password"
11661 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11662 printable characters to compare with the remainder of the second string. If the
11663 length of the comparison string is 24, Exim assumes that it is base64 encoded
11664 (as in the above example). If the length is 32, Exim assumes that it is a
11665 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11666 comparison fails.
11667
11668 .next
11669 .cindex "SHA-1 hash"
11670 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11671 printable characters to compare with the remainder of the second string. If the
11672 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11673 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11674 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11675
11676 .next
11677 .cindex "&[crypt()]&"
11678 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11679 only the first eight characters of the password. However, in modern operating
11680 systems this is no longer true, and in many cases the entire password is used,
11681 whatever its length.
11682
11683 .next
11684 .cindex "&[crypt16()]&"
11685 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11686 use up to 16 characters of the password in some operating systems. Again, in
11687 modern operating systems, more characters may be used.
11688 .endlist
11689 Exim has its own version of &[crypt16()]&, which is just a double call to
11690 &[crypt()]&. For operating systems that have their own version, setting
11691 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11692 operating system version instead of its own. This option is set by default in
11693 the OS-dependent &_Makefile_& for those operating systems that are known to
11694 support &[crypt16()]&.
11695
11696 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11697 it was not using the same algorithm as some operating systems' versions. It
11698 turns out that as well as &[crypt16()]& there is a function called
11699 &[bigcrypt()]& in some operating systems. This may or may not use the same
11700 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11701
11702 However, since there is now a move away from the traditional &[crypt()]&
11703 functions towards using SHA1 and other algorithms, tidying up this area of
11704 Exim is seen as very low priority.
11705
11706 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11707 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11708 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11709 default is &`{crypt}`&. Whatever the default, you can always use either
11710 function by specifying it explicitly in curly brackets.
11711
11712 .vitem &*def:*&<&'variable&~name'&>
11713 .cindex "expansion" "checking for empty variable"
11714 .cindex "&%def%& expansion condition"
11715 The &%def%& condition must be followed by the name of one of the expansion
11716 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11717 variable does not contain the empty string. For example:
11718 .code
11719 ${if def:sender_ident {from $sender_ident}}
11720 .endd
11721 Note that the variable name is given without a leading &%$%& character. If the
11722 variable does not exist, the expansion fails.
11723
11724 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11725         &~&*def:h_*&<&'header&~name'&>&*:*&"
11726 .cindex "expansion" "checking header line existence"
11727 This condition is true if a message is being processed and the named header
11728 exists in the message. For example,
11729 .code
11730 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11731 .endd
11732 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11733 the header name must be terminated by a colon if white space does not follow.
11734
11735 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11736        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11737 .cindex "string" "comparison"
11738 .cindex "expansion" "string comparison"
11739 .cindex "&%eq%& expansion condition"
11740 .cindex "&%eqi%& expansion condition"
11741 The two substrings are first expanded. The condition is true if the two
11742 resulting strings are identical. For &%eq%& the comparison includes the case of
11743 letters, whereas for &%eqi%& the comparison is case-independent, where
11744 case is defined per the system C locale.
11745
11746 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11747 .cindex "expansion" "file existence test"
11748 .cindex "file" "existence test"
11749 .cindex "&%exists%&, expansion condition"
11750 The substring is first expanded and then interpreted as an absolute path. The
11751 condition is true if the named file (or directory) exists. The existence test
11752 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11753 users' filter files may be locked out by the system administrator.
11754
11755 &*Note:*& Testing a path using this condition is not a sufficient way of
11756 de-tainting it.
11757 Consider using a dsearch lookup.
11758
11759 .vitem &*first_delivery*&
11760 .cindex "delivery" "first"
11761 .cindex "first delivery"
11762 .cindex "expansion" "first delivery test"
11763 .cindex "&%first_delivery%& expansion condition"
11764 .cindex retry condition
11765 This condition, which has no data, is true during a message's first delivery
11766 attempt. It is false during any subsequent delivery attempts.
11767
11768
11769 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11770        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11771 .cindex "list" "iterative conditions"
11772 .cindex "expansion" "&*forall*& condition"
11773 .cindex "expansion" "&*forany*& condition"
11774 .vindex "&$item$&"
11775 These conditions iterate over a list. The first argument is expanded to form
11776 the list. By default, the list separator is a colon, but it can be changed by
11777 the normal method (&<<SECTlistsepchange>>&).
11778 The second argument is interpreted as a condition that is to
11779 be applied to each item in the list in turn. During the interpretation of the
11780 condition, the current list item is placed in a variable called &$item$&.
11781 .ilist
11782 For &*forany*&, interpretation stops if the condition is true for any item, and
11783 the result of the whole condition is true. If the condition is false for all
11784 items in the list, the overall condition is false.
11785 .next
11786 For &*forall*&, interpretation stops if the condition is false for any item,
11787 and the result of the whole condition is false. If the condition is true for
11788 all items in the list, the overall condition is true.
11789 .endlist
11790 Note that negation of &*forany*& means that the condition must be false for all
11791 items for the overall condition to succeed, and negation of &*forall*& means
11792 that the condition must be false for at least one item. In this example, the
11793 list separator is changed to a comma:
11794 .code
11795 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11796 .endd
11797 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11798 being processed, to enable these expansion items to be nested.
11799
11800 To scan a named list, expand it with the &*listnamed*& operator.
11801
11802 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11803        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11804        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11805        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11806 .cindex JSON "iterative conditions"
11807 .cindex JSON expansions
11808 .cindex expansion "&*forall_json*& condition"
11809 .cindex expansion "&*forany_json*& condition"
11810 .cindex expansion "&*forall_jsons*& condition"
11811 .cindex expansion "&*forany_jsons*& condition"
11812 As for the above, except that the first argument must, after expansion,
11813 be a JSON array.
11814 The array separator is not changeable.
11815 For the &"jsons"& variants the elements are expected to be JSON strings
11816 and have their quotes removed before the evaluation of the condition.
11817
11818
11819
11820 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11821        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11822 .cindex "string" "comparison"
11823 .cindex "expansion" "string comparison"
11824 .cindex "&%ge%& expansion condition"
11825 .cindex "&%gei%& expansion condition"
11826 The two substrings are first expanded. The condition is true if the first
11827 string is lexically greater than or equal to the second string. For &%ge%& the
11828 comparison includes the case of letters, whereas for &%gei%& the comparison is
11829 case-independent.
11830 Case and collation order are defined per the system C locale.
11831
11832 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11833        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11834 .cindex "string" "comparison"
11835 .cindex "expansion" "string comparison"
11836 .cindex "&%gt%& expansion condition"
11837 .cindex "&%gti%& expansion condition"
11838 The two substrings are first expanded. The condition is true if the first
11839 string is lexically greater than the second string. For &%gt%& the comparison
11840 includes the case of letters, whereas for &%gti%& the comparison is
11841 case-independent.
11842 Case and collation order are defined per the system C locale.
11843
11844
11845 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11846 SRS decode.  See SECT &<<SECTSRS>>& for details.
11847
11848
11849 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11850        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11851 .cindex "string" "comparison"
11852 .cindex "list" "iterative conditions"
11853 Both strings are expanded; the second string is treated as a list of simple
11854 strings; if the first string is a member of the second, then the condition
11855 is true.
11856 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11857
11858 These are simpler to use versions of the more powerful &*forany*& condition.
11859 Examples, and the &*forany*& equivalents:
11860 .code
11861 ${if inlist{needle}{foo:needle:bar}}
11862   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11863 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11864   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11865 .endd
11866
11867 The variable &$value$& will be set for a successful match and can be
11868 used in the success clause of an &%if%& expansion item using the condition.
11869 .cindex "tainted data" "de-tainting"
11870 .cindex "de-tainting" "using an inlist expansion condition"
11871 It will have the same taint status as the list; expansions such as
11872 .code
11873 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11874 .endd
11875 can be used for de-tainting.
11876 Any previous &$value$& is restored after the if.
11877
11878
11879 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11880        &*isip4&~{*&<&'string'&>&*}*& &&&
11881        &*isip6&~{*&<&'string'&>&*}*&
11882 .cindex "IP address" "testing string format"
11883 .cindex "string" "testing for IP address"
11884 .cindex "&%isip%& expansion condition"
11885 .cindex "&%isip4%& expansion condition"
11886 .cindex "&%isip6%& expansion condition"
11887 The substring is first expanded, and then tested to see if it has the form of
11888 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11889 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11890
11891 For an IPv4 address, the test is for four dot-separated components, each of
11892 which consists of from one to three digits. For an IPv6 address, up to eight
11893 colon-separated components are permitted, each containing from one to four
11894 hexadecimal digits. There may be fewer than eight components if an empty
11895 component (adjacent colons) is present. Only one empty component is permitted.
11896
11897 &*Note*&: The checks used to be just on the form of the address; actual numerical
11898 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11899 check.
11900 This is no longer the case.
11901
11902 The main use of these tests is to distinguish between IP addresses and
11903 host names, or between IPv4 and IPv6 addresses. For example, you could use
11904 .code
11905 ${if isip4{$sender_host_address}...
11906 .endd
11907 to test which IP version an incoming SMTP connection is using.
11908
11909 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11910 .cindex "LDAP" "use for authentication"
11911 .cindex "expansion" "LDAP authentication test"
11912 .cindex "&%ldapauth%& expansion condition"
11913 This condition supports user authentication using LDAP. See section
11914 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11915 queries. For this use, the query must contain a user name and password. The
11916 query itself is not used, and can be empty. The condition is true if the
11917 password is not empty, and the user name and password are accepted by the LDAP
11918 server. An empty password is rejected without calling LDAP because LDAP binds
11919 with an empty password are considered anonymous regardless of the username, and
11920 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11921 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11922 this can be used.
11923
11924
11925 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11926        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11927 .cindex "string" "comparison"
11928 .cindex "expansion" "string comparison"
11929 .cindex "&%le%& expansion condition"
11930 .cindex "&%lei%& expansion condition"
11931 The two substrings are first expanded. The condition is true if the first
11932 string is lexically less than or equal to the second string. For &%le%& the
11933 comparison includes the case of letters, whereas for &%lei%& the comparison is
11934 case-independent.
11935 Case and collation order are defined per the system C locale.
11936
11937 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11938        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11939 .cindex "string" "comparison"
11940 .cindex "expansion" "string comparison"
11941 .cindex "&%lt%& expansion condition"
11942 .cindex "&%lti%& expansion condition"
11943 The two substrings are first expanded. The condition is true if the first
11944 string is lexically less than the second string. For &%lt%& the comparison
11945 includes the case of letters, whereas for &%lti%& the comparison is
11946 case-independent.
11947 Case and collation order are defined per the system C locale.
11948
11949
11950 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11951 .cindex "expansion" "regular expression comparison"
11952 .cindex "regular expressions" "match in expanded string"
11953 .cindex "&%match%& expansion condition"
11954 The two substrings are first expanded. The second is then treated as a regular
11955 expression and applied to the first. Because of the pre-expansion, if the
11956 regular expression contains dollar, or backslash characters, they must be
11957 escaped. Care must also be taken if the regular expression contains braces
11958 (curly brackets). A closing brace must be escaped so that it is not taken as a
11959 premature termination of <&'string2'&>. The easiest approach is to use the
11960 &`\N`& feature to disable expansion of the regular expression.
11961 For example,
11962 .code
11963 ${if match {$local_part}{\N^\d{3}\N} ...
11964 .endd
11965 If the whole expansion string is in double quotes, further escaping of
11966 backslashes is also required.
11967
11968 The condition is true if the regular expression match succeeds.
11969 The regular expression is not required to begin with a circumflex
11970 metacharacter, but if there is no circumflex, the expression is not anchored,
11971 and it may match anywhere in the subject, not just at the start. If you want
11972 the pattern to match at the end of the subject, you must include the &`$`&
11973 metacharacter at an appropriate point.
11974 All character handling is done in bytes and is not UTF-8 aware,
11975 but we might change this in a future Exim release.
11976
11977 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11978 At the start of an &%if%& expansion the values of the numeric variable
11979 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11980 succeeds causes them to be reset to the substrings of that condition and they
11981 will have these values during the expansion of the success string. At the end
11982 of the &%if%& expansion, the previous values are restored. After testing a
11983 combination of conditions using &%or%&, the subsequent values of the numeric
11984 variables are those of the condition that succeeded.
11985
11986 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11987 .cindex "&%match_address%& expansion condition"
11988 See &*match_local_part*&.
11989
11990 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11991 .cindex "&%match_domain%& expansion condition"
11992 See &*match_local_part*&.
11993
11994 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11995 .cindex "&%match_ip%& expansion condition"
11996 This condition matches an IP address to a list of IP address patterns. It must
11997 be followed by two argument strings. The first (after expansion) must be an IP
11998 address or an empty string. The second (not expanded) is a restricted host
11999 list that can match only an IP address, not a host name. For example:
12000 .code
12001 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12002 .endd
12003 The specific types of host list item that are permitted in the list are:
12004
12005 .ilist
12006 An IP address, optionally with a CIDR mask.
12007 .next
12008 A single asterisk, which matches any IP address.
12009 .next
12010 An empty item, which matches only if the IP address is empty. This could be
12011 useful for testing for a locally submitted message or one from specific hosts
12012 in a single test such as
12013 . ==== As this is a nested list, any displays it contains must be indented
12014 . ==== as otherwise they are too far to the left. This comment applies to
12015 . ==== the use of xmlto plus fop. There's no problem when formatting with
12016 . ==== sdop, with or without the extra indent.
12017 .code
12018   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12019 .endd
12020 where the first item in the list is the empty string.
12021 .next
12022 The item @[] matches any of the local host's interface addresses.
12023 .next
12024 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12025 even if &`net-`& is not specified. There is never any attempt to turn the IP
12026 address into a host name. The most common type of linear search for
12027 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12028 masks. For example:
12029 .code
12030   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12031 .endd
12032 It is of course possible to use other kinds of lookup, and in such a case, you
12033 do need to specify the &`net-`& prefix if you want to specify a specific
12034 address mask, for example:
12035 .code
12036   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12037 .endd
12038 However, unless you are combining a &%match_ip%& condition with others, it is
12039 just as easy to use the fact that a lookup is itself a condition, and write:
12040 .code
12041   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12042 .endd
12043 .endlist ilist
12044
12045 Note that <&'string2'&> is not itself subject to string expansion, unless
12046 Exim was built with the EXPAND_LISTMATCH_RHS option.
12047
12048 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12049
12050 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12051 .cindex "domain list" "in expansion condition"
12052 .cindex "address list" "in expansion condition"
12053 .cindex "local part" "list, in expansion condition"
12054 .cindex "&%match_local_part%& expansion condition"
12055 This condition, together with &%match_address%& and &%match_domain%&, make it
12056 possible to test domain, address, and local part lists within expansions. Each
12057 condition requires two arguments: an item and a list to match. A trivial
12058 example is:
12059 .code
12060 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12061 .endd
12062 In each case, the second argument may contain any of the allowable items for a
12063 list of the appropriate type. Also, because the second argument
12064 is a standard form of list, it is possible to refer to a named list.
12065 Thus, you can use conditions like this:
12066 .code
12067 ${if match_domain{$domain}{+local_domains}{...
12068 .endd
12069 .cindex "&`+caseful`&"
12070 For address lists, the matching starts off caselessly, but the &`+caseful`&
12071 item can be used, as in all address lists, to cause subsequent items to
12072 have their local parts matched casefully. Domains are always matched
12073 caselessly.
12074
12075 The variable &$value$& will be set for a successful match and can be
12076 used in the success clause of an &%if%& expansion item using the condition.
12077 .cindex "tainted data" "de-tainting"
12078 .cindex "de-tainting" "using a match_local_part expansion condition"
12079 It will have the same taint status as the list; expansions such as
12080 .code
12081 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12082 .endd
12083 can be used for de-tainting.
12084 Any previous &$value$& is restored after the if.
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 &*Note*&: Host lists are &'not'& supported in this way. This is because
12090 hosts have two identities: a name and an IP address, and it is not clear
12091 how to specify cleanly how such a test would work. However, IP addresses can be
12092 matched using &%match_ip%&.
12093
12094 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12095 .cindex "PAM authentication"
12096 .cindex "AUTH" "with PAM"
12097 .cindex "Solaris" "PAM support"
12098 .cindex "expansion" "PAM authentication test"
12099 .cindex "&%pam%& expansion condition"
12100 &'Pluggable Authentication Modules'&
12101 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12102 available in Solaris
12103 and in some GNU/Linux distributions.
12104 The Exim support, which is intended for use in conjunction with
12105 the SMTP AUTH command, is available only if Exim is compiled with
12106 .code
12107 SUPPORT_PAM=yes
12108 .endd
12109 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12110 in some releases of GNU/Linux &%-ldl%& is also needed.
12111
12112 The argument string is first expanded, and the result must be a
12113 colon-separated list of strings. Leading and trailing white space is ignored.
12114 The PAM module is initialized with the service name &"exim"& and the user name
12115 taken from the first item in the colon-separated data string (<&'string1'&>).
12116 The remaining items in the data string are passed over in response to requests
12117 from the authentication function. In the simple case there will only be one
12118 request, for a password, so the data consists of just two strings.
12119
12120 There can be problems if any of the strings are permitted to contain colon
12121 characters. In the usual way, these have to be doubled to avoid being taken as
12122 separators.
12123 The &%listquote%& expansion item can be used for this.
12124 For example, the configuration
12125 of a LOGIN authenticator might contain this setting:
12126 .code
12127 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12128 .endd
12129 In some operating systems, PAM authentication can be done only from a process
12130 running as root. Since Exim is running as the Exim user when receiving
12131 messages, this means that PAM cannot be used directly in those systems.
12132 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12133
12134
12135 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12136 .cindex "&'pwcheck'& daemon"
12137 .cindex "Cyrus"
12138 .cindex "expansion" "&'pwcheck'& authentication test"
12139 .cindex "&%pwcheck%& expansion condition"
12140 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12141 This is one way of making it possible for passwords to be checked by a process
12142 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12143 deprecated. Its replacement is &'saslauthd'& (see below).
12144
12145 The pwcheck support is not included in Exim by default. You need to specify
12146 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12147 building Exim. For example:
12148 .code
12149 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12150 .endd
12151 You do not need to install the full Cyrus software suite in order to use
12152 the pwcheck daemon. You can compile and install just the daemon alone
12153 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12154 access to the &_/var/pwcheck_& directory.
12155
12156 The &%pwcheck%& condition takes one argument, which must be the user name and
12157 password, separated by a colon. For example, in a LOGIN authenticator
12158 configuration, you might have this:
12159 .code
12160 server_condition = ${if pwcheck{$auth1:$auth2}}
12161 .endd
12162 Again, for a PLAIN authenticator configuration, this would be:
12163 .code
12164 server_condition = ${if pwcheck{$auth2:$auth3}}
12165 .endd
12166 .vitem &*queue_running*&
12167 .cindex "queue runner" "detecting when delivering from"
12168 .cindex "expansion" "queue runner test"
12169 .cindex "&%queue_running%& expansion condition"
12170 This condition, which has no data, is true during delivery attempts that are
12171 initiated by queue runner processes, and false otherwise.
12172
12173
12174 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12175 .cindex "Radius"
12176 .cindex "expansion" "Radius authentication"
12177 .cindex "&%radius%& expansion condition"
12178 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12179 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12180 the Radius client configuration file in order to build Exim with Radius
12181 support.
12182
12183 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12184 library, using the original API. If you are using release 0.4.0 or later of
12185 this library, you need to set
12186 .code
12187 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12188 .endd
12189 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12190 &%libradius%& library that comes with FreeBSD. To do this, set
12191 .code
12192 RADIUS_LIB_TYPE=RADLIB
12193 .endd
12194 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12195 You may also have to supply a suitable setting in EXTRALIBS so that the
12196 Radius library can be found when Exim is linked.
12197
12198 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12199 Radius client library, which calls the Radius server. The condition is true if
12200 the authentication is successful. For example:
12201 .code
12202 server_condition = ${if radius{<arguments>}}
12203 .endd
12204
12205
12206 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12207         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12208 .cindex "&'saslauthd'& daemon"
12209 .cindex "Cyrus"
12210 .cindex "expansion" "&'saslauthd'& authentication test"
12211 .cindex "&%saslauthd%& expansion condition"
12212 This condition supports user authentication using the Cyrus &'saslauthd'&
12213 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12214 Using this daemon is one way of making it possible for passwords to be checked
12215 by a process that is not running as root.
12216
12217 The saslauthd support is not included in Exim by default. You need to specify
12218 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12219 building Exim. For example:
12220 .code
12221 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12222 .endd
12223 You do not need to install the full Cyrus software suite in order to use
12224 the saslauthd daemon. You can compile and install just the daemon alone
12225 from the Cyrus SASL library.
12226
12227 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12228 two are mandatory. For example:
12229 .code
12230 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12231 .endd
12232 The service and the realm are optional (which is why the arguments are enclosed
12233 in their own set of braces). For details of the meaning of the service and
12234 realm, and how to run the daemon, consult the Cyrus documentation.
12235 .endlist vlist
12236
12237
12238
12239 .section "Combining expansion conditions" "SECID84"
12240 .cindex "expansion" "combining conditions"
12241 Several conditions can be tested at once by combining them using the &%and%&
12242 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12243 conditions on their own, and precede their lists of sub-conditions. Each
12244 sub-condition must be enclosed in braces within the overall braces that contain
12245 the list. No repetition of &%if%& is used.
12246
12247
12248 .vlist
12249 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12250 .cindex "&""or""& expansion condition"
12251 .cindex "expansion" "&""or""& of conditions"
12252 The sub-conditions are evaluated from left to right. The condition is true if
12253 any one of the sub-conditions is true.
12254 For example,
12255 .code
12256 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12257 .endd
12258 When a true sub-condition is found, the following ones are parsed but not
12259 evaluated. If there are several &"match"& sub-conditions the values of the
12260 numeric variables afterwards are taken from the first one that succeeds.
12261
12262 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12263 .cindex "&""and""& expansion condition"
12264 .cindex "expansion" "&""and""& of conditions"
12265 The sub-conditions are evaluated from left to right. The condition is true if
12266 all of the sub-conditions are true. If there are several &"match"&
12267 sub-conditions, the values of the numeric variables afterwards are taken from
12268 the last one. When a false sub-condition is found, the following ones are
12269 parsed but not evaluated.
12270 .endlist
12271 .ecindex IIDexpcond
12272
12273
12274
12275
12276 .section "Expansion variables" "SECTexpvar"
12277 .cindex "expansion" "variables, list of"
12278 This section contains an alphabetical list of all the expansion variables. Some
12279 of them are available only when Exim is compiled with specific options such as
12280 support for TLS or the content scanning extension.
12281 .cindex "tainted data"
12282 Variables marked as &'tainted'& are likely to carry data supplied by
12283 a potential attacker.
12284 Variables without such marking may also, depending on how their
12285 values are created.
12286 Such variables should not be further expanded,
12287 used as filenames
12288 or used as command-line arguments for external commands.
12289
12290 .vlist
12291 .vitem "&$0$&, &$1$&, etc"
12292 .cindex "numerical variables (&$1$& &$2$& etc)"
12293 When a &%match%& expansion condition succeeds, these variables contain the
12294 captured substrings identified by the regular expression during subsequent
12295 processing of the success string of the containing &%if%& expansion item.
12296 In the expansion condition case
12297 they do not retain their values afterwards; in fact, their previous
12298 values are restored at the end of processing an &%if%& item. The numerical
12299 variables may also be set externally by some other matching process which
12300 precedes the expansion of the string. For example, the commands available in
12301 Exim filter files include an &%if%& command with its own regular expression
12302 matching condition.
12303 If the subject string was tainted then any captured substring will also be.
12304
12305 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12306 Within an acl condition, expansion condition or expansion item
12307 any arguments are copied to these variables,
12308 any unused variables being made empty.
12309
12310 .vitem "&$acl_c...$&"
12311 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12312 can be given any name that starts with &$acl_c$& and is at least six characters
12313 long, but the sixth character must be either a digit or an underscore. For
12314 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12315 variables persist throughout the lifetime of an SMTP connection. They can be
12316 used to pass information between ACLs and between different invocations of the
12317 same ACL. When a message is received, the values of these variables are saved
12318 with the message, and can be accessed by filters, routers, and transports
12319 during subsequent delivery.
12320
12321 .vitem "&$acl_m...$&"
12322 These variables are like the &$acl_c...$& variables, except that their values
12323 are reset after a message has been received. Thus, if several messages are
12324 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12325 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12326 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12327 message is received, the values of these variables are saved with the message,
12328 and can be accessed by filters, routers, and transports during subsequent
12329 delivery.
12330
12331 .vitem &$acl_narg$&
12332 Within an acl condition, expansion condition or expansion item
12333 this variable has the number of arguments.
12334
12335 .vitem &$acl_verify_message$&
12336 .vindex "&$acl_verify_message$&"
12337 After an address verification has failed, this variable contains the failure
12338 message. It retains its value for use in subsequent modifiers of the verb.
12339 The message can be preserved by coding like this:
12340 .code
12341 warn !verify = sender
12342      set acl_m0 = $acl_verify_message
12343 .endd
12344 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12345 &%log_message%& modifiers, to include information about the verification
12346 failure.
12347 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12348
12349 .vitem &$address_data$&
12350 .vindex "&$address_data$&"
12351 This variable is set by means of the &%address_data%& option in routers. The
12352 value then remains with the address while it is processed by subsequent routers
12353 and eventually a transport. If the transport is handling multiple addresses,
12354 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12355 for more details. &*Note*&: The contents of &$address_data$& are visible in
12356 user filter files.
12357
12358 If &$address_data$& is set when the routers are called from an ACL to verify
12359 a recipient address, the final value is still in the variable for subsequent
12360 conditions and modifiers of the ACL statement. If routing the address caused it
12361 to be redirected to just one address, the child address is also routed as part
12362 of the verification, and in this case the final value of &$address_data$& is
12363 from the child's routing.
12364
12365 If &$address_data$& is set when the routers are called from an ACL to verify a
12366 sender address, the final value is also preserved, but this time in
12367 &$sender_address_data$&, to distinguish it from data from a recipient
12368 address.
12369
12370 In both cases (recipient and sender verification), the value does not persist
12371 after the end of the current ACL statement. If you want to preserve
12372 these values for longer, you can save them in ACL variables.
12373
12374 .vitem &$address_file$&
12375 .vindex "&$address_file$&"
12376 When, as a result of aliasing, forwarding, or filtering, a message is directed
12377 to a specific file, this variable holds the name of the file when the transport
12378 is running. At other times, the variable is empty. For example, using the
12379 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12380 .code
12381 /home/r2d2/savemail
12382 .endd
12383 then when the &(address_file)& transport is running, &$address_file$&
12384 contains the text string &`/home/r2d2/savemail`&.
12385 .cindex "Sieve filter" "value of &$address_file$&"
12386 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12387 then up to the transport configuration to generate an appropriate absolute path
12388 to the relevant file.
12389
12390 .vitem &$address_pipe$&
12391 .vindex "&$address_pipe$&"
12392 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12393 this variable holds the pipe command when the transport is running.
12394
12395 .vitem "&$auth1$& &-- &$auth4$&"
12396 .vindex "&$auth1$&, &$auth2$&, etc"
12397 These variables are used in SMTP authenticators (see chapters
12398 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12399
12400 .vitem &$authenticated_id$&
12401 .cindex "authentication" "id"
12402 .vindex "&$authenticated_id$&"
12403 When a server successfully authenticates a client it may be configured to
12404 preserve some of the authentication information in the variable
12405 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12406 user/password authenticator configuration might preserve the user name for use
12407 in the routers. Note that this is not the same information that is saved in
12408 &$sender_host_authenticated$&.
12409
12410 When a message is submitted locally (that is, not over a TCP connection)
12411 the value of &$authenticated_id$& is normally the login name of the calling
12412 process. However, a trusted user can override this by means of the &%-oMai%&
12413 command line option.
12414 This second case also sets up information used by the
12415 &$authresults$& expansion item.
12416
12417 .vitem &$authenticated_fail_id$&
12418 .cindex "authentication" "fail" "id"
12419 .vindex "&$authenticated_fail_id$&"
12420 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12421 will contain the failed authentication id. If more than one authentication
12422 id is attempted, it will contain only the last one. The variable is
12423 available for processing in the ACL's, generally the quit or notquit ACL.
12424 A message to a local recipient could still be accepted without requiring
12425 authentication, which means this variable could also be visible in all of
12426 the ACL's as well.
12427
12428
12429 .tvar &$authenticated_sender$&
12430 .cindex "sender" "authenticated"
12431 .cindex "authentication" "sender"
12432 .cindex "AUTH" "on MAIL command"
12433 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12434 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12435 described in section &<<SECTauthparamail>>&. Unless the data is the string
12436 &"<>"&, it is set as the authenticated sender of the message, and the value is
12437 available during delivery in the &$authenticated_sender$& variable. If the
12438 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12439
12440 .vindex "&$qualify_domain$&"
12441 When a message is submitted locally (that is, not over a TCP connection), the
12442 value of &$authenticated_sender$& is an address constructed from the login
12443 name of the calling process and &$qualify_domain$&, except that a trusted user
12444 can override this by means of the &%-oMas%& command line option.
12445
12446
12447 .vitem &$authentication_failed$&
12448 .cindex "authentication" "failure"
12449 .vindex "&$authentication_failed$&"
12450 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12451 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12452 possible to distinguish between &"did not try to authenticate"&
12453 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12454 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12455 is empty and &$authentication_failed$& is set to &"1"&).
12456 Failure includes cancellation of a authentication attempt,
12457 and any negative response to an AUTH command,
12458 (including, for example, an attempt to use an undefined mechanism).
12459
12460 .vitem &$av_failed$&
12461 .cindex "content scanning" "AV scanner failure"
12462 This variable is available when Exim is compiled with the content-scanning
12463 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12464 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12465 the ACL malware condition.
12466
12467 .vitem &$body_linecount$&
12468 .cindex "message body" "line count"
12469 .cindex "body of message" "line count"
12470 .vindex "&$body_linecount$&"
12471 When a message is being received or delivered, this variable contains the
12472 number of lines in the message's body. See also &$message_linecount$&.
12473
12474 .vitem &$body_zerocount$&
12475 .cindex "message body" "binary zero count"
12476 .cindex "body of message" "binary zero count"
12477 .cindex "binary zero" "in message body"
12478 .vindex "&$body_zerocount$&"
12479 When a message is being received or delivered, this variable contains the
12480 number of binary zero bytes (ASCII NULs) in the message's body.
12481
12482 .vitem &$bounce_recipient$&
12483 .vindex "&$bounce_recipient$&"
12484 This is set to the recipient address of a bounce message while Exim is creating
12485 it. It is useful if a customized bounce message text file is in use (see
12486 chapter &<<CHAPemsgcust>>&).
12487
12488 .vitem &$bounce_return_size_limit$&
12489 .vindex "&$bounce_return_size_limit$&"
12490 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12491 up to a multiple of 1000. It is useful when a customized error message text
12492 file is in use (see chapter &<<CHAPemsgcust>>&).
12493
12494 .vitem &$caller_gid$&
12495 .cindex "gid (group id)" "caller"
12496 .vindex "&$caller_gid$&"
12497 The real group id under which the process that called Exim was running. This is
12498 not the same as the group id of the originator of a message (see
12499 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12500 incarnation normally contains the Exim gid.
12501
12502 .vitem &$caller_uid$&
12503 .cindex "uid (user id)" "caller"
12504 .vindex "&$caller_uid$&"
12505 The real user id under which the process that called Exim was running. This is
12506 not the same as the user id of the originator of a message (see
12507 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12508 incarnation normally contains the Exim uid.
12509
12510 .vitem &$callout_address$&
12511 .vindex "&$callout_address$&"
12512 After a callout for verification, spamd or malware daemon service, the
12513 address that was connected to.
12514
12515 .vitem &$compile_number$&
12516 .vindex "&$compile_number$&"
12517 The building process for Exim keeps a count of the number
12518 of times it has been compiled. This serves to distinguish different
12519 compilations of the same version of Exim.
12520
12521 .vitem &$config_dir$&
12522 .vindex "&$config_dir$&"
12523 The directory name of the main configuration file. That is, the content of
12524 &$config_file$& with the last component stripped. The value does not
12525 contain the trailing slash. If &$config_file$& does not contain a slash,
12526 &$config_dir$& is ".".
12527
12528 .vitem &$config_file$&
12529 .vindex "&$config_file$&"
12530 The name of the main configuration file Exim is using.
12531
12532 .vitem &$dkim_verify_status$&
12533 Results of DKIM verification.
12534 For details see section &<<SECDKIMVFY>>&.
12535
12536 .vitem &$dkim_cur_signer$& &&&
12537        &$dkim_verify_reason$& &&&
12538        &$dkim_domain$& &&&
12539        &$dkim_identity$& &&&
12540        &$dkim_selector$& &&&
12541        &$dkim_algo$& &&&
12542        &$dkim_canon_body$& &&&
12543        &$dkim_canon_headers$& &&&
12544        &$dkim_copiedheaders$& &&&
12545        &$dkim_bodylength$& &&&
12546        &$dkim_created$& &&&
12547        &$dkim_expires$& &&&
12548        &$dkim_headernames$& &&&
12549        &$dkim_key_testing$& &&&
12550        &$dkim_key_nosubdomains$& &&&
12551        &$dkim_key_srvtype$& &&&
12552        &$dkim_key_granularity$& &&&
12553        &$dkim_key_notes$& &&&
12554        &$dkim_key_length$&
12555 These variables are only available within the DKIM ACL.
12556 For details see section &<<SECDKIMVFY>>&.
12557
12558 .vitem &$dkim_signers$&
12559 .vindex &$dkim_signers$&
12560 When a message has been received this variable contains
12561 a colon-separated list of signer domains and identities for the message.
12562 For details see section &<<SECDKIMVFY>>&.
12563
12564 .vitem &$dmarc_domain_policy$& &&&
12565        &$dmarc_status$& &&&
12566        &$dmarc_status_text$& &&&
12567        &$dmarc_used_domains$&
12568 Results of DMARC verification.
12569 For details see section &<<SECDMARC>>&.
12570
12571 .vitem &$dnslist_domain$& &&&
12572        &$dnslist_matched$& &&&
12573        &$dnslist_text$& &&&
12574        &$dnslist_value$&
12575 .vindex "&$dnslist_domain$&"
12576 .vindex "&$dnslist_matched$&"
12577 .vindex "&$dnslist_text$&"
12578 .vindex "&$dnslist_value$&"
12579 .cindex "black list (DNS)"
12580 When a DNS (black) list lookup succeeds, these variables are set to contain
12581 the following data from the lookup: the list's domain name, the key that was
12582 looked up, the contents of any associated TXT record, and the value from the
12583 main A record. See section &<<SECID204>>& for more details.
12584
12585 .tvar &$domain$&
12586 When an address is being routed, or delivered on its own, this variable
12587 contains the domain. Uppercase letters in the domain are converted into lower
12588 case for &$domain$&.
12589
12590 Global address rewriting happens when a message is received, so the value of
12591 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12592 is set during user filtering, but not during system filtering, because a
12593 message may have many recipients and the system filter is called just once.
12594
12595 When more than one address is being delivered at once (for example, several
12596 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12597 have the same domain. Transports can be restricted to handling only one domain
12598 at a time if the value of &$domain$& is required at transport time &-- this is
12599 the default for local transports. For further details of the environment in
12600 which local transports are run, see chapter &<<CHAPenvironment>>&.
12601
12602 .oindex "&%delay_warning_condition%&"
12603 At the end of a delivery, if all deferred addresses have the same domain, it is
12604 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12605
12606 The &$domain$& variable is also used in some other circumstances:
12607
12608 .ilist
12609 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12610 the recipient address. The domain of the &'sender'& address is in
12611 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12612 normally set during the running of the MAIL ACL. However, if the sender address
12613 is verified with a callout during the MAIL ACL, the sender domain is placed in
12614 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12615 the &(smtp)& transport.
12616
12617 .next
12618 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12619 &$domain$& contains the domain portion of the address that is being rewritten;
12620 it can be used in the expansion of the replacement address, for example, to
12621 rewrite domains by file lookup.
12622
12623 .next
12624 With one important exception, whenever a domain list is being scanned,
12625 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12626 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12627 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12628 that, in a RCPT ACL, the sender domain list can be dependent on the
12629 recipient domain (which is what is in &$domain$& at this time).
12630
12631 .next
12632 .cindex "ETRN" "value of &$domain$&"
12633 .oindex "&%smtp_etrn_command%&"
12634 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12635 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12636 .endlist
12637
12638 .cindex "tainted data"
12639 If the origin of the data is an incoming message,
12640 the result of expanding this variable is tainted and may not
12641 be further expanded or used as a filename.
12642 When an untainted version is needed, one should be obtained from
12643 looking up the value in a local (therefore trusted) database.
12644 Often &$domain_data$& is usable in this role.
12645
12646
12647 .vitem &$domain_data$&
12648 .vindex "&$domain_data$&"
12649 When the &%domains%& condition on a router
12650 or an ACL
12651 matches a domain
12652 against a list, the match value is copied to &$domain_data$&.
12653 This is an enhancement over previous versions of Exim, when it only
12654 applied to the data read by a lookup.
12655 For details on match values see section &<<SECTlistresults>>& et. al.
12656
12657 If the router routes the
12658 address to a transport, the value is available in that transport. If the
12659 transport is handling multiple addresses, the value from the first address is
12660 used.
12661
12662 &$domain_data$& set in an ACL is available during
12663 the rest of the ACL statement.
12664
12665 .vitem &$exim_gid$&
12666 .vindex "&$exim_gid$&"
12667 This variable contains the numerical value of the Exim group id.
12668
12669 .vitem &$exim_path$&
12670 .vindex "&$exim_path$&"
12671 This variable contains the path to the Exim binary.
12672
12673 .vitem &$exim_uid$&
12674 .vindex "&$exim_uid$&"
12675 This variable contains the numerical value of the Exim user id.
12676
12677 .vitem &$exim_version$&
12678 .vindex "&$exim_version$&"
12679 This variable contains the version string of the Exim build.
12680 The first character is a major version number, currently 4.
12681 Then after a dot, the next group of digits is a minor version number.
12682 There may be other characters following the minor version.
12683 This value may be overridden by the &%exim_version%& main config option.
12684
12685 .vitem &$header_$&<&'name'&>
12686 .tmark
12687 This is not strictly an expansion variable. It is expansion syntax for
12688 inserting the message header line with the given name. Note that the name must
12689 be terminated by colon or white space, because it may contain a wide variety of
12690 characters. Note also that braces must &'not'& be used.
12691 See the full description in section &<<SECTexpansionitems>>& above.
12692
12693 .vitem &$headers_added$&
12694 .vindex "&$headers_added$&"
12695 Within an ACL this variable contains the headers added so far by
12696 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12697 The headers are a newline-separated list.
12698
12699 .vitem &$home$&
12700 .vindex "&$home$&"
12701 When the &%check_local_user%& option is set for a router, the user's home
12702 directory is placed in &$home$& when the check succeeds. In particular, this
12703 means it is set during the running of users' filter files. A router may also
12704 explicitly set a home directory for use by a transport; this can be overridden
12705 by a setting on the transport itself.
12706
12707 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12708 of the environment variable HOME, which is subject to the
12709 &%keep_environment%& and &%add_environment%& main config options.
12710
12711 .vitem &$host$&
12712 .vindex "&$host$&"
12713 If a router assigns an address to a transport (any transport), and passes a
12714 list of hosts with the address, the value of &$host$& when the transport starts
12715 to run is the name of the first host on the list. Note that this applies both
12716 to local and remote transports.
12717
12718 .cindex "transport" "filter"
12719 .cindex "filter" "transport filter"
12720 For the &(smtp)& transport, if there is more than one host, the value of
12721 &$host$& changes as the transport works its way through the list. In
12722 particular, when the &(smtp)& transport is expanding its options for encryption
12723 using TLS, or for specifying a transport filter (see chapter
12724 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12725 is connected.
12726
12727 When used in the client part of an authenticator configuration (see chapter
12728 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12729 client is connected.
12730
12731
12732 .vitem &$host_address$&
12733 .vindex "&$host_address$&"
12734 This variable is set to the remote host's IP address whenever &$host$& is set
12735 for a remote connection. It is also set to the IP address that is being checked
12736 when the &%ignore_target_hosts%& option is being processed.
12737
12738 .vitem &$host_data$&
12739 .vindex "&$host_data$&"
12740 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12741 result of the lookup is made available in the &$host_data$& variable. This
12742 allows you, for example, to do things like this:
12743 .code
12744 deny  hosts = net-lsearch;/some/file
12745       message = $host_data
12746 .endd
12747
12748 .vitem &$host_lookup_deferred$&
12749 .cindex "host name" "lookup, failure of"
12750 .vindex "&$host_lookup_deferred$&"
12751 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12752 message comes from a remote host and there is an attempt to look up the host's
12753 name from its IP address, and the attempt is not successful, one of these
12754 variables is set to &"1"&.
12755
12756 .ilist
12757 If the lookup receives a definite negative response (for example, a DNS lookup
12758 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12759
12760 .next
12761 If there is any kind of problem during the lookup, such that Exim cannot
12762 tell whether or not the host name is defined (for example, a timeout for a DNS
12763 lookup), &$host_lookup_deferred$& is set to &"1"&.
12764 .endlist ilist
12765
12766 Looking up a host's name from its IP address consists of more than just a
12767 single reverse lookup. Exim checks that a forward lookup of at least one of the
12768 names it receives from a reverse lookup yields the original IP address. If this
12769 is not the case, Exim does not accept the looked up name(s), and
12770 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12771 IP address (for example, the existence of a PTR record in the DNS) is not
12772 sufficient on its own for the success of a host name lookup. If the reverse
12773 lookup succeeds, but there is a lookup problem such as a timeout when checking
12774 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12775 &"1"&. See also &$sender_host_name$&.
12776
12777 .cindex authentication "expansion item"
12778 Performing these checks sets up information used by the
12779 &%authresults%& expansion item.
12780
12781
12782 .vitem &$host_lookup_failed$&
12783 .vindex "&$host_lookup_failed$&"
12784 See &$host_lookup_deferred$&.
12785
12786 .vitem &$host_port$&
12787 .vindex "&$host_port$&"
12788 This variable is set to the remote host's TCP port whenever &$host$& is set
12789 for an outbound connection.
12790
12791 .vitem &$initial_cwd$&
12792 .vindex "&$initial_cwd$&
12793 This variable contains the full path name of the initial working
12794 directory of the current Exim process. This may differ from the current
12795 working directory, as Exim changes this to "/" during early startup, and
12796 to &$spool_directory$& later.
12797
12798 .vitem &$inode$&
12799 .vindex "&$inode$&"
12800 The only time this variable is set is while expanding the &%directory_file%&
12801 option in the &(appendfile)& transport. The variable contains the inode number
12802 of the temporary file which is about to be renamed. It can be used to construct
12803 a unique name for the file.
12804
12805 .vitem &$interface_address$& &&&
12806        &$interface_port$&
12807 .vindex "&$interface_address$&"
12808 .vindex "&$interface_port$&"
12809 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12810
12811 .vitem &$item$&
12812 .vindex "&$item$&"
12813 This variable is used during the expansion of &*forall*& and &*forany*&
12814 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12815 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12816 empty.
12817
12818 .vitem &$ldap_dn$&
12819 .vindex "&$ldap_dn$&"
12820 This variable, which is available only when Exim is compiled with LDAP support,
12821 contains the DN from the last entry in the most recently successful LDAP
12822 lookup.
12823
12824 .vitem &$load_average$&
12825 .vindex "&$load_average$&"
12826 This variable contains the system load average, multiplied by 1000 so that it
12827 is an integer. For example, if the load average is 0.21, the value of the
12828 variable is 210. The value is recomputed every time the variable is referenced.
12829
12830 .tvar &$local_part$&
12831 When an address is being routed, or delivered on its own, this
12832 variable contains the local part. When a number of addresses are being
12833 delivered together (for example, multiple RCPT commands in an SMTP
12834 session), &$local_part$& is not set.
12835
12836 Global address rewriting happens when a message is received, so the value of
12837 &$local_part$& during routing and delivery is the value after rewriting.
12838 &$local_part$& is set during user filtering, but not during system filtering,
12839 because a message may have many recipients and the system filter is called just
12840 once.
12841
12842 .cindex "tainted data"
12843 If the origin of the data is an incoming message,
12844 the result of expanding this variable is tainted and
12845 may not be further expanded or used as a filename.
12846
12847 &*Warning*&: the content of this variable is usually provided by a potential
12848 attacker.
12849 Consider carefully the implications of using it unvalidated as a name
12850 for file access.
12851 This presents issues for users' &_.forward_& and filter files.
12852 For traditional full user accounts, use &%check_local_users%& and the
12853 &$local_part_data$& variable rather than this one.
12854 For virtual users, store a suitable pathname component in the database
12855 which is used for account name validation, and use that retrieved value
12856 rather than this variable.
12857 Often &$local_part_data$& is usable in this role.
12858 If needed, use a router &%address_data%& or &%set%& option for
12859 the retrieved data.
12860
12861 When a message is being delivered to a file, pipe, or autoreply transport as a
12862 result of aliasing or forwarding, &$local_part$& is set to the local part of
12863 the parent address, not to the filename or command (see &$address_file$& and
12864 &$address_pipe$&).
12865
12866 When an ACL is running for a RCPT command, &$local_part$& contains the
12867 local part of the recipient address.
12868
12869 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12870 &$local_part$& contains the local part of the address that is being rewritten;
12871 it can be used in the expansion of the replacement address, for example.
12872
12873 In all cases, all quoting is removed from the local part. For example, for both
12874 the addresses
12875 .code
12876 "abc:xyz"@test.example
12877 abc\:xyz@test.example
12878 .endd
12879 the value of &$local_part$& is
12880 .code
12881 abc:xyz
12882 .endd
12883 If you use &$local_part$& to create another address, you should always wrap it
12884 inside a quoting operator. For example, in a &(redirect)& router you could
12885 have:
12886 .code
12887 data = ${quote_local_part:$local_part}@new.domain.example
12888 .endd
12889 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12890 to process local parts in a case-dependent manner in a router, you can set the
12891 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12892
12893 .vitem &$local_part_data$&
12894 .vindex "&$local_part_data$&"
12895 When the &%local_parts%& condition on a router or ACL
12896 matches a local part list
12897 the match value is copied to &$local_part_data$&.
12898 This is an enhancement over previous versions of Exim, when it only
12899 applied to the data read by a lookup.
12900 For details on match values see section &<<SECTlistresults>>& et. al.
12901
12902 The &%check_local_user%& router option also sets this variable.
12903
12904 .vindex &$local_part_prefix$& &&&
12905         &$local_part_prefix_v$& &&&
12906         &$local_part_suffix$& &&&
12907         &$local_part_suffix_v$&
12908 .cindex affix variables
12909 If a local part prefix or suffix has been recognized, it is not included in the
12910 value of &$local_part$& during routing and subsequent delivery. The values of
12911 any prefix or suffix are in &$local_part_prefix$& and
12912 &$local_part_suffix$&, respectively.
12913 .cindex "tainted data"
12914 If the specification did not include a wildcard then
12915 the affix variable value is not tainted.
12916
12917 If the affix specification included a wildcard then the portion of
12918 the affix matched by the wildcard is in
12919 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12920 and both the whole and varying values are tainted.
12921
12922 .vitem &$local_scan_data$&
12923 .vindex "&$local_scan_data$&"
12924 This variable contains the text returned by the &[local_scan()]& function when
12925 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12926
12927 .vitem &$local_user_gid$&
12928 .vindex "&$local_user_gid$&"
12929 See &$local_user_uid$&.
12930
12931 .vitem &$local_user_uid$&
12932 .vindex "&$local_user_uid$&"
12933 This variable and &$local_user_gid$& are set to the uid and gid after the
12934 &%check_local_user%& router precondition succeeds. This means that their values
12935 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12936 and &%condition%&), for the &%address_data%& expansion, and for any
12937 router-specific expansions. At all other times, the values in these variables
12938 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12939
12940 .vitem &$localhost_number$&
12941 .vindex "&$localhost_number$&"
12942 This contains the expanded value of the
12943 &%localhost_number%& option. The expansion happens after the main options have
12944 been read.
12945
12946 .vitem &$log_inodes$&
12947 .vindex "&$log_inodes$&"
12948 The number of free inodes in the disk partition where Exim's
12949 log files are being written. The value is recalculated whenever the variable is
12950 referenced. If the relevant file system does not have the concept of inodes,
12951 the value of is -1. See also the &%check_log_inodes%& option.
12952
12953 .vitem &$log_space$&
12954 .vindex "&$log_space$&"
12955 The amount of free space (as a number of kilobytes) in the disk
12956 partition where Exim's log files are being written. The value is recalculated
12957 whenever the variable is referenced. If the operating system does not have the
12958 ability to find the amount of free space (only true for experimental systems),
12959 the space value is -1. See also the &%check_log_space%& option.
12960
12961
12962 .vitem &$lookup_dnssec_authenticated$&
12963 .vindex "&$lookup_dnssec_authenticated$&"
12964 This variable is set after a DNS lookup done by
12965 a dnsdb lookup expansion, dnslookup router or smtp transport.
12966 .cindex "DNS" "DNSSEC"
12967 It will be empty if &(DNSSEC)& was not requested,
12968 &"no"& if the result was not labelled as authenticated data
12969 and &"yes"& if it was.
12970 Results that are labelled as authoritative answer that match
12971 the &%dns_trust_aa%& configuration variable count also
12972 as authenticated data.
12973
12974 .vitem &$mailstore_basename$&
12975 .vindex "&$mailstore_basename$&"
12976 This variable is set only when doing deliveries in &"mailstore"& format in the
12977 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12978 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12979 contains the basename of the files that are being written, that is, the name
12980 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12981 variable is empty.
12982
12983 .vitem &$malware_name$&
12984 .vindex "&$malware_name$&"
12985 This variable is available when Exim is compiled with the
12986 content-scanning extension. It is set to the name of the virus that was found
12987 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12988
12989 .vitem &$max_received_linelength$&
12990 .vindex "&$max_received_linelength$&"
12991 .cindex "maximum" "line length"
12992 .cindex "line length" "maximum"
12993 This variable contains the number of bytes in the longest line that was
12994 received as part of the message, not counting the line termination
12995 character(s).
12996 It is not valid if the &%spool_wireformat%& option is used.
12997
12998 .vitem &$message_age$&
12999 .cindex "message" "age of"
13000 .vindex "&$message_age$&"
13001 This variable is set at the start of a delivery attempt to contain the number
13002 of seconds since the message was received. It does not change during a single
13003 delivery attempt.
13004
13005 .tvar &$message_body$&
13006 .cindex "body of message" "expansion variable"
13007 .cindex "message body" "in expansion"
13008 .cindex "binary zero" "in message body"
13009 .oindex "&%message_body_visible%&"
13010 This variable contains the initial portion of a message's body while it is
13011 being delivered, and is intended mainly for use in filter files. The maximum
13012 number of characters of the body that are put into the variable is set by the
13013 &%message_body_visible%& configuration option; the default is 500.
13014
13015 .oindex "&%message_body_newlines%&"
13016 By default, newlines are converted into spaces in &$message_body$&, to make it
13017 easier to search for phrases that might be split over a line break. However,
13018 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13019 zeros are always converted into spaces.
13020
13021 .tvar &$message_body_end$&
13022 .cindex "body of message" "expansion variable"
13023 .cindex "message body" "in expansion"
13024 This variable contains the final portion of a message's
13025 body while it is being delivered. The format and maximum size are as for
13026 &$message_body$&.
13027
13028 .vitem &$message_body_size$&
13029 .cindex "body of message" "size"
13030 .cindex "message body" "size"
13031 .vindex "&$message_body_size$&"
13032 When a message is being delivered, this variable contains the size of the body
13033 in bytes. The count starts from the character after the blank line that
13034 separates the body from the header. Newlines are included in the count. See
13035 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13036
13037 If the spool file is wireformat
13038 (see the &%spool_wireformat%& main option)
13039 the CRLF line-terminators are included in the count.
13040
13041 .vitem &$message_exim_id$&
13042 .vindex "&$message_exim_id$&"
13043 When a message is being received or delivered, this variable contains the
13044 unique message id that is generated and used by Exim to identify the message.
13045 An id is not created for a message until after its header has been successfully
13046 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13047 line; it is the local id that Exim assigns to the message, for example:
13048 &`1BXTIK-0001yO-VA`&.
13049
13050 .tvar &$message_headers$&
13051 This variable contains a concatenation of all the header lines when a message
13052 is being processed, except for lines added by routers or transports. The header
13053 lines are separated by newline characters. Their contents are decoded in the
13054 same way as a header line that is inserted by &%bheader%&.
13055
13056 .tvar &$message_headers_raw$&
13057 This variable is like &$message_headers$& except that no processing of the
13058 contents of header lines is done.
13059
13060 .vitem &$message_id$&
13061 This is an old name for &$message_exim_id$&. It is now deprecated.
13062
13063 .vitem &$message_linecount$&
13064 .vindex "&$message_linecount$&"
13065 This variable contains the total number of lines in the header and body of the
13066 message. Compare &$body_linecount$&, which is the count for the body only.
13067 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13068 number of lines received. Before delivery happens (that is, before filters,
13069 routers, and transports run) the count is increased to include the
13070 &'Received:'& header line that Exim standardly adds, and also any other header
13071 lines that are added by ACLs. The blank line that separates the message header
13072 from the body is not counted.
13073
13074 As with the special case of &$message_size$&, during the expansion of the
13075 appendfile transport's maildir_tag option in maildir format, the value of
13076 &$message_linecount$& is the precise size of the number of newlines in the
13077 file that has been written (minus one for the blank line between the
13078 header and the body).
13079
13080 Here is an example of the use of this variable in a DATA ACL:
13081 .code
13082 deny condition = \
13083       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13084      message   = Too many lines in message header
13085 .endd
13086 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13087 message has not yet been received.
13088
13089 This variable is not valid if the &%spool_wireformat%& option is used.
13090
13091 .vitem &$message_size$&
13092 .cindex "size" "of message"
13093 .cindex "message" "size"
13094 .vindex "&$message_size$&"
13095 When a message is being processed, this variable contains its size in bytes. In
13096 most cases, the size includes those headers that were received with the
13097 message, but not those (such as &'Envelope-to:'&) that are added to individual
13098 deliveries as they are written. However, there is one special case: during the
13099 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13100 doing a delivery in maildir format, the value of &$message_size$& is the
13101 precise size of the file that has been written. See also
13102 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13103
13104 .cindex "RCPT" "value of &$message_size$&"
13105 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13106 contains the size supplied on the MAIL command, or -1 if no size was given. The
13107 value may not, of course, be truthful.
13108
13109 .vitem &$mime_anomaly_level$& &&&
13110        &$mime_anomaly_text$& &&&
13111        &$mime_boundary$& &&&
13112        &$mime_charset$& &&&
13113        &$mime_content_description$& &&&
13114        &$mime_content_disposition$& &&&
13115        &$mime_content_id$& &&&
13116        &$mime_content_size$& &&&
13117        &$mime_content_transfer_encoding$& &&&
13118        &$mime_content_type$& &&&
13119        &$mime_decoded_filename$& &&&
13120        &$mime_filename$& &&&
13121        &$mime_is_coverletter$& &&&
13122        &$mime_is_multipart$& &&&
13123        &$mime_is_rfc822$& &&&
13124        &$mime_part_count$&
13125 A number of variables whose names start with &$mime$& are
13126 available when Exim is compiled with the content-scanning extension. For
13127 details, see section &<<SECTscanmimepart>>&.
13128
13129 .vitem "&$n0$& &-- &$n9$&"
13130 These variables are counters that can be incremented by means
13131 of the &%add%& command in filter files.
13132
13133 .tvar &$original_domain$&
13134 .vindex "&$domain$&"
13135 When a top-level address is being processed for delivery, this contains the
13136 same value as &$domain$&. However, if a &"child"& address (for example,
13137 generated by an alias, forward, or filter file) is being processed, this
13138 variable contains the domain of the original address (lower cased). This
13139 differs from &$parent_domain$& only when there is more than one level of
13140 aliasing or forwarding. When more than one address is being delivered in a
13141 single transport run, &$original_domain$& is not set.
13142
13143 If a new address is created by means of a &%deliver%& command in a system
13144 filter, it is set up with an artificial &"parent"& address. This has the local
13145 part &'system-filter'& and the default qualify domain.
13146
13147 .tvar &$original_local_part$&
13148 .vindex "&$local_part$&"
13149 When a top-level address is being processed for delivery, this contains the
13150 same value as &$local_part$&, unless a prefix or suffix was removed from the
13151 local part, because &$original_local_part$& always contains the full local
13152 part. When a &"child"& address (for example, generated by an alias, forward, or
13153 filter file) is being processed, this variable contains the full local part of
13154 the original address.
13155
13156 If the router that did the redirection processed the local part
13157 case-insensitively, the value in &$original_local_part$& is in lower case.
13158 This variable differs from &$parent_local_part$& only when there is more than
13159 one level of aliasing or forwarding. When more than one address is being
13160 delivered in a single transport run, &$original_local_part$& is not set.
13161
13162 If a new address is created by means of a &%deliver%& command in a system
13163 filter, it is set up with an artificial &"parent"& address. This has the local
13164 part &'system-filter'& and the default qualify domain.
13165
13166 .vitem &$originator_gid$&
13167 .cindex "gid (group id)" "of originating user"
13168 .cindex "sender" "gid"
13169 .vindex "&$caller_gid$&"
13170 .vindex "&$originator_gid$&"
13171 This variable contains the value of &$caller_gid$& that was set when the
13172 message was received. For messages received via the command line, this is the
13173 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13174 normally the gid of the Exim user.
13175
13176 .vitem &$originator_uid$&
13177 .cindex "uid (user id)" "of originating user"
13178 .cindex "sender" "uid"
13179 .vindex "&$caller_uid$&"
13180 .vindex "&$originator_uid$&"
13181 The value of &$caller_uid$& that was set when the message was received. For
13182 messages received via the command line, this is the uid of the sending user.
13183 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13184 user.
13185
13186 .tvar &$parent_domain$&
13187 This variable is similar to &$original_domain$& (see
13188 above), except that it refers to the immediately preceding parent address.
13189
13190 .tvar &$parent_local_part$&
13191 This variable is similar to &$original_local_part$&
13192 (see above), except that it refers to the immediately preceding parent address.
13193
13194 .vitem &$pid$&
13195 .cindex "pid (process id)" "of current process"
13196 .vindex "&$pid$&"
13197 This variable contains the current process id.
13198
13199 .vitem &$pipe_addresses$&
13200 .cindex "filter" "transport filter"
13201 .cindex "transport" "filter"
13202 .vindex "&$pipe_addresses$&"
13203 This is not an expansion variable, but is mentioned here because the string
13204 &`$pipe_addresses`& is handled specially in the command specification for the
13205 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13206 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13207 It cannot be used in general expansion strings, and provokes an &"unknown
13208 variable"& error if encountered.
13209 &*Note*&: This value permits data supplied by a potential attacker to
13210 be used in the command for a &(pipe)& transport.
13211 Such configurations should be carefully assessed for security vulnerbilities.
13212
13213 .vitem &$primary_hostname$&
13214 .vindex "&$primary_hostname$&"
13215 This variable contains the value set by &%primary_hostname%& in the
13216 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13217 a single-component name, Exim calls &[gethostbyname()]& (or
13218 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13219 qualified host name. See also &$smtp_active_hostname$&.
13220
13221
13222 .vitem &$proxy_external_address$& &&&
13223        &$proxy_external_port$& &&&
13224        &$proxy_local_address$& &&&
13225        &$proxy_local_port$& &&&
13226        &$proxy_session$&
13227 These variables are only available when built with Proxy Protocol
13228 or SOCKS5 support.
13229 For details see chapter &<<SECTproxyInbound>>&.
13230
13231 .vitem &$prdr_requested$&
13232 .cindex "PRDR" "variable for"
13233 This variable is set to &"yes"& if PRDR was requested by the client for the
13234 current message, otherwise &"no"&.
13235
13236 .vitem &$prvscheck_address$& &&&
13237        &$prvscheck_keynum$& &&&
13238        &$prvscheck_result$&
13239 These variables are used in conjunction with the &%prvscheck%& expansion item,
13240 which is described in sections &<<SECTexpansionitems>>& and
13241 &<<SECTverifyPRVS>>&.
13242
13243 .vitem &$qualify_domain$&
13244 .vindex "&$qualify_domain$&"
13245 The value set for the &%qualify_domain%& option in the configuration file.
13246
13247 .vitem &$qualify_recipient$&
13248 .vindex "&$qualify_recipient$&"
13249 The value set for the &%qualify_recipient%& option in the configuration file,
13250 or if not set, the value of &$qualify_domain$&.
13251
13252 .vitem &$queue_name$&
13253 .vindex &$queue_name$&
13254 .cindex "named queues" variable
13255 .cindex queues named
13256 The name of the spool queue in use; empty for the default queue.
13257
13258 .vitem &$queue_size$&
13259 .vindex "&$queue_size$&"
13260 .cindex "queue" "size of"
13261 .cindex "spool" "number of messages"
13262 This variable contains the number of messages queued.
13263 It is evaluated on demand, but no more often than once every minute.
13264 If there is no daemon notifier socket open, the value will be
13265 an empty string.
13266
13267 .vitem &$r_...$&
13268 .vindex &$r_...$&
13269 .cindex router variables
13270 Values can be placed in these variables by the &%set%& option of a router.
13271 They can be given any name that starts with &$r_$&.
13272 The values persist for the address being handled through subsequent routers
13273 and the eventual transport.
13274
13275 .vitem &$rcpt_count$&
13276 .vindex "&$rcpt_count$&"
13277 When a message is being received by SMTP, this variable contains the number of
13278 RCPT commands received for the current message. If this variable is used in a
13279 RCPT ACL, its value includes the current command.
13280
13281 .vitem &$rcpt_defer_count$&
13282 .vindex "&$rcpt_defer_count$&"
13283 .cindex "4&'xx'& responses" "count of"
13284 When a message is being received by SMTP, this variable contains the number of
13285 RCPT commands in the current message that have previously been rejected with a
13286 temporary (4&'xx'&) response.
13287
13288 .vitem &$rcpt_fail_count$&
13289 .vindex "&$rcpt_fail_count$&"
13290 When a message is being received by SMTP, this variable contains the number of
13291 RCPT commands in the current message that have previously been rejected with a
13292 permanent (5&'xx'&) response.
13293
13294 .vitem &$received_count$&
13295 .vindex "&$received_count$&"
13296 This variable contains the number of &'Received:'& header lines in the message,
13297 including the one added by Exim (so its value is always greater than zero). It
13298 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13299 delivering.
13300
13301 .tvar &$received_for$&
13302 If there is only a single recipient address in an incoming message, this
13303 variable contains that address when the &'Received:'& header line is being
13304 built. The value is copied after recipient rewriting has happened, but before
13305 the &[local_scan()]& function is run.
13306
13307 .vitem &$received_ip_address$& &&&
13308        &$received_port$&
13309 .vindex "&$received_ip_address$&"
13310 .vindex "&$received_port$&"
13311 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13312 variables are set to the address and port on the local IP interface.
13313 (The remote IP address and port are in
13314 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13315 the port value is -1 unless it has been set using the &%-oMi%& command line
13316 option.
13317
13318 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13319 could be used, for example, to make the filename for a TLS certificate depend
13320 on which interface and/or port is being used for the incoming connection. The
13321 values of &$received_ip_address$& and &$received_port$& are saved with any
13322 messages that are received, thus making these variables available at delivery
13323 time.
13324 For outbound connections see &$sending_ip_address$&.
13325
13326 .vitem &$received_protocol$&
13327 .vindex "&$received_protocol$&"
13328 When a message is being processed, this variable contains the name of the
13329 protocol by which it was received. Most of the names used by Exim are defined
13330 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13331 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13332 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13333 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13334 connection and the client was successfully authenticated.
13335
13336 Exim uses the protocol name &"smtps"& for the case when encryption is
13337 automatically set up on connection without the use of STARTTLS (see
13338 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13339 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13340 where the client initially uses EHLO, sets up an encrypted connection using
13341 STARTTLS, and then uses HELO afterwards.
13342
13343 The &%-oMr%& option provides a way of specifying a custom protocol name for
13344 messages that are injected locally by trusted callers. This is commonly used to
13345 identify messages that are being re-injected after some kind of scanning.
13346
13347 .vitem &$received_time$&
13348 .vindex "&$received_time$&"
13349 This variable contains the date and time when the current message was received,
13350 as a number of seconds since the start of the Unix epoch.
13351
13352 .vitem &$recipient_data$&
13353 .vindex "&$recipient_data$&"
13354 This variable is set after an indexing lookup success in an ACL &%recipients%&
13355 condition. It contains the data from the lookup, and the value remains set
13356 until the next &%recipients%& test. Thus, you can do things like this:
13357 .display
13358 &`require recipients  = cdb*@;/some/file`&
13359 &`deny    `&&'some further test involving'& &`$recipient_data`&
13360 .endd
13361 &*Warning*&: This variable is set only when a lookup is used as an indexing
13362 method in the address list, using the semicolon syntax as in the example above.
13363 The variable is not set for a lookup that is used as part of the string
13364 expansion that all such lists undergo before being interpreted.
13365
13366 .vitem &$recipient_verify_failure$&
13367 .vindex "&$recipient_verify_failure$&"
13368 In an ACL, when a recipient verification fails, this variable contains
13369 information about the failure. It is set to one of the following words:
13370
13371 .ilist
13372 &"qualify"&: The address was unqualified (no domain), and the message
13373 was neither local nor came from an exempted host.
13374
13375 .next
13376 &"route"&: Routing failed.
13377
13378 .next
13379 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13380 or before the MAIL command (that is, on initial connection, HELO, or
13381 MAIL).
13382
13383 .next
13384 &"recipient"&: The RCPT command in a callout was rejected.
13385 .next
13386
13387 &"postmaster"&: The postmaster check in a callout was rejected.
13388 .endlist
13389
13390 The main use of this variable is expected to be to distinguish between
13391 rejections of MAIL and rejections of RCPT.
13392
13393 .tvar &$recipients$&
13394 This variable contains a list of envelope recipients for a message. A comma and
13395 a space separate the addresses in the replacement text. However, the variable
13396 is not generally available, to prevent exposure of Bcc recipients in
13397 unprivileged users' filter files. You can use &$recipients$& only in these
13398 cases:
13399
13400 .olist
13401 In a system filter file.
13402 .next
13403 In the ACLs associated with the DATA command and with non-SMTP messages, that
13404 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13405 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13406 &%acl_not_smtp_mime%&.
13407 .next
13408 From within a &[local_scan()]& function.
13409 .endlist
13410
13411
13412 .vitem &$recipients_count$&
13413 .vindex "&$recipients_count$&"
13414 When a message is being processed, this variable contains the number of
13415 envelope recipients that came with the message. Duplicates are not excluded
13416 from the count. While a message is being received over SMTP, the number
13417 increases for each accepted recipient. It can be referenced in an ACL.
13418
13419
13420 .vitem &$regex_match_string$&
13421 .vindex "&$regex_match_string$&"
13422 This variable is set to contain the matching regular expression after a
13423 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13424
13425 .vitem "&$regex1$&, &$regex2$&, etc"
13426 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13427 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13428 these variables contain the
13429 captured substrings identified by the regular expression.
13430 If the subject string was tainted then so will any captured substring.
13431
13432
13433 .tvar &$reply_address$&
13434 When a message is being processed, this variable contains the contents of the
13435 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13436 contents of the &'From:'& header line. Apart from the removal of leading
13437 white space, the value is not processed in any way. In particular, no RFC 2047
13438 decoding or character code translation takes place.
13439
13440 .vitem &$return_path$&
13441 .vindex "&$return_path$&"
13442 When a message is being delivered, this variable contains the return path &--
13443 the sender field that will be sent as part of the envelope. It is not enclosed
13444 in <> characters. At the start of routing an address, &$return_path$& has the
13445 same value as &$sender_address$&, but if, for example, an incoming message to a
13446 mailing list has been expanded by a router which specifies a different address
13447 for bounce messages, &$return_path$& subsequently contains the new bounce
13448 address, whereas &$sender_address$& always contains the original sender address
13449 that was received with the message. In other words, &$sender_address$& contains
13450 the incoming envelope sender, and &$return_path$& contains the outgoing
13451 envelope sender.
13452
13453 .vitem &$return_size_limit$&
13454 .vindex "&$return_size_limit$&"
13455 This is an obsolete name for &$bounce_return_size_limit$&.
13456
13457 .vitem &$router_name$&
13458 .cindex "router" "name"
13459 .cindex "name" "of router"
13460 .vindex "&$router_name$&"
13461 During the running of a router, or a transport called,
13462 this variable contains the router name.
13463
13464 .vitem &$runrc$&
13465 .cindex "return code" "from &%run%& expansion"
13466 .vindex "&$runrc$&"
13467 This variable contains the return code from a command that is run by the
13468 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13469 assume the order in which option values are expanded, except for those
13470 preconditions whose order of testing is documented. Therefore, you cannot
13471 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13472 another.
13473
13474 .vitem &$self_hostname$&
13475 .oindex "&%self%&" "value of host name"
13476 .vindex "&$self_hostname$&"
13477 When an address is routed to a supposedly remote host that turns out to be the
13478 local host, what happens is controlled by the &%self%& generic router option.
13479 One of its values causes the address to be passed to another router. When this
13480 happens, &$self_hostname$& is set to the name of the local host that the
13481 original router encountered. In other circumstances its contents are null.
13482
13483 .tvar &$sender_address$&
13484 When a message is being processed, this variable contains the sender's address
13485 that was received in the message's envelope. The case of letters in the address
13486 is retained, in both the local part and the domain. For bounce messages, the
13487 value of this variable is the empty string. See also &$return_path$&.
13488
13489 .vitem &$sender_address_data$&
13490 .vindex "&$address_data$&"
13491 .vindex "&$sender_address_data$&"
13492 If &$address_data$& is set when the routers are called from an ACL to verify a
13493 sender address, the final value is preserved in &$sender_address_data$&, to
13494 distinguish it from data from a recipient address. The value does not persist
13495 after the end of the current ACL statement. If you want to preserve it for
13496 longer, you can save it in an ACL variable.
13497
13498 .tvar &$sender_address_domain$&
13499 The domain portion of &$sender_address$&.
13500
13501 .tvar &$sender_address_local_part$&
13502 The local part portion of &$sender_address$&.
13503
13504 .vitem &$sender_data$&
13505 .vindex "&$sender_data$&"
13506 This variable is set after a lookup success in an ACL &%senders%& condition or
13507 in a router &%senders%& option. It contains the data from the lookup, and the
13508 value remains set until the next &%senders%& test. Thus, you can do things like
13509 this:
13510 .display
13511 &`require senders      = cdb*@;/some/file`&
13512 &`deny    `&&'some further test involving'& &`$sender_data`&
13513 .endd
13514 &*Warning*&: This variable is set only when a lookup is used as an indexing
13515 method in the address list, using the semicolon syntax as in the example above.
13516 The variable is not set for a lookup that is used as part of the string
13517 expansion that all such lists undergo before being interpreted.
13518
13519 .vitem &$sender_fullhost$&
13520 .vindex "&$sender_fullhost$&"
13521 When a message is received from a remote host, this variable contains the host
13522 name and IP address in a single string. It ends with the IP address in square
13523 brackets, followed by a colon and a port number if the logging of ports is
13524 enabled. The format of the rest of the string depends on whether the host
13525 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13526 looking up its IP address. (Looking up the IP address can be forced by the
13527 &%host_lookup%& option, independent of verification.) A plain host name at the
13528 start of the string is a verified host name; if this is not present,
13529 verification either failed or was not requested. A host name in parentheses is
13530 the argument of a HELO or EHLO command. This is omitted if it is identical to
13531 the verified host name or to the host's IP address in square brackets.
13532
13533 .vitem &$sender_helo_dnssec$&
13534 .vindex "&$sender_helo_dnssec$&"
13535 This boolean variable is true if a successful HELO verification was
13536 .cindex "DNS" "DNSSEC"
13537 done using DNS information the resolver library stated was authenticated data.
13538
13539 .tvar &$sender_helo_name$&
13540 When a message is received from a remote host that has issued a HELO or EHLO
13541 command, the argument of that command is placed in this variable. It is also
13542 set if HELO or EHLO is used when a message is received using SMTP locally via
13543 the &%-bs%& or &%-bS%& options.
13544
13545 .vitem &$sender_host_address$&
13546 .vindex "&$sender_host_address$&"
13547 When a message is received from a remote host using SMTP,
13548 this variable contains that
13549 host's IP address. For locally non-SMTP submitted messages, it is empty.
13550
13551 .vitem &$sender_host_authenticated$&
13552 .vindex "&$sender_host_authenticated$&"
13553 This variable contains the name (not the public name) of the authenticator
13554 driver that successfully authenticated the client from which the message was
13555 received. It is empty if there was no successful authentication. See also
13556 &$authenticated_id$&.
13557
13558 .vitem &$sender_host_dnssec$&
13559 .vindex "&$sender_host_dnssec$&"
13560 If an attempt to populate &$sender_host_name$& has been made
13561 (by reference, &%hosts_lookup%& or
13562 otherwise) then this boolean will have been set true if, and only if, the
13563 resolver library states that both
13564 the reverse and forward DNS were authenticated data.  At all
13565 other times, this variable is false.
13566
13567 .cindex "DNS" "DNSSEC"
13568 It is likely that you will need to coerce DNSSEC support on in the resolver
13569 library, by setting:
13570 .code
13571 dns_dnssec_ok = 1
13572 .endd
13573
13574 In addition, on Linux with glibc 2.31 or newer the resolver library will
13575 default to stripping out a successful validation status.
13576 This will break a previously working Exim installation.
13577 Provided that you do trust the resolver (ie, is on localhost) you can tell
13578 glibc to pass through any successful validation with a new option in
13579 &_/etc/resolv.conf_&:
13580 .code
13581 options trust-ad
13582 .endd
13583
13584 Exim does not perform DNSSEC validation itself, instead leaving that to a
13585 validating resolver (e.g. unbound, or bind with suitable configuration).
13586
13587 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13588 mechanism in the list, then this variable will be false.
13589
13590 This requires that your system resolver library support EDNS0 (and that
13591 DNSSEC flags exist in the system headers).  If the resolver silently drops
13592 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13593 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13594
13595
13596 .tvar &$sender_host_name$&
13597 When a message is received from a remote host, this variable contains the
13598 host's name as obtained by looking up its IP address. For messages received by
13599 other means, this variable is empty.
13600
13601 .vindex "&$host_lookup_failed$&"
13602 If the host name has not previously been looked up, a reference to
13603 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13604 A looked up name is accepted only if it leads back to the original IP address
13605 via a forward lookup. If either the reverse or the forward lookup fails to find
13606 any data, or if the forward lookup does not yield the original IP address,
13607 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13608
13609 .vindex "&$host_lookup_deferred$&"
13610 However, if either of the lookups cannot be completed (for example, there is a
13611 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13612 &$host_lookup_failed$& remains set to &"0"&.
13613
13614 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13615 host name again if there is a subsequent reference to &$sender_host_name$&
13616 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13617 is set to &"1"&.
13618
13619 Exim does not automatically look up every calling host's name. If you want
13620 maximum efficiency, you should arrange your configuration so that it avoids
13621 these lookups altogether. The lookup happens only if one or more of the
13622 following are true:
13623
13624 .ilist
13625 A string containing &$sender_host_name$& is expanded.
13626 .next
13627 The calling host matches the list in &%host_lookup%&. In the default
13628 configuration, this option is set to *, so it must be changed if lookups are
13629 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13630 .next
13631 Exim needs the host name in order to test an item in a host list. The items
13632 that require this are described in sections &<<SECThoslispatnam>>& and
13633 &<<SECThoslispatnamsk>>&.
13634 .next
13635 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13636 In this case, the host name is required to compare with the name quoted in any
13637 EHLO or HELO commands that the client issues.
13638 .next
13639 The remote host issues a EHLO or HELO command that quotes one of the
13640 domains in &%helo_lookup_domains%&. The default value of this option is
13641 . ==== As this is a nested list, any displays it contains must be indented
13642 . ==== as otherwise they are too far to the left.
13643 .code
13644   helo_lookup_domains = @ : @[]
13645 .endd
13646 which causes a lookup if a remote host (incorrectly) gives the server's name or
13647 IP address in an EHLO or HELO command.
13648 .endlist
13649
13650
13651 .vitem &$sender_host_port$&
13652 .vindex "&$sender_host_port$&"
13653 When a message is received from a remote host, this variable contains the port
13654 number that was used on the remote host.
13655
13656 .vitem &$sender_ident$&
13657 .vindex "&$sender_ident$&"
13658 When a message is received from a remote host, this variable contains the
13659 identification received in response to an RFC 1413 request. When a message has
13660 been received locally, this variable contains the login name of the user that
13661 called Exim.
13662
13663 .vitem &$sender_rate_$&&'xxx'&
13664 A number of variables whose names begin &$sender_rate_$& are set as part of the
13665 &%ratelimit%& ACL condition. Details are given in section
13666 &<<SECTratelimiting>>&.
13667
13668 .vitem &$sender_rcvhost$&
13669 .cindex "DNS" "reverse lookup"
13670 .cindex "reverse DNS lookup"
13671 .vindex "&$sender_rcvhost$&"
13672 This is provided specifically for use in &'Received:'& headers. It starts with
13673 either the verified host name (as obtained from a reverse DNS lookup) or, if
13674 there is no verified host name, the IP address in square brackets. After that
13675 there may be text in parentheses. When the first item is a verified host name,
13676 the first thing in the parentheses is the IP address in square brackets,
13677 followed by a colon and a port number if port logging is enabled. When the
13678 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13679 the parentheses.
13680
13681 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13682 was used and its argument was not identical to the real host name or IP
13683 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13684 all three items are present in the parentheses, a newline and tab are inserted
13685 into the string, to improve the formatting of the &'Received:'& header.
13686
13687 .vitem &$sender_verify_failure$&
13688 .vindex "&$sender_verify_failure$&"
13689 In an ACL, when a sender verification fails, this variable contains information
13690 about the failure. The details are the same as for
13691 &$recipient_verify_failure$&.
13692
13693 .vitem &$sending_ip_address$&
13694 .vindex "&$sending_ip_address$&"
13695 This variable is set whenever an outgoing SMTP connection to another host has
13696 been set up. It contains the IP address of the local interface that is being
13697 used. This is useful if a host that has more than one IP address wants to take
13698 on different personalities depending on which one is being used. For incoming
13699 connections, see &$received_ip_address$&.
13700
13701 .vitem &$sending_port$&
13702 .vindex "&$sending_port$&"
13703 This variable is set whenever an outgoing SMTP connection to another host has
13704 been set up. It contains the local port that is being used. For incoming
13705 connections, see &$received_port$&.
13706
13707 .vitem &$smtp_active_hostname$&
13708 .vindex "&$smtp_active_hostname$&"
13709 During an incoming SMTP session, this variable contains the value of the active
13710 host name, as specified by the &%smtp_active_hostname%& option. The value of
13711 &$smtp_active_hostname$& is saved with any message that is received, so its
13712 value can be consulted during routing and delivery.
13713
13714 .tvar &$smtp_command$&
13715 During the processing of an incoming SMTP command, this variable contains the
13716 entire command. This makes it possible to distinguish between HELO and EHLO in
13717 the HELO ACL, and also to distinguish between commands such as these:
13718 .code
13719 MAIL FROM:<>
13720 MAIL FROM: <>
13721 .endd
13722 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13723 command, the address in &$smtp_command$& is the original address before any
13724 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13725 the address after SMTP-time rewriting.
13726
13727 .tvar &$smtp_command_argument$&
13728 .cindex "SMTP" "command, argument for"
13729 While an ACL is running to check an SMTP command, this variable contains the
13730 argument, that is, the text that follows the command name, with leading white
13731 space removed. Following the introduction of &$smtp_command$&, this variable is
13732 somewhat redundant, but is retained for backwards compatibility.
13733
13734 .vitem &$smtp_command_history$&
13735 .cindex SMTP "command history"
13736 .vindex "&$smtp_command_history$&"
13737 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13738 received, in time-order left to right.  Only a limited number of commands
13739 are remembered.
13740
13741 .vitem &$smtp_count_at_connection_start$&
13742 .vindex "&$smtp_count_at_connection_start$&"
13743 This variable is set greater than zero only in processes spawned by the Exim
13744 daemon for handling incoming SMTP connections. The name is deliberately long,
13745 in order to emphasize what the contents are. When the daemon accepts a new
13746 connection, it increments this variable. A copy of the variable is passed to
13747 the child process that handles the connection, but its value is fixed, and
13748 never changes. It is only an approximation of how many incoming connections
13749 there actually are, because many other connections may come and go while a
13750 single connection is being processed. When a child process terminates, the
13751 daemon decrements its copy of the variable.
13752
13753 .vitem &$smtp_notquit_reason$&
13754 .vindex "&$smtp_notquit_reason$&"
13755 When the not-QUIT ACL is running, this variable is set to a string
13756 that indicates the reason for the termination of the SMTP connection.
13757
13758 .vitem "&$sn0$& &-- &$sn9$&"
13759 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13760 that were current at the end of the system filter file. This allows a system
13761 filter file to set values that can be tested in users' filter files. For
13762 example, a system filter could set a value indicating how likely it is that a
13763 message is junk mail.
13764
13765 .vitem &$spam_score$& &&&
13766        &$spam_score_int$& &&&
13767        &$spam_bar$& &&&
13768        &$spam_report$& &&&
13769        &$spam_action$&
13770 A number of variables whose names start with &$spam$& are available when Exim
13771 is compiled with the content-scanning extension. For details, see section
13772 &<<SECTscanspamass>>&.
13773
13774 .vitem &$spf_header_comment$& &&&
13775        &$spf_received$& &&&
13776        &$spf_result$& &&&
13777        &$spf_result_guessed$& &&&
13778        &$spf_smtp_comment$&
13779 These variables are only available if Exim is built with SPF support.
13780 For details see section &<<SECSPF>>&.
13781
13782 .vitem &$spool_directory$&
13783 .vindex "&$spool_directory$&"
13784 The name of Exim's spool directory.
13785
13786 .vitem &$spool_inodes$&
13787 .vindex "&$spool_inodes$&"
13788 The number of free inodes in the disk partition where Exim's spool files are
13789 being written. The value is recalculated whenever the variable is referenced.
13790 If the relevant file system does not have the concept of inodes, the value of
13791 is -1. See also the &%check_spool_inodes%& option.
13792
13793 .vitem &$spool_space$&
13794 .vindex "&$spool_space$&"
13795 The amount of free space (as a number of kilobytes) in the disk partition where
13796 Exim's spool files are being written. The value is recalculated whenever the
13797 variable is referenced. If the operating system does not have the ability to
13798 find the amount of free space (only true for experimental systems), the space
13799 value is -1. For example, to check in an ACL that there is at least 50
13800 megabytes free on the spool, you could write:
13801 .code
13802 condition = ${if > {$spool_space}{50000}}
13803 .endd
13804 See also the &%check_spool_space%& option.
13805
13806
13807 .vitem &$thisaddress$&
13808 .vindex "&$thisaddress$&"
13809 This variable is set only during the processing of the &%foranyaddress%&
13810 command in a filter file. Its use is explained in the description of that
13811 command, which can be found in the separate document entitled &'Exim's
13812 interfaces to mail filtering'&.
13813
13814 .vitem &$tls_in_bits$&
13815 .vindex "&$tls_in_bits$&"
13816 Contains an approximation of the TLS cipher's bit-strength
13817 on the inbound connection; the meaning of
13818 this depends upon the TLS implementation used.
13819 If TLS has not been negotiated, the value will be 0.
13820 The value of this is automatically fed into the Cyrus SASL authenticator
13821 when acting as a server, to specify the "external SSF" (a SASL term).
13822
13823 The deprecated &$tls_bits$& variable refers to the inbound side
13824 except when used in the context of an outbound SMTP delivery, when it refers to
13825 the outbound.
13826
13827 .vitem &$tls_out_bits$&
13828 .vindex "&$tls_out_bits$&"
13829 Contains an approximation of the TLS cipher's bit-strength
13830 on an outbound SMTP connection; the meaning of
13831 this depends upon the TLS implementation used.
13832 If TLS has not been negotiated, the value will be 0.
13833
13834 .vitem &$tls_in_ourcert$&
13835 .vindex "&$tls_in_ourcert$&"
13836 .cindex certificate variables
13837 This variable refers to the certificate presented to the peer of an
13838 inbound connection when the message was received.
13839 It is only useful as the argument of a
13840 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13841 or a &%def%& condition.
13842
13843 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13844 when a list of more than one
13845 file is used for &%tls_certificate%&, this variable is not reliable.
13846 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13847
13848 .vitem &$tls_in_peercert$&
13849 .vindex "&$tls_in_peercert$&"
13850 This variable refers to the certificate presented by the peer of an
13851 inbound connection when the message was received.
13852 It is only useful as the argument of a
13853 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13854 or a &%def%& condition.
13855 If certificate verification fails it may refer to a failing chain element
13856 which is not the leaf.
13857
13858 .vitem &$tls_out_ourcert$&
13859 .vindex "&$tls_out_ourcert$&"
13860 This variable refers to the certificate presented to the peer of an
13861 outbound connection.  It is only useful as the argument of a
13862 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13863 or a &%def%& condition.
13864
13865 .vitem &$tls_out_peercert$&
13866 .vindex "&$tls_out_peercert$&"
13867 This variable refers to the certificate presented by the peer of an
13868 outbound connection.  It is only useful as the argument of a
13869 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13870 or a &%def%& condition.
13871 If certificate verification fails it may refer to a failing chain element
13872 which is not the leaf.
13873
13874 .vitem &$tls_in_certificate_verified$&
13875 .vindex "&$tls_in_certificate_verified$&"
13876 This variable is set to &"1"& if a TLS certificate was verified when the
13877 message was received, and &"0"& otherwise.
13878
13879 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13880 except when used in the context of an outbound SMTP delivery, when it refers to
13881 the outbound.
13882
13883 .vitem &$tls_out_certificate_verified$&
13884 .vindex "&$tls_out_certificate_verified$&"
13885 This variable is set to &"1"& if a TLS certificate was verified when an
13886 outbound SMTP connection was made,
13887 and &"0"& otherwise.
13888
13889 .vitem &$tls_in_cipher$&
13890 .vindex "&$tls_in_cipher$&"
13891 .vindex "&$tls_cipher$&"
13892 When a message is received from a remote host over an encrypted SMTP
13893 connection, this variable is set to the cipher suite that was negotiated, for
13894 example DES-CBC3-SHA. In other circumstances, in particular, for message
13895 received over unencrypted connections, the variable is empty. Testing
13896 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13897 non-encrypted connections during ACL processing.
13898
13899 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13900 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13901 becomes the same as &$tls_out_cipher$&.
13902
13903 .vitem &$tls_in_cipher_std$&
13904 .vindex "&$tls_in_cipher_std$&"
13905 As above, but returning the RFC standard name for the cipher suite.
13906
13907 .vitem &$tls_out_cipher$&
13908 .vindex "&$tls_out_cipher$&"
13909 This variable is
13910 cleared before any outgoing SMTP connection is made,
13911 and then set to the outgoing cipher suite if one is negotiated. See chapter
13912 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13913 details of the &(smtp)& transport.
13914
13915 .vitem &$tls_out_cipher_std$&
13916 .vindex "&$tls_out_cipher_std$&"
13917 As above, but returning the RFC standard name for the cipher suite.
13918
13919 .vitem &$tls_out_dane$&
13920 .vindex &$tls_out_dane$&
13921 DANE active status.  See section &<<SECDANE>>&.
13922
13923 .vitem &$tls_in_ocsp$&
13924 .vindex "&$tls_in_ocsp$&"
13925 When a message is received from a remote client connection
13926 the result of any OCSP request from the client is encoded in this variable:
13927 .code
13928 0 OCSP proof was not requested (default value)
13929 1 No response to request
13930 2 Response not verified
13931 3 Verification failed
13932 4 Verification succeeded
13933 .endd
13934
13935 .vitem &$tls_out_ocsp$&
13936 .vindex "&$tls_out_ocsp$&"
13937 When a message is sent to a remote host connection
13938 the result of any OCSP request made is encoded in this variable.
13939 See &$tls_in_ocsp$& for values.
13940
13941 .vitem &$tls_in_peerdn$&
13942 .vindex "&$tls_in_peerdn$&"
13943 .vindex "&$tls_peerdn$&"
13944 .cindex certificate "extracting fields"
13945 When a message is received from a remote host over an encrypted SMTP
13946 connection, and Exim is configured to request a certificate from the client,
13947 the value of the Distinguished Name of the certificate is made available in the
13948 &$tls_in_peerdn$& during subsequent processing.
13949 If certificate verification fails it may refer to a failing chain element
13950 which is not the leaf.
13951
13952 The deprecated &$tls_peerdn$& variable refers to the inbound side
13953 except when used in the context of an outbound SMTP delivery, when it refers to
13954 the outbound.
13955
13956 .vitem &$tls_out_peerdn$&
13957 .vindex "&$tls_out_peerdn$&"
13958 When a message is being delivered to a remote host over an encrypted SMTP
13959 connection, and Exim is configured to request a certificate from the server,
13960 the value of the Distinguished Name of the certificate is made available in the
13961 &$tls_out_peerdn$& during subsequent processing.
13962 If certificate verification fails it may refer to a failing chain element
13963 which is not the leaf.
13964
13965
13966 .vitem &$tls_in_resumption$& &&&
13967        &$tls_out_resumption$&
13968 .vindex &$tls_in_resumption$&
13969 .vindex &$tls_out_resumption$&
13970 .cindex TLS resumption
13971 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13972
13973
13974 .tvar &$tls_in_sni$&
13975 .vindex "&$tls_sni$&"
13976 .cindex "TLS" "Server Name Indication"
13977 .cindex "TLS" SNI
13978 .cindex SNI "observability on server"
13979 When a TLS session is being established, if the client sends the Server
13980 Name Indication extension, the value will be placed in this variable.
13981 If the variable appears in &%tls_certificate%& then this option and
13982 some others, described in &<<SECTtlssni>>&,
13983 will be re-expanded early in the TLS session, to permit
13984 a different certificate to be presented (and optionally a different key to be
13985 used) to the client, based upon the value of the SNI extension.
13986
13987 The deprecated &$tls_sni$& variable refers to the inbound side
13988 except when used in the context of an outbound SMTP delivery, when it refers to
13989 the outbound.
13990
13991 .vitem &$tls_out_sni$&
13992 .vindex "&$tls_out_sni$&"
13993 .cindex "TLS" "Server Name Indication"
13994 .cindex "TLS" SNI
13995 .cindex SNI "observability in client"
13996 During outbound
13997 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13998 the transport.
13999
14000 .vitem &$tls_out_tlsa_usage$&
14001 .vindex &$tls_out_tlsa_usage$&
14002 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14003
14004 .vitem &$tls_in_ver$&
14005 .vindex "&$tls_in_ver$&"
14006 When a message is received from a remote host over an encrypted SMTP connection
14007 this variable is set to the protocol version, eg &'TLS1.2'&.
14008
14009 .vitem &$tls_out_ver$&
14010 .vindex "&$tls_out_ver$&"
14011 When a message is being delivered to a remote host over an encrypted SMTP connection
14012 this variable is set to the protocol version.
14013
14014
14015 .vitem &$tod_bsdinbox$&
14016 .vindex "&$tod_bsdinbox$&"
14017 The time of day and the date, in the format required for BSD-style mailbox
14018 files, for example: Thu Oct 17 17:14:09 1995.
14019
14020 .vitem &$tod_epoch$&
14021 .vindex "&$tod_epoch$&"
14022 The time and date as a number of seconds since the start of the Unix epoch.
14023
14024 .vitem &$tod_epoch_l$&
14025 .vindex "&$tod_epoch_l$&"
14026 The time and date as a number of microseconds since the start of the Unix epoch.
14027
14028 .vitem &$tod_full$&
14029 .vindex "&$tod_full$&"
14030 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14031 +0100. The timezone is always given as a numerical offset from UTC, with
14032 positive values used for timezones that are ahead (east) of UTC, and negative
14033 values for those that are behind (west).
14034
14035 .vitem &$tod_log$&
14036 .vindex "&$tod_log$&"
14037 The time and date in the format used for writing Exim's log files, for example:
14038 1995-10-12 15:32:29, but without a timezone.
14039
14040 .vitem &$tod_logfile$&
14041 .vindex "&$tod_logfile$&"
14042 This variable contains the date in the format yyyymmdd. This is the format that
14043 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14044 flag.
14045
14046 .vitem &$tod_zone$&
14047 .vindex "&$tod_zone$&"
14048 This variable contains the numerical value of the local timezone, for example:
14049 -0500.
14050
14051 .vitem &$tod_zulu$&
14052 .vindex "&$tod_zulu$&"
14053 This variable contains the UTC date and time in &"Zulu"& format, as specified
14054 by ISO 8601, for example: 20030221154023Z.
14055
14056 .vitem &$transport_name$&
14057 .cindex "transport" "name"
14058 .cindex "name" "of transport"
14059 .vindex "&$transport_name$&"
14060 During the running of a transport, this variable contains its name.
14061
14062 .vitem &$value$&
14063 .vindex "&$value$&"
14064 This variable contains the result of an expansion lookup, extraction operation,
14065 or external command, as described above. It is also used during a
14066 &*reduce*& expansion.
14067
14068 .vitem &$verify_mode$&
14069 .vindex "&$verify_mode$&"
14070 While a router or transport is being run in verify mode or for cutthrough delivery,
14071 contains "S" for sender-verification or "R" for recipient-verification.
14072 Otherwise, empty.
14073
14074 .vitem &$version_number$&
14075 .vindex "&$version_number$&"
14076 The version number of Exim. Same as &$exim_version$&, may be overridden
14077 by the &%exim_version%& main config option.
14078
14079 .vitem &$warn_message_delay$&
14080 .vindex "&$warn_message_delay$&"
14081 This variable is set only during the creation of a message warning about a
14082 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14083
14084 .vitem &$warn_message_recipients$&
14085 .vindex "&$warn_message_recipients$&"
14086 This variable is set only during the creation of a message warning about a
14087 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14088 .endlist
14089 .ecindex IIDstrexp
14090
14091
14092
14093 . ////////////////////////////////////////////////////////////////////////////
14094 . ////////////////////////////////////////////////////////////////////////////
14095
14096 .chapter "Embedded Perl" "CHAPperl"
14097 .scindex IIDperl "Perl" "calling from Exim"
14098 Exim can be built to include an embedded Perl interpreter. When this is done,
14099 Perl subroutines can be called as part of the string expansion process. To make
14100 use of the Perl support, you need version 5.004 or later of Perl installed on
14101 your system. To include the embedded interpreter in the Exim binary, include
14102 the line
14103 .code
14104 EXIM_PERL = perl.o
14105 .endd
14106 in your &_Local/Makefile_& and then build Exim in the normal way.
14107
14108
14109 .section "Setting up so Perl can be used" "SECID85"
14110 .oindex "&%perl_startup%&"
14111 Access to Perl subroutines is via a global configuration option called
14112 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14113 no &%perl_startup%& option in the Exim configuration file then no Perl
14114 interpreter is started and there is almost no overhead for Exim (since none of
14115 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14116 option then the associated value is taken to be Perl code which is executed in
14117 a newly created Perl interpreter.
14118
14119 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14120 need backslashes before any characters to escape special meanings. The option
14121 should usually be something like
14122 .code
14123 perl_startup = do '/etc/exim.pl'
14124 .endd
14125 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14126 use from Exim. Exim can be configured either to start up a Perl interpreter as
14127 soon as it is entered, or to wait until the first time it is needed. Starting
14128 the interpreter at the beginning ensures that it is done while Exim still has
14129 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14130 fact used in a particular run. Also, note that this does not mean that Exim is
14131 necessarily running as root when Perl is called at a later time. By default,
14132 the interpreter is started only when it is needed, but this can be changed in
14133 two ways:
14134
14135 .ilist
14136 .oindex "&%perl_at_start%&"
14137 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14138 a startup when Exim is entered.
14139 .next
14140 The command line option &%-ps%& also requests a startup when Exim is entered,
14141 overriding the setting of &%perl_at_start%&.
14142 .endlist
14143
14144 There is also a command line option &%-pd%& (for delay) which suppresses the
14145 initial startup, even if &%perl_at_start%& is set.
14146
14147 .ilist
14148 .oindex "&%perl_taintmode%&"
14149 .cindex "Perl" "taintmode"
14150 To provide more security executing Perl code via the embedded Perl
14151 interpreter, the &%perl_taintmode%& option can be set. This enables the
14152 taint mode of the Perl interpreter. You are encouraged to set this
14153 option to a true value. To avoid breaking existing installations, it
14154 defaults to false.
14155
14156 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14157
14158
14159 .section "Calling Perl subroutines" "SECID86"
14160 When the configuration file includes a &%perl_startup%& option you can make use
14161 of the string expansion item to call the Perl subroutines that are defined
14162 by the &%perl_startup%& code. The operator is used in any of the following
14163 forms:
14164 .code
14165 ${perl{foo}}
14166 ${perl{foo}{argument}}
14167 ${perl{foo}{argument1}{argument2} ... }
14168 .endd
14169 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14170 arguments may be passed. Passing more than this results in an expansion failure
14171 with an error message of the form
14172 .code
14173 Too many arguments passed to Perl subroutine "foo" (max is 8)
14174 .endd
14175 The return value of the Perl subroutine is evaluated in a scalar context before
14176 it is passed back to Exim to be inserted into the expanded string. If the
14177 return value is &'undef'&, the expansion is forced to fail in the same way as
14178 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14179 by obeying Perl's &%die%& function, the expansion fails with the error message
14180 that was passed to &%die%&.
14181
14182
14183 .section "Calling Exim functions from Perl" "SECID87"
14184 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14185 is available to call back into Exim's string expansion function. For example,
14186 the Perl code
14187 .code
14188 my $lp = Exim::expand_string('$local_part');
14189 .endd
14190 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14191 Note those are single quotes and not double quotes to protect against
14192 &$local_part$& being interpolated as a Perl variable.
14193
14194 If the string expansion is forced to fail by a &"fail"& item, the result of
14195 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14196 expansion string, the Perl call from the original expansion string fails with
14197 an appropriate error message, in the same way as if &%die%& were used.
14198
14199 .cindex "debugging" "from embedded Perl"
14200 .cindex "log" "writing from embedded Perl"
14201 Two other Exim functions are available for use from within Perl code.
14202 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14203 debugging is enabled. If you want a newline at the end, you must supply it.
14204 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14205 timestamp. In this case, you should not supply a terminating newline.
14206
14207
14208 .section "Use of standard output and error by Perl" "SECID88"
14209 .cindex "Perl" "standard output and error"
14210 You should not write to the standard error or output streams from within your
14211 Perl code, as it is not defined how these are set up. In versions of Exim
14212 before 4.50, it is possible for the standard output or error to refer to the
14213 SMTP connection during message reception via the daemon. Writing to this stream
14214 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14215 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14216 avoided, but the output is lost.
14217
14218 .cindex "Perl" "use of &%warn%&"
14219 The Perl &%warn%& statement writes to the standard error stream by default.
14220 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14221 you have no control. When Exim starts up the Perl interpreter, it arranges for
14222 output from the &%warn%& statement to be written to the Exim main log. You can
14223 change this by including appropriate Perl magic somewhere in your Perl code.
14224 For example, to discard &%warn%& output completely, you need this:
14225 .code
14226 $SIG{__WARN__} = sub { };
14227 .endd
14228 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14229 example, the code for the subroutine is empty, so it does nothing, but you can
14230 include any Perl code that you like. The text of the &%warn%& message is passed
14231 as the first subroutine argument.
14232 .ecindex IIDperl
14233
14234
14235 . ////////////////////////////////////////////////////////////////////////////
14236 . ////////////////////////////////////////////////////////////////////////////
14237
14238 .chapter "Starting the daemon and the use of network interfaces" &&&
14239          "CHAPinterfaces" &&&
14240          "Starting the daemon"
14241 .cindex "daemon" "starting"
14242 .cindex "interface" "listening"
14243 .cindex "network interface"
14244 .cindex "interface" "network"
14245 .cindex "IP address" "for listening"
14246 .cindex "daemon" "listening IP addresses"
14247 .cindex "TCP/IP" "setting listening interfaces"
14248 .cindex "TCP/IP" "setting listening ports"
14249 A host that is connected to a TCP/IP network may have one or more physical
14250 hardware network interfaces. Each of these interfaces may be configured as one
14251 or more &"logical"& interfaces, which are the entities that a program actually
14252 works with. Each of these logical interfaces is associated with an IP address.
14253 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14254 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14255 knowledge about the host's interfaces for use in three different circumstances:
14256
14257 .olist
14258 When a listening daemon is started, Exim needs to know which interfaces
14259 and ports to listen on.
14260 .next
14261 When Exim is routing an address, it needs to know which IP addresses
14262 are associated with local interfaces. This is required for the correct
14263 processing of MX lists by removing the local host and others with the
14264 same or higher priority values. Also, Exim needs to detect cases
14265 when an address is routed to an IP address that in fact belongs to the
14266 local host. Unless the &%self%& router option or the &%allow_localhost%&
14267 option of the smtp transport is set (as appropriate), this is treated
14268 as an error situation.
14269 .next
14270 When Exim connects to a remote host, it may need to know which interface to use
14271 for the outgoing connection.
14272 .endlist
14273
14274
14275 Exim's default behaviour is likely to be appropriate in the vast majority
14276 of cases. If your host has only one interface, and you want all its IP
14277 addresses to be treated in the same way, and you are using only the
14278 standard SMTP port, you should not need to take any special action. The
14279 rest of this chapter does not apply to you.
14280
14281 In a more complicated situation you may want to listen only on certain
14282 interfaces, or on different ports, and for this reason there are a number of
14283 options that can be used to influence Exim's behaviour. The rest of this
14284 chapter describes how they operate.
14285
14286 When a message is received over TCP/IP, the interface and port that were
14287 actually used are set in &$received_ip_address$& and &$received_port$&.
14288
14289
14290
14291 .section "Starting a listening daemon" "SECID89"
14292 When a listening daemon is started (by means of the &%-bd%& command line
14293 option), the interfaces and ports on which it listens are controlled by the
14294 following options:
14295
14296 .ilist
14297 &%daemon_smtp_ports%& contains a list of default ports
14298 or service names.
14299 (For backward compatibility, this option can also be specified in the singular.)
14300 .next
14301 &%local_interfaces%& contains list of interface IP addresses on which to
14302 listen. Each item may optionally also specify a port.
14303 .endlist
14304
14305 The default list separator in both cases is a colon, but this can be changed as
14306 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14307 it is usually best to change the separator to avoid having to double all the
14308 colons. For example:
14309 .code
14310 local_interfaces = <; 127.0.0.1 ; \
14311                       192.168.23.65 ; \
14312                       ::1 ; \
14313                       3ffe:ffff:836f::fe86:a061
14314 .endd
14315 There are two different formats for specifying a port along with an IP address
14316 in &%local_interfaces%&:
14317
14318 .olist
14319 The port is added onto the address with a dot separator. For example, to listen
14320 on port 1234 on two different IP addresses:
14321 .code
14322 local_interfaces = <; 192.168.23.65.1234 ; \
14323                       3ffe:ffff:836f::fe86:a061.1234
14324 .endd
14325 .next
14326 The IP address is enclosed in square brackets, and the port is added
14327 with a colon separator, for example:
14328 .code
14329 local_interfaces = <; [192.168.23.65]:1234 ; \
14330                       [3ffe:ffff:836f::fe86:a061]:1234
14331 .endd
14332 .endlist
14333
14334 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14335 default setting contains just one port:
14336 .code
14337 daemon_smtp_ports = smtp
14338 .endd
14339 If more than one port is listed, each interface that does not have its own port
14340 specified listens on all of them. Ports that are listed in
14341 &%daemon_smtp_ports%& can be identified either by name (defined in
14342 &_/etc/services_&) or by number. However, when ports are given with individual
14343 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14344
14345
14346
14347 .section "Special IP listening addresses" "SECID90"
14348 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14349 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14350 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14351 instead of setting up separate listening sockets for each interface. The
14352 default value of &%local_interfaces%& is
14353 .code
14354 local_interfaces = 0.0.0.0
14355 .endd
14356 when Exim is built without IPv6 support; otherwise it is:
14357 .code
14358 local_interfaces = <; ::0 ; 0.0.0.0
14359 .endd
14360 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14361
14362
14363
14364 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14365 The &%-oX%& command line option can be used to override the values of
14366 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14367 instance. Another way of doing this would be to use macros and the &%-D%&
14368 option. However, &%-oX%& can be used by any admin user, whereas modification of
14369 the runtime configuration by &%-D%& is allowed only when the caller is root or
14370 exim.
14371
14372 The value of &%-oX%& is a list of items. The default colon separator can be
14373 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14374 If there are any items that do not
14375 contain dots or colons (that is, are not IP addresses), the value of
14376 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14377 items that do contain dots or colons, the value of &%local_interfaces%& is
14378 replaced by those items. Thus, for example,
14379 .code
14380 -oX 1225
14381 .endd
14382 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14383 whereas
14384 .code
14385 -oX 192.168.34.5.1125
14386 .endd
14387 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14388 (However, since &%local_interfaces%& now contains no items without ports, the
14389 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14390
14391
14392
14393 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14394 .cindex "submissions protocol"
14395 .cindex "ssmtp protocol"
14396 .cindex "smtps protocol"
14397 .cindex "SMTP" "ssmtp protocol"
14398 .cindex "SMTP" "smtps protocol"
14399 Exim supports the use of TLS-on-connect, used by mail clients in the
14400 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14401 For some years, IETF Standards Track documents only blessed the
14402 STARTTLS-based Submission service (port 587) while common practice was to support
14403 the same feature set on port 465, but using TLS-on-connect.
14404 If your installation needs to provide service to mail clients
14405 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14406 the 465 TCP ports.
14407
14408 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14409 service names, connections to those ports must first establish TLS, before
14410 proceeding to the application layer use of the SMTP protocol.
14411
14412 The common use of this option is expected to be
14413 .code
14414 tls_on_connect_ports = 465
14415 .endd
14416 per RFC 8314.
14417 There is also a command line option &%-tls-on-connect%&, which forces all ports
14418 to behave in this way when a daemon is started.
14419
14420 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14421 daemon to listen on those ports. You must still specify them in
14422 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14423 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14424 connections via the daemon.)
14425
14426
14427
14428
14429 .section "IPv6 address scopes" "SECID92"
14430 .cindex "IPv6" "address scopes"
14431 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14432 can, in principle, have the same link-local IPv6 address on different
14433 interfaces. Thus, additional information is needed, over and above the IP
14434 address, to distinguish individual interfaces. A convention of using a
14435 percent sign followed by something (often the interface name) has been
14436 adopted in some cases, leading to addresses like this:
14437 .code
14438 fe80::202:b3ff:fe03:45c1%eth0
14439 .endd
14440 To accommodate this usage, a percent sign followed by an arbitrary string is
14441 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14442 to convert a textual IPv6 address for actual use. This function recognizes the
14443 percent convention in operating systems that support it, and it processes the
14444 address appropriately. Unfortunately, some older libraries have problems with
14445 &[getaddrinfo()]&. If
14446 .code
14447 IPV6_USE_INET_PTON=yes
14448 .endd
14449 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14450 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14451 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14452 function.) Of course, this means that the additional functionality of
14453 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14454
14455 .section "Disabling IPv6" "SECID93"
14456 .cindex "IPv6" "disabling"
14457 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14458 run on a host whose kernel does not support IPv6. The binary will fall back to
14459 using IPv4, but it may waste resources looking up AAAA records, and trying to
14460 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14461 .oindex "&%disable_ipv6%&"
14462 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14463 activities take place. AAAA records are never looked up, and any IPv6 addresses
14464 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14465 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14466 to handle IPv6 literal addresses.
14467
14468 On the other hand, when IPv6 is in use, there may be times when you want to
14469 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14470 option to globally suppress the lookup of AAAA records for specified domains,
14471 and you can use the &%ignore_target_hosts%& generic router option to ignore
14472 IPv6 addresses in an individual router.
14473
14474
14475
14476 .section "Examples of starting a listening daemon" "SECID94"
14477 The default case in an IPv6 environment is
14478 .code
14479 daemon_smtp_ports = smtp
14480 local_interfaces = <; ::0 ; 0.0.0.0
14481 .endd
14482 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14483 Either one or two sockets may be used, depending on the characteristics of
14484 the TCP/IP stack. (This is complicated and messy; for more information,
14485 read the comments in the &_daemon.c_& source file.)
14486
14487 To specify listening on ports 25 and 26 on all interfaces:
14488 .code
14489 daemon_smtp_ports = 25 : 26
14490 .endd
14491 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14492 .code
14493 local_interfaces = <; ::0.25     ; ::0.26 \
14494                       0.0.0.0.25 ; 0.0.0.0.26
14495 .endd
14496 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14497 IPv4 loopback address only:
14498 .code
14499 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14500 .endd
14501 To specify listening on the default port on specific interfaces only:
14502 .code
14503 local_interfaces = 10.0.0.67 : 192.168.34.67
14504 .endd
14505 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14506
14507
14508
14509 .section "Recognizing the local host" "SECTreclocipadd"
14510 The &%local_interfaces%& option is also used when Exim needs to determine
14511 whether or not an IP address refers to the local host. That is, the IP
14512 addresses of all the interfaces on which a daemon is listening are always
14513 treated as local.
14514
14515 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14516 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14517 available interfaces from the operating system, and extracts the relevant
14518 (that is, IPv4 or IPv6) addresses to use for checking.
14519
14520 Some systems set up large numbers of virtual interfaces in order to provide
14521 many virtual web servers. In this situation, you may want to listen for
14522 email on only a few of the available interfaces, but nevertheless treat all
14523 interfaces as local when routing. You can do this by setting
14524 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14525 &"all"& wildcard values. These addresses are recognized as local, but are not
14526 used for listening. Consider this example:
14527 .code
14528 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14529                       192.168.53.235 ; \
14530                       3ffe:2101:12:1:a00:20ff:fe86:a061
14531
14532 extra_local_interfaces = <; ::0 ; 0.0.0.0
14533 .endd
14534 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14535 address, but all available interface addresses are treated as local when
14536 Exim is routing.
14537
14538 In some environments the local host name may be in an MX list, but with an IP
14539 address that is not assigned to any local interface. In other cases it may be
14540 desirable to treat other host names as if they referred to the local host. Both
14541 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14542 This contains host names rather than IP addresses. When a host is referenced
14543 during routing, either via an MX record or directly, it is treated as the local
14544 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14545 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14546
14547
14548
14549 .section "Delivering to a remote host" "SECID95"
14550 Delivery to a remote host is handled by the smtp transport. By default, it
14551 allows the system's TCP/IP functions to choose which interface to use (if
14552 there is more than one) when connecting to a remote host. However, the
14553 &%interface%& option can be set to specify which interface is used. See the
14554 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14555 details.
14556
14557
14558
14559
14560 . ////////////////////////////////////////////////////////////////////////////
14561 . ////////////////////////////////////////////////////////////////////////////
14562
14563 .chapter "Main configuration" "CHAPmainconfig"
14564 .scindex IIDconfima "configuration file" "main section"
14565 .scindex IIDmaiconf "main configuration"
14566 The first part of the runtime configuration file contains three types of item:
14567
14568 .ilist
14569 Macro definitions: These lines start with an upper case letter. See section
14570 &<<SECTmacrodefs>>& for details of macro processing.
14571 .next
14572 Named list definitions: These lines start with one of the words &"domainlist"&,
14573 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14574 section &<<SECTnamedlists>>&.
14575 .next
14576 Main configuration settings: Each setting occupies one line of the file
14577 (with possible continuations). If any setting is preceded by the word
14578 &"hide"&, the &%-bP%& command line option displays its value to admin users
14579 only. See section &<<SECTcos>>& for a description of the syntax of these option
14580 settings.
14581 .endlist
14582
14583 This chapter specifies all the main configuration options, along with their
14584 types and default values. For ease of finding a particular option, they appear
14585 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14586 are now so many options, they are first listed briefly in functional groups, as
14587 an aid to finding the name of the option you are looking for. Some options are
14588 listed in more than one group.
14589
14590 .section "Miscellaneous" "SECID96"
14591 .table2
14592 .row &%add_environment%&             "environment variables"
14593 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14594 .row &%debug_store%&                 "do extra internal checks"
14595 .row &%disable_ipv6%&                "do no IPv6 processing"
14596 .row &%keep_environment%&            "environment variables"
14597 .row &%keep_malformed%&              "for broken files &-- should not happen"
14598 .row &%localhost_number%&            "for unique message ids in clusters"
14599 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14600 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14601 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14602 .row &%print_topbitchars%&           "top-bit characters are printing"
14603 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14604 .row &%timezone%&                    "force time zone"
14605 .endtable
14606
14607
14608 .section "Exim parameters" "SECID97"
14609 .table2
14610 .row &%exim_group%&                  "override compiled-in value"
14611 .row &%exim_path%&                   "override compiled-in value"
14612 .row &%exim_user%&                   "override compiled-in value"
14613 .row &%primary_hostname%&            "default from &[uname()]&"
14614 .row &%split_spool_directory%&       "use multiple directories"
14615 .row &%spool_directory%&             "override compiled-in value"
14616 .endtable
14617
14618
14619
14620 .section "Privilege controls" "SECID98"
14621 .table2
14622 .row &%admin_groups%&                "groups that are Exim admin users"
14623 .row &%commandline_checks_require_admin%& "require admin for various checks"
14624 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14625 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14626 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14627 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14628 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14629 .row &%never_users%&                 "do not run deliveries as these"
14630 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14631 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14632 .row &%trusted_groups%&              "groups that are trusted"
14633 .row &%trusted_users%&               "users that are trusted"
14634 .endtable
14635
14636
14637
14638 .section "Logging" "SECID99"
14639 .table2
14640 .row &%event_action%&                "custom logging"
14641 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14642 .row &%log_file_path%&               "override compiled-in value"
14643 .row &%log_selector%&                "set/unset optional logging"
14644 .row &%log_timezone%&                "add timezone to log lines"
14645 .row &%message_logs%&                "create per-message logs"
14646 .row &%preserve_message_logs%&       "after message completion"
14647 .row &%panic_coredump%&              "request coredump on fatal errors"
14648 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14649 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14650 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14651 .row &%syslog_facility%&             "set syslog &""facility""& field"
14652 .row &%syslog_pid%&                  "pid in syslog lines"
14653 .row &%syslog_processname%&          "set syslog &""ident""& field"
14654 .row &%syslog_timestamp%&            "timestamp syslog lines"
14655 .row &%write_rejectlog%&             "control use of message log"
14656 .endtable
14657
14658
14659
14660 .section "Frozen messages" "SECID100"
14661 .table2
14662 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14663 .row &%freeze_tell%&                 "send message when freezing"
14664 .row &%move_frozen_messages%&        "to another directory"
14665 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14666 .endtable
14667
14668
14669
14670 .section "Data lookups" "SECID101"
14671 .table2
14672 .row &%ibase_servers%&               "InterBase servers"
14673 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14674 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14675 .row &%ldap_cert_file%&              "client cert file for LDAP"
14676 .row &%ldap_cert_key%&               "client key file for LDAP"
14677 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14678 .row &%ldap_default_servers%&        "used if no server in query"
14679 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14680 .row &%ldap_start_tls%&              "require TLS within LDAP"
14681 .row &%ldap_version%&                "set protocol version"
14682 .row &%lookup_open_max%&             "lookup files held open"
14683 .row &%mysql_servers%&               "default MySQL servers"
14684 .row &%oracle_servers%&              "Oracle servers"
14685 .row &%pgsql_servers%&               "default PostgreSQL servers"
14686 .row &%sqlite_lock_timeout%&         "as it says"
14687 .endtable
14688
14689
14690
14691 .section "Message ids" "SECID102"
14692 .table2
14693 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14694 .row &%message_id_header_text%&      "ditto"
14695 .endtable
14696
14697
14698
14699 .section "Embedded Perl Startup" "SECID103"
14700 .table2
14701 .row &%perl_at_start%&               "always start the interpreter"
14702 .row &%perl_startup%&                "code to obey when starting Perl"
14703 .row &%perl_taintmode%&              "enable taint mode in Perl"
14704 .endtable
14705
14706
14707
14708 .section "Daemon" "SECID104"
14709 .table2
14710 .row &%daemon_smtp_ports%&           "default ports"
14711 .row &%daemon_startup_retries%&      "number of times to retry"
14712 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14713 .row &%extra_local_interfaces%&      "not necessarily listened on"
14714 .row &%local_interfaces%&            "on which to listen, with optional ports"
14715 .row &%notifier_socket%&             "override compiled-in value"
14716 .row &%pid_file_path%&               "override compiled-in value"
14717 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14718 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14719 .endtable
14720
14721
14722
14723 .section "Resource control" "SECID105"
14724 .table2
14725 .row &%check_log_inodes%&            "before accepting a message"
14726 .row &%check_log_space%&             "before accepting a message"
14727 .row &%check_spool_inodes%&          "before accepting a message"
14728 .row &%check_spool_space%&           "before accepting a message"
14729 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14730 .row &%queue_only_load%&             "queue incoming if load high"
14731 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14732 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14733 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14734 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14735 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14736 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14737 .row &%smtp_accept_max_per_connection%& "messages per connection"
14738 .row &%smtp_accept_max_per_host%&    "connections from one host"
14739 .row &%smtp_accept_queue%&           "queue mail if more connections"
14740 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14741                                            connection"
14742 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14743 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14744 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14745 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14746 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14747 .endtable
14748
14749
14750
14751 .section "Policy controls" "SECID106"
14752 .table2
14753 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14754 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14755 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14756 .row &%acl_smtp_auth%&               "ACL for AUTH"
14757 .row &%acl_smtp_connect%&            "ACL for connection"
14758 .row &%acl_smtp_data%&               "ACL for DATA"
14759 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14760 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14761 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14762 .row &%acl_smtp_expn%&               "ACL for EXPN"
14763 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14764 .row &%acl_smtp_mail%&               "ACL for MAIL"
14765 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14766 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14767 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14768 .row &%acl_smtp_predata%&            "ACL for start of data"
14769 .row &%acl_smtp_quit%&               "ACL for QUIT"
14770 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14771 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14772 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14773 .row &%av_scanner%&                  "specify virus scanner"
14774 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14775                                       words""&"
14776 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14777 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14778 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14779 .row &%header_maxsize%&              "total size of message header"
14780 .row &%header_line_maxsize%&         "individual header line limit"
14781 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14782 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14783 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14784 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14785 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14786 .row &%host_lookup%&                 "host name looked up for these hosts"
14787 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14788 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14789 .row &%host_reject_connection%&      "reject connection from these hosts"
14790 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14791 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14792 .row &%message_size_limit%&          "for all messages"
14793 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14794 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14795 .row &%spamd_address%&               "set interface to SpamAssassin"
14796 .row &%strict_acl_vars%&             "object to unset ACL variables"
14797 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14798 .endtable
14799
14800
14801
14802 .section "Callout cache" "SECID107"
14803 .table2
14804 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14805                                          item"
14806 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14807                                          item"
14808 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14809 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14810 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14811 .endtable
14812
14813
14814
14815 .section "TLS" "SECID108"
14816 .table2
14817 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14818 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14819 .row &%hosts_require_alpn%&          "mandatory ALPN"
14820 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14821 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14822 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14823 .row &%tls_alpn%&                    "acceptable protocol names"
14824 .row &%tls_certificate%&             "location of server certificate"
14825 .row &%tls_crl%&                     "certificate revocation list"
14826 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14827 .row &%tls_dhparam%&                 "DH parameters for server"
14828 .row &%tls_eccurve%&                 "EC curve selection for server"
14829 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14830 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14831 .row &%tls_privatekey%&              "location of server private key"
14832 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14833 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14834 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14835 .row &%tls_verify_certificates%&     "expected client certificates"
14836 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14837 .endtable
14838
14839
14840
14841 .section "Local user handling" "SECID109"
14842 .table2
14843 .row &%finduser_retries%&            "useful in NIS environments"
14844 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14845 .row &%gecos_pattern%&               "ditto"
14846 .row &%max_username_length%&         "for systems that truncate"
14847 .row &%unknown_login%&               "used when no login name found"
14848 .row &%unknown_username%&            "ditto"
14849 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14850 .row &%uucp_from_sender%&            "ditto"
14851 .endtable
14852
14853
14854
14855 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14856 .table2
14857 .row &%header_maxsize%&              "total size of message header"
14858 .row &%header_line_maxsize%&         "individual header line limit"
14859 .row &%message_size_limit%&          "applies to all messages"
14860 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14861 .row &%received_header_text%&        "expanded to make &'Received:'&"
14862 .row &%received_headers_max%&        "for mail loop detection"
14863 .row &%recipients_max%&              "limit per message"
14864 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14865 .endtable
14866
14867
14868
14869
14870 .section "Non-SMTP incoming messages" "SECID111"
14871 .table2
14872 .row &%receive_timeout%&             "for non-SMTP messages"
14873 .endtable
14874
14875
14876
14877
14878
14879 .section "Incoming SMTP messages" "SECID112"
14880 See also the &'Policy controls'& section above.
14881
14882 .table2
14883 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14884 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14885 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14886 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14887 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14888 .row &%dmarc_history_file%&          "DMARC results log"
14889 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14890 .row &%host_lookup%&                 "host name looked up for these hosts"
14891 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14892 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14893 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14894 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14895 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14896 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14897 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14898 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14899 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14900 .row &%smtp_accept_max_per_connection%& "messages per connection"
14901 .row &%smtp_accept_max_per_host%&    "connections from one host"
14902 .row &%smtp_accept_queue%&           "queue mail if more connections"
14903 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14904                                            connection"
14905 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14906 .row &%smtp_active_hostname%&        "host name to use in messages"
14907 .row &%smtp_banner%&                 "text for welcome banner"
14908 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14909 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14910 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14911 .row &%smtp_etrn_command%&           "what to run for ETRN"
14912 .row &%smtp_etrn_serialize%&         "only one at once"
14913 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14914 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14915 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14916 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14917 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14918 .row &%smtp_receive_timeout%&        "per command or data line"
14919 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14920 .row &%smtp_return_error_details%&   "give detail on rejections"
14921 .endtable
14922
14923
14924
14925 .section "SMTP extensions" "SECID113"
14926 .table2
14927 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14928 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14929 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14930 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14931 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14932 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14933 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14934 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14935 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14936 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14937 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14938 .endtable
14939
14940
14941
14942 .section "Processing messages" "SECID114"
14943 .table2
14944 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14945 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14946 .row &%allow_utf8_domains%&          "in addresses"
14947 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14948                                       words""&"
14949 .row &%delivery_date_remove%&        "from incoming messages"
14950 .row &%envelope_to_remove%&          "from incoming messages"
14951 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14952 .row &%headers_charset%&             "default for translations"
14953 .row &%qualify_domain%&              "default for senders"
14954 .row &%qualify_recipient%&           "default for recipients"
14955 .row &%return_path_remove%&          "from incoming messages"
14956 .row &%strip_excess_angle_brackets%& "in addresses"
14957 .row &%strip_trailing_dot%&          "at end of addresses"
14958 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14959 .endtable
14960
14961
14962
14963 .section "System filter" "SECID115"
14964 .table2
14965 .row &%system_filter%&               "locate system filter"
14966 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14967                                             directory"
14968 .row &%system_filter_file_transport%& "transport for delivery to a file"
14969 .row &%system_filter_group%&         "group for filter running"
14970 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14971 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14972 .row &%system_filter_user%&          "user for filter running"
14973 .endtable
14974
14975
14976
14977 .section "Routing and delivery" "SECID116"
14978 .table2
14979 .row &%disable_ipv6%&                "do no IPv6 processing"
14980 .row &%dns_again_means_nonexist%&    "for broken domains"
14981 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14982 .row &%dns_dnssec_ok%&               "parameter for resolver"
14983 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14984 .row &%dns_retrans%&                 "parameter for resolver"
14985 .row &%dns_retry%&                   "parameter for resolver"
14986 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14987 .row &%dns_use_edns0%&               "parameter for resolver"
14988 .row &%hold_domains%&                "hold delivery for these domains"
14989 .row &%local_interfaces%&            "for routing checks"
14990 .row &%queue_domains%&               "no immediate delivery for these"
14991 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14992 .row &%queue_only%&                  "no immediate delivery at all"
14993 .row &%queue_only_file%&             "no immediate delivery if file exists"
14994 .row &%queue_only_load%&             "no immediate delivery if load is high"
14995 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14996 .row &%queue_only_override%&         "allow command line to override"
14997 .row &%queue_run_in_order%&          "order of arrival"
14998 .row &%queue_run_max%&               "of simultaneous queue runners"
14999 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15000 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15001 .row &%remote_sort_domains%&         "order of remote deliveries"
15002 .row &%retry_data_expire%&           "timeout for retry data"
15003 .row &%retry_interval_max%&          "safety net for retry rules"
15004 .endtable
15005
15006
15007
15008 .section "Bounce and warning messages" "SECID117"
15009 .table2
15010 .row &%bounce_message_file%&         "content of bounce"
15011 .row &%bounce_message_text%&         "content of bounce"
15012 .row &%bounce_return_body%&          "include body if returning message"
15013 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15014 .row &%bounce_return_message%&       "include original message in bounce"
15015 .row &%bounce_return_size_limit%&    "limit on returned message"
15016 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15017 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15018 .row &%errors_copy%&                 "copy bounce messages"
15019 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15020 .row &%delay_warning%&               "time schedule"
15021 .row &%delay_warning_condition%&     "condition for warning messages"
15022 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15023 .row &%smtp_return_error_details%&   "give detail on rejections"
15024 .row &%warn_message_file%&           "content of warning message"
15025 .endtable
15026
15027
15028
15029 .section "Alphabetical list of main options" "SECTalomo"
15030 Those options that undergo string expansion before use are marked with
15031 &dagger;.
15032
15033 .option accept_8bitmime main boolean true
15034 .cindex "8BITMIME"
15035 .cindex "8-bit characters"
15036 .cindex "log" "selectors"
15037 .cindex "log" "8BITMIME"
15038 .cindex "ESMTP extensions" 8BITMIME
15039 This option causes Exim to send 8BITMIME in its response to an SMTP
15040 EHLO command, and to accept the BODY= parameter on MAIL commands.
15041 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15042 takes no steps to do anything special with messages received by this route.
15043
15044 Historically Exim kept this option off by default, but the maintainers
15045 feel that in today's Internet, this causes more problems than it solves.
15046 It now defaults to true.
15047 A more detailed analysis of the issues is provided by Dan Bernstein:
15048 .display
15049 &url(https://cr.yp.to/smtp/8bitmime.html)
15050 .endd
15051
15052 To log received 8BITMIME status use
15053 .code
15054 log_selector = +8bitmime
15055 .endd
15056
15057 .option acl_not_smtp main string&!! unset
15058 .cindex "&ACL;" "for non-SMTP messages"
15059 .cindex "non-SMTP messages" "ACLs for"
15060 This option defines the ACL that is run when a non-SMTP message has been
15061 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15062 further details.
15063
15064 .option acl_not_smtp_mime main string&!! unset
15065 This option defines the ACL that is run for individual MIME parts of non-SMTP
15066 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15067 SMTP messages.
15068
15069 .option acl_not_smtp_start main string&!! unset
15070 .cindex "&ACL;" "at start of non-SMTP message"
15071 .cindex "non-SMTP messages" "ACLs for"
15072 This option defines the ACL that is run before Exim starts reading a
15073 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15074
15075 .option acl_smtp_auth main string&!! unset
15076 .cindex "&ACL;" "setting up for SMTP commands"
15077 .cindex "AUTH" "ACL for"
15078 This option defines the ACL that is run when an SMTP AUTH command is
15079 received. See chapter &<<CHAPACL>>& for further details.
15080
15081 .option acl_smtp_connect main string&!! unset
15082 .cindex "&ACL;" "on SMTP connection"
15083 This option defines the ACL that is run when an SMTP connection is received.
15084 See chapter &<<CHAPACL>>& for further details.
15085
15086 .option acl_smtp_data main string&!! unset
15087 .cindex "DATA" "ACL for"
15088 This option defines the ACL that is run after an SMTP DATA command has been
15089 processed and the message itself has been received, but before the final
15090 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15091
15092 .option acl_smtp_data_prdr main string&!! accept
15093 .cindex "PRDR" "ACL for"
15094 .cindex "DATA" "PRDR ACL for"
15095 .cindex "&ACL;" "PRDR-related"
15096 .cindex "&ACL;" "per-user data processing"
15097 This option defines the ACL that,
15098 if the PRDR feature has been negotiated,
15099 is run for each recipient after an SMTP DATA command has been
15100 processed and the message itself has been received, but before the
15101 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15102
15103 .option acl_smtp_dkim main string&!! unset
15104 .cindex DKIM "ACL for"
15105 This option defines the ACL that is run for each DKIM signature
15106 (by default, or as specified in the dkim_verify_signers option)
15107 of a received message.
15108 See section &<<SECDKIMVFY>>& for further details.
15109
15110 .option acl_smtp_etrn main string&!! unset
15111 .cindex "ETRN" "ACL for"
15112 This option defines the ACL that is run when an SMTP ETRN command is
15113 received. See chapter &<<CHAPACL>>& for further details.
15114
15115 .option acl_smtp_expn main string&!! unset
15116 .cindex "EXPN" "ACL for"
15117 This option defines the ACL that is run when an SMTP EXPN command is
15118 received. See chapter &<<CHAPACL>>& for further details.
15119
15120 .option acl_smtp_helo main string&!! unset
15121 .cindex "EHLO" "ACL for"
15122 .cindex "HELO" "ACL for"
15123 This option defines the ACL that is run when an SMTP EHLO or HELO
15124 command is received. See chapter &<<CHAPACL>>& for further details.
15125
15126
15127 .option acl_smtp_mail main string&!! unset
15128 .cindex "MAIL" "ACL for"
15129 This option defines the ACL that is run when an SMTP MAIL command is
15130 received. See chapter &<<CHAPACL>>& for further details.
15131
15132 .option acl_smtp_mailauth main string&!! unset
15133 .cindex "AUTH" "on MAIL command"
15134 This option defines the ACL that is run when there is an AUTH parameter on
15135 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15136 &<<CHAPSMTPAUTH>>& for details of authentication.
15137
15138 .option acl_smtp_mime main string&!! unset
15139 .cindex "MIME content scanning" "ACL for"
15140 This option is available when Exim is built with the content-scanning
15141 extension. It defines the ACL that is run for each MIME part in a message. See
15142 section &<<SECTscanmimepart>>& for details.
15143
15144 .option acl_smtp_notquit main string&!! unset
15145 .cindex "not-QUIT, ACL for"
15146 This option defines the ACL that is run when an SMTP session
15147 ends without a QUIT command being received.
15148 See chapter &<<CHAPACL>>& for further details.
15149
15150 .option acl_smtp_predata main string&!! unset
15151 This option defines the ACL that is run when an SMTP DATA command is
15152 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15153 further details.
15154
15155 .option acl_smtp_quit main string&!! unset
15156 .cindex "QUIT, ACL for"
15157 This option defines the ACL that is run when an SMTP QUIT command is
15158 received. See chapter &<<CHAPACL>>& for further details.
15159
15160 .option acl_smtp_rcpt main string&!! unset
15161 .cindex "RCPT" "ACL for"
15162 This option defines the ACL that is run when an SMTP RCPT command is
15163 received. See chapter &<<CHAPACL>>& for further details.
15164
15165 .option acl_smtp_starttls main string&!! unset
15166 .cindex "STARTTLS, ACL for"
15167 This option defines the ACL that is run when an SMTP STARTTLS command is
15168 received. See chapter &<<CHAPACL>>& for further details.
15169
15170 .option acl_smtp_vrfy main string&!! unset
15171 .cindex "VRFY" "ACL for"
15172 This option defines the ACL that is run when an SMTP VRFY command is
15173 received. See chapter &<<CHAPACL>>& for further details.
15174
15175 .option add_environment main "string list" empty
15176 .cindex "environment" "set values"
15177 This option adds individual environment variables that the
15178 currently linked libraries and programs in child processes may use.
15179 Each list element should be of the form &"name=value"&.
15180
15181 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15182
15183 .option admin_groups main "string list&!!" unset
15184 .cindex "admin user"
15185 This option is expanded just once, at the start of Exim's processing. If the
15186 current group or any of the supplementary groups of an Exim caller is in this
15187 colon-separated list, the caller has admin privileges. If all your system
15188 programmers are in a specific group, for example, you can give them all Exim
15189 admin privileges by putting that group in &%admin_groups%&. However, this does
15190 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15191 To permit this, you have to add individuals to the Exim group.
15192
15193 .option allow_domain_literals main boolean false
15194 .cindex "domain literal"
15195 If this option is set, the RFC 2822 domain literal format is permitted in
15196 email addresses. The option is not set by default, because the domain literal
15197 format is not normally required these days, and few people know about it. It
15198 has, however, been exploited by mail abusers.
15199
15200 Unfortunately, it seems that some DNS black list maintainers are using this
15201 format to report black listing to postmasters. If you want to accept messages
15202 addressed to your hosts by IP address, you need to set
15203 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15204 domains (defined in the named domain list &%local_domains%& in the default
15205 configuration). This &"magic string"& matches the domain literal form of all
15206 the local host's IP addresses.
15207
15208 .option allow_mx_to_ip main boolean false
15209 .cindex "MX record" "pointing to IP address"
15210 It appears that more and more DNS zone administrators are breaking the rules
15211 and putting domain names that look like IP addresses on the right hand side of
15212 MX records. Exim follows the rules and rejects this, giving an error message
15213 that explains the misconfiguration. However, some other MTAs support this
15214 practice, so to avoid &"Why can't Exim do this?"& complaints,
15215 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15216 recommended, except when you have no other choice.
15217
15218 .option allow_utf8_domains main boolean false
15219 .cindex "domain" "UTF-8 characters in"
15220 .cindex "UTF-8" "in domain name"
15221 Lots of discussion is going on about internationalized domain names. One
15222 camp is strongly in favour of just using UTF-8 characters, and it seems
15223 that at least two other MTAs permit this.
15224 This option allows Exim users to experiment if they wish.
15225
15226 If it is set true, Exim's domain parsing function allows valid
15227 UTF-8 multicharacters to appear in domain name components, in addition to
15228 letters, digits, and hyphens.
15229
15230 If Exim is built with internationalization support
15231 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15232 this option can be left as default.
15233 Without that,
15234 if you want to look up such domain names in the DNS, you must also
15235 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15236 suitable setting is:
15237 .code
15238 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15239   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15240 .endd
15241 Alternatively, you can just disable this feature by setting
15242 .code
15243 dns_check_names_pattern =
15244 .endd
15245 That is, set the option to an empty string so that no check is done.
15246
15247
15248 .option auth_advertise_hosts main "host list&!!" *
15249 .cindex "authentication" "advertising"
15250 .cindex "AUTH" "advertising"
15251 .cindex "ESMTP extensions" AUTH
15252 If any server authentication mechanisms are configured, Exim advertises them in
15253 response to an EHLO command only if the calling host matches this list.
15254 Otherwise, Exim does not advertise AUTH.
15255 Exim does not accept AUTH commands from clients to which it has not
15256 advertised the availability of AUTH. The advertising of individual
15257 authentication mechanisms can be controlled by the use of the
15258 &%server_advertise_condition%& generic authenticator option on the individual
15259 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15260
15261 Certain mail clients (for example, Netscape) require the user to provide a name
15262 and password for authentication if AUTH is advertised, even though it may
15263 not be needed (the host may accept messages from hosts on its local LAN without
15264 authentication, for example). The &%auth_advertise_hosts%& option can be used
15265 to make these clients more friendly by excluding them from the set of hosts to
15266 which Exim advertises AUTH.
15267
15268 .cindex "AUTH" "advertising when encrypted"
15269 If you want to advertise the availability of AUTH only when the connection
15270 is encrypted using TLS, you can make use of the fact that the value of this
15271 option is expanded, with a setting like this:
15272 .code
15273 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15274 .endd
15275 .vindex "&$tls_in_cipher$&"
15276 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15277 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15278 expansion is *, which matches all hosts.
15279
15280
15281 .option auto_thaw main time 0s
15282 .cindex "thawing messages"
15283 .cindex "unfreezing messages"
15284 If this option is set to a time greater than zero, a queue runner will try a
15285 new delivery attempt on any frozen message, other than a bounce message, if
15286 this much time has passed since it was frozen. This may result in the message
15287 being re-frozen if nothing has changed since the last attempt. It is a way of
15288 saying &"keep on trying, even though there are big problems"&.
15289
15290 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15291 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15292 thought to be very useful any more, and its use should probably be avoided.
15293
15294
15295 .option av_scanner main string "see below"
15296 This option is available if Exim is built with the content-scanning extension.
15297 It specifies which anti-virus scanner to use. The default value is:
15298 .code
15299 sophie:/var/run/sophie
15300 .endd
15301 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15302 before use. See section &<<SECTscanvirus>>& for further details.
15303
15304
15305 .option bi_command main string unset
15306 .oindex "&%-bi%&"
15307 This option supplies the name of a command that is run when Exim is called with
15308 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15309 just the command name, it is not a complete command line. If an argument is
15310 required, it must come from the &%-oA%& command line option.
15311
15312
15313 .option bounce_message_file main string&!! unset
15314 .cindex "bounce message" "customizing"
15315 .cindex "customizing" "bounce message"
15316 This option defines a template file containing paragraphs of text to be used
15317 for constructing bounce messages.  Details of the file's contents are given in
15318 chapter &<<CHAPemsgcust>>&.
15319 .cindex bounce_message_file "tainted data"
15320 The option is expanded to give the file path, which must be
15321 absolute and untainted.
15322 See also &%warn_message_file%&.
15323
15324
15325 .option bounce_message_text main string unset
15326 When this option is set, its contents are included in the default bounce
15327 message immediately after &"This message was created automatically by mail
15328 delivery software."& It is not used if &%bounce_message_file%& is set.
15329
15330 .option bounce_return_body main boolean true
15331 .cindex "bounce message" "including body"
15332 This option controls whether the body of an incoming message is included in a
15333 bounce message when &%bounce_return_message%& is true. The default setting
15334 causes the entire message, both header and body, to be returned (subject to the
15335 value of &%bounce_return_size_limit%&). If this option is false, only the
15336 message header is included. In the case of a non-SMTP message containing an
15337 error that is detected during reception, only those header lines preceding the
15338 point at which the error was detected are returned.
15339 .cindex "bounce message" "including original"
15340
15341 .option bounce_return_linesize_limit main integer 998
15342 .cindex "size" "of bounce lines, limit"
15343 .cindex "bounce message" "line length limit"
15344 .cindex "limit" "bounce message line length"
15345 This option sets a limit in bytes on the line length of messages
15346 that are returned to senders due to delivery problems,
15347 when &%bounce_return_message%& is true.
15348 The default value corresponds to RFC limits.
15349 If the message being returned has lines longer than this value it is
15350 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15351
15352 The option also applies to bounces returned when an error is detected
15353 during reception of a message.
15354 In this case lines from the original are truncated.
15355
15356 The option does not apply to messages generated by an &(autoreply)& transport.
15357
15358
15359 .option bounce_return_message main boolean true
15360 If this option is set false, none of the original message is included in
15361 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15362 &%bounce_return_body%&.
15363
15364
15365 .option bounce_return_size_limit main integer 100K
15366 .cindex "size" "of bounce, limit"
15367 .cindex "bounce message" "size limit"
15368 .cindex "limit" "bounce message size"
15369 This option sets a limit in bytes on the size of messages that are returned to
15370 senders as part of bounce messages when &%bounce_return_message%& is true. The
15371 limit should be less than the value of the global &%message_size_limit%& and of
15372 any &%message_size_limit%& settings on transports, to allow for the bounce text
15373 that Exim generates. If this option is set to zero there is no limit.
15374
15375 When the body of any message that is to be included in a bounce message is
15376 greater than the limit, it is truncated, and a comment pointing this out is
15377 added at the top. The actual cutoff may be greater than the value given, owing
15378 to the use of buffering for transferring the message in chunks (typically 8K in
15379 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15380 messages.
15381
15382 .option bounce_sender_authentication main string unset
15383 .cindex "bounce message" "sender authentication"
15384 .cindex "authentication" "bounce message"
15385 .cindex "AUTH" "on bounce message"
15386 This option provides an authenticated sender address that is sent with any
15387 bounce messages generated by Exim that are sent over an authenticated SMTP
15388 connection. A typical setting might be:
15389 .code
15390 bounce_sender_authentication = mailer-daemon@my.domain.example
15391 .endd
15392 which would cause bounce messages to be sent using the SMTP command:
15393 .code
15394 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15395 .endd
15396 The value of &%bounce_sender_authentication%& must always be a complete email
15397 address.
15398
15399 .option callout_domain_negative_expire main time 3h
15400 .cindex "caching" "callout timeouts"
15401 .cindex "callout" "caching timeouts"
15402 This option specifies the expiry time for negative callout cache data for a
15403 domain. See section &<<SECTcallver>>& for details of callout verification, and
15404 section &<<SECTcallvercache>>& for details of the caching.
15405
15406
15407 .option callout_domain_positive_expire main time 7d
15408 This option specifies the expiry time for positive callout cache data for a
15409 domain. See section &<<SECTcallver>>& for details of callout verification, and
15410 section &<<SECTcallvercache>>& for details of the caching.
15411
15412
15413 .option callout_negative_expire main time 2h
15414 This option specifies the expiry time for negative callout cache data for an
15415 address. See section &<<SECTcallver>>& for details of callout verification, and
15416 section &<<SECTcallvercache>>& for details of the caching.
15417
15418
15419 .option callout_positive_expire main time 24h
15420 This option specifies the expiry time for positive callout cache data for an
15421 address. See section &<<SECTcallver>>& for details of callout verification, and
15422 section &<<SECTcallvercache>>& for details of the caching.
15423
15424
15425 .option callout_random_local_part main string&!! "see below"
15426 This option defines the &"random"& local part that can be used as part of
15427 callout verification. The default value is
15428 .code
15429 $primary_hostname-$tod_epoch-testing
15430 .endd
15431 See section &<<CALLaddparcall>>& for details of how this value is used.
15432
15433
15434 .option check_log_inodes main integer 100
15435 See &%check_spool_space%& below.
15436
15437
15438 .option check_log_space main integer 10M
15439 See &%check_spool_space%& below.
15440
15441 .oindex "&%check_rfc2047_length%&"
15442 .cindex "RFC 2047" "disabling length check"
15443 .option check_rfc2047_length main boolean true
15444 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15445 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15446 word; strings to be encoded that exceed this length are supposed to use
15447 multiple encoded words. By default, Exim does not recognize encoded words that
15448 exceed the maximum length. However, it seems that some software, in violation
15449 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15450 set false, Exim recognizes encoded words of any length.
15451
15452
15453 .option check_spool_inodes main integer 100
15454 See &%check_spool_space%& below.
15455
15456
15457 .option check_spool_space main integer 10M
15458 .cindex "checking disk space"
15459 .cindex "disk space, checking"
15460 .cindex "spool directory" "checking space"
15461 The four &%check_...%& options allow for checking of disk resources before a
15462 message is accepted.
15463
15464 .vindex "&$log_inodes$&"
15465 .vindex "&$log_space$&"
15466 .vindex "&$spool_inodes$&"
15467 .vindex "&$spool_space$&"
15468 When any of these options are nonzero, they apply to all incoming messages. If you
15469 want to apply different checks to different kinds of message, you can do so by
15470 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15471 &$spool_space$& in an ACL with appropriate additional conditions.
15472
15473
15474 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15475 either value is greater than zero, for example:
15476 .code
15477 check_spool_space = 100M
15478 check_spool_inodes = 100
15479 .endd
15480 The spool partition is the one that contains the directory defined by
15481 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15482 transit.
15483
15484 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15485 files are written if either is greater than zero. These should be set only if
15486 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15487
15488 If there is less space or fewer inodes than requested, Exim refuses to accept
15489 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15490 error response to the MAIL command. If ESMTP is in use and there was a
15491 SIZE parameter on the MAIL command, its value is added to the
15492 &%check_spool_space%& value, and the check is performed even if
15493 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15494
15495 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15496 number of kilobytes (though specified in bytes).
15497 If a non-multiple of 1024 is specified, it is rounded up.
15498
15499 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15500 failure a message is written to stderr and Exim exits with a non-zero code, as
15501 it obviously cannot send an error message of any kind.
15502
15503 There is a slight performance penalty for these checks.
15504 Versions of Exim preceding 4.88 had these disabled by default;
15505 high-rate installations confident they will never run out of resources
15506 may wish to deliberately disable them.
15507
15508 .option chunking_advertise_hosts main "host list&!!" *
15509 .cindex CHUNKING advertisement
15510 .cindex "RFC 3030" "CHUNKING"
15511 .cindex "ESMTP extensions" CHUNKING
15512 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15513 these hosts.
15514 Hosts may use the BDAT command as an alternate to DATA.
15515
15516 .option commandline_checks_require_admin main boolean &`false`&
15517 .cindex "restricting access to features"
15518 This option restricts various basic checking features to require an
15519 administrative user.
15520 This affects most of the &%-b*%& options, such as &%-be%&.
15521
15522 .option debug_store main boolean &`false`&
15523 .cindex debugging "memory corruption"
15524 .cindex memory debugging
15525 This option, when true, enables extra checking in Exim's internal memory
15526 management.  For use when a memory corruption issue is being investigated,
15527 it should normally be left as default.
15528
15529 .option daemon_smtp_ports main string &`smtp`&
15530 .cindex "port" "for daemon"
15531 .cindex "TCP/IP" "setting listening ports"
15532 This option specifies one or more default SMTP ports on which the Exim daemon
15533 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15534 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15535
15536 .option daemon_startup_retries main integer 9
15537 .cindex "daemon startup, retrying"
15538 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15539 the daemon at startup when it cannot immediately bind a listening socket
15540 (typically because the socket is already in use): &%daemon_startup_retries%&
15541 defines the number of retries after the first failure, and
15542 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15543
15544 .option daemon_startup_sleep main time 30s
15545 See &%daemon_startup_retries%&.
15546
15547 .option delay_warning main "time list" 24h
15548 .cindex "warning of delay"
15549 .cindex "delay warning, specifying"
15550 .cindex "queue" "delay warning"
15551 When a message is delayed, Exim sends a warning message to the sender at
15552 intervals specified by this option. The data is a colon-separated list of times
15553 after which to send warning messages. If the value of the option is an empty
15554 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15555 message has been in the queue for longer than the last time, the last interval
15556 between the times is used to compute subsequent warning times. For example,
15557 with
15558 .code
15559 delay_warning = 4h:8h:24h
15560 .endd
15561 the first message is sent after 4 hours, the second after 8 hours, and
15562 the third one after 24 hours. After that, messages are sent every 16 hours,
15563 because that is the interval between the last two times on the list. If you set
15564 just one time, it specifies the repeat interval. For example, with:
15565 .code
15566 delay_warning = 6h
15567 .endd
15568 messages are repeated every six hours. To stop warnings after a given time, set
15569 a very large time at the end of the list. For example:
15570 .code
15571 delay_warning = 2h:12h:99d
15572 .endd
15573 Note that the option is only evaluated at the time a delivery attempt fails,
15574 which depends on retry and queue-runner configuration.
15575 Typically retries will be configured more frequently than warning messages.
15576
15577 .option delay_warning_condition main string&!! "see below"
15578 .vindex "&$domain$&"
15579 The string is expanded at the time a warning message might be sent. If all the
15580 deferred addresses have the same domain, it is set in &$domain$& during the
15581 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15582 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15583 &"false"& (the comparison being done caselessly) then the warning message is
15584 not sent. The default is:
15585 .code
15586 delay_warning_condition = ${if or {\
15587   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15588   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15589   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15590   } {no}{yes}}
15591 .endd
15592 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15593 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15594 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15595 &"auto-replied"& in an &'Auto-Submitted:'& header.
15596
15597 .option deliver_drop_privilege main boolean false
15598 .cindex "unprivileged delivery"
15599 .cindex "delivery" "unprivileged"
15600 If this option is set true, Exim drops its root privilege at the start of a
15601 delivery process, and runs as the Exim user throughout. This severely restricts
15602 the kinds of local delivery that are possible, but is viable in certain types
15603 of configuration. There is a discussion about the use of root privilege in
15604 chapter &<<CHAPsecurity>>&.
15605
15606 .option deliver_queue_load_max main fixed-point unset
15607 .cindex "load average"
15608 .cindex "queue runner" "abandoning"
15609 When this option is set, a queue run is abandoned if the system load average
15610 becomes greater than the value of the option. The option has no effect on
15611 ancient operating systems on which Exim cannot determine the load average.
15612 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15613
15614
15615 .option delivery_date_remove main boolean true
15616 .cindex "&'Delivery-date:'& header line"
15617 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15618 message when it is delivered, in exactly the same way as &'Return-path:'& is
15619 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15620 should not be present in incoming messages, and this option causes them to be
15621 removed at the time the message is received, to avoid any problems that might
15622 occur when a delivered message is subsequently sent on to some other recipient.
15623
15624 .option disable_fsync main boolean false
15625 .cindex "&[fsync()]&, disabling"
15626 This option is available only if Exim was built with the compile-time option
15627 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15628 a runtime configuration generates an &"unknown option"& error. You should not
15629 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15630 really, really, really understand what you are doing. &'No pre-compiled
15631 distributions of Exim should ever make this option available.'&
15632
15633 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15634 updated files' data to be written to disc before continuing. Unexpected events
15635 such as crashes and power outages may cause data to be lost or scrambled.
15636 Here be Dragons. &*Beware.*&
15637
15638
15639 .option disable_ipv6 main boolean false
15640 .cindex "IPv6" "disabling"
15641 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15642 activities take place. AAAA records are never looked up, and any IPv6 addresses
15643 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15644 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15645 to handle IPv6 literal addresses.
15646
15647
15648 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15649 .cindex DKIM "selecting signature algorithms"
15650 This option gives a list of hash types which are acceptable in signatures,
15651 and an order of processing.
15652 Signatures with algorithms not in the list will be ignored.
15653
15654 Acceptable values include:
15655 .code
15656 sha1
15657 sha256
15658 sha512
15659 .endd
15660
15661 Note that the acceptance of sha1 violates RFC 8301.
15662
15663 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15664 This option gives a list of key types which are acceptable in signatures,
15665 and an order of processing.
15666 Signatures with algorithms not in the list will be ignored.
15667
15668
15669 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15670 This option gives a list of key sizes which are acceptable in signatures.
15671 The list is keyed by the algorithm type for the key; the values are in bits.
15672 Signatures with keys smaller than given by this option will fail verification.
15673
15674 The default enforces the RFC 8301 minimum key size for RSA signatures.
15675
15676 .option dkim_verify_minimal main boolean false
15677 If set to true, verification of signatures will terminate after the
15678 first success.
15679
15680 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15681 .cindex DKIM "controlling calls to the ACL"
15682 This option gives a list of DKIM domains for which the DKIM ACL is run.
15683 It is expanded after the message is received; by default it runs
15684 the ACL once for each signature in the message.
15685 See section &<<SECDKIMVFY>>&.
15686
15687
15688 .option dmarc_forensic_sender main string&!! unset
15689 .option dmarc_history_file main string unset
15690 .option dmarc_tld_file main string unset
15691 .cindex DMARC "main section options"
15692 These options control DMARC processing.
15693 See section &<<SECDMARC>>& for details.
15694
15695
15696 .option dns_again_means_nonexist main "domain list&!!" unset
15697 .cindex "DNS" "&""try again""& response; overriding"
15698 DNS lookups give a &"try again"& response for the DNS errors
15699 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15700 keep trying to deliver a message, or to give repeated temporary errors to
15701 incoming mail. Sometimes the effect is caused by a badly set up name server and
15702 may persist for a long time. If a domain which exhibits this problem matches
15703 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15704 This option should be used with care. You can make it apply to reverse lookups
15705 by a setting such as this:
15706 .code
15707 dns_again_means_nonexist = *.in-addr.arpa
15708 .endd
15709 This option applies to all DNS lookups that Exim does,
15710 .new
15711 except for TLSA lookups (where knowing about such failures
15712 is security-relevant).
15713 .wen
15714 It also applies when the
15715 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15716 since these are most likely to be caused by DNS lookup problems. The
15717 &(dnslookup)& router has some options of its own for controlling what happens
15718 when lookups for MX or SRV records give temporary errors. These more specific
15719 options are applied after this global option.
15720
15721 .option dns_check_names_pattern main string "see below"
15722 .cindex "DNS" "pre-check of name syntax"
15723 When this option is set to a non-empty string, it causes Exim to check domain
15724 names for characters that are not allowed in host names before handing them to
15725 the DNS resolver, because some resolvers give temporary errors for names that
15726 contain unusual characters. If a domain name contains any unwanted characters,
15727 a &"not found"& result is forced, and the resolver is not called. The check is
15728 done by matching the domain name against a regular expression, which is the
15729 value of this option. The default pattern is
15730 .code
15731 dns_check_names_pattern = \
15732   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15733 .endd
15734 which permits only letters, digits, slashes, and hyphens in components, but
15735 they must start and end with a letter or digit. Slashes are not, in fact,
15736 permitted in host names, but they are found in certain NS records (which can be
15737 accessed in Exim by using a &%dnsdb%& lookup). If you set
15738 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15739 empty string.
15740
15741 .option dns_csa_search_limit main integer 5
15742 This option controls the depth of parental searching for CSA SRV records in the
15743 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15744
15745 .option dns_csa_use_reverse main boolean true
15746 This option controls whether or not an IP address, given as a CSA domain, is
15747 reversed and looked up in the reverse DNS, as described in more detail in
15748 section &<<SECTverifyCSA>>&.
15749
15750 .option dns_cname_loops main integer 1
15751 .cindex DNS "CNAME following"
15752 This option controls the following of CNAME chains, needed if the resolver does
15753 not do it internally.
15754 As of 2018 most should, and the default can be left.
15755 If you have an ancient one, a value of 10 is likely needed.
15756
15757 The default value of one CNAME-follow is needed
15758 thanks to the observed return for an MX request,
15759 given no MX presence but a CNAME to an A, of the CNAME.
15760
15761
15762 .option dns_dnssec_ok main integer -1
15763 .cindex "DNS" "resolver options"
15764 .cindex "DNS" "DNSSEC"
15765 If this option is set to a non-negative number then Exim will initialise the
15766 DNS resolver library to either use or not use DNSSEC, overriding the system
15767 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15768
15769 If the resolver library does not support DNSSEC then this option has no effect.
15770
15771 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15772 will default to stripping out a successful validation status.
15773 This will break a previously working Exim installation.
15774 Provided that you do trust the resolver (ie, is on localhost) you can tell
15775 glibc to pass through any successful validation with a new option in
15776 &_/etc/resolv.conf_&:
15777 .code
15778 options trust-ad
15779 .endd
15780
15781
15782 .option dns_ipv4_lookup main "domain list&!!" unset
15783 .cindex "IPv6" "DNS lookup for AAAA records"
15784 .cindex "DNS" "IPv6 lookup for AAAA records"
15785 .cindex DNS "IPv6 disabling"
15786 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15787 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15788 (A records) when trying to find IP addresses for hosts, unless the host's
15789 domain matches this list.
15790
15791 This is a fudge to help with name servers that give big delays or otherwise do
15792 not work for the AAAA record type. In due course, when the world's name
15793 servers have all been upgraded, there should be no need for this option.
15794 Note that all lookups, including those done for verification, are affected;
15795 this will result in verify failure for IPv6 connections or ones using names
15796 only valid for IPv6 addresses.
15797
15798
15799 .option dns_retrans main time 0s
15800 .cindex "DNS" "resolver options"
15801 .cindex timeout "dns lookup"
15802 .cindex "DNS" timeout
15803 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15804 retransmission and retry parameters for DNS lookups. Values of zero (the
15805 defaults) leave the system default settings unchanged. The first value is the
15806 time between retries, and the second is the number of retries. It isn't
15807 totally clear exactly how these settings affect the total time a DNS lookup may
15808 take. I haven't found any documentation about timeouts on DNS lookups; these
15809 parameter values are available in the external resolver interface structure,
15810 but nowhere does it seem to describe how they are used or what you might want
15811 to set in them.
15812 See also the &%slow_lookup_log%& option.
15813
15814
15815 .option dns_retry main integer 0
15816 See &%dns_retrans%& above.
15817
15818
15819 .option dns_trust_aa main "domain list&!!" unset
15820 .cindex "DNS" "resolver options"
15821 .cindex "DNS" "DNSSEC"
15822 If this option is set then lookup results marked with the AA bit
15823 (Authoritative Answer) are trusted the same way as if they were
15824 DNSSEC-verified. The authority section's name of the answer must
15825 match with this expanded domain list.
15826
15827 Use this option only if you talk directly to a resolver that is
15828 authoritative for some zones and does not set the AD (Authentic Data)
15829 bit in the answer. Some DNS servers may have an configuration option to
15830 mark the answers from their own zones as verified (they set the AD bit).
15831 Others do not have this option. It is considered as poor practice using
15832 a resolver that is an authoritative server for some zones.
15833
15834 Use this option only if you really have to (e.g. if you want
15835 to use DANE for remote delivery to a server that is listed in the DNS
15836 zones that your resolver is authoritative for).
15837
15838 If the DNS answer packet has the AA bit set and contains resource record
15839 in the answer section, the name of the first NS record appearing in the
15840 authority section is compared against the list. If the answer packet is
15841 authoritative but the answer section is empty, the name of the first SOA
15842 record in the authoritative section is used instead.
15843
15844 .cindex "DNS" "resolver options"
15845 .option dns_use_edns0 main integer -1
15846 .cindex "DNS" "resolver options"
15847 .cindex "DNS" "EDNS0"
15848 .cindex "DNS" "OpenBSD
15849 If this option is set to a non-negative number then Exim will initialise the
15850 DNS resolver library to either use or not use EDNS0 extensions, overriding
15851 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15852 on.
15853
15854 If the resolver library does not support EDNS0 then this option has no effect.
15855
15856 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15857 means that DNSSEC will not work with Exim on that platform either, unless Exim
15858 is linked against an alternative DNS client library.
15859
15860
15861 .option drop_cr main boolean false
15862 This is an obsolete option that is now a no-op. It used to affect the way Exim
15863 handled CR and LF characters in incoming messages. What happens now is
15864 described in section &<<SECTlineendings>>&.
15865
15866 .option dsn_advertise_hosts main "host list&!!" unset
15867 .cindex "bounce messages" "success"
15868 .cindex "DSN" "success"
15869 .cindex "Delivery Status Notification" "success"
15870 .cindex "ESMTP extensions" DSN
15871 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15872 and accepted from, these hosts.
15873 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15874 and RET and ENVID options on MAIL FROM commands.
15875 A NOTIFY=SUCCESS option requests success-DSN messages.
15876 A NOTIFY= option with no argument requests that no delay or failure DSNs
15877 are sent.
15878 &*Note*&: Supplying success-DSN messages has been criticised
15879 on privacy grounds; it can leak details of internal forwarding.
15880
15881 .option dsn_from main "string&!!" "see below"
15882 .cindex "&'From:'& header line" "in bounces"
15883 .cindex "bounce messages" "&'From:'& line, specifying"
15884 This option can be used to vary the contents of &'From:'& header lines in
15885 bounces and other automatically generated messages (&"Delivery Status
15886 Notifications"& &-- hence the name of the option). The default setting is:
15887 .code
15888 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15889 .endd
15890 The value is expanded every time it is needed. If the expansion fails, a
15891 panic is logged, and the default value is used.
15892
15893 .option envelope_to_remove main boolean true
15894 .cindex "&'Envelope-to:'& header line"
15895 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15896 message when it is delivered, in exactly the same way as &'Return-path:'& is
15897 handled. &'Envelope-to:'& records the original recipient address from the
15898 message's envelope that caused the delivery to happen. Such headers should not
15899 be present in incoming messages, and this option causes them to be removed at
15900 the time the message is received, to avoid any problems that might occur when a
15901 delivered message is subsequently sent on to some other recipient.
15902
15903
15904 .option errors_copy main "string list&!!" unset
15905 .cindex "bounce message" "copy to other address"
15906 .cindex "copy of bounce message"
15907 Setting this option causes Exim to send bcc copies of bounce messages that it
15908 generates to other addresses. &*Note*&: This does not apply to bounce messages
15909 coming from elsewhere. The value of the option is a colon-separated list of
15910 items. Each item consists of a pattern, terminated by white space, followed by
15911 a comma-separated list of email addresses. If a pattern contains spaces, it
15912 must be enclosed in double quotes.
15913
15914 Each pattern is processed in the same way as a single item in an address list
15915 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15916 the bounce message, the message is copied to the addresses on the list. The
15917 items are scanned in order, and once a matching one is found, no further items
15918 are examined. For example:
15919 .code
15920 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15921               rqps@mydomain   hostmaster@mydomain.example,\
15922                               postmaster@mydomain.example
15923 .endd
15924 .vindex "&$domain$&"
15925 .vindex "&$local_part$&"
15926 The address list is expanded before use. The expansion variables &$local_part$&
15927 and &$domain$& are set from the original recipient of the error message, and if
15928 there was any wildcard matching in the pattern, the expansion
15929 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15930 variables &$0$&, &$1$&, etc. are set in the normal way.
15931
15932
15933 .option errors_reply_to main string unset
15934 .cindex "bounce message" "&'Reply-to:'& in"
15935 By default, Exim's bounce and delivery warning messages contain the header line
15936 .display
15937 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15938 .endd
15939 .oindex &%quota_warn_message%&
15940 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15941 A warning message that is generated by the &%quota_warn_message%& option in an
15942 &(appendfile)& transport may contain its own &'From:'& header line that
15943 overrides the default.
15944
15945 Experience shows that people reply to bounce messages. If the
15946 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15947 and warning messages. For example:
15948 .code
15949 errors_reply_to = postmaster@my.domain.example
15950 .endd
15951 The value of the option is not expanded. It must specify a valid RFC 2822
15952 address. However, if a warning message that is generated by the
15953 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15954 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15955 not used.
15956
15957
15958 .option event_action main string&!! unset
15959 .cindex events
15960 This option declares a string to be expanded for Exim's events mechanism.
15961 For details see chapter &<<CHAPevents>>&.
15962
15963
15964 .option exim_group main string "compile-time configured"
15965 .cindex "gid (group id)" "Exim's own"
15966 .cindex "Exim group"
15967 This option changes the gid under which Exim runs when it gives up root
15968 privilege. The default value is compiled into the binary. The value of this
15969 option is used only when &%exim_user%& is also set. Unless it consists entirely
15970 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15971 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15972 security issues.
15973
15974
15975 .option exim_path main string "see below"
15976 .cindex "Exim binary, path name"
15977 This option specifies the path name of the Exim binary, which is used when Exim
15978 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15979 the directory configured at compile time by the BIN_DIRECTORY setting. It
15980 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15981 other place.
15982 &*Warning*&: Do not use a macro to define the value of this option, because
15983 you will break those Exim utilities that scan the configuration file to find
15984 where the binary is. (They then use the &%-bP%& option to extract option
15985 settings such as the value of &%spool_directory%&.)
15986
15987
15988 .option exim_user main string "compile-time configured"
15989 .cindex "uid (user id)" "Exim's own"
15990 .cindex "Exim user"
15991 This option changes the uid under which Exim runs when it gives up root
15992 privilege. The default value is compiled into the binary. Ownership of the run
15993 time configuration file and the use of the &%-C%& and &%-D%& command line
15994 options is checked against the values in the binary, not what is set here.
15995
15996 Unless it consists entirely of digits, the string is looked up using
15997 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15998 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15999 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16000
16001
16002 .option exim_version main string "current version"
16003 .cindex "Exim version"
16004 .cindex customizing "version number"
16005 .cindex "version number of Exim" override
16006 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16007 various places.  Use with care; this may fool stupid security scanners.
16008
16009
16010 .option extra_local_interfaces main "string list" unset
16011 This option defines network interfaces that are to be considered local when
16012 routing, but which are not used for listening by the daemon. See section
16013 &<<SECTreclocipadd>>& for details.
16014
16015
16016 . Allow this long option name to split; give it unsplit as a fifth argument
16017 . for the automatic .oindex that is generated by .option.
16018
16019 .option "extract_addresses_remove_arguments" main boolean true &&&
16020          extract_addresses_remove_arguments
16021 .oindex "&%-t%&"
16022 .cindex "command line" "addresses with &%-t%&"
16023 .cindex "Sendmail compatibility" "&%-t%& option"
16024 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16025 are present on the command line when the &%-t%& option is used to build an
16026 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16027 line addresses are removed from the recipients list. This is also how Smail
16028 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16029 command line addresses are added to those obtained from the header lines. When
16030 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16031 argument headers. If it is set false, Exim adds rather than removes argument
16032 addresses.
16033
16034
16035 .option finduser_retries main integer 0
16036 .cindex "NIS, retrying user lookups"
16037 On systems running NIS or other schemes in which user and group information is
16038 distributed from a remote system, there can be times when &[getpwnam()]& and
16039 related functions fail, even when given valid data, because things time out.
16040 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16041 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16042 many extra times to find a user or a group, waiting for one second between
16043 retries.
16044
16045 .cindex "&_/etc/passwd_&" "multiple reading of"
16046 You should not set this option greater than zero if your user information is in
16047 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16048 search the file multiple times for non-existent users, and also cause delay.
16049
16050
16051
16052 .option freeze_tell main "string list, comma separated" unset
16053 .cindex "freezing messages" "sending a message when freezing"
16054 .cindex "frozen messages" "sending a message when freezing"
16055 On encountering certain errors, or when configured to do so in a system filter,
16056 ACL, or special router, Exim freezes a message. This means that no further
16057 delivery attempts take place until an administrator thaws the message, or the
16058 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16059 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16060 warning message whenever it freezes something, unless the message it is
16061 freezing is a locally-generated bounce message. (Without this exception there
16062 is the possibility of looping.) The warning message is sent to the addresses
16063 supplied as the comma-separated value of this option. If several of the
16064 message's addresses cause freezing, only a single message is sent. If the
16065 freezing was automatic, the reason(s) for freezing can be found in the message
16066 log. If you configure freezing in a filter or ACL, you must arrange for any
16067 logging that you require.
16068
16069
16070 .option gecos_name main string&!! unset
16071 .cindex "HP-UX"
16072 .cindex "&""gecos""& field, parsing"
16073 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16074 password file to hold other information in addition to users' real names. Exim
16075 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16076 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16077 of the field are used unchanged, except that, if an ampersand is encountered,
16078 it is replaced by the user's login name with the first character forced to
16079 upper case, since this is a convention that is observed on many systems.
16080
16081 When these options are set, &%gecos_pattern%& is treated as a regular
16082 expression that is to be applied to the field (again with && replaced by the
16083 login name), and if it matches, &%gecos_name%& is expanded and used as the
16084 user's name.
16085
16086 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16087 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16088 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16089 name terminates at the first comma, the following can be used:
16090 .code
16091 gecos_pattern = ([^,]*)
16092 gecos_name = $1
16093 .endd
16094
16095 .option gecos_pattern main string unset
16096 See &%gecos_name%& above.
16097
16098
16099 .option gnutls_compat_mode main boolean unset
16100 This option controls whether GnuTLS is used in compatibility mode in an Exim
16101 server. This reduces security slightly, but improves interworking with older
16102 implementations of TLS.
16103
16104
16105 .option gnutls_allow_auto_pkcs11 main boolean unset
16106 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16107 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16108
16109 See
16110 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16111 for documentation.
16112
16113
16114
16115 .option headers_charset main string "see below"
16116 This option sets a default character set for translating from encoded MIME
16117 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16118 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16119 ultimate default is ISO-8859-1. For more details see the description of header
16120 insertions in section &<<SECTexpansionitems>>&.
16121
16122
16123
16124 .option header_maxsize main integer "see below"
16125 .cindex "header section" "maximum size of"
16126 .cindex "limit" "size of message header section"
16127 This option controls the overall maximum size of a message's header
16128 section. The default is the value of HEADER_MAXSIZE in
16129 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16130 sections are rejected.
16131
16132
16133 .option header_line_maxsize main integer 0
16134 .cindex "header lines" "maximum size of"
16135 .cindex "limit" "size of one header line"
16136 This option limits the length of any individual header line in a message, after
16137 all the continuations have been joined together. Messages with individual
16138 header lines that are longer than the limit are rejected. The default value of
16139 zero means &"no limit"&.
16140
16141
16142
16143
16144 .option helo_accept_junk_hosts main "host list&!!" unset
16145 .cindex "HELO" "accepting junk data"
16146 .cindex "EHLO" "accepting junk data"
16147 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16148 mail, and gives an error response for invalid data. Unfortunately, there are
16149 some SMTP clients that send syntactic junk. They can be accommodated by setting
16150 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16151 if you want to do semantic checking.
16152 See also &%helo_allow_chars%& for a way of extending the permitted character
16153 set.
16154
16155
16156 .option helo_allow_chars main string unset
16157 .cindex "HELO" "underscores in"
16158 .cindex "EHLO" "underscores in"
16159 .cindex "underscore in EHLO/HELO"
16160 This option can be set to a string of rogue characters that are permitted in
16161 all EHLO and HELO names in addition to the standard letters, digits,
16162 hyphens, and dots. If you really must allow underscores, you can set
16163 .code
16164 helo_allow_chars = _
16165 .endd
16166 Note that the value is one string, not a list.
16167
16168
16169 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16170 .cindex "HELO" "forcing reverse lookup"
16171 .cindex "EHLO" "forcing reverse lookup"
16172 If the domain given by a client in a HELO or EHLO command matches this
16173 list, a reverse lookup is done in order to establish the host's true name. The
16174 default forces a lookup if the client host gives the server's name or any of
16175 its IP addresses (in brackets), something that broken clients have been seen to
16176 do.
16177
16178
16179 .option helo_try_verify_hosts main "host list&!!" unset
16180 .cindex "HELO verifying" "optional"
16181 .cindex "EHLO" "verifying, optional"
16182 By default, Exim just checks the syntax of HELO and EHLO commands (see
16183 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16184 to do more extensive checking of the data supplied by these commands. The ACL
16185 condition &`verify = helo`& is provided to make this possible.
16186 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16187 to force the check to occur. From release 4.53 onwards, this is no longer
16188 necessary. If the check has not been done before &`verify = helo`& is
16189 encountered, it is done at that time. Consequently, this option is obsolete.
16190 Its specification is retained here for backwards compatibility.
16191
16192 When an EHLO or HELO command is received, if the calling host matches
16193 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16194 EHLO command either:
16195
16196 .ilist
16197 is an IP literal matching the calling address of the host, or
16198 .next
16199 .cindex "DNS" "reverse lookup"
16200 .cindex "reverse DNS lookup"
16201 matches the host name that Exim obtains by doing a reverse lookup of the
16202 calling host address, or
16203 .next
16204 when looked up in DNS yields the calling host address.
16205 .endlist
16206
16207 However, the EHLO or HELO command is not rejected if any of the checks
16208 fail. Processing continues, but the result of the check is remembered, and can
16209 be detected later in an ACL by the &`verify = helo`& condition.
16210
16211 If DNS was used for successful verification, the variable
16212 .cindex "DNS" "DNSSEC"
16213 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16214
16215 .option helo_verify_hosts main "host list&!!" unset
16216 .cindex "HELO verifying" "mandatory"
16217 .cindex "EHLO" "verifying, mandatory"
16218 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16219 backwards compatibility. For hosts that match this option, Exim checks the host
16220 name given in the HELO or EHLO in the same way as for
16221 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16222 rejected with a 550 error, and entries are written to the main and reject logs.
16223 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16224 error.
16225
16226 .option hold_domains main "domain list&!!" unset
16227 .cindex "domain" "delaying delivery"
16228 .cindex "delivery" "delaying certain domains"
16229 This option allows mail for particular domains to be held in the queue
16230 manually. The option is overridden if a message delivery is forced with the
16231 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16232 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16233 item in &%hold_domains%&, no routing or delivery for that address is done, and
16234 it is deferred every time the message is looked at.
16235
16236 This option is intended as a temporary operational measure for delaying the
16237 delivery of mail while some problem is being sorted out, or some new
16238 configuration tested. If you just want to delay the processing of some
16239 domains until a queue run occurs, you should use &%queue_domains%& or
16240 &%queue_smtp_domains%&, not &%hold_domains%&.
16241
16242 A setting of &%hold_domains%& does not override Exim's code for removing
16243 messages from the queue if they have been there longer than the longest retry
16244 time in any retry rule. If you want to hold messages for longer than the normal
16245 retry times, insert a dummy retry rule with a long retry time.
16246
16247
16248 .option host_lookup main "host list&!!" unset
16249 .cindex "host name" "lookup, forcing"
16250 Exim does not look up the name of a calling host from its IP address unless it
16251 is required to compare against some host list, or the host matches
16252 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16253 option (which normally contains IP addresses rather than host names). The
16254 default configuration file contains
16255 .code
16256 host_lookup = *
16257 .endd
16258 which causes a lookup to happen for all hosts. If the expense of these lookups
16259 is felt to be too great, the setting can be changed or removed.
16260
16261 After a successful reverse lookup, Exim does a forward lookup on the name it
16262 has obtained, to verify that it yields the IP address that it started with. If
16263 this check fails, Exim behaves as if the name lookup failed.
16264
16265 .vindex "&$host_lookup_failed$&"
16266 .vindex "&$sender_host_name$&"
16267 After any kind of failure, the host name (in &$sender_host_name$&) remains
16268 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16269 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16270 &`verify = reverse_host_lookup`& in ACLs.
16271
16272
16273 .option host_lookup_order main "string list" &`bydns:byaddr`&
16274 This option specifies the order of different lookup methods when Exim is trying
16275 to find a host name from an IP address. The default is to do a DNS lookup
16276 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16277 if that fails. You can change the order of these lookups, or omit one entirely,
16278 if you want.
16279
16280 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16281 multiple PTR records in the DNS and the IP address is not listed in
16282 &_/etc/hosts_&. Different operating systems give different results in this
16283 case. That is why the default tries a DNS lookup first.
16284
16285
16286
16287 .option host_reject_connection main "host list&!!" unset
16288 .cindex "host" "rejecting connections from"
16289 If this option is set, incoming SMTP calls from the hosts listed are rejected
16290 as soon as the connection is made.
16291 This option is obsolete, and retained only for backward compatibility, because
16292 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16293 connections immediately.
16294
16295 .new
16296 If the connection is on a TLS-on-connect port then the TCP connection is
16297 just dropped.  Otherwise, an SMTP error is sent first.
16298 .wen
16299
16300 The ability to give an immediate rejection (either by this option or using an
16301 ACL) is provided for use in unusual cases. Many hosts will just try again,
16302 sometimes without much delay. Normally, it is better to use an ACL to reject
16303 incoming messages at a later stage, such as after RCPT commands. See
16304 chapter &<<CHAPACL>>&.
16305
16306
16307 .option hosts_connection_nolog main "host list&!!" unset
16308 .cindex "host" "not logging connections from"
16309 This option defines a list of hosts for which connection logging does not
16310 happen, even though the &%smtp_connection%& log selector is set. For example,
16311 you might want not to log SMTP connections from local processes, or from
16312 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16313 the daemon; you should therefore strive to restrict its value to a short inline
16314 list of IP addresses and networks. To disable logging SMTP connections from
16315 local processes, you must create a host list with an empty item. For example:
16316 .code
16317 hosts_connection_nolog = :
16318 .endd
16319 .new
16320 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16321 lines, as may commonly be produced by a monitoring system.
16322 .wen
16323
16324
16325 .option hosts_require_alpn main "host list&!!" unset
16326 .cindex ALPN "require negotiation in server"
16327 .cindex TLS ALPN
16328 .cindex TLS "Application Layer Protocol Names"
16329 If the TLS library supports ALPN
16330 then a successful negotiation of ALPN will be required for any client
16331 matching the list, for TLS to be used.
16332 See also the &%tls_alpn%& option.
16333
16334 &*Note*&: prevention of fallback to in-clear connection is not
16335 managed by this option, and should be done separately.
16336
16337
16338 .option hosts_require_helo main "host list&!!" *
16339 .cindex "HELO/EHLO" requiring
16340 Exim will require an accepted HELO or EHLO command from a host matching
16341 this list, before accepting a MAIL command.
16342
16343
16344 .option hosts_proxy main "host list&!!" unset
16345 .cindex proxy "proxy protocol"
16346 This option enables use of Proxy Protocol proxies for incoming
16347 connections.  For details see section &<<SECTproxyInbound>>&.
16348
16349
16350 .option hosts_treat_as_local main "domain list&!!" unset
16351 .cindex "local host" "domains treated as"
16352 .cindex "host" "treated as local"
16353 If this option is set, any host names that match the domain list are treated as
16354 if they were the local host when Exim is scanning host lists obtained from MX
16355 records
16356 or other sources. Note that the value of this option is a domain list, not a
16357 host list, because it is always used to check host names, not IP addresses.
16358
16359 This option also applies when Exim is matching the special items
16360 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16361 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16362 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16363 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16364 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16365 interfaces and recognizing the local host.
16366
16367
16368 .option ibase_servers main "string list" unset
16369 .cindex "InterBase" "server list"
16370 This option provides a list of InterBase servers and associated connection data,
16371 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16372 The option is available only if Exim has been built with InterBase support.
16373
16374
16375
16376 .option ignore_bounce_errors_after main time 10w
16377 .cindex "bounce message" "discarding"
16378 .cindex "discarding bounce message"
16379 This option affects the processing of bounce messages that cannot be delivered,
16380 that is, those that suffer a permanent delivery failure. (Bounce messages that
16381 suffer temporary delivery failures are of course retried in the usual way.)
16382
16383 After a permanent delivery failure, bounce messages are frozen,
16384 because there is no sender to whom they can be returned. When a frozen bounce
16385 message has been in the queue for more than the given time, it is unfrozen at
16386 the next queue run, and a further delivery is attempted. If delivery fails
16387 again, the bounce message is discarded. This makes it possible to keep failed
16388 bounce messages around for a shorter time than the normal maximum retry time
16389 for frozen messages. For example,
16390 .code
16391 ignore_bounce_errors_after = 12h
16392 .endd
16393 retries failed bounce message deliveries after 12 hours, discarding any further
16394 failures. If the value of this option is set to a zero time period, bounce
16395 failures are discarded immediately. Setting a very long time (as in the default
16396 value) has the effect of disabling this option. For ways of automatically
16397 dealing with other kinds of frozen message, see &%auto_thaw%& and
16398 &%timeout_frozen_after%&.
16399
16400
16401 .option ignore_fromline_hosts main "host list&!!" unset
16402 .cindex "&""From""& line"
16403 .cindex "UUCP" "&""From""& line"
16404 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16405 the headers of a message. By default this is treated as the start of the
16406 message's body, which means that any following headers are not recognized as
16407 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16408 match those hosts that insist on sending it. If the sender is actually a local
16409 process rather than a remote host, and is using &%-bs%& to inject the messages,
16410 &%ignore_fromline_local%& must be set to achieve this effect.
16411
16412
16413 .option ignore_fromline_local main boolean false
16414 See &%ignore_fromline_hosts%& above.
16415
16416 .option keep_environment main "string list" unset
16417 .cindex "environment" "values from"
16418 This option contains a string list of environment variables to keep.
16419 You have to trust these variables or you have to be sure that
16420 these variables do not impose any security risk. Keep in mind that
16421 during the startup phase Exim is running with an effective UID 0 in most
16422 installations. As the default value is an empty list, the default
16423 environment for using libraries, running embedded Perl code, or running
16424 external binaries is empty, and does not not even contain PATH or HOME.
16425
16426 Actually the list is interpreted as a list of patterns
16427 (&<<SECTlistexpand>>&), except that it is not expanded first.
16428
16429 WARNING: Macro substitution is still done first, so having a macro
16430 FOO and having FOO_HOME in your &%keep_environment%& option may have
16431 unexpected results. You may work around this using a regular expression
16432 that does not match the macro name: ^[F]OO_HOME$.
16433
16434 Current versions of Exim issue a warning during startup if you do not mention
16435 &%keep_environment%& in your runtime configuration file and if your
16436 current environment is not empty. Future versions may not issue that warning
16437 anymore.
16438
16439 See the &%add_environment%& main config option for a way to set
16440 environment variables to a fixed value.  The environment for &(pipe)&
16441 transports is handled separately, see section &<<SECTpipeenv>>& for
16442 details.
16443
16444
16445 .option keep_malformed main time 4d
16446 This option specifies the length of time to keep messages whose spool files
16447 have been corrupted in some way. This should, of course, never happen. At the
16448 next attempt to deliver such a message, it gets removed. The incident is
16449 logged.
16450
16451
16452 .option ldap_ca_cert_dir main string unset
16453 .cindex "LDAP", "TLS CA certificate directory"
16454 .cindex certificate "directory for LDAP"
16455 This option indicates which directory contains CA certificates for verifying
16456 a TLS certificate presented by an LDAP server.
16457 While Exim does not provide a default value, your SSL library may.
16458 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16459 and constrained to be a directory.
16460
16461
16462 .option ldap_ca_cert_file main string unset
16463 .cindex "LDAP", "TLS CA certificate file"
16464 .cindex certificate "file for LDAP"
16465 This option indicates which file contains CA certificates for verifying
16466 a TLS certificate presented by an LDAP server.
16467 While Exim does not provide a default value, your SSL library may.
16468 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16469 and constrained to be a file.
16470
16471
16472 .option ldap_cert_file main string unset
16473 .cindex "LDAP" "TLS client certificate file"
16474 .cindex certificate "file for LDAP"
16475 This option indicates which file contains an TLS client certificate which
16476 Exim should present to the LDAP server during TLS negotiation.
16477 Should be used together with &%ldap_cert_key%&.
16478
16479
16480 .option ldap_cert_key main string unset
16481 .cindex "LDAP" "TLS client key file"
16482 .cindex certificate "key for LDAP"
16483 This option indicates which file contains the secret/private key to use
16484 to prove identity to the LDAP server during TLS negotiation.
16485 Should be used together with &%ldap_cert_file%&, which contains the
16486 identity to be proven.
16487
16488
16489 .option ldap_cipher_suite main string unset
16490 .cindex "LDAP" "TLS cipher suite"
16491 This controls the TLS cipher-suite negotiation during TLS negotiation with
16492 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16493 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16494
16495
16496 .option ldap_default_servers main "string list" unset
16497 .cindex "LDAP" "default servers"
16498 This option provides a list of LDAP servers which are tried in turn when an
16499 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16500 details of LDAP queries. This option is available only when Exim has been built
16501 with LDAP support.
16502
16503
16504 .option ldap_require_cert main string unset.
16505 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16506 This should be one of the values "hard", "demand", "allow", "try" or "never".
16507 A value other than one of these is interpreted as "never".
16508 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16509 Although Exim does not set a default, the LDAP library probably defaults
16510 to hard/demand.
16511
16512
16513 .option ldap_start_tls main boolean false
16514 .cindex "LDAP" "whether or not to negotiate TLS"
16515 If set, Exim will attempt to negotiate TLS with the LDAP server when
16516 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16517 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16518 of SSL-on-connect.
16519 In the event of failure to negotiate TLS, the action taken is controlled
16520 by &%ldap_require_cert%&.
16521 This option is ignored for &`ldapi`& connections.
16522
16523
16524 .option ldap_version main integer unset
16525 .cindex "LDAP" "protocol version, forcing"
16526 This option can be used to force Exim to set a specific protocol version for
16527 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16528 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16529 the LDAP headers; otherwise it is 2. This option is available only when Exim
16530 has been built with LDAP support.
16531
16532
16533
16534 .option local_from_check main boolean true
16535 .cindex "&'Sender:'& header line" "disabling addition of"
16536 .cindex "&'From:'& header line" "disabling checking of"
16537 When a message is submitted locally (that is, not over a TCP/IP connection) by
16538 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16539 checks that the &'From:'& header line matches the login of the calling user and
16540 the domain specified by &%qualify_domain%&.
16541
16542 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16543 locally submitted message is automatically qualified by Exim, unless the
16544 &%-bnq%& command line option is used.
16545
16546 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16547 on the local part. If the &'From:'& header line does not match, Exim adds a
16548 &'Sender:'& header with an address constructed from the calling user's login
16549 and the default qualify domain.
16550
16551 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16552 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16553 &'Sender:'& header lines supplied by untrusted users, you must also set
16554 &%local_sender_retain%& to be true.
16555
16556 .cindex "envelope from"
16557 .cindex "envelope sender"
16558 These options affect only the header lines in the message. The envelope sender
16559 is still forced to be the login id at the qualify domain unless
16560 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16561
16562 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16563 request similar header line checking. See section &<<SECTthesenhea>>&, which
16564 has more details about &'Sender:'& processing.
16565
16566
16567
16568
16569 .option local_from_prefix main string unset
16570 When Exim checks the &'From:'& header line of locally submitted messages for
16571 matching the login id (see &%local_from_check%& above), it can be configured to
16572 ignore certain prefixes and suffixes in the local part of the address. This is
16573 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16574 appropriate lists, in the same form as the &%local_part_prefix%& and
16575 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16576 example, if
16577 .code
16578 local_from_prefix = *-
16579 .endd
16580 is set, a &'From:'& line containing
16581 .code
16582 From: anything-user@your.domain.example
16583 .endd
16584 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16585 matches the actual sender address that is constructed from the login name and
16586 qualify domain.
16587
16588
16589 .option local_from_suffix main string unset
16590 See &%local_from_prefix%& above.
16591
16592
16593 .option local_interfaces main "string list" "see below"
16594 This option controls which network interfaces are used by the daemon for
16595 listening; they are also used to identify the local host when routing. Chapter
16596 &<<CHAPinterfaces>>& contains a full description of this option and the related
16597 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16598 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16599 &%local_interfaces%& is
16600 .code
16601 local_interfaces = 0.0.0.0
16602 .endd
16603 when Exim is built without IPv6 support; otherwise it is
16604 .code
16605 local_interfaces = <; ::0 ; 0.0.0.0
16606 .endd
16607
16608 .option local_scan_timeout main time 5m
16609 .cindex "timeout" "for &[local_scan()]& function"
16610 .cindex "&[local_scan()]& function" "timeout"
16611 This timeout applies to the &[local_scan()]& function (see chapter
16612 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16613 the incoming message is rejected with a temporary error if it is an SMTP
16614 message. For a non-SMTP message, the message is dropped and Exim ends with a
16615 non-zero code. The incident is logged on the main and reject logs.
16616
16617
16618
16619 .option local_sender_retain main boolean false
16620 .cindex "&'Sender:'& header line" "retaining from local submission"
16621 When a message is submitted locally (that is, not over a TCP/IP connection) by
16622 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16623 do not want this to happen, you must set &%local_sender_retain%&, and you must
16624 also set &%local_from_check%& to be false (Exim will complain if you do not).
16625 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16626 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16627
16628
16629
16630
16631 .option localhost_number main string&!! unset
16632 .cindex "host" "locally unique number for"
16633 .cindex "message ids" "with multiple hosts"
16634 .vindex "&$localhost_number$&"
16635 Exim's message ids are normally unique only within the local host. If
16636 uniqueness among a set of hosts is required, each host must set a different
16637 value for the &%localhost_number%& option. The string is expanded immediately
16638 after reading the configuration file (so that a number can be computed from the
16639 host name, for example) and the result of the expansion must be a number in the
16640 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16641 systems). This is available in subsequent string expansions via the variable
16642 &$localhost_number$&. When &%localhost_number is set%&, the final two
16643 characters of the message id, instead of just being a fractional part of the
16644 time, are computed from the time and the local host number as described in
16645 section &<<SECTmessiden>>&.
16646
16647
16648
16649 .option log_file_path main "string list&!!" "set at compile time"
16650 .cindex "log" "file path for"
16651 This option sets the path which is used to determine the names of Exim's log
16652 files, or indicates that logging is to be to syslog, or both. It is expanded
16653 when Exim is entered, so it can, for example, contain a reference to the host
16654 name. If no specific path is set for the log files at compile or runtime,
16655 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16656 they are written in a sub-directory called &_log_& in Exim's spool directory.
16657 A path must start with a slash.
16658 To send to syslog, use the word &"syslog"&.
16659 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16660 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16661 used. If this string is fixed at your installation (contains no expansion
16662 variables) it is recommended that you do not set this option in the
16663 configuration file, but instead supply the path using LOG_FILE_PATH in
16664 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16665 early on &-- in particular, failure to read the configuration file.
16666
16667
16668 .option log_selector main string unset
16669 .cindex "log" "selectors"
16670 This option can be used to reduce or increase the number of things that Exim
16671 writes to its log files. Its argument is made up of names preceded by plus or
16672 minus characters. For example:
16673 .code
16674 log_selector = +arguments -retry_defer
16675 .endd
16676 A list of possible names and what they control is given in the chapter on
16677 logging, in section &<<SECTlogselector>>&.
16678
16679
16680 .option log_timezone main boolean false
16681 .cindex "log" "timezone for entries"
16682 .vindex "&$tod_log$&"
16683 .vindex "&$tod_zone$&"
16684 By default, the timestamps on log lines are in local time without the
16685 timezone. This means that if your timezone changes twice a year, the timestamps
16686 in log lines are ambiguous for an hour when the clocks go back. One way of
16687 avoiding this problem is to set the timezone to UTC. An alternative is to set
16688 &%log_timezone%& true. This turns on the addition of the timezone offset to
16689 timestamps in log lines. Turning on this option can add quite a lot to the size
16690 of log files because each line is extended by 6 characters. Note that the
16691 &$tod_log$& variable contains the log timestamp without the zone, but there is
16692 another variable called &$tod_zone$& that contains just the timezone offset.
16693
16694
16695 .option lookup_open_max main integer 25
16696 .cindex "too many open files"
16697 .cindex "open files, too many"
16698 .cindex "file" "too many open"
16699 .cindex "lookup" "maximum open files"
16700 .cindex "limit" "open files for lookups"
16701 This option limits the number of simultaneously open files for single-key
16702 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16703 Exim normally keeps these files open during routing, because often the same
16704 file is required several times. If the limit is reached, Exim closes the least
16705 recently used file. Note that if you are using the &'ndbm'& library, it
16706 actually opens two files for each logical DBM database, though it still counts
16707 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16708 open files"& errors with NDBM, you need to reduce the value of
16709 &%lookup_open_max%&.
16710
16711
16712 .option max_username_length main integer 0
16713 .cindex "length of login name"
16714 .cindex "user name" "maximum length"
16715 .cindex "limit" "user name length"
16716 Some operating systems are broken in that they truncate long arguments to
16717 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16718 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16719 an argument that is longer behaves as if &[getpwnam()]& failed.
16720
16721
16722 .option message_body_newlines main bool false
16723 .cindex "message body" "newlines in variables"
16724 .cindex "newline" "in message body variables"
16725 .vindex "&$message_body$&"
16726 .vindex "&$message_body_end$&"
16727 By default, newlines in the message body are replaced by spaces when setting
16728 the &$message_body$& and &$message_body_end$& expansion variables. If this
16729 option is set true, this no longer happens.
16730
16731
16732 .option message_body_visible main integer 500
16733 .cindex "body of message" "visible size"
16734 .cindex "message body" "visible size"
16735 .vindex "&$message_body$&"
16736 .vindex "&$message_body_end$&"
16737 This option specifies how much of a message's body is to be included in the
16738 &$message_body$& and &$message_body_end$& expansion variables.
16739
16740
16741 .option message_id_header_domain main string&!! unset
16742 .cindex "&'Message-ID:'& header line"
16743 If this option is set, the string is expanded and used as the right hand side
16744 (domain) of the &'Message-ID:'& header that Exim creates if a
16745 locally-originated incoming message does not have one. &"Locally-originated"&
16746 means &"not received over TCP/IP."&
16747 Otherwise, the primary host name is used.
16748 Only letters, digits, dot and hyphen are accepted; any other characters are
16749 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16750 empty string, the option is ignored.
16751
16752
16753 .option message_id_header_text main string&!! unset
16754 If this variable is set, the string is expanded and used to augment the text of
16755 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16756 message does not have one. The text of this header is required by RFC 2822 to
16757 take the form of an address. By default, Exim uses its internal message id as
16758 the local part, and the primary host name as the domain. If this option is set,
16759 it is expanded, and provided the expansion is not forced to fail, and does not
16760 yield an empty string, the result is inserted into the header immediately
16761 before the @, separated from the internal message id by a dot. Any characters
16762 that are illegal in an address are automatically converted into hyphens. This
16763 means that variables such as &$tod_log$& can be used, because the spaces and
16764 colons will become hyphens.
16765
16766
16767 .option message_logs main boolean true
16768 .cindex "message logs" "disabling"
16769 .cindex "log" "message log; disabling"
16770 If this option is turned off, per-message log files are not created in the
16771 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16772 Exim, by reducing the number of files involved in handling a message from a
16773 minimum of four (header spool file, body spool file, delivery journal, and
16774 per-message log) to three. The other major I/O activity is Exim's main log,
16775 which is not affected by this option.
16776
16777
16778 .option message_size_limit main string&!! 50M
16779 .cindex "message" "size limit"
16780 .cindex "limit" "message size"
16781 .cindex "size" "of message, limit"
16782 This option limits the maximum size of message that Exim will process. The
16783 value is expanded for each incoming connection so, for example, it can be made
16784 to depend on the IP address of the remote host for messages arriving via
16785 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16786 optionally followed by K or M.
16787
16788 .cindex "SIZE" "ESMTP extension, advertising"
16789 .cindex "ESMTP extensions" SIZE
16790 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16791 service extension keyword.
16792
16793 &*Note*&: This limit cannot be made to depend on a message's sender or any
16794 other properties of an individual message, because it has to be advertised in
16795 the server's response to EHLO. String expansion failure causes a temporary
16796 error. A value of zero means no limit, but its use is not recommended. See also
16797 &%bounce_return_size_limit%&.
16798
16799 Incoming SMTP messages are failed with a 552 error if the limit is
16800 exceeded; locally-generated messages either get a stderr message or a delivery
16801 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16802 an oversized message is logged in both the main and the reject logs. See also
16803 the generic transport option &%message_size_limit%&, which limits the size of
16804 message that an individual transport can process.
16805
16806 If you use a virus-scanner and set this option to to a value larger than the
16807 maximum size that your virus-scanner is configured to support, you may get
16808 failures triggered by large mails.  The right size to configure for the
16809 virus-scanner depends upon what data is passed and the options in use but it's
16810 probably safest to just set it to a little larger than this value.  E.g., with a
16811 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16812 some problems may result.
16813
16814 A value of 0 will disable size limit checking; Exim will still advertise the
16815 SIZE extension in an EHLO response, but without a limit, so as to permit
16816 SMTP clients to still indicate the message size along with the MAIL verb.
16817
16818
16819 .option move_frozen_messages main boolean false
16820 .cindex "frozen messages" "moving"
16821 This option, which is available only if Exim has been built with the setting
16822 .code
16823 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16824 .endd
16825 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16826 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16827 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16828 standard utilities for handling such moved messages, and they do not show up in
16829 lists generated by &%-bp%& or by the Exim monitor.
16830
16831
16832 .option mua_wrapper main boolean false
16833 Setting this option true causes Exim to run in a very restrictive mode in which
16834 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16835 contains a full description of this facility.
16836
16837
16838
16839 .option mysql_servers main "string list" unset
16840 .cindex "MySQL" "server list"
16841 This option provides a list of MySQL servers and associated connection data, to
16842 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16843 option is available only if Exim has been built with MySQL support.
16844
16845
16846 .option never_users main "string list&!!" unset
16847 This option is expanded just once, at the start of Exim's processing. Local
16848 message deliveries are normally run in processes that are setuid to the
16849 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16850 It is usually desirable to prevent any deliveries from running as root, as a
16851 safety precaution.
16852
16853 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16854 list of users that must not be used for local deliveries. This list is fixed in
16855 the binary and cannot be overridden by the configuration file. By default, it
16856 contains just the single user name &"root"&. The &%never_users%& runtime option
16857 can be used to add more users to the fixed list.
16858
16859 If a message is to be delivered as one of the users on the fixed list or the
16860 &%never_users%& list, an error occurs, and delivery is deferred. A common
16861 example is
16862 .code
16863 never_users = root:daemon:bin
16864 .endd
16865 Including root is redundant if it is also on the fixed list, but it does no
16866 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16867 transport driver.
16868
16869
16870 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16871 This option gives the name for a unix-domain socket on which the daemon
16872 listens for work and information-requests.
16873 Only installations running multiple daemons sharing a spool directory
16874 should need to modify the default.
16875
16876 The option is expanded before use.
16877 If the platform supports Linux-style abstract socket names, the result
16878 is used with a nul byte prefixed.
16879 Otherwise,
16880 it should be a full path name and use a directory accessible
16881 to Exim.
16882
16883 If this option is set as empty,
16884 or the command line &%-oY%& option is used, or
16885 the command line uses a &%-oX%& option and does not use &%-oP%&,
16886 then a notifier socket is not created.
16887
16888
16889 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16890 .cindex "OpenSSL "compatibility options"
16891 This option allows an administrator to adjust the SSL options applied
16892 by OpenSSL to connections.  It is given as a space-separated list of items,
16893 each one to be +added or -subtracted from the current value.
16894
16895 This option is only available if Exim is built against OpenSSL.  The values
16896 available for this option vary according to the age of your OpenSSL install.
16897 The &"all"& value controls a subset of flags which are available, typically
16898 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16899 list the values known on your system and Exim should support all the
16900 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16901 names lose the leading &"SSL_OP_"& and are lower-cased.
16902
16903 Note that adjusting the options can have severe impact upon the security of
16904 SSL as used by Exim.  It is possible to disable safety checks and shoot
16905 yourself in the foot in various unpleasant ways.  This option should not be
16906 adjusted lightly.  An unrecognised item will be detected at startup, by
16907 invoking Exim with the &%-bV%& flag.
16908
16909 The option affects Exim operating both as a server and as a client.
16910
16911 Historical note: prior to release 4.80, Exim defaulted this value to
16912 "+dont_insert_empty_fragments", which may still be needed for compatibility
16913 with some clients, but which lowers security by increasing exposure to
16914 some now infamous attacks.
16915
16916 Examples:
16917 .code
16918 # Make both old MS and old Eudora happy:
16919 openssl_options = -all +microsoft_big_sslv3_buffer \
16920                        +dont_insert_empty_fragments
16921
16922 # Disable older protocol versions:
16923 openssl_options = +no_sslv2 +no_sslv3
16924 .endd
16925
16926 Possible options may include:
16927 .ilist
16928 &`all`&
16929 .next
16930 &`allow_unsafe_legacy_renegotiation`&
16931 .next
16932 &`cipher_server_preference`&
16933 .next
16934 &`dont_insert_empty_fragments`&
16935 .next
16936 &`ephemeral_rsa`&
16937 .next
16938 &`legacy_server_connect`&
16939 .next
16940 &`microsoft_big_sslv3_buffer`&
16941 .next
16942 &`microsoft_sess_id_bug`&
16943 .next
16944 &`msie_sslv2_rsa_padding`&
16945 .next
16946 &`netscape_challenge_bug`&
16947 .next
16948 &`netscape_reuse_cipher_change_bug`&
16949 .next
16950 &`no_compression`&
16951 .next
16952 &`no_session_resumption_on_renegotiation`&
16953 .next
16954 &`no_sslv2`&
16955 .next
16956 &`no_sslv3`&
16957 .next
16958 &`no_ticket`&
16959 .next
16960 &`no_tlsv1`&
16961 .next
16962 &`no_tlsv1_1`&
16963 .next
16964 &`no_tlsv1_2`&
16965 .next
16966 &`safari_ecdhe_ecdsa_bug`&
16967 .next
16968 &`single_dh_use`&
16969 .next
16970 &`single_ecdh_use`&
16971 .next
16972 &`ssleay_080_client_dh_bug`&
16973 .next
16974 &`sslref2_reuse_cert_type_bug`&
16975 .next
16976 &`tls_block_padding_bug`&
16977 .next
16978 &`tls_d5_bug`&
16979 .next
16980 &`tls_rollback_bug`&
16981 .endlist
16982
16983 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16984 all clients connecting using the MacOS SecureTransport TLS facility prior
16985 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16986 to negotiate TLS then this option value might help, provided that your OpenSSL
16987 release is new enough to contain this work-around.  This may be a situation
16988 where you have to upgrade OpenSSL to get buggy clients working.
16989
16990
16991 .option oracle_servers main "string list" unset
16992 .cindex "Oracle" "server list"
16993 This option provides a list of Oracle servers and associated connection data,
16994 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16995 The option is available only if Exim has been built with Oracle support.
16996
16997
16998 .new
16999 .option panic_coredump main boolean false
17000 This option is rarely needed but can help for some debugging investigations.
17001 If set, when an internal error is detected by Exim which is sufficient
17002 to terminate the process
17003 (all such are logged in the paniclog)
17004 then a coredump is requested.
17005
17006 Note that most systems require additional administrative configuration
17007 to permit write a core file for a setuid program, which is Exim's
17008 common installed configuration.
17009 .wen
17010
17011 .option percent_hack_domains main "domain list&!!" unset
17012 .cindex "&""percent hack""&"
17013 .cindex "source routing" "in email address"
17014 .cindex "address" "source-routed"
17015 The &"percent hack"& is the convention whereby a local part containing a
17016 percent sign is re-interpreted as a new email address, with the percent
17017 replaced by @. This is sometimes called &"source routing"&, though that term is
17018 also applied to RFC 2822 addresses that begin with an @ character. If this
17019 option is set, Exim implements the percent facility for those domains listed,
17020 but no others. This happens before an incoming SMTP address is tested against
17021 an ACL.
17022
17023 &*Warning*&: The &"percent hack"& has often been abused by people who are
17024 trying to get round relaying restrictions. For this reason, it is best avoided
17025 if at all possible. Unfortunately, a number of less security-conscious MTAs
17026 implement it unconditionally. If you are running Exim on a gateway host, and
17027 routing mail through to internal MTAs without processing the local parts, it is
17028 a good idea to reject recipient addresses with percent characters in their
17029 local parts. Exim's default configuration does this.
17030
17031
17032 .option perl_at_start main boolean false
17033 .cindex "Perl"
17034 This option is available only when Exim is built with an embedded Perl
17035 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17036
17037
17038 .option perl_startup main string unset
17039 .cindex "Perl"
17040 This option is available only when Exim is built with an embedded Perl
17041 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17042
17043 .option perl_taintmode main boolean false
17044 .cindex "Perl"
17045 This option enables the taint mode of the embedded Perl interpreter.
17046
17047
17048 .option pgsql_servers main "string list" unset
17049 .cindex "PostgreSQL lookup type" "server list"
17050 This option provides a list of PostgreSQL servers and associated connection
17051 data, to be used in conjunction with &(pgsql)& lookups (see section
17052 &<<SECID72>>&). The option is available only if Exim has been built with
17053 PostgreSQL support.
17054
17055
17056 .option pid_file_path main string&!! "set at compile time"
17057 .cindex "daemon" "pid file path"
17058 .cindex "pid file, path for"
17059 This option sets the name of the file to which the Exim daemon writes its
17060 process id. The string is expanded, so it can contain, for example, references
17061 to the host name:
17062 .code
17063 pid_file_path = /var/log/$primary_hostname/exim.pid
17064 .endd
17065 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17066 spool directory.
17067 The value set by the option can be overridden by the &%-oP%& command line
17068 option. A pid file is not written if a &"non-standard"& daemon is run by means
17069 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17070
17071
17072 .option pipelining_advertise_hosts main "host list&!!" *
17073 .cindex "PIPELINING" "suppressing advertising"
17074 .cindex "ESMTP extensions" PIPELINING
17075 This option can be used to suppress the advertisement of the SMTP
17076 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17077 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17078 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17079 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17080 that clients will use it; &"out of order"& commands that are &"expected"& do
17081 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17082
17083 .option pipelining_connect_advertise_hosts main "host list&!!" *
17084 .cindex "pipelining" "early connection"
17085 .cindex "pipelining" PIPECONNECT
17086 .cindex "ESMTP extensions" PIPECONNECT
17087 If Exim is built without the DISABLE_PIPE_CONNECT build option
17088 this option controls which hosts the facility is advertised to
17089 and from which pipeline early-connection (before MAIL) SMTP
17090 commands are acceptable.
17091 When used, the pipelining saves on roundtrip times.
17092
17093 See also the &%hosts_pipe_connect%& smtp transport option.
17094
17095 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17096 it permits the client to pipeline
17097 TCP connection and hello command (inclear phase),
17098 or TLS-establishment and hello command (encrypted phase),
17099 on later connections to the same host.
17100
17101
17102 .option prdr_enable main boolean false
17103 .cindex "PRDR" "enabling on server"
17104 .cindex "ESMTP extensions" PRDR
17105 This option can be used to enable the Per-Recipient Data Response extension
17106 to SMTP, defined by Eric Hall.
17107 If the option is set, PRDR is advertised by Exim when operating as a server.
17108 If the client requests PRDR, and more than one recipient, for a message
17109 an additional ACL is called for each recipient after the message content
17110 is received.  See section &<<SECTPRDRACL>>&.
17111
17112 .option preserve_message_logs main boolean false
17113 .cindex "message logs" "preserving"
17114 If this option is set, message log files are not deleted when messages are
17115 completed. Instead, they are moved to a sub-directory of the spool directory
17116 called &_msglog.OLD_&, where they remain available for statistical or debugging
17117 purposes. This is a dangerous option to set on systems with any appreciable
17118 volume of mail. Use with care!
17119
17120
17121 .option primary_hostname main string "see below"
17122 .cindex "name" "of local host"
17123 .cindex "host" "name of local"
17124 .cindex "local host" "name of"
17125 .vindex "&$primary_hostname$&"
17126 This specifies the name of the current host. It is used in the default EHLO or
17127 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17128 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17129 The value is also used by default in some SMTP response messages from an Exim
17130 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17131
17132 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17133 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17134 contains only one component, Exim passes it to &[gethostbyname()]& (or
17135 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17136 version. The variable &$primary_hostname$& contains the host name, whether set
17137 explicitly by this option, or defaulted.
17138
17139
17140 .option print_topbitchars main boolean false
17141 .cindex "printing characters"
17142 .cindex "8-bit characters"
17143 By default, Exim considers only those characters whose codes lie in the range
17144 32&--126 to be printing characters. In a number of circumstances (for example,
17145 when writing log entries) non-printing characters are converted into escape
17146 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17147 is set, code values of 128 and above are also considered to be printing
17148 characters.
17149
17150 This option also affects the header syntax checks performed by the
17151 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17152 the user's full name when constructing From: and Sender: addresses (as
17153 described in section &<<SECTconstr>>&). Setting this option can cause
17154 Exim to generate eight bit message headers that do not conform to the
17155 standards.
17156
17157
17158 .option process_log_path main string unset
17159 .cindex "process log path"
17160 .cindex "log" "process log"
17161 .cindex "&'exiwhat'&"
17162 This option sets the name of the file to which an Exim process writes its
17163 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17164 utility script. If this option is unset, the file called &_exim-process.info_&
17165 in Exim's spool directory is used. The ability to specify the name explicitly
17166 can be useful in environments where two different Exims are running, using
17167 different spool directories.
17168
17169
17170 .option prod_requires_admin main boolean true
17171 .cindex "restricting access to features"
17172 .oindex "&%-M%&"
17173 .oindex "&%-R%&"
17174 .oindex "&%-q%&"
17175 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17176 admin user unless &%prod_requires_admin%& is set false. See also
17177 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17178
17179
17180 .option proxy_protocol_timeout main time 3s
17181 .cindex proxy "proxy protocol"
17182 This option sets the timeout for proxy protocol negotiation.
17183 For details see section &<<SECTproxyInbound>>&.
17184
17185
17186 .option qualify_domain main string "see below"
17187 .cindex "domain" "for qualifying addresses"
17188 .cindex "address" "qualification"
17189 This option specifies the domain name that is added to any envelope sender
17190 addresses that do not have a domain qualification. It also applies to
17191 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17192 are accepted by default only for locally-generated messages. Qualification is
17193 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17194 locally-generated messages, unless the &%-bnq%& command line option is used.
17195
17196 Messages from external sources must always contain fully qualified addresses,
17197 unless the sending host matches &%sender_unqualified_hosts%& or
17198 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17199 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17200 necessary. Internally, Exim always works with fully qualified envelope
17201 addresses. If &%qualify_domain%& is not set, it defaults to the
17202 &%primary_hostname%& value.
17203
17204
17205 .option qualify_recipient main string "see below"
17206 This option allows you to specify a different domain for qualifying recipient
17207 addresses to the one that is used for senders. See &%qualify_domain%& above.
17208
17209
17210
17211 .option queue_domains main "domain list&!!" unset
17212 .cindex "domain" "specifying non-immediate delivery"
17213 .cindex "queueing incoming messages"
17214 .cindex "message" "queueing certain domains"
17215 This option lists domains for which immediate delivery is not required.
17216 A delivery process is started whenever a message is received, but only those
17217 domains that do not match are processed. All other deliveries wait until the
17218 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17219
17220
17221 .option queue_fast_ramp main boolean true
17222 .cindex "queue runner" "two phase"
17223 .cindex "queue" "double scanning"
17224 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17225 command line, may start parallel delivery processes during their first
17226 phase.  This will be done when a threshold number of messages have been
17227 routed for a single host.
17228
17229
17230 .option queue_list_requires_admin main boolean true
17231 .cindex "restricting access to features"
17232 .oindex "&%-bp%&"
17233 The &%-bp%& command-line option, which lists the messages that are on the
17234 queue, requires the caller to be an admin user unless
17235 &%queue_list_requires_admin%& is set false.
17236 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17237
17238
17239 .option queue_only main boolean false
17240 .cindex "queueing incoming messages"
17241 .cindex "message" "queueing unconditionally"
17242 If &%queue_only%& is set, a delivery process is not automatically started
17243 whenever a message is received. Instead, the message waits in the queue for the
17244 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17245 delivered immediately when certain conditions (such as heavy load) occur.
17246
17247 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17248 and &%-odi%& command line options override &%queue_only%& unless
17249 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17250 &%queue_only_load%&, and &%smtp_accept_queue%&.
17251
17252
17253 .option queue_only_file main string unset
17254 .cindex "queueing incoming messages"
17255 .cindex "message" "queueing by file existence"
17256 This option can be set to a colon-separated list of absolute path names, each
17257 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17258 it tests for the existence of each listed path using a call to &[stat()]&. For
17259 each path that exists, the corresponding queueing option is set.
17260 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17261 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17262 .code
17263 queue_only_file = smtp/some/file
17264 .endd
17265 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17266 &_/some/file_& exists.
17267
17268
17269 .option queue_only_load main fixed-point unset
17270 .cindex "load average"
17271 .cindex "queueing incoming messages"
17272 .cindex "message" "queueing by load"
17273 If the system load average is higher than this value, incoming messages from
17274 all sources are queued, and no automatic deliveries are started. If this
17275 happens during local or remote SMTP input, all subsequent messages received on
17276 the same SMTP connection are queued by default, whatever happens to the load in
17277 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17278 false.
17279
17280 Deliveries will subsequently be performed by queue runner processes. This
17281 option has no effect on ancient operating systems on which Exim cannot
17282 determine the load average. See also &%deliver_queue_load_max%& and
17283 &%smtp_load_reserve%&.
17284
17285
17286 .option queue_only_load_latch main boolean true
17287 .cindex "load average" "re-evaluating per message"
17288 When this option is true (the default), once one message has been queued
17289 because the load average is higher than the value set by &%queue_only_load%&,
17290 all subsequent messages received on the same SMTP connection are also queued.
17291 This is a deliberate choice; even though the load average may fall below the
17292 threshold, it doesn't seem right to deliver later messages on the same
17293 connection when not delivering earlier ones. However, there are special
17294 circumstances such as very long-lived connections from scanning appliances
17295 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17296 should be set false. This causes the value of the load average to be
17297 re-evaluated for each message.
17298
17299
17300 .option queue_only_override main boolean true
17301 .cindex "queueing incoming messages"
17302 When this option is true, the &%-od%&&'x'& command line options override the
17303 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17304 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17305 to override; they are accepted, but ignored.
17306
17307
17308 .option queue_run_in_order main boolean false
17309 .cindex "queue runner" "processing messages in order"
17310 If this option is set, queue runs happen in order of message arrival instead of
17311 in an arbitrary order. For this to happen, a complete list of the entire queue
17312 must be set up before the deliveries start. When the queue is all held in a
17313 single directory (the default), a single list is created for both the ordered
17314 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17315 single list is not created when &%queue_run_in_order%& is false. In this case,
17316 the sub-directories are processed one at a time (in a random order), and this
17317 avoids setting up one huge list for the whole queue. Thus, setting
17318 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17319 when the queue is large, because of the extra work in setting up the single,
17320 large list. In most situations, &%queue_run_in_order%& should not be set.
17321
17322
17323
17324 .option queue_run_max main integer&!! 5
17325 .cindex "queue runner" "maximum number of"
17326 This controls the maximum number of queue runner processes that an Exim daemon
17327 can run simultaneously. This does not mean that it starts them all at once,
17328 but rather that if the maximum number are still running when the time comes to
17329 start another one, it refrains from starting another one. This can happen with
17330 very large queues and/or very sluggish deliveries. This option does not,
17331 however, interlock with other processes, so additional queue runners can be
17332 started by other means, or by killing and restarting the daemon.
17333
17334 Setting this option to zero does not suppress queue runs; rather, it disables
17335 the limit, allowing any number of simultaneous queue runner processes to be
17336 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17337 the daemon's command line.
17338
17339 .cindex queues named
17340 .cindex "named queues" "resource limit"
17341 To set limits for different named queues use
17342 an expansion depending on the &$queue_name$& variable.
17343
17344 .option queue_smtp_domains main "domain list&!!" unset
17345 .cindex "queueing incoming messages"
17346 .cindex "message" "queueing remote deliveries"
17347 .cindex "first pass routing"
17348 When this option is set, a delivery process is started whenever a message is
17349 received, routing is performed, and local deliveries take place.
17350 However, if any SMTP deliveries are required for domains that match
17351 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17352 message waits in the queue for the next queue run. Since routing of the message
17353 has taken place, Exim knows to which remote hosts it must be delivered, and so
17354 when the queue run happens, multiple messages for the same host are delivered
17355 over a single SMTP connection. The &%-odqs%& command line option causes all
17356 SMTP deliveries to be queued in this way, and is equivalent to setting
17357 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17358 &%queue_domains%&.
17359
17360
17361 .option receive_timeout main time 0s
17362 .cindex "timeout" "for non-SMTP input"
17363 This option sets the timeout for accepting a non-SMTP message, that is, the
17364 maximum time that Exim waits when reading a message on the standard input. If
17365 the value is zero, it will wait forever. This setting is overridden by the
17366 &%-or%& command line option. The timeout for incoming SMTP messages is
17367 controlled by &%smtp_receive_timeout%&.
17368
17369 .option received_header_text main string&!! "see below"
17370 .cindex "customizing" "&'Received:'& header"
17371 .cindex "&'Received:'& header line" "customizing"
17372 This string defines the contents of the &'Received:'& message header that is
17373 added to each message, except for the timestamp, which is automatically added
17374 on at the end (preceded by a semicolon). The string is expanded each time it is
17375 used. If the expansion yields an empty string, no &'Received:'& header line is
17376 added to the message. Otherwise, the string should start with the text
17377 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17378 header lines.
17379 The default setting is:
17380
17381 .code
17382 received_header_text = Received: \
17383   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17384     {${if def:sender_ident \
17385       {from ${quote_local_part:$sender_ident} }}\
17386         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17387   by $primary_hostname \
17388   ${if def:received_protocol {with $received_protocol }}\
17389   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17390   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17391   (Exim $version_number)\n\t\
17392   ${if def:sender_address \
17393   {(envelope-from <$sender_address>)\n\t}}\
17394   id $message_exim_id\
17395   ${if def:received_for {\n\tfor $received_for}}
17396 .endd
17397
17398 The references to the TLS version and cipher are
17399 omitted when Exim is built without TLS
17400 support. The use of conditional expansions ensures that this works for both
17401 locally generated messages and messages received from remote hosts, giving
17402 header lines such as the following:
17403 .code
17404 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17405 by marley.carol.example with esmtp (Exim 4.00)
17406 (envelope-from <bob@carol.example>)
17407 id 16IOWa-00019l-00
17408 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17409 Received: by scrooge.carol.example with local (Exim 4.00)
17410 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17411 .endd
17412 Until the body of the message has been received, the timestamp is the time when
17413 the message started to be received. Once the body has arrived, and all policy
17414 checks have taken place, the timestamp is updated to the time at which the
17415 message was accepted.
17416
17417
17418 .option received_headers_max main integer 30
17419 .cindex "loop" "prevention"
17420 .cindex "mail loop prevention"
17421 .cindex "&'Received:'& header line" "counting"
17422 When a message is to be delivered, the number of &'Received:'& headers is
17423 counted, and if it is greater than this parameter, a mail loop is assumed to
17424 have occurred, the delivery is abandoned, and an error message is generated.
17425 This applies to both local and remote deliveries.
17426
17427
17428 .option recipient_unqualified_hosts main "host list&!!" unset
17429 .cindex "unqualified addresses"
17430 .cindex "host" "unqualified addresses from"
17431 This option lists those hosts from which Exim is prepared to accept unqualified
17432 recipient addresses in message envelopes. The addresses are made fully
17433 qualified by the addition of the &%qualify_recipient%& value. This option also
17434 affects message header lines. Exim does not reject unqualified recipient
17435 addresses in headers, but it qualifies them only if the message came from a
17436 host that matches &%recipient_unqualified_hosts%&,
17437 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17438 option was not set.
17439
17440
17441 .option recipients_max main integer 50000
17442 .cindex "limit" "number of recipients"
17443 .cindex "recipient" "maximum number"
17444 If this option is set greater than zero, it specifies the maximum number of
17445 original recipients for any message. Additional recipients that are generated
17446 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17447 all recipients over the limit; earlier recipients are delivered as normal.
17448 Non-SMTP messages with too many recipients are failed, and no deliveries are
17449 done.
17450
17451 .cindex "RCPT" "maximum number of incoming"
17452 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17453 RCPT commands in a single message.
17454
17455
17456 .option recipients_max_reject main boolean false
17457 If this option is set true, Exim rejects SMTP messages containing too many
17458 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17459 error to the eventual DATA command. Otherwise (the default) it gives a 452
17460 error to the surplus RCPT commands and accepts the message on behalf of the
17461 initial set of recipients. The remote server should then re-send the message
17462 for the remaining recipients at a later time.
17463
17464
17465 .option remote_max_parallel main integer 4
17466 .cindex "delivery" "parallelism for remote"
17467 This option controls parallel delivery of one message to a number of remote
17468 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17469 does all the remote deliveries for a message one by one. Otherwise, if a single
17470 message has to be delivered to more than one remote host, or if several copies
17471 have to be sent to the same remote host, up to &%remote_max_parallel%&
17472 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17473 deliveries are required, the maximum number of processes are started, and as
17474 each one finishes, another is begun. The order of starting processes is the
17475 same as if sequential delivery were being done, and can be controlled by the
17476 &%remote_sort_domains%& option. If parallel delivery takes place while running
17477 with debugging turned on, the debugging output from each delivery process is
17478 tagged with its process id.
17479
17480 This option controls only the maximum number of parallel deliveries for one
17481 message in one Exim delivery process. Because Exim has no central queue
17482 manager, there is no way of controlling the total number of simultaneous
17483 deliveries if the configuration allows a delivery attempt as soon as a message
17484 is received.
17485
17486 See also the &%max_parallel%& generic transport option,
17487 and the &%serialize_hosts%& smtp transport option.
17488
17489 .cindex "number of deliveries"
17490 .cindex "delivery" "maximum number of"
17491 If you want to control the total number of deliveries on the system, you
17492 need to set the &%queue_only%& option. This ensures that all incoming messages
17493 are added to the queue without starting a delivery process. Then set up an Exim
17494 daemon to start queue runner processes at appropriate intervals (probably
17495 fairly often, for example, every minute), and limit the total number of queue
17496 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17497 delivers only one message at a time, the maximum number of deliveries that can
17498 then take place at once is &%queue_run_max%& multiplied by
17499 &%remote_max_parallel%&.
17500
17501 If it is purely remote deliveries you want to control, use
17502 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17503 doing the SMTP routing before queueing, so that several messages for the same
17504 host will eventually get delivered down the same connection.
17505
17506
17507 .option remote_sort_domains main "domain list&!!" unset
17508 .cindex "sorting remote deliveries"
17509 .cindex "delivery" "sorting remote"
17510 When there are a number of remote deliveries for a message, they are sorted by
17511 domain into the order given by this list. For example,
17512 .code
17513 remote_sort_domains = *.cam.ac.uk:*.uk
17514 .endd
17515 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17516 then to those in the &%uk%& domain, then to any others.
17517
17518
17519 .option retry_data_expire main time 7d
17520 .cindex "hints database" "data expiry"
17521 This option sets a &"use before"& time on retry information in Exim's hints
17522 database. Any older retry data is ignored. This means that, for example, once a
17523 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17524 past failures.
17525
17526
17527 .option retry_interval_max main time 24h
17528 .cindex "retry" "limit on interval"
17529 .cindex "limit" "on retry interval"
17530 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17531 intervals between delivery attempts for messages that cannot be delivered
17532 straight away. This option sets an overall limit to the length of time between
17533 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17534 the default value.
17535
17536
17537 .option return_path_remove main boolean true
17538 .cindex "&'Return-path:'& header line" "removing"
17539 RFC 2821, section 4.4, states that an SMTP server must insert a
17540 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17541 The &'Return-path:'& header preserves the sender address as received in the
17542 MAIL command. This description implies that this header should not be present
17543 in an incoming message. If &%return_path_remove%& is true, any existing
17544 &'Return-path:'& headers are removed from messages at the time they are
17545 received. Exim's transports have options for adding &'Return-path:'& headers at
17546 the time of delivery. They are normally used only for final local deliveries.
17547
17548
17549 .option return_size_limit main integer 100K
17550 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17551
17552
17553 .option rfc1413_hosts main "host list&!!" @[]
17554 .cindex "RFC 1413"
17555 .cindex "host" "for RFC 1413 calls"
17556 RFC 1413 identification calls are made to any client host which matches
17557 an item in the list.
17558 The default value specifies just this host, being any local interface
17559 for the system.
17560
17561 .option rfc1413_query_timeout main time 0s
17562 .cindex "RFC 1413" "query timeout"
17563 .cindex "timeout" "for RFC 1413 call"
17564 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17565 no RFC 1413 calls are ever made.
17566
17567
17568 .option sender_unqualified_hosts main "host list&!!" unset
17569 .cindex "unqualified addresses"
17570 .cindex "host" "unqualified addresses from"
17571 This option lists those hosts from which Exim is prepared to accept unqualified
17572 sender addresses. The addresses are made fully qualified by the addition of
17573 &%qualify_domain%&. This option also affects message header lines. Exim does
17574 not reject unqualified addresses in headers that contain sender addresses, but
17575 it qualifies them only if the message came from a host that matches
17576 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17577 using TCP/IP), and the &%-bnq%& option was not set.
17578
17579
17580 .option slow_lookup_log main integer 0
17581 .cindex "logging" "slow lookups"
17582 .cindex "dns" "logging slow lookups"
17583 This option controls logging of slow lookups.
17584 If the value is nonzero it is taken as a number of milliseconds
17585 and lookups taking longer than this are logged.
17586 Currently this applies only to DNS lookups.
17587
17588
17589
17590 .option smtp_accept_keepalive main boolean true
17591 .cindex "keepalive" "on incoming connection"
17592 This option controls the setting of the SO_KEEPALIVE option on incoming
17593 TCP/IP socket connections. When set, it causes the kernel to probe idle
17594 connections periodically, by sending packets with &"old"& sequence numbers. The
17595 other end of the connection should send an acknowledgment if the connection is
17596 still okay or a reset if the connection has been aborted. The reason for doing
17597 this is that it has the beneficial effect of freeing up certain types of
17598 connection that can get stuck when the remote host is disconnected without
17599 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17600 hours to detect unreachable hosts.
17601
17602
17603
17604 .option smtp_accept_max main integer 20
17605 .cindex "limit" "incoming SMTP connections"
17606 .cindex "SMTP" "incoming connection count"
17607 .cindex "inetd"
17608 This option specifies the maximum number of simultaneous incoming SMTP calls
17609 that Exim will accept. It applies only to the listening daemon; there is no
17610 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17611 value is set to zero, no limit is applied. However, it is required to be
17612 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17613 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17614
17615 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17616 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17617 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17618 and &%smtp_load_reserve%& are then checked before accepting the connection.
17619
17620
17621 .option smtp_accept_max_nonmail main integer 10
17622 .cindex "limit" "non-mail SMTP commands"
17623 .cindex "SMTP" "limiting non-mail commands"
17624 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17625 the connection if there are too many. This option defines &"too many"&. The
17626 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17627 client looping sending EHLO, for example. The check is applied only if the
17628 client host matches &%smtp_accept_max_nonmail_hosts%&.
17629
17630 When a new message is expected, one occurrence of RSET is not counted. This
17631 allows a client to send one RSET between messages (this is not necessary,
17632 but some clients do it). Exim also allows one uncounted occurrence of HELO
17633 or EHLO, and one occurrence of STARTTLS between messages. After
17634 starting up a TLS session, another EHLO is expected, and so it too is not
17635 counted. The first occurrence of AUTH in a connection, or immediately
17636 following STARTTLS is not counted. Otherwise, all commands other than
17637 MAIL, RCPT, DATA, and QUIT are counted.
17638
17639
17640 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17641 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17642 check by setting this option. The default value makes it apply to all hosts. By
17643 changing the value, you can exclude any badly-behaved hosts that you have to
17644 live with.
17645
17646
17647 . Allow this long option name to split; give it unsplit as a fifth argument
17648 . for the automatic .oindex that is generated by .option.
17649 . We insert " &~&~" which is both pretty nasty visually and results in
17650 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17651 . zero-width-space, which would be nicer visually and results in (at least)
17652 . html that Firefox will split on when it's forced to reflow (rather than
17653 . inserting a horizontal scrollbar).  However, the text is still not
17654 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17655 . the option name to split.
17656
17657 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17658          smtp_accept_max_per_connection
17659 .cindex "SMTP" "limiting incoming message count"
17660 .cindex "limit" "messages per SMTP connection"
17661 The value of this option limits the number of MAIL commands that Exim is
17662 prepared to accept over a single SMTP connection, whether or not each command
17663 results in the transfer of a message. After the limit is reached, a 421
17664 response is given to subsequent MAIL commands. This limit is a safety
17665 precaution against a client that goes mad (incidents of this type have been
17666 seen).
17667 The option is expanded after the HELO or EHLO is received
17668 and may depend on values available at that time.
17669 An empty or zero value after expansion removes the limit.
17670
17671
17672 .option smtp_accept_max_per_host main string&!! unset
17673 .cindex "limit" "SMTP connections from one host"
17674 .cindex "host" "limiting SMTP connections from"
17675 This option restricts the number of simultaneous IP connections from a single
17676 host (strictly, from a single IP address) to the Exim daemon. The option is
17677 expanded, to enable different limits to be applied to different hosts by
17678 reference to &$sender_host_address$&. Once the limit is reached, additional
17679 connection attempts from the same host are rejected with error code 421. This
17680 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17681 of zero imposes no limit. If this option is set greater than zero, it is
17682 required that &%smtp_accept_max%& be non-zero.
17683
17684 &*Warning*&: When setting this option you should not use any expansion
17685 constructions that take an appreciable amount of time. The expansion and test
17686 happen in the main daemon loop, in order to reject additional connections
17687 without forking additional processes (otherwise a denial-of-service attack
17688 could cause a vast number or processes to be created). While the daemon is
17689 doing this processing, it cannot accept any other incoming connections.
17690
17691
17692
17693 .option smtp_accept_queue main integer 0
17694 .cindex "SMTP" "incoming connection count"
17695 .cindex "queueing incoming messages"
17696 .cindex "message" "queueing by SMTP connection count"
17697 If the number of simultaneous incoming SMTP connections being handled via the
17698 listening daemon exceeds this value, messages received by SMTP are just placed
17699 in the queue; no delivery processes are started automatically. The count is
17700 fixed at the start of an SMTP connection. It cannot be updated in the
17701 subprocess that receives messages, and so the queueing or not queueing applies
17702 to all messages received in the same connection.
17703
17704 A value of zero implies no limit, and clearly any non-zero value is useful only
17705 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17706 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17707 various &%-od%&&'x'& command line options.
17708
17709
17710 . See the comment on smtp_accept_max_per_connection
17711
17712 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17713          smtp_accept_queue_per_connection
17714 .cindex "queueing incoming messages"
17715 .cindex "message" "queueing by message count"
17716 This option limits the number of delivery processes that Exim starts
17717 automatically when receiving messages via SMTP, whether via the daemon or by
17718 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17719 and the number of messages received in a single SMTP session exceeds this
17720 number, subsequent messages are placed in the queue, but no delivery processes
17721 are started. This helps to limit the number of Exim processes when a server
17722 restarts after downtime and there is a lot of mail waiting for it on other
17723 systems. On large systems, the default should probably be increased, and on
17724 dial-in client systems it should probably be set to zero (that is, disabled).
17725
17726
17727 .option smtp_accept_reserve main integer 0
17728 .cindex "SMTP" "incoming call count"
17729 .cindex "host" "reserved"
17730 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17731 number of SMTP connections that are reserved for connections from the hosts
17732 that are specified in &%smtp_reserve_hosts%&. The value set in
17733 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17734 restricted to this number of connections; the option specifies a minimum number
17735 of connection slots for them, not a maximum. It is a guarantee that this group
17736 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17737 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17738 individual host.
17739
17740 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17741 set to 5, once there are 45 active connections (from any hosts), new
17742 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17743 provided the other criteria for acceptance are met.
17744
17745
17746 .option smtp_active_hostname main string&!! unset
17747 .cindex "host" "name in SMTP responses"
17748 .cindex "SMTP" "host name in responses"
17749 .vindex "&$primary_hostname$&"
17750 This option is provided for multi-homed servers that want to masquerade as
17751 several different hosts. At the start of an incoming SMTP connection, its value
17752 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17753 responses. For example, it is used as domain name in the response to an
17754 incoming HELO or EHLO command.
17755
17756 .vindex "&$smtp_active_hostname$&"
17757 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17758 is saved with any messages that are received. It is therefore available for use
17759 in routers and transports when the message is later delivered.
17760
17761 If this option is unset, or if its expansion is forced to fail, or if the
17762 expansion results in an empty string, the value of &$primary_hostname$& is
17763 used. Other expansion failures cause a message to be written to the main and
17764 panic logs, and the SMTP command receives a temporary error. Typically, the
17765 value of &%smtp_active_hostname%& depends on the incoming interface address.
17766 For example:
17767 .code
17768 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17769   {cox.mydomain}{box.mydomain}}
17770 .endd
17771
17772 Although &$smtp_active_hostname$& is primarily concerned with incoming
17773 messages, it is also used as the default for HELO commands in callout
17774 verification if there is no remote transport from which to obtain a
17775 &%helo_data%& value.
17776
17777 .option smtp_backlog_monitor main integer 0
17778 .cindex "connection backlog" monitoring
17779 If this option is set to greater than zero, and the backlog of available
17780 TCP connections on a socket listening for SMTP is larger than it, a line
17781 is logged giving the value and the socket address and port.
17782 The value is retrived jsut before an accept call.
17783 This facility is only available on Linux.
17784
17785 .option smtp_banner main string&!! "see below"
17786 .cindex "SMTP" "welcome banner"
17787 .cindex "banner for SMTP"
17788 .cindex "welcome banner for SMTP"
17789 .cindex "customizing" "SMTP banner"
17790 If a connect ACL does not supply a message,
17791 this string (which is expanded every time it is used) is output as the initial
17792 positive response to an SMTP connection. The default setting is:
17793 .code
17794 smtp_banner = $smtp_active_hostname ESMTP Exim \
17795   $version_number $tod_full
17796 .endd
17797 .new
17798 Failure to expand the string causes a panic error;
17799 a forced fail just closes the connection.
17800 .wen
17801 If you want to create a
17802 multiline response to the initial SMTP connection, use &"\n"& in the string at
17803 appropriate points, but not at the end. Note that the 220 code is not included
17804 in this string. Exim adds it automatically (several times in the case of a
17805 multiline response).
17806
17807
17808 .option smtp_check_spool_space main boolean true
17809 .cindex "checking disk space"
17810 .cindex "disk space, checking"
17811 .cindex "spool directory" "checking space"
17812 When this option is set, if an incoming SMTP session encounters the SIZE
17813 option on a MAIL command, it checks that there is enough space in the
17814 spool directory's partition to accept a message of that size, while still
17815 leaving free the amount specified by &%check_spool_space%& (even if that value
17816 is zero). If there isn't enough space, a temporary error code is returned.
17817
17818
17819 .option smtp_connect_backlog main integer 20
17820 .cindex "connection backlog" "set maximum"
17821 .cindex "SMTP" "connection backlog"
17822 .cindex "backlog of connections"
17823 This option specifies a maximum number of waiting SMTP connections. Exim passes
17824 this value to the TCP/IP system when it sets up its listener. Once this number
17825 of connections are waiting for the daemon's attention, subsequent connection
17826 attempts are refused at the TCP/IP level. At least, that is what the manuals
17827 say; in some circumstances such connection attempts have been observed to time
17828 out instead. For large systems it is probably a good idea to increase the
17829 value (to 50, say). It also gives some protection against denial-of-service
17830 attacks by SYN flooding.
17831
17832
17833 .option smtp_enforce_sync main boolean true
17834 .cindex "SMTP" "synchronization checking"
17835 .cindex "synchronization checking in SMTP"
17836 The SMTP protocol specification requires the client to wait for a response from
17837 the server at certain points in the dialogue. Without PIPELINING these
17838 synchronization points are after every command; with PIPELINING they are
17839 fewer, but they still exist.
17840
17841 Some spamming sites send out a complete set of SMTP commands without waiting
17842 for any response. Exim protects against this by rejecting a message if the
17843 client has sent further input when it should not have. The error response &"554
17844 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17845 for this error cannot be perfect because of transmission delays (unexpected
17846 input may be on its way but not yet received when Exim checks). However, it
17847 does detect many instances.
17848
17849 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17850 If you want to disable the check selectively (for example, only for certain
17851 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17852 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17853
17854
17855
17856 .option smtp_etrn_command main string&!! unset
17857 .cindex "ETRN" "command to be run"
17858 .cindex "ESMTP extensions" ETRN
17859 .vindex "&$domain$&"
17860 If this option is set, the given command is run whenever an SMTP ETRN
17861 command is received from a host that is permitted to issue such commands (see
17862 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17863 are independently expanded. The expansion variable &$domain$& is set to the
17864 argument of the ETRN command, and no syntax checking is done on it. For
17865 example:
17866 .code
17867 smtp_etrn_command = /etc/etrn_command $domain \
17868                     $sender_host_address
17869 .endd
17870 If the option is not set, the argument for the ETRN command must
17871 be a &'#'& followed by an address string.
17872 In this case an &'exim -R <string>'& command is used;
17873 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17874
17875 A new process is created to run the command, but Exim does not wait for it to
17876 complete. Consequently, its status cannot be checked. If the command cannot be
17877 run, a line is written to the panic log, but the ETRN caller still receives
17878 a 250 success response. Exim is normally running under its own uid when
17879 receiving SMTP, so it is not possible for it to change the uid before running
17880 the command.
17881
17882
17883 .option smtp_etrn_serialize main boolean true
17884 .cindex "ETRN" "serializing"
17885 When this option is set, it prevents the simultaneous execution of more than
17886 one identical command as a result of ETRN in an SMTP connection. See
17887 section &<<SECTETRN>>& for details.
17888
17889
17890 .option smtp_load_reserve main fixed-point unset
17891 .cindex "load average"
17892 If the system load average ever gets higher than this, incoming SMTP calls are
17893 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17894 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17895 the load is over the limit. The option has no effect on ancient operating
17896 systems on which Exim cannot determine the load average. See also
17897 &%deliver_queue_load_max%& and &%queue_only_load%&.
17898
17899
17900
17901 .option smtp_max_synprot_errors main integer 3
17902 .cindex "SMTP" "limiting syntax and protocol errors"
17903 .cindex "limit" "SMTP syntax and protocol errors"
17904 Exim rejects SMTP commands that contain syntax or protocol errors. In
17905 particular, a syntactically invalid email address, as in this command:
17906 .code
17907 RCPT TO:<abc xyz@a.b.c>
17908 .endd
17909 causes immediate rejection of the command, before any other tests are done.
17910 (The ACL cannot be run if there is no valid address to set up for it.) An
17911 example of a protocol error is receiving RCPT before MAIL. If there are
17912 too many syntax or protocol errors in one SMTP session, the connection is
17913 dropped. The limit is set by this option.
17914
17915 .cindex "PIPELINING" "expected errors"
17916 When the PIPELINING extension to SMTP is in use, some protocol errors are
17917 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17918 Exim assumes that PIPELINING will be used if it advertises it (see
17919 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17920 not count towards the limit.
17921
17922
17923
17924 .option smtp_max_unknown_commands main integer 3
17925 .cindex "SMTP" "limiting unknown commands"
17926 .cindex "limit" "unknown SMTP commands"
17927 If there are too many unrecognized commands in an incoming SMTP session, an
17928 Exim server drops the connection. This is a defence against some kinds of abuse
17929 that subvert web
17930 clients
17931 into making connections to SMTP ports; in these circumstances, a number of
17932 non-SMTP command lines are sent first.
17933
17934
17935
17936 .option smtp_ratelimit_hosts main "host list&!!" unset
17937 .cindex "SMTP" "rate limiting"
17938 .cindex "limit" "rate of message arrival"
17939 .cindex "RCPT" "rate limiting"
17940 Some sites find it helpful to be able to limit the rate at which certain hosts
17941 can send them messages, and the rate at which an individual message can specify
17942 recipients.
17943
17944 Exim has two rate-limiting facilities. This section describes the older
17945 facility, which can limit rates within a single connection. The newer
17946 &%ratelimit%& ACL condition can limit rates across all connections. See section
17947 &<<SECTratelimiting>>& for details of the newer facility.
17948
17949 When a host matches &%smtp_ratelimit_hosts%&, the values of
17950 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17951 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17952 respectively. Each option, if set, must contain a set of four comma-separated
17953 values:
17954
17955 .ilist
17956 A threshold, before which there is no rate limiting.
17957 .next
17958 An initial time delay. Unlike other times in Exim, numbers with decimal
17959 fractional parts are allowed here.
17960 .next
17961 A factor by which to increase the delay each time.
17962 .next
17963 A maximum value for the delay. This should normally be less than 5 minutes,
17964 because after that time, the client is liable to timeout the SMTP command.
17965 .endlist
17966
17967 For example, these settings have been used successfully at the site which
17968 first suggested this feature, for controlling mail from their customers:
17969 .code
17970 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17971 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17972 .endd
17973 The first setting specifies delays that are applied to MAIL commands after
17974 two have been received over a single connection. The initial delay is 0.5
17975 seconds, increasing by a factor of 1.05 each time. The second setting applies
17976 delays to RCPT commands when more than four occur in a single message.
17977
17978
17979 .option smtp_ratelimit_mail main string unset
17980 See &%smtp_ratelimit_hosts%& above.
17981
17982
17983 .option smtp_ratelimit_rcpt main string unset
17984 See &%smtp_ratelimit_hosts%& above.
17985
17986
17987 .option smtp_receive_timeout main time&!! 5m
17988 .cindex "timeout" "for SMTP input"
17989 .cindex "SMTP" "input timeout"
17990 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17991 input, including batch SMTP. If a line of input (either an SMTP command or a
17992 data line) is not received within this time, the SMTP connection is dropped and
17993 the message is abandoned.
17994 A line is written to the log containing one of the following messages:
17995 .code
17996 SMTP command timeout on connection from...
17997 SMTP data timeout on connection from...
17998 .endd
17999 The former means that Exim was expecting to read an SMTP command; the latter
18000 means that it was in the DATA phase, reading the contents of a message.
18001
18002 If the first character of the option is a &"$"& the option is
18003 expanded before use and may depend on
18004 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18005
18006
18007 .oindex "&%-os%&"
18008 The value set by this option can be overridden by the
18009 &%-os%& command-line option. A setting of zero time disables the timeout, but
18010 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18011 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18012 timeout is controlled by &%receive_timeout%& and &%-or%&.
18013
18014
18015 .option smtp_reserve_hosts main "host list&!!" unset
18016 This option defines hosts for which SMTP connections are reserved; see
18017 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18018
18019
18020 .option smtp_return_error_details main boolean false
18021 .cindex "SMTP" "details policy failures"
18022 .cindex "policy control" "rejection, returning details"
18023 In the default state, Exim uses bland messages such as
18024 &"Administrative prohibition"& when it rejects SMTP commands for policy
18025 reasons. Many sysadmins like this because it gives away little information
18026 to spammers. However, some other sysadmins who are applying strict checking
18027 policies want to give out much fuller information about failures. Setting
18028 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18029 example, instead of &"Administrative prohibition"&, it might give:
18030 .code
18031 550-Rejected after DATA: '>' missing at end of address:
18032 550 failing address in "From" header is: <user@dom.ain
18033 .endd
18034
18035
18036 .option smtputf8_advertise_hosts main "host list&!!" *
18037 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18038 .cindex "ESMTP extensions" SMTPUTF8
18039 When Exim is built with support for internationalised mail names,
18040 the availability thereof is advertised in
18041 response to EHLO only to those client hosts that match this option. See
18042 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18043
18044
18045 .option spamd_address main string "127.0.0.1 783"
18046 This option is available when Exim is compiled with the content-scanning
18047 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18048 See section &<<SECTscanspamass>>& for more details.
18049
18050
18051
18052 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18053 This option is available when Exim is compiled with SPF support.
18054 See section &<<SECSPF>>& for more details.
18055
18056 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18057 This option is available when Exim is compiled with SPF support.  It
18058 allows the customisation of the SMTP comment that the SPF library
18059 generates.  You are strongly encouraged to link to your own explanative
18060 site. The template must not contain spaces. If you need spaces in the
18061 output, use the proper placeholder. If libspf2 can not parse the
18062 template, it uses a built-in default broken link. The following placeholders
18063 (along with Exim variables (but see below)) are allowed in the template:
18064 .ilist
18065 &*%_*&: A space.
18066 .next
18067 &*%{L}*&: Envelope sender's local part.
18068 .next
18069 &*%{S}*&: Envelope sender.
18070 .next
18071 &*%{O}*&: Envelope sender's domain.
18072 .next
18073 &*%{D}*&: Current(?) domain.
18074 .next
18075 &*%{I}*&: SMTP client Ip.
18076 .next
18077 &*%{C}*&: SMTP client pretty IP.
18078 .next
18079 &*%{T}*&: Epoch time (UTC).
18080 .next
18081 &*%{P}*&: SMTP client domain name.
18082 .next
18083 &*%{V}*&: IP version.
18084 .next
18085 &*%{H}*&: EHLO/HELO domain.
18086 .next
18087 &*%{R}*&: Receiving domain.
18088 .endlist
18089 The capitalized placeholders do proper URL encoding, if you use them
18090 lowercased, no encoding takes place.  This list was compiled from the
18091 libspf2 sources.
18092
18093 A note on using Exim variables: As
18094 currently the SPF library is initialized before the SMTP EHLO phase,
18095 the variables useful for expansion are quite limited.
18096
18097
18098 .option split_spool_directory main boolean false
18099 .cindex "multiple spool directories"
18100 .cindex "spool directory" "split"
18101 .cindex "directories, multiple"
18102 If this option is set, it causes Exim to split its input directory into 62
18103 subdirectories, each with a single alphanumeric character as its name. The
18104 sixth character of the message id is used to allocate messages to
18105 subdirectories; this is the least significant base-62 digit of the time of
18106 arrival of the message.
18107
18108 Splitting up the spool in this way may provide better performance on systems
18109 where there are long mail queues, by reducing the number of files in any one
18110 directory. The msglog directory is also split up in a similar way to the input
18111 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18112 are still placed in the single directory &_msglog.OLD_&.
18113
18114 It is not necessary to take any special action for existing messages when
18115 changing &%split_spool_directory%&. Exim notices messages that are in the
18116 &"wrong"& place, and continues to process them. If the option is turned off
18117 after a period of being on, the subdirectories will eventually empty and be
18118 automatically deleted.
18119
18120 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18121 changes. Instead of creating a list of all messages in the queue, and then
18122 trying to deliver each one, in turn, it constructs a list of those in one
18123 sub-directory and tries to deliver them, before moving on to the next
18124 sub-directory. The sub-directories are processed in a random order. This
18125 spreads out the scanning of the input directories, and uses less memory. It is
18126 particularly beneficial when there are lots of messages in the queue. However,
18127 if &%queue_run_in_order%& is set, none of this new processing happens. The
18128 entire queue has to be scanned and sorted before any deliveries can start.
18129
18130
18131 .option spool_directory main string&!! "set at compile time"
18132 .cindex "spool directory" "path to"
18133 This defines the directory in which Exim keeps its spool, that is, the messages
18134 it is waiting to deliver. The default value is taken from the compile-time
18135 configuration setting, if there is one. If not, this option must be set. The
18136 string is expanded, so it can contain, for example, a reference to
18137 &$primary_hostname$&.
18138
18139 If the spool directory name is fixed on your installation, it is recommended
18140 that you set it at build time rather than from this option, particularly if the
18141 log files are being written to the spool directory (see &%log_file_path%&).
18142 Otherwise log files cannot be used for errors that are detected early on, such
18143 as failures in the configuration file.
18144
18145 By using this option to override the compiled-in path, it is possible to run
18146 tests of Exim without using the standard spool.
18147
18148 .option spool_wireformat main boolean false
18149 .cindex "spool directory" "file formats"
18150 If this option is set, Exim may for some messages use an alternative format
18151 for data-files in the spool which matches the wire format.
18152 Doing this permits more efficient message reception and transmission.
18153 Currently it is only done for messages received using the ESMTP CHUNKING
18154 option.
18155
18156 The following variables will not have useful values:
18157 .code
18158 $max_received_linelength
18159 $body_linecount
18160 $body_zerocount
18161 .endd
18162
18163 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18164 and any external programs which are passed a reference to a message data file
18165 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18166 will need to be aware of the different formats potentially available.
18167
18168 Using any of the ACL conditions noted will negate the reception benefit
18169 (as a Unix-mbox-format file is constructed for them).
18170 The transmission benefit is maintained.
18171
18172 .option sqlite_lock_timeout main time 5s
18173 .cindex "sqlite lookup type" "lock timeout"
18174 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18175 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18176
18177 .option strict_acl_vars main boolean false
18178 .cindex "&ACL;" "variables, handling unset"
18179 This option controls what happens if a syntactically valid but undefined ACL
18180 variable is referenced. If it is false (the default), an empty string
18181 is substituted; if it is true, an error is generated. See section
18182 &<<SECTaclvariables>>& for details of ACL variables.
18183
18184 .option strip_excess_angle_brackets main boolean false
18185 .cindex "angle brackets, excess"
18186 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18187 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18188 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18189 passed on to another MTA, the excess angle brackets are not passed on. If this
18190 option is not set, multiple pairs of angle brackets cause a syntax error.
18191
18192
18193 .option strip_trailing_dot main boolean false
18194 .cindex "trailing dot on domain"
18195 .cindex "dot" "trailing on domain"
18196 If this option is set, a trailing dot at the end of a domain in an address is
18197 ignored. If this is in the envelope and the message is passed on to another
18198 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18199 domain causes a syntax error.
18200 However, addresses in header lines are checked only when an ACL requests header
18201 syntax checking.
18202
18203
18204 .option syslog_duplication main boolean true
18205 .cindex "syslog" "duplicate log lines; suppressing"
18206 When Exim is logging to syslog, it writes the log lines for its three
18207 separate logs at different syslog priorities so that they can in principle
18208 be separated on the logging hosts. Some installations do not require this
18209 separation, and in those cases, the duplication of certain log lines is a
18210 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18211 particular log line is written to syslog. For lines that normally go to
18212 both the main log and the reject log, the reject log version (possibly
18213 containing message header lines) is written, at LOG_NOTICE priority.
18214 Lines that normally go to both the main and the panic log are written at
18215 the LOG_ALERT priority.
18216
18217
18218 .option syslog_facility main string unset
18219 .cindex "syslog" "facility; setting"
18220 This option sets the syslog &"facility"& name, used when Exim is logging to
18221 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18222 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18223 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18224 details of Exim's logging.
18225
18226
18227 .option syslog_pid main boolean true
18228 .cindex "syslog" "pid"
18229 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18230 omitted when these lines are sent to syslog. (Syslog normally prefixes
18231 the log lines with the PID of the logging process automatically.) You need
18232 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18233 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18234
18235
18236
18237 .option syslog_processname main string &`exim`&
18238 .cindex "syslog" "process name; setting"
18239 This option sets the syslog &"ident"& name, used when Exim is logging to
18240 syslog. The value must be no longer than 32 characters. See chapter
18241 &<<CHAPlog>>& for details of Exim's logging.
18242
18243
18244
18245 .option syslog_timestamp main boolean true
18246 .cindex "syslog" "timestamps"
18247 .cindex timestamps syslog
18248 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18249 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18250 details of Exim's logging.
18251
18252
18253 .option system_filter main string&!! unset
18254 .cindex "filter" "system filter"
18255 .cindex "system filter" "specifying"
18256 .cindex "Sieve filter" "not available for system filter"
18257 This option specifies an Exim filter file that is applied to all messages at
18258 the start of each delivery attempt, before any routing is done. System filters
18259 must be Exim filters; they cannot be Sieve filters. If the system filter
18260 generates any deliveries to files or pipes, or any new mail messages, the
18261 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18262 which transports are to be used. Details of this facility are given in chapter
18263 &<<CHAPsystemfilter>>&.
18264 A forced expansion failure results in no filter operation.
18265
18266
18267 .option system_filter_directory_transport main string&!! unset
18268 .vindex "&$address_file$&"
18269 This sets the name of the transport driver that is to be used when the
18270 &%save%& command in a system message filter specifies a path ending in &"/"&,
18271 implying delivery of each message into a separate file in some directory.
18272 During the delivery, the variable &$address_file$& contains the path name.
18273
18274
18275 .option system_filter_file_transport main string&!! unset
18276 .cindex "file" "transport for system filter"
18277 This sets the name of the transport driver that is to be used when the &%save%&
18278 command in a system message filter specifies a path not ending in &"/"&. During
18279 the delivery, the variable &$address_file$& contains the path name.
18280
18281 .option system_filter_group main string unset
18282 .cindex "gid (group id)" "system filter"
18283 This option is used only when &%system_filter_user%& is also set. It sets the
18284 gid under which the system filter is run, overriding any gid that is associated
18285 with the user. The value may be numerical or symbolic.
18286
18287 .option system_filter_pipe_transport main string&!! unset
18288 .cindex "&(pipe)& transport" "for system filter"
18289 .vindex "&$address_pipe$&"
18290 This specifies the transport driver that is to be used when a &%pipe%& command
18291 is used in a system filter. During the delivery, the variable &$address_pipe$&
18292 contains the pipe command.
18293
18294
18295 .option system_filter_reply_transport main string&!! unset
18296 .cindex "&(autoreply)& transport" "for system filter"
18297 This specifies the transport driver that is to be used when a &%mail%& command
18298 is used in a system filter.
18299
18300
18301 .option system_filter_user main string unset
18302 .cindex "uid (user id)" "system filter"
18303 If this option is set to root, the system filter is run in the main Exim
18304 delivery process, as root.  Otherwise, the system filter runs in a separate
18305 process, as the given user, defaulting to the Exim run-time user.
18306 Unless the string consists entirely of digits, it
18307 is looked up in the password data. Failure to find the named user causes a
18308 configuration error. The gid is either taken from the password data, or
18309 specified by &%system_filter_group%&. When the uid is specified numerically,
18310 &%system_filter_group%& is required to be set.
18311
18312 If the system filter generates any pipe, file, or reply deliveries, the uid
18313 under which the filter is run is used when transporting them, unless a
18314 transport option overrides.
18315
18316
18317 .option tcp_nodelay main boolean true
18318 .cindex "daemon" "TCP_NODELAY on sockets"
18319 .cindex "Nagle algorithm"
18320 .cindex "TCP_NODELAY on listening sockets"
18321 If this option is set false, it stops the Exim daemon setting the
18322 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18323 turns off the &"Nagle algorithm"&, which is a way of improving network
18324 performance in interactive (character-by-character) situations. Turning it off
18325 should improve Exim's performance a bit, so that is what happens by default.
18326 However, it appears that some broken clients cannot cope, and time out. Hence
18327 this option. It affects only those sockets that are set up for listening by the
18328 daemon. Sockets created by the smtp transport for delivering mail always set
18329 TCP_NODELAY.
18330
18331
18332 .option timeout_frozen_after main time 0s
18333 .cindex "frozen messages" "timing out"
18334 .cindex "timeout" "frozen messages"
18335 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18336 message of any kind that has been in the queue for longer than the given time
18337 is automatically cancelled at the next queue run. If the frozen message is a
18338 bounce message, it is just discarded; otherwise, a bounce is sent to the
18339 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18340 If you want to timeout frozen bounce messages earlier than other kinds of
18341 frozen message, see &%ignore_bounce_errors_after%&.
18342
18343 &*Note:*& the default value of zero means no timeouts; with this setting,
18344 frozen messages remain in the queue forever (except for any frozen bounce
18345 messages that are released by &%ignore_bounce_errors_after%&).
18346
18347
18348 .option timezone main string unset
18349 .cindex "timezone, setting"
18350 .cindex "environment" "values from"
18351 The value of &%timezone%& is used to set the environment variable TZ while
18352 running Exim (if it is different on entry). This ensures that all timestamps
18353 created by Exim are in the required timezone. If you want all your timestamps
18354 to be in UTC (aka GMT) you should set
18355 .code
18356 timezone = UTC
18357 .endd
18358 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18359 or, if that is not set, from the value of the TZ environment variable when Exim
18360 is built. If &%timezone%& is set to the empty string, either at build or run
18361 time, any existing TZ variable is removed from the environment when Exim
18362 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18363 unfortunately not all, operating systems.
18364
18365
18366 .option tls_advertise_hosts main "host list&!!" *
18367 .cindex "TLS" "advertising"
18368 .cindex "encryption" "on SMTP connection"
18369 .cindex "SMTP" "encrypted connection"
18370 .cindex "ESMTP extensions" STARTTLS
18371 When Exim is built with support for TLS encrypted connections, the availability
18372 of the STARTTLS command to set up an encrypted session is advertised in
18373 response to EHLO only to those client hosts that match this option. See
18374 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18375 Note that the default value requires that a certificate be supplied
18376 using the &%tls_certificate%& option.  If TLS support for incoming connections
18377 is not required the &%tls_advertise_hosts%& option should be set empty.
18378
18379
18380 .option tls_alpn main "string list&!!" "smtp : esmtp"
18381 .cindex TLS "Application Layer Protocol Names"
18382 .cindex TLS ALPN
18383 .cindex ALPN "set acceptable names for server"
18384 If this option is set,
18385 the TLS library supports ALPN,
18386 and the client offers either more than
18387 ALPN name or a name which does not match the list,
18388 the TLS connection is declined.
18389
18390
18391 .option tls_certificate main "string list&!!" unset
18392 .cindex "TLS" "server certificate; location of"
18393 .cindex "certificate" "server, location of"
18394 The value of this option is expanded, and must then be a list of absolute paths to
18395 files which contain the server's certificates (in PEM format).
18396 Commonly only one file is needed.
18397 The server's private key is also
18398 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18399 &<<CHAPTLS>>& for further details.
18400
18401 &*Note*&: The certificates defined by this option are used only when Exim is
18402 receiving incoming messages as a server. If you want to supply certificates for
18403 use when sending messages as a client, you must set the &%tls_certificate%&
18404 option in the relevant &(smtp)& transport.
18405
18406 &*Note*&: If you use filenames based on IP addresses, change the list
18407 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18408
18409 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18410 when a list of more than one
18411 file is used, the &$tls_in_ourcert$& variable is unreliable.
18412 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18413
18414 .cindex SNI "selecting server certificate based on"
18415 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18416 if the OpenSSL build supports TLS extensions and the TLS client sends the
18417 Server Name Indication extension, then this option and others documented in
18418 &<<SECTtlssni>>& will be re-expanded.
18419
18420 If this option is unset or empty a self-signed certificate will be
18421 used.
18422 Under Linux this is generated at daemon startup; on other platforms it will be
18423 generated fresh for every connection.
18424
18425 .option tls_crl main string&!! unset
18426 .cindex "TLS" "server certificate revocation list"
18427 .cindex "certificate" "revocation list for server"
18428 This option specifies a certificate revocation list. The expanded value must
18429 be the name of a file that contains CRLs in PEM format.
18430
18431 Under OpenSSL the option can specify a directory with CRL files.
18432
18433 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18434 for each signing element of the certificate chain (i.e. all but the leaf).
18435 For the file variant this can be multiple PEM blocks in the one file.
18436
18437 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18438
18439
18440 .option tls_dh_max_bits main integer 2236
18441 .cindex "TLS" "D-H bit count"
18442 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18443 the chosen TLS library.  That value might prove to be too high for
18444 interoperability.  This option provides a maximum clamp on the value
18445 suggested, trading off security for interoperability.
18446
18447 The value must be at least 1024.
18448
18449 The value 2236 was chosen because, at time of adding the option, it was the
18450 hard-coded maximum value supported by the NSS cryptographic library, as used
18451 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18452
18453 If you prefer more security and are willing to break some clients, raise this
18454 number.
18455
18456 Note that the value passed to GnuTLS for *generating* a new prime may be a
18457 little less than this figure, because GnuTLS is inexact and may produce a
18458 larger prime than requested.
18459
18460
18461 .option tls_dhparam main string&!! unset
18462 .cindex "TLS" "D-H parameters for server"
18463 The value of this option is expanded and indicates the source of DH parameters
18464 to be used by Exim.
18465
18466 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18467 local DH parameters*&, which has been supported across all versions of Exim.  The
18468 other specific constants available are a fallback so that even when
18469 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18470
18471 If &%tls_dhparam%& is a filename starting with a &`/`&,
18472 then it names a file from which DH
18473 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18474 PKCS#3 representation of the DH prime.  If the file does not exist, for
18475 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18476 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18477 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18478 and treated as though the &%tls_dhparam%& were set to "none".
18479
18480 If this option expands to the string "none", then no DH parameters will be
18481 loaded by Exim.
18482
18483 If this option expands to the string "historic" and Exim is using GnuTLS, then
18484 Exim will attempt to load a file from inside the spool directory.  If the file
18485 does not exist, Exim will attempt to create it.
18486 See section &<<SECTgnutlsparam>>& for further details.
18487
18488 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18489 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18490
18491 In older versions of Exim the default was the 2048 bit prime described in section
18492 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18493 in IKE is assigned number 23.
18494
18495 Otherwise, the option must expand to the name used by Exim for any of a number
18496 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18497 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18498 the number used by IKE, or "default" which corresponds to
18499 &`exim.dev.20160529.3`&.
18500
18501 The available standard primes are:
18502 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18503 &`ike1`&, &`ike2`&, &`ike5`&,
18504 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18505 &`ike22`&, &`ike23`& and &`ike24`&.
18506
18507 The available additional primes are:
18508 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18509
18510 Some of these will be too small to be accepted by clients.
18511 Some may be too large to be accepted by clients.
18512 The open cryptographic community has suspicions about the integrity of some
18513 of the later IKE values, which led into RFC7919 providing new fixed constants
18514 (the "ffdhe" identifiers).
18515
18516 At this point, all of the "ike" values should be considered obsolete;
18517 they are still in Exim to avoid breaking unusual configurations, but are
18518 candidates for removal the next time we have backwards-incompatible changes.
18519 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18520 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18521 SHOULD NOT.
18522 Because of this, Exim regards them as deprecated; if either of the first pair
18523 are used, warnings will be logged in the paniclog, and if any are used then
18524 warnings will be logged in the mainlog.
18525 All four will be removed in a future Exim release.
18526
18527 The TLS protocol does not negotiate an acceptable size for this; clients tend
18528 to hard-drop connections if what is offered by the server is unacceptable,
18529 whether too large or too small, and there's no provision for the client to
18530 tell the server what these constraints are.  Thus, as a server operator, you
18531 need to make an educated guess as to what is most likely to work for your
18532 userbase.
18533
18534 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18535 is most likely to maximise interoperability.  The upper bound comes from
18536 applications using the Mozilla Network Security Services (NSS) library, which
18537 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18538 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18539 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18540 acceptable bound from 1024 to 2048.
18541
18542
18543 .option tls_eccurve main string list&!! &`auto`&
18544 .cindex TLS "EC cryptography"
18545 This option selects EC curves for use by Exim when used with OpenSSL.
18546 It has no effect when Exim is used with GnuTLS
18547 (the equivalent can be done using a priority string for the
18548 &%tls_require_ciphers%& option).
18549
18550 After expansion it must contain
18551 .new
18552 one or (only for OpenSSL versiona 1.1.1 onwards) more
18553 .wen
18554 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18555 Consult your OpenSSL manual for valid curve names.
18556
18557 For OpenSSL versions before (and not including) 1.0.2, the string
18558 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18559 &`auto`& tells the library to choose.
18560
18561 .new
18562 If the option expands to an empty string, the effect is undefined.
18563 .wen
18564
18565
18566 .option tls_ocsp_file main string&!! unset
18567 .cindex TLS "certificate status"
18568 .cindex TLS "OCSP proof file"
18569 This option
18570 must if set expand to the absolute path to a file which contains a current
18571 status proof for the server's certificate, as obtained from the
18572 Certificate Authority.
18573
18574 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18575 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18576
18577 For OpenSSL 1.1.0 or later, and
18578 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18579 of files, to match a list given for the &%tls_certificate%& option.
18580 The ordering of the two lists must match.
18581 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18582
18583 The file(s) should be in DER format,
18584 except for GnuTLS 3.6.3 or later
18585 or for OpenSSL,
18586 when an optional filetype prefix can be used.
18587 The prefix must be one of "DER" or "PEM", followed by
18588 a single space.  If one is used it sets the format for subsequent
18589 files in the list; the initial format is DER.
18590 If multiple proofs are wanted, for multiple chain elements
18591 (this only works under TLS1.3)
18592 they must be coded as a combined OCSP response.
18593
18594 Although GnuTLS will accept PEM files with multiple separate
18595 PEM blobs (ie. separate OCSP responses), it sends them in the
18596 TLS Certificate record interleaved with the certificates of the chain;
18597 although a GnuTLS client is happy with that, an OpenSSL client is not.
18598
18599 .option tls_on_connect_ports main "string list" unset
18600 .cindex SSMTP
18601 .cindex SMTPS
18602 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18603 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18604 set up without waiting for the client to issue a STARTTLS command. For
18605 further details, see section &<<SECTsupobssmt>>&.
18606
18607
18608
18609 .option tls_privatekey main "string list&!!" unset
18610 .cindex "TLS" "server private key; location of"
18611 The value of this option is expanded, and must then be a list of absolute paths to
18612 files which contains the server's private keys.
18613 If this option is unset, or if
18614 the expansion is forced to fail, or the result is an empty string, the private
18615 key is assumed to be in the same file as the server's certificates. See chapter
18616 &<<CHAPTLS>>& for further details.
18617
18618 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18619
18620
18621 .option tls_remember_esmtp main boolean false
18622 .cindex "TLS" "esmtp state; remembering"
18623 .cindex "TLS" "broken clients"
18624 If this option is set true, Exim violates the RFCs by remembering that it is in
18625 &"esmtp"& state after successfully negotiating a TLS session. This provides
18626 support for broken clients that fail to send a new EHLO after starting a
18627 TLS session.
18628
18629
18630 .option tls_require_ciphers main string&!! unset
18631 .cindex "TLS" "requiring specific ciphers"
18632 .cindex "cipher" "requiring specific"
18633 This option controls which ciphers can be used for incoming TLS connections.
18634 The &(smtp)& transport has an option of the same name for controlling outgoing
18635 connections. This option is expanded for each connection, so can be varied for
18636 different clients if required. The value of this option must be a list of
18637 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18638 in somewhat different ways. If GnuTLS is being used, the client controls the
18639 preference order of the available ciphers. Details are given in sections
18640 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18641
18642
18643 .option tls_resumption_hosts main "host list&!!" unset
18644 .cindex TLS resumption
18645 This option controls which connections to offer the TLS resumption feature.
18646 See &<<SECTresumption>>& for details.
18647
18648
18649 .option tls_try_verify_hosts main "host list&!!" unset
18650 .cindex "TLS" "client certificate verification"
18651 .cindex "certificate" "verification of client"
18652 See &%tls_verify_hosts%& below.
18653
18654
18655 .option tls_verify_certificates main string&!! system
18656 .cindex "TLS" "client certificate verification"
18657 .cindex "certificate" "verification of client"
18658 The value of this option is expanded, and must then be either the
18659 word "system"
18660 or the absolute path to
18661 a file or directory containing permitted certificates for clients that
18662 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18663
18664 The "system" value for the option will use a
18665 system default location compiled into the SSL library.
18666 This is not available for GnuTLS versions preceding 3.0.20,
18667 and will be taken as empty; an explicit location
18668 must be specified.
18669
18670 The use of a directory for the option value is not available for GnuTLS versions
18671 preceding 3.3.6 and a single file must be used.
18672
18673 With OpenSSL the certificates specified
18674 explicitly
18675 either by file or directory
18676 are added to those given by the system default location.
18677
18678 These certificates should be for the certificate authorities trusted, rather
18679 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18680 the value is a file then the certificates are sent by Exim as a server to
18681 connecting clients, defining the list of accepted certificate authorities.
18682 Thus the values defined should be considered public data.  To avoid this,
18683 use the explicit directory version. (If your peer is Exim up to 4.85,
18684 using GnuTLS, you may need to send the CAs (thus using the file
18685 variant). Otherwise the peer doesn't send its certificate.)
18686
18687 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18688
18689 A forced expansion failure or setting to an empty string is equivalent to
18690 being unset.
18691
18692
18693 .option tls_verify_hosts main "host list&!!" unset
18694 .cindex "TLS" "client certificate verification"
18695 .cindex "certificate" "verification of client"
18696 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18697 certificates from clients. The expected certificates are defined by
18698 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18699 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18700 &%tls_verify_certificates%& is not set.
18701
18702 Any client that matches &%tls_verify_hosts%& is constrained by
18703 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18704 present one of the listed certificates. If it does not, the connection is
18705 aborted.
18706 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18707 the host to use TLS. It can still send SMTP commands through unencrypted
18708 connections. Forcing a client to use TLS has to be done separately using an
18709 ACL to reject inappropriate commands when the connection is not encrypted.
18710
18711 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18712 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18713 certificate and checks it against &%tls_verify_certificates%&, but does not
18714 abort the connection if there is no certificate or if it does not match. This
18715 state can be detected in an ACL, which makes it possible to implement policies
18716 such as &"accept for relay only if a verified certificate has been received,
18717 but accept for local delivery if encrypted, even without a verified
18718 certificate"&.
18719
18720 Client hosts that match neither of these lists are not asked to present
18721 certificates.
18722
18723
18724 .option trusted_groups main "string list&!!" unset
18725 .cindex "trusted groups"
18726 .cindex "groups" "trusted"
18727 This option is expanded just once, at the start of Exim's processing. If this
18728 option is set, any process that is running in one of the listed groups, or
18729 which has one of them as a supplementary group, is trusted. The groups can be
18730 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18731 details of what trusted callers are permitted to do. If neither
18732 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18733 are trusted.
18734
18735 .option trusted_users main "string list&!!" unset
18736 .cindex "trusted users"
18737 .cindex "user" "trusted"
18738 This option is expanded just once, at the start of Exim's processing. If this
18739 option is set, any process that is running as one of the listed users is
18740 trusted. The users can be specified numerically or by name. See section
18741 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18742 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18743 Exim user are trusted.
18744
18745 .option unknown_login main string&!! unset
18746 .cindex "uid (user id)" "unknown caller"
18747 .vindex "&$caller_uid$&"
18748 This is a specialized feature for use in unusual configurations. By default, if
18749 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18750 gives up. The &%unknown_login%& option can be used to set a login name to be
18751 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18752 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18753 is used for the user's real name (gecos field), unless this has been set by the
18754 &%-F%& option.
18755
18756 .option unknown_username main string unset
18757 See &%unknown_login%&.
18758
18759 .option untrusted_set_sender main "address list&!!" unset
18760 .cindex "trusted users"
18761 .cindex "sender" "setting by untrusted user"
18762 .cindex "untrusted user setting sender"
18763 .cindex "user" "untrusted setting sender"
18764 .cindex "envelope from"
18765 .cindex "envelope sender"
18766 When an untrusted user submits a message to Exim using the standard input, Exim
18767 normally creates an envelope sender address from the user's login and the
18768 default qualification domain. Data from the &%-f%& option (for setting envelope
18769 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18770 is used) is ignored.
18771
18772 However, untrusted users are permitted to set an empty envelope sender address,
18773 to declare that a message should never generate any bounces. For example:
18774 .code
18775 exim -f '<>' user@domain.example
18776 .endd
18777 .vindex "&$sender_ident$&"
18778 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18779 other envelope sender addresses in a controlled way. When it is set, untrusted
18780 users are allowed to set envelope sender addresses that match any of the
18781 patterns in the list. Like all address lists, the string is expanded. The
18782 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18783 users to setting senders that start with their login ids
18784 followed by a hyphen
18785 by a setting like this:
18786 .code
18787 untrusted_set_sender = ^$sender_ident-
18788 .endd
18789 If you want to allow untrusted users to set envelope sender addresses without
18790 restriction, you can use
18791 .code
18792 untrusted_set_sender = *
18793 .endd
18794 The &%untrusted_set_sender%& option applies to all forms of local input, but
18795 only to the setting of the envelope sender. It does not permit untrusted users
18796 to use the other options which trusted user can use to override message
18797 parameters. Furthermore, it does not stop Exim from removing an existing
18798 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18799 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18800 overriding these actions. The handling of the &'Sender:'& header is also
18801 described in section &<<SECTthesenhea>>&.
18802
18803 The log line for a message's arrival shows the envelope sender following
18804 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18805 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18806 envelope sender address, the user's login is shown in parentheses after the
18807 sender address.
18808
18809
18810 .option uucp_from_pattern main string "see below"
18811 .cindex "&""From""& line"
18812 .cindex "UUCP" "&""From""& line"
18813 Some applications that pass messages to an MTA via a command line interface use
18814 an initial line starting with &"From&~"& to pass the envelope sender. In
18815 particular, this is used by UUCP software. Exim recognizes such a line by means
18816 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18817 matches, the sender address is constructed by expanding the contents of
18818 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18819 default pattern recognizes lines in the following two forms:
18820 .code
18821 From ph10 Fri Jan  5 12:35 GMT 1996
18822 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18823 .endd
18824 The pattern can be seen by running
18825 .code
18826 exim -bP uucp_from_pattern
18827 .endd
18828 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18829 year in the second case. The first word after &"From&~"& is matched in the
18830 regular expression by a parenthesized subpattern. The default value for
18831 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18832 (&"ph10"& in the example above) as the message's sender. See also
18833 &%ignore_fromline_hosts%&.
18834
18835
18836 .option uucp_from_sender main string&!! &`$1`&
18837 See &%uucp_from_pattern%& above.
18838
18839
18840 .option warn_message_file main string&!! unset
18841 .cindex "warning of delay" "customizing the message"
18842 .cindex "customizing" "warning message"
18843 This option defines a template file containing paragraphs of text to be used
18844 for constructing the warning message which is sent by Exim when a message has
18845 been in the queue for a specified amount of time, as specified by
18846 &%delay_warning%&. Details of the file's contents are given in chapter
18847 &<<CHAPemsgcust>>&.
18848 .cindex warn_message_file "tainted data"
18849 The option is expanded to give the file path, which must be
18850 absolute and untainted.
18851 See also &%bounce_message_file%&.
18852
18853
18854 .option write_rejectlog main boolean true
18855 .cindex "reject log" "disabling"
18856 If this option is set false, Exim no longer writes anything to the reject log.
18857 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18858 .ecindex IIDconfima
18859 .ecindex IIDmaiconf
18860
18861
18862
18863
18864 . ////////////////////////////////////////////////////////////////////////////
18865 . ////////////////////////////////////////////////////////////////////////////
18866
18867 .chapter "Generic options for routers" "CHAProutergeneric"
18868 .scindex IIDgenoprou1 "options" "generic; for routers"
18869 .scindex IIDgenoprou2 "generic options" "router"
18870 This chapter describes the generic options that apply to all routers.
18871 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18872
18873 For a general description of how a router operates, see sections
18874 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18875 which the preconditions are tested. The order of expansion of the options that
18876 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18877 &%headers_remove%&, &%transport%&.
18878
18879 The name of a router is limited to be &drivernamemax; ASCII characters long;
18880 prior to Exim 4.95 names would be silently truncated at this length, but now
18881 it is enforced.
18882
18883
18884 .option address_data routers string&!! unset
18885 .cindex "router" "data attached to address"
18886 The string is expanded just before the router is run, that is, after all the
18887 precondition tests have succeeded. If the expansion is forced to fail, the
18888 router declines, the value of &%address_data%& remains unchanged, and the
18889 &%more%& option controls what happens next. Other expansion failures cause
18890 delivery of the address to be deferred.
18891
18892 .vindex "&$address_data$&"
18893 When the expansion succeeds, the value is retained with the address, and can be
18894 accessed using the variable &$address_data$& in the current router, subsequent
18895 routers, and the eventual transport.
18896
18897 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18898 that runs a user's filter file, the contents of &$address_data$& are accessible
18899 in the filter. This is not normally a problem, because such data is usually
18900 either not confidential or it &"belongs"& to the current user, but if you do
18901 put confidential data into &$address_data$& you need to remember this point.
18902
18903 Even if the router declines or passes, the value of &$address_data$& remains
18904 with the address, though it can be changed by another &%address_data%& setting
18905 on a subsequent router. If a router generates child addresses, the value of
18906 &$address_data$& propagates to them. This also applies to the special kind of
18907 &"child"& that is generated by a router with the &%unseen%& option.
18908
18909 The idea of &%address_data%& is that you can use it to look up a lot of data
18910 for the address once, and then pick out parts of the data later. For example,
18911 you could use a single LDAP lookup to return a string of the form
18912 .code
18913 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18914 .endd
18915 In the transport you could pick out the mailbox by a setting such as
18916 .code
18917 file = ${extract{mailbox}{$address_data}}
18918 .endd
18919 This makes the configuration file less messy, and also reduces the number of
18920 lookups (though Exim does cache lookups).
18921
18922 See also the &%set%& option below.
18923
18924 .vindex "&$sender_address_data$&"
18925 .vindex "&$address_data$&"
18926 The &%address_data%& facility is also useful as a means of passing information
18927 from one router to another, and from a router to a transport. In addition, if
18928 &$address_data$& is set by a router when verifying a recipient address from an
18929 ACL, it remains available for use in the rest of the ACL statement. After
18930 verifying a sender, the value is transferred to &$sender_address_data$&.
18931
18932
18933
18934 .option address_test routers&!? boolean true
18935 .oindex "&%-bt%&"
18936 .cindex "router" "skipping when address testing"
18937 If this option is set false, the router is skipped when routing is being tested
18938 by means of the &%-bt%& command line option. This can be a convenience when
18939 your first router sends messages to an external scanner, because it saves you
18940 having to set the &"already scanned"& indicator when testing real address
18941 routing.
18942
18943
18944
18945 .option cannot_route_message routers string&!! unset
18946 .cindex "router" "customizing &""cannot route""& message"
18947 .cindex "customizing" "&""cannot route""& message"
18948 This option specifies a text message that is used when an address cannot be
18949 routed because Exim has run out of routers. The default message is
18950 &"Unrouteable address"&. This option is useful only on routers that have
18951 &%more%& set false, or on the very last router in a configuration, because the
18952 value that is used is taken from the last router that is considered. This
18953 includes a router that is skipped because its preconditions are not met, as
18954 well as a router that declines. For example, using the default configuration,
18955 you could put:
18956 .code
18957 cannot_route_message = Remote domain not found in DNS
18958 .endd
18959 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18960 and
18961 .code
18962 cannot_route_message = Unknown local user
18963 .endd
18964 on the final router that checks for local users. If string expansion fails for
18965 this option, the default message is used. Unless the expansion failure was
18966 explicitly forced, a message about the failure is written to the main and panic
18967 logs, in addition to the normal message about the routing failure.
18968
18969
18970 .option caseful_local_part routers boolean false
18971 .cindex "case of local parts"
18972 .cindex "router" "case of local parts"
18973 By default, routers handle the local parts of addresses in a case-insensitive
18974 manner, though the actual case is preserved for transmission with the message.
18975 If you want the case of letters to be significant in a router, you must set
18976 this option true. For individual router options that contain address or local
18977 part lists (for example, &%local_parts%&), case-sensitive matching can be
18978 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18979 more details.
18980
18981 .vindex "&$local_part$&"
18982 .vindex "&$original_local_part$&"
18983 .vindex "&$parent_local_part$&"
18984 The value of the &$local_part$& variable is forced to lower case while a
18985 router is running unless &%caseful_local_part%& is set. When a router assigns
18986 an address to a transport, the value of &$local_part$& when the transport runs
18987 is the same as it was in the router. Similarly, when a router generates child
18988 addresses by aliasing or forwarding, the values of &$original_local_part$&
18989 and &$parent_local_part$& are those that were used by the redirecting router.
18990
18991 This option applies to the processing of an address by a router. When a
18992 recipient address is being processed in an ACL, there is a separate &%control%&
18993 modifier that can be used to specify case-sensitive processing within the ACL
18994 (see section &<<SECTcontrols>>&).
18995
18996
18997
18998 .option check_local_user routers&!? boolean false
18999 .cindex "local user, checking in router"
19000 .cindex "router" "checking for local user"
19001 .cindex "&_/etc/passwd_&"
19002 .vindex "&$home$&"
19003 When this option is true, Exim checks that the local part of the recipient
19004 address (with affixes removed if relevant) is the name of an account on the
19005 local system. The check is done by calling the &[getpwnam()]& function rather
19006 than trying to read &_/etc/passwd_& directly. This means that other methods of
19007 holding password data (such as NIS) are supported. If the local part is a local
19008 user,
19009 .cindex "tainted data" "de-tainting"
19010 .cindex "de-tainting" "using router check_local_user option"
19011 &$local_part_data$& is set to an untainted version of the local part and
19012 &$home$& is set from the password data. The latter can be tested in other
19013 preconditions that are evaluated after this one (the order of evaluation is
19014 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19015 overridden by &%router_home_directory%&. If the local part is not a local user,
19016 the router is skipped.
19017
19018 If you want to check that the local part is either the name of a local user
19019 or matches something else, you cannot combine &%check_local_user%& with a
19020 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19021 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19022 setting to achieve this. For example:
19023 .code
19024 local_parts = passwd;$local_part : lsearch;/etc/other/users
19025 .endd
19026 Note, however, that the side effects of &%check_local_user%& (such as setting
19027 up a home directory) do not occur when a &(passwd)& lookup is used in a
19028 &%local_parts%& (or any other) precondition.
19029
19030
19031
19032 .option condition routers&!? string&!! unset
19033 .cindex "router" "customized precondition"
19034 This option specifies a general precondition test that has to succeed for the
19035 router to be called. The &%condition%& option is the last precondition to be
19036 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19037 result is a forced failure, or an empty string, or one of the strings &"0"& or
19038 &"no"& or &"false"& (checked without regard to the case of the letters), the
19039 router is skipped, and the address is offered to the next one.
19040
19041 If the result is any other value, the router is run (as this is the last
19042 precondition to be evaluated, all the other preconditions must be true).
19043
19044 This option is unusual in that multiple &%condition%& options may be present.
19045 All &%condition%& options must succeed.
19046
19047 The &%condition%& option provides a means of applying custom conditions to the
19048 running of routers. Note that in the case of a simple conditional expansion,
19049 the default expansion values are exactly what is wanted. For example:
19050 .code
19051 condition = ${if >{$message_age}{600}}
19052 .endd
19053 Because of the default behaviour of the string expansion, this is equivalent to
19054 .code
19055 condition = ${if >{$message_age}{600}{true}{}}
19056 .endd
19057
19058 A multiple condition example, which succeeds:
19059 .code
19060 condition = ${if >{$message_age}{600}}
19061 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19062 condition = foobar
19063 .endd
19064
19065 If the expansion fails (other than forced failure) delivery is deferred. Some
19066 of the other precondition options are common special cases that could in fact
19067 be specified using &%condition%&.
19068
19069 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19070 are far older, and use one set of semantics.  ACLs are newer and when
19071 they were created, the ACL &%condition%& process was given far stricter
19072 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19073 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19074 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19075 Router rules processing behavior.
19076
19077 This is best illustrated in an example:
19078 .code
19079 # If used in an ACL condition will fail with a syntax error, but
19080 # in a router condition any extra characters are treated as a string
19081
19082 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19083 true {yes} {no}}
19084
19085 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19086  {yes} {no}}
19087 .endd
19088 In each example above, the &%if%& statement actually ends after
19089 &"{google.com}}"&.  Since no true or false braces were defined, the
19090 default &%if%& behavior is to return a boolean true or a null answer
19091 (which evaluates to false). The rest of the line is then treated as a
19092 string. So the first example resulted in the boolean answer &"true"&
19093 with the string &" {yes} {no}}"& appended to it. The second example
19094 resulted in the null output (indicating false) with the string
19095 &" {yes} {no}}"& appended to it.
19096
19097 In fact you can put excess forward braces in too.  In the router
19098 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19099 mean something, like after a &"$"& or when required as part of a
19100 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19101 string characters.
19102
19103 Thus, in a Router, the above expansion strings will both always evaluate
19104 true, as the result of expansion is a non-empty string which doesn't
19105 match an explicit false value.  This can be tricky to debug.  By
19106 contrast, in an ACL either of those strings will always result in an
19107 expansion error because the result doesn't look sufficiently boolean.
19108
19109
19110 .option debug_print routers string&!! unset
19111 .cindex "testing" "variables in drivers"
19112 If this option is set and debugging is enabled (see the &%-d%& command line
19113 option) or in address-testing mode (see the &%-bt%& command line option),
19114 the string is expanded and included in the debugging output.
19115 If expansion of the string fails, the error message is written to the debugging
19116 output, and Exim carries on processing.
19117 This option is provided to help with checking out the values of variables and
19118 so on when debugging router configurations. For example, if a &%condition%&
19119 option appears not to be working, &%debug_print%& can be used to output the
19120 variables it references. The output happens after checks for &%domains%&,
19121 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19122 are tested. A newline is added to the text if it does not end with one.
19123 The variable &$router_name$& contains the name of the router.
19124
19125
19126
19127 .option disable_logging routers boolean false
19128 If this option is set true, nothing is logged for any routing errors
19129 or for any deliveries caused by this router. You should not set this option
19130 unless you really, really know what you are doing. See also the generic
19131 transport option of the same name.
19132
19133 .option dnssec_request_domains routers "domain list&!!" *
19134 .cindex "MX record" "security"
19135 .cindex "DNSSEC" "MX lookup"
19136 .cindex "security" "MX lookup"
19137 .cindex "DNS" "DNSSEC"
19138 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19139 the DNSSEC request bit set.
19140 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19141
19142 .option dnssec_require_domains routers "domain list&!!" unset
19143 .cindex "MX record" "security"
19144 .cindex "DNSSEC" "MX lookup"
19145 .cindex "security" "MX lookup"
19146 .cindex "DNS" "DNSSEC"
19147 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19148 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19149 (AD bit) set will be ignored and logged as a host-lookup failure.
19150 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19151
19152
19153 .option domains routers&!? "domain list&!!" unset
19154 .cindex "router" "restricting to specific domains"
19155 .vindex "&$domain_data$&"
19156 If this option is set, the router is skipped unless the current domain matches
19157 the list. If the match is achieved by means of a file lookup, the data that the
19158 lookup returned for the domain is placed in &$domain_data$& for use in string
19159 expansions of the driver's private options and in the transport.
19160 See section &<<SECTrouprecon>>& for
19161 a list of the order in which preconditions are evaluated.
19162
19163
19164
19165 .option driver routers string unset
19166 This option must always be set. It specifies which of the available routers is
19167 to be used.
19168
19169
19170 .option dsn_lasthop routers boolean false
19171 .cindex "DSN" "success"
19172 .cindex "Delivery Status Notification" "success"
19173 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19174 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19175 instead send a success DSN as if the next hop does not support DSN.
19176 Not effective on redirect routers.
19177
19178
19179
19180 .option errors_to routers string&!! unset
19181 .cindex "envelope from"
19182 .cindex "envelope sender"
19183 .cindex "router" "changing address for errors"
19184 If a router successfully handles an address, it may assign the address to a
19185 transport for delivery or it may generate child addresses. In both cases, if
19186 there is a delivery problem during later processing, the resulting bounce
19187 message is sent to the address that results from expanding this string,
19188 provided that the address verifies successfully. The &%errors_to%& option is
19189 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19190
19191 The &%errors_to%& setting associated with an address can be overridden if it
19192 subsequently passes through other routers that have their own &%errors_to%&
19193 settings, or if the message is delivered by a transport with a &%return_path%&
19194 setting.
19195
19196 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19197 the expansion fails to verify, the errors address associated with the incoming
19198 address is used. At top level, this is the envelope sender. A non-forced
19199 expansion failure causes delivery to be deferred.
19200
19201 If an address for which &%errors_to%& has been set ends up being delivered over
19202 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19203 any bounces that are generated by other MTAs on the delivery route are also
19204 sent there. You can set &%errors_to%& to the empty string by either of these
19205 settings:
19206 .code
19207 errors_to =
19208 errors_to = ""
19209 .endd
19210 An expansion item that yields an empty string has the same effect. If you do
19211 this, a locally detected delivery error for addresses processed by this router
19212 no longer gives rise to a bounce message; the error is discarded. If the
19213 address is delivered to a remote host, the return path is set to &`<>`&, unless
19214 overridden by the &%return_path%& option on the transport.
19215
19216 .vindex "&$address_data$&"
19217 If for some reason you want to discard local errors, but use a non-empty
19218 MAIL command for remote delivery, you can preserve the original return
19219 path in &$address_data$& in the router, and reinstate it in the transport by
19220 setting &%return_path%&.
19221
19222 The most common use of &%errors_to%& is to direct mailing list bounces to the
19223 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19224 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19225
19226
19227
19228 .option expn routers&!? boolean true
19229 .cindex "address" "testing"
19230 .cindex "testing" "addresses"
19231 .cindex "EXPN" "router skipping"
19232 .cindex "router" "skipping for EXPN"
19233 If this option is turned off, the router is skipped when testing an address
19234 as a result of processing an SMTP EXPN command. You might, for example,
19235 want to turn it off on a router for users' &_.forward_& files, while leaving it
19236 on for the system alias file.
19237 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19238 are evaluated.
19239
19240 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19241 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19242 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19243
19244
19245
19246 .option fail_verify routers boolean false
19247 .cindex "router" "forcing verification failure"
19248 Setting this option has the effect of setting both &%fail_verify_sender%& and
19249 &%fail_verify_recipient%& to the same value.
19250
19251
19252
19253 .option fail_verify_recipient routers boolean false
19254 If this option is true and an address is accepted by this router when
19255 verifying a recipient, verification fails.
19256
19257
19258
19259 .option fail_verify_sender routers boolean false
19260 If this option is true and an address is accepted by this router when
19261 verifying a sender, verification fails.
19262
19263
19264
19265 .option fallback_hosts routers "string list" unset
19266 .cindex "router" "fallback hosts"
19267 .cindex "fallback" "hosts specified on router"
19268 String expansion is not applied to this option. The argument must be a
19269 colon-separated list of host names or IP addresses. The list separator can be
19270 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19271 each name or address. In fact, the format of each item is exactly the same as
19272 defined for the list of hosts in a &(manualroute)& router (see section
19273 &<<SECTformatonehostitem>>&).
19274
19275 If a router queues an address for a remote transport, this host list is
19276 associated with the address, and used instead of the transport's fallback host
19277 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19278 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19279 transport for further details.
19280
19281
19282 .option group routers string&!! "see below"
19283 .cindex "gid (group id)" "local delivery"
19284 .cindex "local transports" "uid and gid"
19285 .cindex "transport" "local"
19286 .cindex "router" "setting group"
19287 When a router queues an address for a transport, and the transport does not
19288 specify a group, the group given here is used when running the delivery
19289 process.
19290 The group may be specified numerically or by name. If expansion fails, the
19291 error is logged and delivery is deferred.
19292 The default is unset, unless &%check_local_user%& is set, when the default
19293 is taken from the password information. See also &%initgroups%& and &%user%&
19294 and the discussion in chapter &<<CHAPenvironment>>&.
19295
19296
19297
19298 .option headers_add routers list&!! unset
19299 .cindex "header lines" "adding"
19300 .cindex "router" "adding header lines"
19301 This option specifies a list of text headers,
19302 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19303 that is associated with any addresses that are accepted by the router.
19304 Each item is separately expanded, at routing time.  However, this
19305 option has no effect when an address is just being verified. The way in which
19306 the text is used to add header lines at transport time is described in section
19307 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19308 message is in the process of being transported. This means that references to
19309 header lines in string expansions in the transport's configuration do not
19310 &"see"& the added header lines.
19311
19312 The &%headers_add%& option is expanded after &%errors_to%&, but before
19313 &%headers_remove%& and &%transport%&. If an item is empty, or if
19314 an item expansion is forced to fail, the item has no effect. Other expansion
19315 failures are treated as configuration errors.
19316
19317 Unlike most options, &%headers_add%& can be specified multiple times
19318 for a router; all listed headers are added.
19319
19320 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19321 router that has the &%one_time%& option set.
19322
19323 .cindex "duplicate addresses"
19324 .oindex "&%unseen%&"
19325 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19326 additions are deleted when the address is passed on to subsequent routers.
19327 For a &%redirect%& router, if a generated address is the same as the incoming
19328 address, this can lead to duplicate addresses with different header
19329 modifications. Exim does not do duplicate deliveries (except, in certain
19330 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19331 which of the duplicates is discarded, so this ambiguous situation should be
19332 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19333
19334
19335
19336 .option headers_remove routers list&!! unset
19337 .cindex "header lines" "removing"
19338 .cindex "router" "removing header lines"
19339 This option specifies a list of text headers,
19340 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19341 that is associated with any addresses that are accepted by the router.
19342 However, the option has no effect when an address is just being verified.
19343 Each list item is separately expanded, at transport time.
19344 If an item ends in *, it will match any header with the given prefix.
19345 The way in which
19346 the text is used to remove header lines at transport time is described in
19347 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19348 the message is in the process of being transported. This means that references
19349 to header lines in string expansions in the transport's configuration still
19350 &"see"& the original header lines.
19351
19352 The &%headers_remove%& option is handled after &%errors_to%& and
19353 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19354 the item has no effect. Other expansion failures are treated as configuration
19355 errors.
19356
19357 Unlike most options, &%headers_remove%& can be specified multiple times
19358 for a router; all listed headers are removed.
19359
19360 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19361 router that has the &%one_time%& option set.
19362
19363 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19364 removal requests are deleted when the address is passed on to subsequent
19365 routers, and this can lead to problems with duplicates -- see the similar
19366 warning for &%headers_add%& above.
19367
19368 &*Warning 3*&: Because of the separate expansion of the list items,
19369 items that contain a list separator must have it doubled.
19370 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19371
19372
19373
19374 .option ignore_target_hosts routers "host list&!!" unset
19375 .cindex "IP address" "discarding"
19376 .cindex "router" "discarding IP addresses"
19377 Although this option is a host list, it should normally contain IP address
19378 entries rather than names. If any host that is looked up by the router has an
19379 IP address that matches an item in this list, Exim behaves as if that IP
19380 address did not exist. This option allows you to cope with rogue DNS entries
19381 like
19382 .code
19383 remote.domain.example.  A  127.0.0.1
19384 .endd
19385 by setting
19386 .code
19387 ignore_target_hosts = 127.0.0.1
19388 .endd
19389 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19390 discarded in this way, the router declines. In a conventional configuration, an
19391 attempt to mail to such a domain would normally provoke the &"unrouteable
19392 domain"& error, and an attempt to verify an address in the domain would fail.
19393 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19394 router declines if presented with one of the listed addresses.
19395
19396 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19397 means of the first or the second of the following settings, respectively:
19398 .code
19399 ignore_target_hosts = 0.0.0.0/0
19400 ignore_target_hosts = <; 0::0/0
19401 .endd
19402 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19403 in the second line matches all IPv6 addresses.
19404
19405 This option may also be useful for ignoring link-local and site-local IPv6
19406 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19407 is expanded before use as a list, it is possible to make it dependent on the
19408 domain that is being routed.
19409
19410 .vindex "&$host_address$&"
19411 During its expansion, &$host_address$& is set to the IP address that is being
19412 checked.
19413
19414 .option initgroups routers boolean false
19415 .cindex "additional groups"
19416 .cindex "groups" "additional"
19417 .cindex "local transports" "uid and gid"
19418 .cindex "transport" "local"
19419 If the router queues an address for a transport, and this option is true, and
19420 the uid supplied by the router is not overridden by the transport, the
19421 &[initgroups()]& function is called when running the transport to ensure that
19422 any additional groups associated with the uid are set up. See also &%group%&
19423 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19424
19425
19426
19427 .option local_part_prefix routers&!? "string list" unset
19428 .cindex affix "router precondition"
19429 .cindex "router" "prefix for local part"
19430 .cindex "prefix" "for local part, used in router"
19431 If this option is set, the router is skipped unless the local part starts with
19432 one of the given strings, or &%local_part_prefix_optional%& is true. See
19433 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19434 evaluated.
19435
19436 The list is scanned from left to right, and the first prefix that matches is
19437 used. A limited form of wildcard is available; if the prefix begins with an
19438 asterisk, it matches the longest possible sequence of arbitrary characters at
19439 the start of the local part. An asterisk should therefore always be followed by
19440 some character that does not occur in normal local parts.
19441 .cindex "multiple mailboxes"
19442 .cindex "mailbox" "multiple"
19443 Wildcarding can be used to set up multiple user mailboxes, as described in
19444 section &<<SECTmulbox>>&.
19445
19446 .vindex "&$local_part$&"
19447 .vindex "&$local_part_prefix$&"
19448 During the testing of the &%local_parts%& option, and while the router is
19449 running, the prefix is removed from the local part, and is available in the
19450 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19451 the router accepts the address, this remains true during subsequent delivery by
19452 a transport. In particular, the local part that is transmitted in the RCPT
19453 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19454 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19455 the relevant transport.
19456
19457 .vindex &$local_part_prefix_v$&
19458 If wildcarding (above) was used then the part of the prefix matching the
19459 wildcard is available in &$local_part_prefix_v$&.
19460
19461 When an address is being verified, &%local_part_prefix%& affects only the
19462 behaviour of the router. If the callout feature of verification is in use, this
19463 means that the full address, including the prefix, will be used during the
19464 callout.
19465
19466 The prefix facility is commonly used to handle local parts of the form
19467 &%owner-something%&. Another common use is to support local parts of the form
19468 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19469 to tell a user their forwarding is broken &-- by placing a router like this one
19470 immediately before the router that handles &_.forward_& files:
19471 .code
19472 real_localuser:
19473   driver = accept
19474   local_part_prefix = real-
19475   check_local_user
19476   transport = local_delivery
19477 .endd
19478 For security, it would probably be a good idea to restrict the use of this
19479 router to locally-generated messages, using a condition such as this:
19480 .code
19481   condition = ${if match {$sender_host_address}\
19482                          {\N^(|127\.0\.0\.1)$\N}}
19483 .endd
19484
19485 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19486 both conditions must be met if not optional. Care must be taken if wildcards
19487 are used in both a prefix and a suffix on the same router. Different
19488 separator characters must be used to avoid ambiguity.
19489
19490
19491 .option local_part_prefix_optional routers boolean false
19492 See &%local_part_prefix%& above.
19493
19494
19495
19496 .option local_part_suffix routers&!? "string list" unset
19497 .cindex "router" "suffix for local part"
19498 .cindex "suffix for local part" "used in router"
19499 This option operates in the same way as &%local_part_prefix%&, except that the
19500 local part must end (rather than start) with the given string, the
19501 &%local_part_suffix_optional%& option determines whether the suffix is
19502 mandatory, and the wildcard * character, if present, must be the last
19503 character of the suffix. This option facility is commonly used to handle local
19504 parts of the form &%something-request%& and multiple user mailboxes of the form
19505 &%username-foo%&.
19506
19507
19508 .option local_part_suffix_optional routers boolean false
19509 See &%local_part_suffix%& above.
19510
19511
19512
19513 .option local_parts routers&!? "local part list&!!" unset
19514 .cindex "router" "restricting to specific local parts"
19515 .cindex "local part" "checking in router"
19516 The router is run only if the local part of the address matches the list.
19517 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19518 are evaluated, and
19519 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19520 string is expanded, it is possible to make it depend on the domain, for
19521 example:
19522 .code
19523 local_parts = dbm;/usr/local/specials/$domain_data
19524 .endd
19525 .vindex "&$local_part_data$&"
19526 If the match is achieved by a lookup, the data that the lookup returned
19527 for the local part is placed in the variable &$local_part_data$& for use in
19528 expansions of the router's private options or in the transport.
19529 You might use this option, for
19530 example, if you have a large number of local virtual domains, and you want to
19531 send all postmaster mail to the same place without having to set up an alias in
19532 each virtual domain:
19533 .code
19534 postmaster:
19535   driver = redirect
19536   local_parts = postmaster
19537   data = postmaster@real.domain.example
19538 .endd
19539
19540
19541 .option log_as_local routers boolean "see below"
19542 .cindex "log" "delivery line"
19543 .cindex "delivery" "log line format"
19544 Exim has two logging styles for delivery, the idea being to make local
19545 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19546 recipient address is given just as the local part, without a domain. The use of
19547 this style is controlled by this option. It defaults to true for the &(accept)&
19548 router, and false for all the others. This option applies only when a
19549 router assigns an address to a transport. It has no effect on routers that
19550 redirect addresses.
19551
19552
19553
19554 .option more routers boolean&!! true
19555 The result of string expansion for this option must be a valid boolean value,
19556 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19557 result causes an error, and delivery is deferred. If the expansion is forced to
19558 fail, the default value for the option (true) is used. Other failures cause
19559 delivery to be deferred.
19560
19561 If this option is set false, and the router declines to handle the address, no
19562 further routers are tried, routing fails, and the address is bounced.
19563 .oindex "&%self%&"
19564 However, if the router explicitly passes an address to the following router by
19565 means of the setting
19566 .code
19567 self = pass
19568 .endd
19569 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19570 does not affect the behaviour if one of the precondition tests fails. In that
19571 case, the address is always passed to the next router.
19572
19573 Note that &%address_data%& is not considered to be a precondition. If its
19574 expansion is forced to fail, the router declines, and the value of &%more%&
19575 controls what happens next.
19576
19577
19578 .option pass_on_timeout routers boolean false
19579 .cindex "timeout" "of router"
19580 .cindex "router" "timeout"
19581 If a router times out during a host lookup, it normally causes deferral of the
19582 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19583 router, overriding &%no_more%&. This may be helpful for systems that are
19584 intermittently connected to the Internet, or those that want to pass to a smart
19585 host any messages that cannot immediately be delivered.
19586
19587 There are occasional other temporary errors that can occur while doing DNS
19588 lookups. They are treated in the same way as a timeout, and this option
19589 applies to all of them.
19590
19591
19592
19593 .option pass_router routers string unset
19594 .cindex "router" "go to after &""pass""&"
19595 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19596 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19597 routing to continue, and overriding a false setting of &%more%&. When one of
19598 these routers returns &"pass"&, the address is normally handed on to the next
19599 router in sequence. This can be changed by setting &%pass_router%& to the name
19600 of another router. However (unlike &%redirect_router%&) the named router must
19601 be below the current router, to avoid loops. Note that this option applies only
19602 to the special case of &"pass"&. It does not apply when a router returns
19603 &"decline"& because it cannot handle an address.
19604
19605
19606
19607 .option redirect_router routers string unset
19608 .cindex "router" "start at after redirection"
19609 Sometimes an administrator knows that it is pointless to reprocess addresses
19610 generated from alias or forward files with the same router again. For
19611 example, if an alias file translates real names into login ids there is no
19612 point searching the alias file a second time, especially if it is a large file.
19613
19614 The &%redirect_router%& option can be set to the name of any router instance.
19615 It causes the routing of any generated addresses to start at the named router
19616 instead of at the first router. This option has no effect if the router in
19617 which it is set does not generate new addresses.
19618
19619
19620
19621 .option require_files routers&!? "string list&!!" unset
19622 .cindex "file" "requiring for router"
19623 .cindex "router" "requiring file existence"
19624 This option provides a general mechanism for predicating the running of a
19625 router on the existence or non-existence of certain files or directories.
19626 Before running a router, as one of its precondition tests, Exim works its way
19627 through the &%require_files%& list, expanding each item separately.
19628
19629 Because the list is split before expansion, any colons in expansion items must
19630 be doubled, or the facility for using a different list separator must be used
19631 (&<<SECTlistsepchange>>&).
19632 If any expansion is forced to fail, the item is ignored. Other expansion
19633 failures cause routing of the address to be deferred.
19634
19635 If any expanded string is empty, it is ignored. Otherwise, except as described
19636 below, each string must be a fully qualified file path, optionally preceded by
19637 &"!"&. The paths are passed to the &[stat()]& function to test for the
19638 existence of the files or directories. The router is skipped if any paths not
19639 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19640
19641 .cindex "NFS"
19642 If &[stat()]& cannot determine whether a file exists or not, delivery of
19643 the message is deferred. This can happen when NFS-mounted filesystems are
19644 unavailable.
19645
19646 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19647 options, so you cannot use it to check for the existence of a file in which to
19648 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19649 full list of the order in which preconditions are evaluated.) However, as
19650 these options are all expanded, you can use the &%exists%& expansion condition
19651 to make such tests. The &%require_files%& option is intended for checking files
19652 that the router may be going to use internally, or which are needed by a
19653 transport (e.g., &_.procmailrc_&).
19654
19655 During delivery, the &[stat()]& function is run as root, but there is a
19656 facility for some checking of the accessibility of a file by another user.
19657 This is not a proper permissions check, but just a &"rough"& check that
19658 operates as follows:
19659
19660 If an item in a &%require_files%& list does not contain any forward slash
19661 characters, it is taken to be the user (and optional group, separated by a
19662 comma) to be checked for subsequent files in the list. If no group is specified
19663 but the user is specified symbolically, the gid associated with the uid is
19664 used. For example:
19665 .code
19666 require_files = mail:/some/file
19667 require_files = $local_part_data:$home/.procmailrc
19668 .endd
19669 If a user or group name in a &%require_files%& list does not exist, the
19670 &%require_files%& condition fails.
19671
19672 Exim performs the check by scanning along the components of the file path, and
19673 checking the access for the given uid and gid. It checks for &"x"& access on
19674 directories, and &"r"& access on the final file. Note that this means that file
19675 access control lists, if the operating system has them, are ignored.
19676
19677 &*Warning 1*&: When the router is being run to verify addresses for an
19678 incoming SMTP message, Exim is not running as root, but under its own uid. This
19679 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19680 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19681 user is not permitted to read one of the directories on the file's path.
19682
19683 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19684 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19685 without root access. In this case, if a check for access by a particular user
19686 is requested, Exim creates a subprocess that runs as that user, and tries the
19687 check again in that process.
19688
19689 The default action for handling an unresolved EACCES is to consider it to
19690 be caused by a configuration error, and routing is deferred because the
19691 existence or non-existence of the file cannot be determined. However, in some
19692 circumstances it may be desirable to treat this condition as if the file did
19693 not exist. If the filename (or the exclamation mark that precedes the filename
19694 for non-existence) is preceded by a plus sign, the EACCES error is treated
19695 as if the file did not exist. For example:
19696 .code
19697 require_files = +/some/file
19698 .endd
19699 If the router is not an essential part of verification (for example, it
19700 handles users' &_.forward_& files), another solution is to set the &%verify%&
19701 option false so that the router is skipped when verifying.
19702
19703
19704
19705 .option retry_use_local_part routers boolean "see below"
19706 .cindex "hints database" "retry keys"
19707 .cindex "local part" "in retry keys"
19708 When a delivery suffers a temporary routing failure, a retry record is created
19709 in Exim's hints database. For addresses whose routing depends only on the
19710 domain, the key for the retry record should not involve the local part, but for
19711 other addresses, both the domain and the local part should be included.
19712 Usually, remote routing is of the former kind, and local routing is of the
19713 latter kind.
19714
19715 This option controls whether the local part is used to form the key for retry
19716 hints for addresses that suffer temporary errors while being handled by this
19717 router. The default value is true for any router that has any of
19718 &%check_local_user%&,
19719 &%local_parts%&,
19720 &%condition%&,
19721 &%local_part_prefix%&,
19722 &%local_part_suffix%&,
19723 &%senders%& or
19724 &%require_files%&
19725 set, and false otherwise. Note that this option does not apply to hints keys
19726 for transport delays; they are controlled by a generic transport option of the
19727 same name.
19728
19729 Failing to set this option when it is needed
19730 (because a remote router handles only some of the local-parts for a domain)
19731 can result in incorrect error messages being generated.
19732
19733 The setting of &%retry_use_local_part%& applies only to the router on which it
19734 appears. If the router generates child addresses, they are routed
19735 independently; this setting does not become attached to them.
19736
19737
19738
19739 .option router_home_directory routers string&!! unset
19740 .cindex "router" "home directory for"
19741 .cindex "home directory" "for router"
19742 .vindex "&$home$&"
19743 This option sets a home directory for use while the router is running. (Compare
19744 &%transport_home_directory%&, which sets a home directory for later
19745 transporting.) In particular, if used on a &(redirect)& router, this option
19746 sets a value for &$home$& while a filter is running. The value is expanded;
19747 forced expansion failure causes the option to be ignored &-- other failures
19748 cause the router to defer.
19749
19750 Expansion of &%router_home_directory%& happens immediately after the
19751 &%check_local_user%& test (if configured), before any further expansions take
19752 place.
19753 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19754 are evaluated.)
19755 While the router is running, &%router_home_directory%& overrides the value of
19756 &$home$& that came from &%check_local_user%&.
19757
19758 When a router accepts an address and assigns it to a local transport (including
19759 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19760 delivery), the home directory setting for the transport is taken from the first
19761 of these values that is set:
19762
19763 .ilist
19764 The &%home_directory%& option on the transport;
19765 .next
19766 The &%transport_home_directory%& option on the router;
19767 .next
19768 The password data if &%check_local_user%& is set on the router;
19769 .next
19770 The &%router_home_directory%& option on the router.
19771 .endlist
19772
19773 In other words, &%router_home_directory%& overrides the password data for the
19774 router, but not for the transport.
19775
19776
19777
19778 .option self routers string freeze
19779 .cindex "MX record" "pointing to local host"
19780 .cindex "local host" "MX pointing to"
19781 This option applies to those routers that use a recipient address to find a
19782 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19783 and &(manualroute)& routers.
19784 Certain configurations of the &(queryprogram)& router can also specify a list
19785 of remote hosts.
19786 Usually such routers are configured to send the message to a remote host via an
19787 &(smtp)& transport. The &%self%& option specifies what happens when the first
19788 host on the list turns out to be the local host.
19789 The way in which Exim checks for the local host is described in section
19790 &<<SECTreclocipadd>>&.
19791
19792 Normally this situation indicates either an error in Exim's configuration (for
19793 example, the router should be configured not to process this domain), or an
19794 error in the DNS (for example, the MX should not point to this host). For this
19795 reason, the default action is to log the incident, defer the address, and
19796 freeze the message. The following alternatives are provided for use in special
19797 cases:
19798
19799 .vlist
19800 .vitem &%defer%&
19801 Delivery of the message is tried again later, but the message is not frozen.
19802
19803 .vitem "&%reroute%&: <&'domain'&>"
19804 The domain is changed to the given domain, and the address is passed back to
19805 be reprocessed by the routers. No rewriting of headers takes place. This
19806 behaviour is essentially a redirection.
19807
19808 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19809 The domain is changed to the given domain, and the address is passed back to be
19810 reprocessed by the routers. Any headers that contain the original domain are
19811 rewritten.
19812
19813 .vitem &%pass%&
19814 .oindex "&%more%&"
19815 .vindex "&$self_hostname$&"
19816 The router passes the address to the next router, or to the router named in the
19817 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19818 subsequent routing and delivery, the variable &$self_hostname$& contains the
19819 name of the local host that the router encountered. This can be used to
19820 distinguish between different cases for hosts with multiple names. The
19821 combination
19822 .code
19823 self = pass
19824 no_more
19825 .endd
19826 ensures that only those addresses that routed to the local host are passed on.
19827 Without &%no_more%&, addresses that were declined for other reasons would also
19828 be passed to the next router.
19829
19830 .vitem &%fail%&
19831 Delivery fails and an error report is generated.
19832
19833 .vitem &%send%&
19834 .cindex "local host" "sending to"
19835 The anomaly is ignored and the address is queued for the transport. This
19836 setting should be used with extreme caution. For an &(smtp)& transport, it
19837 makes sense only in cases where the program that is listening on the SMTP port
19838 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19839 different configuration file that handles the domain in another way.
19840 .endlist
19841
19842
19843
19844 .option senders routers&!? "address list&!!" unset
19845 .cindex "router" "checking senders"
19846 If this option is set, the router is skipped unless the message's sender
19847 address matches something on the list.
19848 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19849 are evaluated.
19850
19851 There are issues concerning verification when the running of routers is
19852 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19853 setting, it sets the sender to the null string. When using the &%-bt%& option
19854 to check a configuration file, it is necessary also to use the &%-f%& option to
19855 set an appropriate sender. For incoming mail, the sender is unset when
19856 verifying the sender, but is available when verifying any recipients. If the
19857 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19858 matters.
19859
19860
19861 .option set routers "string list" unset
19862 .cindex router variables
19863 This option may be used multiple times on a router;
19864 because of this the list aspect is mostly irrelevant.
19865 The list separator is a semicolon but can be changed in the
19866 usual way.
19867
19868 Each list-element given must be of the form &"name = value"&
19869 and the names used must start with the string &"r_"&.
19870 Values containing a list-separator should have them doubled.
19871 When a router runs, the strings are evaluated in order,
19872 to create variables which are added to the set associated with
19873 the address.
19874 This is done immediately after all the preconditions, before the
19875 evaluation of the &%address_data%& option.
19876 The variable is set with the expansion of the value.
19877 The variables can be used by the router options
19878 (not including any preconditions)
19879 and by the transport.
19880 Later definitions of a given named variable will override former ones.
19881 Variable use is via the usual &$r_...$& syntax.
19882
19883 This is similar to the &%address_data%& option, except that
19884 many independent variables can be used, with choice of naming.
19885
19886
19887 .option translate_ip_address routers string&!! unset
19888 .cindex "IP address" "translating"
19889 .cindex "packet radio"
19890 .cindex "router" "IP address translation"
19891 There exist some rare networking situations (for example, packet radio) where
19892 it is helpful to be able to translate IP addresses generated by normal routing
19893 mechanisms into other IP addresses, thus performing a kind of manual IP
19894 routing. This should be done only if the normal IP routing of the TCP/IP stack
19895 is inadequate or broken. Because this is an extremely uncommon requirement, the
19896 code to support this option is not included in the Exim binary unless
19897 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19898
19899 .vindex "&$host_address$&"
19900 The &%translate_ip_address%& string is expanded for every IP address generated
19901 by the router, with the generated address set in &$host_address$&. If the
19902 expansion is forced to fail, no action is taken.
19903 For any other expansion error, delivery of the message is deferred.
19904 If the result of the expansion is an IP address, that replaces the original
19905 address; otherwise the result is assumed to be a host name &-- this is looked
19906 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19907 produce one or more replacement IP addresses. For example, to subvert all IP
19908 addresses in some specific networks, this could be added to a router:
19909 .code
19910 translate_ip_address = \
19911   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19912     {$value}fail}}
19913 .endd
19914 The file would contain lines like
19915 .code
19916 10.2.3.128/26    some.host
19917 10.8.4.34/26     10.44.8.15
19918 .endd
19919 You should not make use of this facility unless you really understand what you
19920 are doing.
19921
19922
19923
19924 .option transport routers string&!! unset
19925 This option specifies the transport to be used when a router accepts an address
19926 and sets it up for delivery. A transport is never needed if a router is used
19927 only for verification. The value of the option is expanded at routing time,
19928 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19929 and result must be the name of one of the configured transports. If it is not,
19930 delivery is deferred.
19931
19932 The &%transport%& option is not used by the &(redirect)& router, but it does
19933 have some private options that set up transports for pipe and file deliveries
19934 (see chapter &<<CHAPredirect>>&).
19935
19936
19937
19938 .option transport_current_directory routers string&!! unset
19939 .cindex "current directory for local transport"
19940 This option associates a current directory with any address that is routed
19941 to a local transport. This can happen either because a transport is
19942 explicitly configured for the router, or because it generates a delivery to a
19943 file or a pipe. During the delivery process (that is, at transport time), this
19944 option string is expanded and is set as the current directory, unless
19945 overridden by a setting on the transport.
19946 If the expansion fails for any reason, including forced failure, an error is
19947 logged, and delivery is deferred.
19948 See chapter &<<CHAPenvironment>>& for details of the local delivery
19949 environment.
19950
19951
19952
19953
19954 .option transport_home_directory routers string&!! "see below"
19955 .cindex "home directory" "for local transport"
19956 This option associates a home directory with any address that is routed to a
19957 local transport. This can happen either because a transport is explicitly
19958 configured for the router, or because it generates a delivery to a file or a
19959 pipe. During the delivery process (that is, at transport time), the option
19960 string is expanded and is set as the home directory, unless overridden by a
19961 setting of &%home_directory%& on the transport.
19962 If the expansion fails for any reason, including forced failure, an error is
19963 logged, and delivery is deferred.
19964
19965 If the transport does not specify a home directory, and
19966 &%transport_home_directory%& is not set for the router, the home directory for
19967 the transport is taken from the password data if &%check_local_user%& is set for
19968 the router. Otherwise it is taken from &%router_home_directory%& if that option
19969 is set; if not, no home directory is set for the transport.
19970
19971 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19972 environment.
19973
19974
19975
19976
19977 .option unseen routers boolean&!! false
19978 .cindex "router" "carrying on after success"
19979 The result of string expansion for this option must be a valid boolean value,
19980 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19981 result causes an error, and delivery is deferred. If the expansion is forced to
19982 fail, the default value for the option (false) is used. Other failures cause
19983 delivery to be deferred.
19984
19985 When this option is set true, routing does not cease if the router accepts the
19986 address. Instead, a copy of the incoming address is passed to the next router,
19987 overriding a false setting of &%more%&. There is little point in setting
19988 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19989 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19990 sometimes true and sometimes false).
19991
19992 .cindex "copy of message (&%unseen%& option)"
19993 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19994 qualifier in filter files. It can be used to cause copies of messages to be
19995 delivered to some other destination, while also carrying out a normal delivery.
19996 In effect, the current address is made into a &"parent"& that has two children
19997 &-- one that is delivered as specified by this router, and a clone that goes on
19998 to be routed further. For this reason, &%unseen%& may not be combined with the
19999 &%one_time%& option in a &(redirect)& router.
20000
20001 &*Warning*&: Header lines added to the address (or specified for removal) by
20002 this router or by previous routers affect the &"unseen"& copy of the message
20003 only. The clone that continues to be processed by further routers starts with
20004 no added headers and none specified for removal. For a &%redirect%& router, if
20005 a generated address is the same as the incoming address, this can lead to
20006 duplicate addresses with different header modifications. Exim does not do
20007 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20008 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20009 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20010 &%redirect%& router may be of help.
20011
20012 Unlike the handling of header modifications, any data that was set by the
20013 &%address_data%& option in the current or previous routers &'is'& passed on to
20014 subsequent routers.
20015
20016
20017 .option user routers string&!! "see below"
20018 .cindex "uid (user id)" "local delivery"
20019 .cindex "local transports" "uid and gid"
20020 .cindex "transport" "local"
20021 .cindex "router" "user for filter processing"
20022 .cindex "filter" "user for processing"
20023 When a router queues an address for a transport, and the transport does not
20024 specify a user, the user given here is used when running the delivery process.
20025 The user may be specified numerically or by name. If expansion fails, the
20026 error is logged and delivery is deferred.
20027 This user is also used by the &(redirect)& router when running a filter file.
20028 The default is unset, except when &%check_local_user%& is set. In this case,
20029 the default is taken from the password information. If the user is specified as
20030 a name, and &%group%& is not set, the group associated with the user is used.
20031 See also &%initgroups%& and &%group%& and the discussion in chapter
20032 &<<CHAPenvironment>>&.
20033
20034
20035
20036 .option verify routers&!? boolean true
20037 Setting this option has the effect of setting &%verify_sender%& and
20038 &%verify_recipient%& to the same value.
20039
20040
20041 .option verify_only routers&!? boolean false
20042 .cindex "EXPN" "with &%verify_only%&"
20043 .oindex "&%-bv%&"
20044 .cindex "router" "used only when verifying"
20045 If this option is set, the router is used only when verifying an address,
20046 delivering in cutthrough mode or
20047 testing with the &%-bv%& option, not when actually doing a delivery, testing
20048 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20049 restricted to verifying only senders or recipients by means of
20050 &%verify_sender%& and &%verify_recipient%&.
20051
20052 &*Warning*&: When the router is being run to verify addresses for an incoming
20053 SMTP message, Exim is not running as root, but under its own uid. If the router
20054 accesses any files, you need to make sure that they are accessible to the Exim
20055 user or group.
20056
20057
20058 .option verify_recipient routers&!? boolean true
20059 If this option is false, the router is skipped when verifying recipient
20060 addresses,
20061 delivering in cutthrough mode
20062 or testing recipient verification using &%-bv%&.
20063 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20064 are evaluated.
20065 See also the &$verify_mode$& variable.
20066
20067
20068 .option verify_sender routers&!? boolean true
20069 If this option is false, the router is skipped when verifying sender addresses
20070 or testing sender verification using &%-bvs%&.
20071 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20072 are evaluated.
20073 See also the &$verify_mode$& variable.
20074 .ecindex IIDgenoprou1
20075 .ecindex IIDgenoprou2
20076
20077
20078
20079
20080
20081
20082 . ////////////////////////////////////////////////////////////////////////////
20083 . ////////////////////////////////////////////////////////////////////////////
20084
20085 .chapter "The accept router" "CHID4"
20086 .cindex "&(accept)& router"
20087 .cindex "routers" "&(accept)&"
20088 The &(accept)& router has no private options of its own. Unless it is being
20089 used purely for verification (see &%verify_only%&) a transport is required to
20090 be defined by the generic &%transport%& option. If the preconditions that are
20091 specified by generic options are met, the router accepts the address and queues
20092 it for the given transport. The most common use of this router is for setting
20093 up deliveries to local mailboxes. For example:
20094 .code
20095 localusers:
20096   driver = accept
20097   domains = mydomain.example
20098   check_local_user
20099   transport = local_delivery
20100 .endd
20101 The &%domains%& condition in this example checks the domain of the address, and
20102 &%check_local_user%& checks that the local part is the login of a local user.
20103 When both preconditions are met, the &(accept)& router runs, and queues the
20104 address for the &(local_delivery)& transport.
20105
20106
20107
20108
20109
20110
20111 . ////////////////////////////////////////////////////////////////////////////
20112 . ////////////////////////////////////////////////////////////////////////////
20113
20114 .chapter "The dnslookup router" "CHAPdnslookup"
20115 .scindex IIDdnsrou1 "&(dnslookup)& router"
20116 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20117 The &(dnslookup)& router looks up the hosts that handle mail for the
20118 recipient's domain in the DNS. A transport must always be set for this router,
20119 unless &%verify_only%& is set.
20120
20121 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20122 SRV records. If none are found, or if SRV support is not configured,
20123 MX records are looked up. If no MX records exist, address records are sought.
20124 However, &%mx_domains%& can be set to disable the direct use of address
20125 records.
20126
20127 MX records of equal priority are sorted by Exim into a random order. Exim then
20128 looks for address records for the host names obtained from MX or SRV records.
20129 When a host has more than one IP address, they are sorted into a random order,
20130 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20131 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20132 generic option, the router declines.
20133
20134 Unless they have the highest priority (lowest MX value), MX records that point
20135 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20136 are discarded, together with any other MX records of equal or lower priority.
20137
20138 .cindex "MX record" "pointing to local host"
20139 .cindex "local host" "MX pointing to"
20140 .oindex "&%self%&" "in &(dnslookup)& router"
20141 If the host pointed to by the highest priority MX record, or looked up as an
20142 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20143 happens is controlled by the generic &%self%& option.
20144
20145
20146 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20147 There have been problems with DNS servers when SRV records are looked up.
20148 Some misbehaving servers return a DNS error or timeout when a non-existent
20149 SRV record is sought. Similar problems have in the past been reported for
20150 MX records. The global &%dns_again_means_nonexist%& option can help with this
20151 problem, but it is heavy-handed because it is a global option.
20152
20153 For this reason, there are two options, &%srv_fail_domains%& and
20154 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20155 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20156 an attempt to look up an SRV or MX record causes one of these results, and the
20157 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20158 such record"&. In the case of an SRV lookup, this means that the router
20159 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20160 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20161 case routing fails.
20162
20163
20164 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20165 .cindex "&(dnslookup)& router" "declines"
20166 There are a few cases where a &(dnslookup)& router will decline to accept
20167 an address; if such a router is expected to handle "all remaining non-local
20168 domains", then it is important to set &%no_more%&.
20169
20170 The router will defer rather than decline if the domain
20171 is found in the &%fail_defer_domains%& router option.
20172
20173 Reasons for a &(dnslookup)& router to decline currently include:
20174 .ilist
20175 The domain does not exist in DNS
20176 .next
20177 The domain exists but the MX record's host part is just "."; this is a common
20178 convention (borrowed from SRV) used to indicate that there is no such service
20179 for this domain and to not fall back to trying A/AAAA records.
20180 .next
20181 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20182 .next
20183 MX record points to a non-existent host.
20184 .next
20185 MX record points to an IP address and the main section option
20186 &%allow_mx_to_ip%& is not set.
20187 .next
20188 MX records exist and point to valid hosts, but all hosts resolve only to
20189 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20190 .next
20191 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20192 &%dns_check_names_pattern%& for handling one variant of this)
20193 .next
20194 &%check_secondary_mx%& is set on this router but the local host can
20195 not be found in the MX records (see below)
20196 .endlist
20197
20198
20199
20200
20201 .section "Private options for dnslookup" "SECID118"
20202 .cindex "options" "&(dnslookup)& router"
20203 The private options for the &(dnslookup)& router are as follows:
20204
20205 .option check_secondary_mx dnslookup boolean false
20206 .cindex "MX record" "checking for secondary"
20207 If this option is set, the router declines unless the local host is found in
20208 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20209 process domains for which the local host is a secondary mail exchanger
20210 differently to other domains. The way in which Exim decides whether a host is
20211 the local host is described in section &<<SECTreclocipadd>>&.
20212
20213
20214 .option check_srv dnslookup string&!! unset
20215 .cindex "SRV record" "enabling use of"
20216 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20217 addition to MX and address records. The support is disabled by default. To
20218 enable SRV support, set the &%check_srv%& option to the name of the service
20219 required. For example,
20220 .code
20221 check_srv = smtp
20222 .endd
20223 looks for SRV records that refer to the normal smtp service. The option is
20224 expanded, so the service name can vary from message to message or address
20225 to address. This might be helpful if SRV records are being used for a
20226 submission service. If the expansion is forced to fail, the &%check_srv%&
20227 option is ignored, and the router proceeds to look for MX records in the
20228 normal way.
20229
20230 When the expansion succeeds, the router searches first for SRV records for
20231 the given service (it assumes TCP protocol). A single SRV record with a
20232 host name that consists of just a single dot indicates &"no such service for
20233 this domain"&; if this is encountered, the router declines. If other kinds of
20234 SRV record are found, they are used to construct a host list for delivery
20235 according to the rules of RFC 2782. MX records are not sought in this case.
20236
20237 When no SRV records are found, MX records (and address records) are sought in
20238 the traditional way. In other words, SRV records take precedence over MX
20239 records, just as MX records take precedence over address records. Note that
20240 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20241 defined it. It is apparently believed that MX records are sufficient for email
20242 and that SRV records should not be used for this purpose. However, SRV records
20243 have an additional &"weight"& feature which some people might find useful when
20244 trying to split an SMTP load between hosts of different power.
20245
20246 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20247 when there is a DNS lookup error.
20248
20249
20250
20251
20252 .option fail_defer_domains dnslookup "domain list&!!" unset
20253 .cindex "MX record" "not found"
20254 DNS lookups for domains matching &%fail_defer_domains%&
20255 which find no matching record will cause the router to defer
20256 rather than the default behaviour of decline.
20257 This maybe be useful for queueing messages for a newly created
20258 domain while the DNS configuration is not ready.
20259 However, it will result in any message with mistyped domains
20260 also being queued.
20261
20262
20263 .option ipv4_only "string&!!" unset
20264 .cindex IPv6 disabling
20265 .cindex DNS "IPv6 disabling"
20266 The string is expanded, and if the result is anything but a forced failure,
20267 or an empty string, or one of the strings “0” or “no” or “false”
20268 (checked without regard to the case of the letters),
20269 only A records are used.
20270
20271 .option ipv4_prefer "string&!!" unset
20272 .cindex IPv4 preference
20273 .cindex DNS "IPv4 preference"
20274 The string is expanded, and if the result is anything but a forced failure,
20275 or an empty string, or one of the strings “0” or “no” or “false”
20276 (checked without regard to the case of the letters),
20277 A records are sorted before AAAA records (inverting the default).
20278
20279 .option mx_domains dnslookup "domain list&!!" unset
20280 .cindex "MX record" "required to exist"
20281 .cindex "SRV record" "required to exist"
20282 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20283 record in order to be recognized. (The name of this option could be improved.)
20284 For example, if all the mail hosts in &'fict.example'& are known to have MX
20285 records, except for those in &'discworld.fict.example'&, you could use this
20286 setting:
20287 .code
20288 mx_domains = ! *.discworld.fict.example : *.fict.example
20289 .endd
20290 This specifies that messages addressed to a domain that matches the list but
20291 has no MX record should be bounced immediately instead of being routed using
20292 the address record.
20293
20294
20295 .option mx_fail_domains dnslookup "domain list&!!" unset
20296 If the DNS lookup for MX records for one of the domains in this list causes a
20297 DNS lookup error, Exim behaves as if no MX records were found. See section
20298 &<<SECTprowitdnsloo>>& for more discussion.
20299
20300
20301
20302
20303 .option qualify_single dnslookup boolean true
20304 .cindex "DNS" "resolver options"
20305 .cindex "DNS" "qualifying single-component names"
20306 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20307 lookups. Typically, but not standardly, this causes the resolver to qualify
20308 single-component names with the default domain. For example, on a machine
20309 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20310 &'thesaurus.ref.example'& inside the resolver. For details of what your
20311 resolver actually does, consult your man pages for &'resolver'& and
20312 &'resolv.conf'&.
20313
20314
20315
20316 .option rewrite_headers dnslookup boolean true
20317 .cindex "rewriting" "header lines"
20318 .cindex "header lines" "rewriting"
20319 If the domain name in the address that is being processed is not fully
20320 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20321 an address is specified as &'dormouse@teaparty'&, the domain might be
20322 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20323 occur as a result of setting the &%widen_domains%& option. If
20324 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20325 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20326 header lines of the message are rewritten with the full domain name.
20327
20328 This option should be turned off only when it is known that no message is
20329 ever going to be sent outside an environment where the abbreviation makes
20330 sense.
20331
20332 When an MX record is looked up in the DNS and matches a wildcard record, name
20333 servers normally return a record containing the name that has been looked up,
20334 making it impossible to detect whether a wildcard was present or not. However,
20335 some name servers have recently been seen to return the wildcard entry. If the
20336 name returned by a DNS lookup begins with an asterisk, it is not used for
20337 header rewriting.
20338
20339
20340 .option same_domain_copy_routing dnslookup boolean false
20341 .cindex "address" "copying routing"
20342 Addresses with the same domain are normally routed by the &(dnslookup)& router
20343 to the same list of hosts. However, this cannot be presumed, because the router
20344 options and preconditions may refer to the local part of the address. By
20345 default, therefore, Exim routes each address in a message independently. DNS
20346 servers run caches, so repeated DNS lookups are not normally expensive, and in
20347 any case, personal messages rarely have more than a few recipients.
20348
20349 If you are running mailing lists with large numbers of subscribers at the same
20350 domain, and you are using a &(dnslookup)& router which is independent of the
20351 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20352 lookups for identical domains in one message. In this case, when &(dnslookup)&
20353 routes an address to a remote transport, any other unrouted addresses in the
20354 message that have the same domain are automatically given the same routing
20355 without processing them independently,
20356 provided the following conditions are met:
20357
20358 .ilist
20359 No router that processed the address specified &%headers_add%& or
20360 &%headers_remove%&.
20361 .next
20362 The router did not change the address in any way, for example, by &"widening"&
20363 the domain.
20364 .endlist
20365
20366
20367
20368
20369 .option search_parents dnslookup boolean false
20370 .cindex "DNS" "resolver options"
20371 When this option is true, the resolver option RES_DNSRCH is set for DNS
20372 lookups. This is different from the &%qualify_single%& option in that it
20373 applies to domains containing dots. Typically, but not standardly, it causes
20374 the resolver to search for the name in the current domain and in parent
20375 domains. For example, on a machine in the &'fict.example'& domain, if looking
20376 up &'teaparty.wonderland'& failed, the resolver would try
20377 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20378 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20379
20380 Setting this option true can cause problems in domains that have a wildcard MX
20381 record, because any domain that does not have its own MX record matches the
20382 local wildcard.
20383
20384
20385
20386 .option srv_fail_domains dnslookup "domain list&!!" unset
20387 If the DNS lookup for SRV records for one of the domains in this list causes a
20388 DNS lookup error, Exim behaves as if no SRV records were found. See section
20389 &<<SECTprowitdnsloo>>& for more discussion.
20390
20391
20392
20393
20394 .option widen_domains dnslookup "string list" unset
20395 .cindex "domain" "partial; widening"
20396 If a DNS lookup fails and this option is set, each of its strings in turn is
20397 added onto the end of the domain, and the lookup is tried again. For example,
20398 if
20399 .code
20400 widen_domains = fict.example:ref.example
20401 .endd
20402 is set and a lookup of &'klingon.dictionary'& fails,
20403 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20404 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20405 and &%search_parents%& options can cause some widening to be undertaken inside
20406 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20407 when verifying, unless &%rewrite_headers%& is false (not the default).
20408
20409
20410 .section "Effect of qualify_single and search_parents" "SECID119"
20411 When a domain from an envelope recipient is changed by the resolver as a result
20412 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20413 corresponding address in the message's header lines unless &%rewrite_headers%&
20414 is set false. Exim then re-routes the address, using the full domain.
20415
20416 These two options affect only the DNS lookup that takes place inside the router
20417 for the domain of the address that is being routed. They do not affect lookups
20418 such as that implied by
20419 .code
20420 domains = @mx_any
20421 .endd
20422 that may happen while processing a router precondition before the router is
20423 entered. No widening ever takes place for these lookups.
20424 .ecindex IIDdnsrou1
20425 .ecindex IIDdnsrou2
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435 . ////////////////////////////////////////////////////////////////////////////
20436 . ////////////////////////////////////////////////////////////////////////////
20437
20438 .chapter "The ipliteral router" "CHID5"
20439 .cindex "&(ipliteral)& router"
20440 .cindex "domain literal" "routing"
20441 .cindex "routers" "&(ipliteral)&"
20442 This router has no private options. Unless it is being used purely for
20443 verification (see &%verify_only%&) a transport is required to be defined by the
20444 generic &%transport%& option. The router accepts the address if its domain part
20445 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20446 router handles the address
20447 .code
20448 root@[192.168.1.1]
20449 .endd
20450 by setting up delivery to the host with that IP address. IPv4 domain literals
20451 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20452 are similar, but the address is preceded by &`ipv6:`&. For example:
20453 .code
20454 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20455 .endd
20456 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20457 grounds that sooner or later somebody will try it.
20458
20459 .oindex "&%self%&" "in &(ipliteral)& router"
20460 If the IP address matches something in &%ignore_target_hosts%&, the router
20461 declines. If an IP literal turns out to refer to the local host, the generic
20462 &%self%& option determines what happens.
20463
20464 The RFCs require support for domain literals; however, their use is
20465 controversial in today's Internet. If you want to use this router, you must
20466 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20467 Exim will not recognize the domain literal syntax in addresses.
20468
20469
20470
20471 . ////////////////////////////////////////////////////////////////////////////
20472 . ////////////////////////////////////////////////////////////////////////////
20473
20474 .chapter "The iplookup router" "CHID6"
20475 .cindex "&(iplookup)& router"
20476 .cindex "routers" "&(iplookup)&"
20477 The &(iplookup)& router was written to fulfil a specific requirement in
20478 Cambridge University (which in fact no longer exists). For this reason, it is
20479 not included in the binary of Exim by default. If you want to include it, you
20480 must set
20481 .code
20482 ROUTER_IPLOOKUP=yes
20483 .endd
20484 in your &_Local/Makefile_& configuration file.
20485
20486 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20487 connection to one or more specific hosts. The host can then return the same or
20488 a different address &-- in effect rewriting the recipient address in the
20489 message's envelope. The new address is then passed on to subsequent routers. If
20490 this process fails, the address can be passed on to other routers, or delivery
20491 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20492 must not be specified for it.
20493
20494 .cindex "options" "&(iplookup)& router"
20495 .option hosts iplookup string unset
20496 This option must be supplied. Its value is a colon-separated list of host
20497 names. The hosts are looked up using &[gethostbyname()]&
20498 (or &[getipnodebyname()]& when available)
20499 and are tried in order until one responds to the query. If none respond, what
20500 happens is controlled by &%optional%&.
20501
20502
20503 .option optional iplookup boolean false
20504 If &%optional%& is true, if no response is obtained from any host, the address
20505 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20506 delivery to the address is deferred.
20507
20508
20509 .option port iplookup integer 0
20510 .cindex "port" "&(iplookup)& router"
20511 This option must be supplied. It specifies the port number for the TCP or UDP
20512 call.
20513
20514
20515 .option protocol iplookup string udp
20516 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20517 protocols is to be used.
20518
20519
20520 .option query iplookup string&!! "see below"
20521 This defines the content of the query that is sent to the remote hosts. The
20522 default value is:
20523 .code
20524 $local_part@$domain $local_part@$domain
20525 .endd
20526 The repetition serves as a way of checking that a response is to the correct
20527 query in the default case (see &%response_pattern%& below).
20528
20529
20530 .option reroute iplookup string&!! unset
20531 If this option is not set, the rerouted address is precisely the byte string
20532 returned by the remote host, up to the first white space, if any. If set, the
20533 string is expanded to form the rerouted address. It can include parts matched
20534 in the response by &%response_pattern%& by means of numeric variables such as
20535 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20536 whether or not a pattern is in use. In all cases, the rerouted address must end
20537 up in the form &'local_part@domain'&.
20538
20539
20540 .option response_pattern iplookup string unset
20541 This option can be set to a regular expression that is applied to the string
20542 returned from the remote host. If the pattern does not match the response, the
20543 router declines. If &%response_pattern%& is not set, no checking of the
20544 response is done, unless the query was defaulted, in which case there is a
20545 check that the text returned after the first white space is the original
20546 address. This checks that the answer that has been received is in response to
20547 the correct question. For example, if the response is just a new domain, the
20548 following could be used:
20549 .code
20550 response_pattern = ^([^@]+)$
20551 reroute = $local_part@$1
20552 .endd
20553
20554 .option timeout iplookup time 5s
20555 This specifies the amount of time to wait for a response from the remote
20556 machine. The same timeout is used for the &[connect()]& function for a TCP
20557 call. It does not apply to UDP.
20558
20559
20560
20561
20562 . ////////////////////////////////////////////////////////////////////////////
20563 . ////////////////////////////////////////////////////////////////////////////
20564
20565 .chapter "The manualroute router" "CHID7"
20566 .scindex IIDmanrou1 "&(manualroute)& router"
20567 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20568 .cindex "domain" "manually routing"
20569 The &(manualroute)& router is so-called because it provides a way of manually
20570 routing an address according to its domain. It is mainly used when you want to
20571 route addresses to remote hosts according to your own rules, bypassing the
20572 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20573 route to local transports, a facility that may be useful if you want to save
20574 messages for dial-in hosts in local files.
20575
20576 The &(manualroute)& router compares a list of domain patterns with the domain
20577 it is trying to route. If there is no match, the router declines. Each pattern
20578 has associated with it a list of hosts and some other optional data, which may
20579 include a transport. The combination of a pattern and its data is called a
20580 &"routing rule"&. For patterns that do not have an associated transport, the
20581 generic &%transport%& option must specify a transport, unless the router is
20582 being used purely for verification (see &%verify_only%&).
20583
20584 .vindex "&$host$&"
20585 In the case of verification, matching the domain pattern is sufficient for the
20586 router to accept the address. When actually routing an address for delivery,
20587 an address that matches a domain pattern is queued for the associated
20588 transport. If the transport is not a local one, a host list must be associated
20589 with the pattern; IP addresses are looked up for the hosts, and these are
20590 passed to the transport along with the mail address. For local transports, a
20591 host list is optional. If it is present, it is passed in &$host$& as a single
20592 text string.
20593
20594 The list of routing rules can be provided as an inline string in
20595 &%route_list%&, or the data can be obtained by looking up the domain in a file
20596 or database by setting &%route_data%&. Only one of these settings may appear in
20597 any one instance of &(manualroute)&. The format of routing rules is described
20598 below, following the list of private options.
20599
20600
20601 .section "Private options for manualroute" "SECTprioptman"
20602
20603 .cindex "options" "&(manualroute)& router"
20604 The private options for the &(manualroute)& router are as follows:
20605
20606 .option host_all_ignored manualroute string defer
20607 See &%host_find_failed%&.
20608
20609 .option host_find_failed manualroute string freeze
20610 This option controls what happens when &(manualroute)& tries to find an IP
20611 address for a host, and the host does not exist. The option can be set to one
20612 of the following values:
20613 .code
20614 decline
20615 defer
20616 fail
20617 freeze
20618 ignore
20619 pass
20620 .endd
20621 The default (&"freeze"&) assumes that this state is a serious configuration
20622 error. The difference between &"pass"& and &"decline"& is that the former
20623 forces the address to be passed to the next router (or the router defined by
20624 &%pass_router%&),
20625 .oindex "&%more%&"
20626 overriding &%no_more%&, whereas the latter passes the address to the next
20627 router only if &%more%& is true.
20628
20629 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20630 cannot be found. If all the hosts in the list are ignored, the behaviour is
20631 controlled by the &%host_all_ignored%& option. This takes the same values
20632 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20633
20634 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20635 state; if a host lookup gets a temporary error, delivery is deferred unless the
20636 generic &%pass_on_timeout%& option is set.
20637
20638
20639 .option hosts_randomize manualroute boolean false
20640 .cindex "randomized host list"
20641 .cindex "host" "list of; randomized"
20642 If this option is set, the order of the items in a host list in a routing rule
20643 is randomized each time the list is used, unless an option in the routing rule
20644 overrides (see below). Randomizing the order of a host list can be used to do
20645 crude load sharing. However, if more than one mail address is routed by the
20646 same router to the same host list, the host lists are considered to be the same
20647 (even though they may be randomized into different orders) for the purpose of
20648 deciding whether to batch the deliveries into a single SMTP transaction.
20649
20650 When &%hosts_randomize%& is true, a host list may be split
20651 into groups whose order is separately randomized. This makes it possible to
20652 set up MX-like behaviour. The boundaries between groups are indicated by an
20653 item that is just &`+`& in the host list. For example:
20654 .code
20655 route_list = * host1:host2:host3:+:host4:host5
20656 .endd
20657 The order of the first three hosts and the order of the last two hosts is
20658 randomized for each use, but the first three always end up before the last two.
20659 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20660 randomized host list is passed to an &(smtp)& transport that also has
20661 &%hosts_randomize set%&, the list is not re-randomized.
20662
20663
20664 .option route_data manualroute string&!! unset
20665 If this option is set, it must expand to yield the data part of a routing rule.
20666 Typically, the expansion string includes a lookup based on the domain. For
20667 example:
20668 .code
20669 route_data = ${lookup{$domain}dbm{/etc/routes}}
20670 .endd
20671 If the expansion is forced to fail, or the result is an empty string, the
20672 router declines. Other kinds of expansion failure cause delivery to be
20673 deferred.
20674
20675
20676 .option route_list manualroute "string list" unset
20677 This string is a list of routing rules, in the form defined below. Note that,
20678 unlike most string lists, the items are separated by semicolons. This is so
20679 that they may contain colon-separated host lists.
20680
20681
20682 .option same_domain_copy_routing manualroute boolean false
20683 .cindex "address" "copying routing"
20684 Addresses with the same domain are normally routed by the &(manualroute)&
20685 router to the same list of hosts. However, this cannot be presumed, because the
20686 router options and preconditions may refer to the local part of the address. By
20687 default, therefore, Exim routes each address in a message independently. DNS
20688 servers run caches, so repeated DNS lookups are not normally expensive, and in
20689 any case, personal messages rarely have more than a few recipients.
20690
20691 If you are running mailing lists with large numbers of subscribers at the same
20692 domain, and you are using a &(manualroute)& router which is independent of the
20693 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20694 lookups for identical domains in one message. In this case, when
20695 &(manualroute)& routes an address to a remote transport, any other unrouted
20696 addresses in the message that have the same domain are automatically given the
20697 same routing without processing them independently. However, this is only done
20698 if &%headers_add%& and &%headers_remove%& are unset.
20699
20700
20701
20702
20703 .section "Routing rules in route_list" "SECID120"
20704 The value of &%route_list%& is a string consisting of a sequence of routing
20705 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20706 entered as two semicolons. Alternatively, the list separator can be changed as
20707 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20708 Empty rules are ignored. The format of each rule is
20709 .display
20710 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20711 .endd
20712 The following example contains two rules, each with a simple domain pattern and
20713 no options:
20714 .code
20715 route_list = \
20716   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20717   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20718 .endd
20719 The three parts of a rule are separated by white space. The pattern and the
20720 list of hosts can be enclosed in quotes if necessary, and if they are, the
20721 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20722 single domain pattern, which is the only mandatory item in the rule. The
20723 pattern is in the same format as one item in a domain list (see section
20724 &<<SECTdomainlist>>&),
20725 except that it may not be the name of an interpolated file.
20726 That is, it may be wildcarded, or a regular expression, or a file or database
20727 lookup (with semicolons doubled, because of the use of semicolon as a separator
20728 in a &%route_list%&).
20729
20730 The rules in &%route_list%& are searched in order until one of the patterns
20731 matches the domain that is being routed. The list of hosts and then options are
20732 then used as described below. If there is no match, the router declines. When
20733 &%route_list%& is set, &%route_data%& must not be set.
20734
20735
20736
20737 .section "Routing rules in route_data" "SECID121"
20738 The use of &%route_list%& is convenient when there are only a small number of
20739 routing rules. For larger numbers, it is easier to use a file or database to
20740 hold the routing information, and use the &%route_data%& option instead.
20741 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20742 Most commonly, &%route_data%& is set as a string that contains an
20743 expansion lookup. For example, suppose we place two routing rules in a file
20744 like this:
20745 .code
20746 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20747 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20748 .endd
20749 This data can be accessed by setting
20750 .code
20751 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20752 .endd
20753 Failure of the lookup results in an empty string, causing the router to
20754 decline. However, you do not have to use a lookup in &%route_data%&. The only
20755 requirement is that the result of expanding the string is a list of hosts,
20756 possibly followed by options, separated by white space. The list of hosts must
20757 be enclosed in quotes if it contains white space.
20758
20759
20760
20761
20762 .section "Format of the list of hosts" "SECID122"
20763 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20764 always separately expanded before use. If the expansion fails, the router
20765 declines. The result of the expansion must be a colon-separated list of names
20766 and/or IP addresses, optionally also including ports.
20767 If the list is written with spaces, it must be protected with quotes.
20768 The format of each item
20769 in the list is described in the next section. The list separator can be changed
20770 as described in section &<<SECTlistsepchange>>&.
20771
20772 If the list of hosts was obtained from a &%route_list%& item, the following
20773 variables are set during its expansion:
20774
20775 .ilist
20776 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20777 If the domain was matched against a regular expression, the numeric variables
20778 &$1$&, &$2$&, etc. may be set. For example:
20779 .code
20780 route_list = ^domain(\d+)   host-$1.text.example
20781 .endd
20782 .next
20783 &$0$& is always set to the entire domain.
20784 .next
20785 &$1$& is also set when partial matching is done in a file lookup.
20786
20787 .next
20788 .vindex "&$value$&"
20789 If the pattern that matched the domain was a lookup item, the data that was
20790 looked up is available in the expansion variable &$value$&. For example:
20791 .code
20792 route_list = lsearch;;/some/file.routes  $value
20793 .endd
20794 .endlist
20795
20796 Note the doubling of the semicolon in the pattern that is necessary because
20797 semicolon is the default route list separator.
20798
20799
20800
20801 .section "Format of one host item" "SECTformatonehostitem"
20802 Each item in the list of hosts can be either a host name or an IP address,
20803 optionally with an attached port number, or it can be a single "+"
20804 (see &%hosts_randomize%&).
20805 When no port is given, an IP address
20806 is not enclosed in brackets. When a port is specified, it overrides the port
20807 specification on the transport. The port is separated from the name or address
20808 by a colon. This leads to some complications:
20809
20810 .ilist
20811 Because colon is the default separator for the list of hosts, either
20812 the colon that specifies a port must be doubled, or the list separator must
20813 be changed. The following two examples have the same effect:
20814 .code
20815 route_list = * "host1.tld::1225 : host2.tld::1226"
20816 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20817 .endd
20818 .next
20819 When IPv6 addresses are involved, it gets worse, because they contain
20820 colons of their own. To make this case easier, it is permitted to
20821 enclose an IP address (either v4 or v6) in square brackets if a port
20822 number follows. For example:
20823 .code
20824 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20825 .endd
20826 .endlist
20827
20828 .section "How the list of hosts is used" "SECThostshowused"
20829 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20830 the hosts is tried, in the order specified, when carrying out the SMTP
20831 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20832 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20833 transport.
20834
20835 Hosts may be listed by name or by IP address. An unadorned name in the list of
20836 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20837 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20838 records in the DNS. For example:
20839 .code
20840 route_list = *  x.y.z:p.q.r/MX:e.f.g
20841 .endd
20842 If this feature is used with a port specifier, the port must come last. For
20843 example:
20844 .code
20845 route_list = *  dom1.tld/mx::1225
20846 .endd
20847 If the &%hosts_randomize%& option is set, the order of the items in the list is
20848 randomized before any lookups are done. Exim then scans the list; for any name
20849 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20850 be an interface on the local host and the item is not the first in the list,
20851 Exim discards it and any subsequent items. If it is the first item, what
20852 happens is controlled by the
20853 .oindex "&%self%&" "in &(manualroute)& router"
20854 &%self%& option of the router.
20855
20856 A name on the list that is followed by &`/MX`& is replaced with the list of
20857 hosts obtained by looking up MX records for the name. This is always a DNS
20858 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20859 below) are not relevant here. The order of these hosts is determined by the
20860 preference values in the MX records, according to the usual rules. Because
20861 randomizing happens before the MX lookup, it does not affect the order that is
20862 defined by MX preferences.
20863
20864 If the local host is present in the sublist obtained from MX records, but is
20865 not the most preferred host in that list, it and any equally or less
20866 preferred hosts are removed before the sublist is inserted into the main list.
20867
20868 If the local host is the most preferred host in the MX list, what happens
20869 depends on where in the original list of hosts the &`/MX`& item appears. If it
20870 is not the first item (that is, there are previous hosts in the main list),
20871 Exim discards this name and any subsequent items in the main list.
20872
20873 If the MX item is first in the list of hosts, and the local host is the
20874 most preferred host, what happens is controlled by the &%self%& option of the
20875 router.
20876
20877 DNS failures when lookup up the MX records are treated in the same way as DNS
20878 failures when looking up IP addresses: &%pass_on_timeout%& and
20879 &%host_find_failed%& are used when relevant.
20880
20881 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20882 whether obtained from an MX lookup or not.
20883
20884
20885
20886 .section "How the options are used" "SECThowoptused"
20887 The options are a sequence of words, space-separated.
20888 One of the words can be the name of a transport; this overrides the
20889 &%transport%& option on the router for this particular routing rule only. The
20890 other words (if present) control randomization of the list of hosts on a
20891 per-rule basis, and how the IP addresses of the hosts are to be found when
20892 routing to a remote transport. These options are as follows:
20893
20894 .ilist
20895 &%randomize%&: randomize the order of the hosts in this list, overriding the
20896 setting of &%hosts_randomize%& for this routing rule only.
20897 .next
20898 &%no_randomize%&: do not randomize the order of the hosts in this list,
20899 overriding the setting of &%hosts_randomize%& for this routing rule only.
20900 .next
20901 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20902 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20903 also look in &_/etc/hosts_& or other sources of information.
20904 .next
20905 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20906 no address records are found. If there is a temporary DNS error (such as a
20907 timeout), delivery is deferred.
20908 .next
20909 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20910 .next
20911 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20912 .endlist
20913
20914 For example:
20915 .code
20916 route_list = domain1  host1:host2:host3  randomize bydns;\
20917              domain2  host4:host5
20918 .endd
20919 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20920 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20921 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20922 or &[gethostbyname()]&, and the result of the lookup is the result of that
20923 call.
20924
20925 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20926 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20927 instead of TRY_AGAIN. That is why the default action is to try a DNS
20928 lookup first. Only if that gives a definite &"no such host"& is the local
20929 function called.
20930
20931 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20932 inadvertent constraint that a transport name as an option had to be the last
20933 option specified.
20934
20935
20936
20937 If no IP address for a host can be found, what happens is controlled by the
20938 &%host_find_failed%& option.
20939
20940 .vindex "&$host$&"
20941 When an address is routed to a local transport, IP addresses are not looked up.
20942 The host list is passed to the transport in the &$host$& variable.
20943
20944
20945
20946 .section "Manualroute examples" "SECID123"
20947 In some of the examples that follow, the presence of the &%remote_smtp%&
20948 transport, as defined in the default configuration file, is assumed:
20949
20950 .ilist
20951 .cindex "smart host" "example router"
20952 The &(manualroute)& router can be used to forward all external mail to a
20953 &'smart host'&. If you have set up, in the main part of the configuration, a
20954 named domain list that contains your local domains, for example:
20955 .code
20956 domainlist local_domains = my.domain.example
20957 .endd
20958 You can arrange for all other domains to be routed to a smart host by making
20959 your first router something like this:
20960 .code
20961 smart_route:
20962   driver = manualroute
20963   domains = !+local_domains
20964   transport = remote_smtp
20965   route_list = * smarthost.ref.example
20966 .endd
20967 This causes all non-local addresses to be sent to the single host
20968 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20969 they are tried in order
20970 (but you can use &%hosts_randomize%& to vary the order each time).
20971 Another way of configuring the same thing is this:
20972 .code
20973 smart_route:
20974   driver = manualroute
20975   transport = remote_smtp
20976   route_list = !+local_domains  smarthost.ref.example
20977 .endd
20978 There is no difference in behaviour between these two routers as they stand.
20979 However, they behave differently if &%no_more%& is added to them. In the first
20980 example, the router is skipped if the domain does not match the &%domains%&
20981 precondition; the following router is always tried. If the router runs, it
20982 always matches the domain and so can never decline. Therefore, &%no_more%&
20983 would have no effect. In the second case, the router is never skipped; it
20984 always runs. However, if it doesn't match the domain, it declines. In this case
20985 &%no_more%& would prevent subsequent routers from running.
20986
20987 .next
20988 .cindex "mail hub example"
20989 A &'mail hub'& is a host which receives mail for a number of domains via MX
20990 records in the DNS and delivers it via its own private routing mechanism. Often
20991 the final destinations are behind a firewall, with the mail hub being the one
20992 machine that can connect to machines both inside and outside the firewall. The
20993 &(manualroute)& router is usually used on a mail hub to route incoming messages
20994 to the correct hosts. For a small number of domains, the routing can be inline,
20995 using the &%route_list%& option, but for a larger number a file or database
20996 lookup is easier to manage.
20997
20998 If the domain names are in fact the names of the machines to which the mail is
20999 to be sent by the mail hub, the configuration can be quite simple. For
21000 example:
21001 .code
21002 hub_route:
21003   driver = manualroute
21004   transport = remote_smtp
21005   route_list = *.rhodes.tvs.example  $domain
21006 .endd
21007 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21008 whose names are the same as the mail domains. A similar approach can be taken
21009 if the host name can be obtained from the domain name by a string manipulation
21010 that the expansion facilities can handle. Otherwise, a lookup based on the
21011 domain can be used to find the host:
21012 .code
21013 through_firewall:
21014   driver = manualroute
21015   transport = remote_smtp
21016   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21017 .endd
21018 The result of the lookup must be the name or IP address of the host (or
21019 hosts) to which the address is to be routed. If the lookup fails, the route
21020 data is empty, causing the router to decline. The address then passes to the
21021 next router.
21022
21023 .next
21024 .cindex "batched SMTP output example"
21025 .cindex "SMTP" "batched outgoing; example"
21026 You can use &(manualroute)& to deliver messages to pipes or files in batched
21027 SMTP format for onward transportation by some other means. This is one way of
21028 storing mail for a dial-up host when it is not connected. The route list entry
21029 can be as simple as a single domain name in a configuration like this:
21030 .code
21031 save_in_file:
21032   driver = manualroute
21033   transport = batchsmtp_appendfile
21034   route_list = saved.domain.example
21035 .endd
21036 though often a pattern is used to pick up more than one domain. If there are
21037 several domains or groups of domains with different transport requirements,
21038 different transports can be listed in the routing information:
21039 .code
21040 save_in_file:
21041   driver = manualroute
21042   route_list = \
21043     *.saved.domain1.example  $domain  batch_appendfile; \
21044     *.saved.domain2.example  \
21045       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21046       batch_pipe
21047 .endd
21048 .vindex "&$domain$&"
21049 .vindex "&$host$&"
21050 The first of these just passes the domain in the &$host$& variable, which
21051 doesn't achieve much (since it is also in &$domain$&), but the second does a
21052 file lookup to find a value to pass, causing the router to decline to handle
21053 the address if the lookup fails.
21054
21055 .next
21056 .cindex "UUCP" "example of router for"
21057 Routing mail directly to UUCP software is a specific case of the use of
21058 &(manualroute)& in a gateway to another mail environment. This is an example of
21059 one way it can be done:
21060 .code
21061 # Transport
21062 uucp:
21063   driver = pipe
21064   user = nobody
21065   command = /usr/local/bin/uux -r - \
21066     ${substr_-5:$host}!rmail ${local_part}
21067   return_fail_output = true
21068
21069 # Router
21070 uucphost:
21071   transport = uucp
21072   driver = manualroute
21073   route_data = \
21074     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21075 .endd
21076 The file &_/usr/local/exim/uucphosts_& contains entries like
21077 .code
21078 darksite.ethereal.example:           darksite.UUCP
21079 .endd
21080 It can be set up more simply without adding and removing &".UUCP"& but this way
21081 makes clear the distinction between the domain name
21082 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21083 .endlist
21084 .ecindex IIDmanrou1
21085 .ecindex IIDmanrou2
21086
21087
21088
21089
21090
21091
21092
21093
21094 . ////////////////////////////////////////////////////////////////////////////
21095 . ////////////////////////////////////////////////////////////////////////////
21096
21097 .chapter "The queryprogram router" "CHAPdriverlast"
21098 .scindex IIDquerou1 "&(queryprogram)& router"
21099 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21100 .cindex "routing" "by external program"
21101 The &(queryprogram)& router routes an address by running an external command
21102 and acting on its output. This is an expensive way to route, and is intended
21103 mainly for use in lightly-loaded systems, or for performing experiments.
21104 However, if it is possible to use the precondition options (&%domains%&,
21105 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21106 be used in special cases, even on a busy host. There are the following private
21107 options:
21108 .cindex "options" "&(queryprogram)& router"
21109
21110 .option command queryprogram string&!! unset
21111 This option must be set. It specifies the command that is to be run. The
21112 command is split up into a command name and arguments, and then each is
21113 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21114 &<<CHAPpipetransport>>&).
21115
21116
21117 .option command_group queryprogram string unset
21118 .cindex "gid (group id)" "in &(queryprogram)& router"
21119 This option specifies a gid to be set when running the command while routing an
21120 address for deliver. It must be set if &%command_user%& specifies a numerical
21121 uid. If it begins with a digit, it is interpreted as the numerical value of the
21122 gid. Otherwise it is looked up using &[getgrnam()]&.
21123
21124
21125 .option command_user queryprogram string unset
21126 .cindex "uid (user id)" "for &(queryprogram)&"
21127 This option must be set. It specifies the uid which is set when running the
21128 command while routing an address for delivery. If the value begins with a digit,
21129 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21130 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21131 not set, a value for the gid also.
21132
21133 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21134 root, which it does during a normal delivery in a conventional configuration.
21135 However, when an address is being verified during message reception, Exim is
21136 usually running as the Exim user, not as root. If the &(queryprogram)& router
21137 is called from a non-root process, Exim cannot change uid or gid before running
21138 the command. In this circumstance the command runs under the current uid and
21139 gid.
21140
21141
21142 .option current_directory queryprogram string /
21143 This option specifies an absolute path which is made the current directory
21144 before running the command.
21145
21146
21147 .option timeout queryprogram time 1h
21148 If the command does not complete within the timeout period, its process group
21149 is killed and the message is frozen. A value of zero time specifies no
21150 timeout.
21151
21152
21153 The standard output of the command is connected to a pipe, which is read when
21154 the command terminates. It should consist of a single line of output,
21155 containing up to five fields, separated by white space. The maximum length of
21156 the line is 1023 characters. Longer lines are silently truncated. The first
21157 field is one of the following words (case-insensitive):
21158
21159 .ilist
21160 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21161 below).
21162 .next
21163 &'Decline'&: the router declines; pass the address to the next router, unless
21164 &%no_more%& is set.
21165 .next
21166 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21167 subsequent text on the line is an error message. If the router is run as part
21168 of address verification during an incoming SMTP message, the message is
21169 included in the SMTP response.
21170 .next
21171 &'Defer'&: routing could not be completed at this time; try again later. Any
21172 subsequent text on the line is an error message which is logged. It is not
21173 included in any SMTP response.
21174 .next
21175 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21176 .next
21177 &'Pass'&: pass the address to the next router (or the router specified by
21178 &%pass_router%&), overriding &%no_more%&.
21179 .next
21180 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21181 new addresses, which are routed independently, starting with the first router,
21182 or the router specified by &%redirect_router%&, if set.
21183 .endlist
21184
21185 When the first word is &'accept'&, the remainder of the line consists of a
21186 number of keyed data values, as follows (split into two lines here, to fit on
21187 the page):
21188 .code
21189 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21190 LOOKUP=byname|bydns DATA=<text>
21191 .endd
21192 The data items can be given in any order, and all are optional. If no transport
21193 is included, the transport specified by the generic &%transport%& option is
21194 used. The list of hosts and the lookup type are needed only if the transport is
21195 an &(smtp)& transport that does not itself supply a list of hosts.
21196
21197 The format of the list of hosts is the same as for the &(manualroute)& router.
21198 As well as host names and IP addresses with optional port numbers, as described
21199 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21200 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21201 (see section &<<SECThostshowused>>&).
21202
21203 If the lookup type is not specified, Exim behaves as follows when trying to
21204 find an IP address for each host: First, a DNS lookup is done. If this yields
21205 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21206 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21207 result of the lookup is the result of that call.
21208
21209 .vindex "&$address_data$&"
21210 If the DATA field is set, its value is placed in the &$address_data$&
21211 variable. For example, this return line
21212 .code
21213 accept hosts=x1.y.example:x2.y.example data="rule1"
21214 .endd
21215 routes the address to the default transport, passing a list of two hosts. When
21216 the transport runs, the string &"rule1"& is in &$address_data$&.
21217 .ecindex IIDquerou1
21218 .ecindex IIDquerou2
21219
21220
21221
21222
21223 . ////////////////////////////////////////////////////////////////////////////
21224 . ////////////////////////////////////////////////////////////////////////////
21225
21226 .chapter "The redirect router" "CHAPredirect"
21227 .scindex IIDredrou1 "&(redirect)& router"
21228 .scindex IIDredrou2 "routers" "&(redirect)&"
21229 .cindex "alias file" "in a &(redirect)& router"
21230 .cindex "address redirection" "&(redirect)& router"
21231 The &(redirect)& router handles several kinds of address redirection. Its most
21232 common uses are for resolving local part aliases from a central alias file
21233 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21234 files, but it has many other potential uses. The incoming address can be
21235 redirected in several different ways:
21236
21237 .ilist
21238 It can be replaced by one or more new addresses which are themselves routed
21239 independently.
21240 .next
21241 It can be routed to be delivered to a given file or directory.
21242 .next
21243 It can be routed to be delivered to a specified pipe command.
21244 .next
21245 It can cause an automatic reply to be generated.
21246 .next
21247 It can be forced to fail, optionally with a custom error message.
21248 .next
21249 It can be temporarily deferred, optionally with a custom message.
21250 .next
21251 It can be discarded.
21252 .endlist
21253
21254 The generic &%transport%& option must not be set for &(redirect)& routers.
21255 However, there are some private options which define transports for delivery to
21256 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21257 &%pipe_transport%& and &%reply_transport%& descriptions below.
21258
21259 If success DSNs have been requested
21260 .cindex "DSN" "success"
21261 .cindex "Delivery Status Notification" "success"
21262 redirection triggers one and the DSN options are not passed any further.
21263
21264
21265
21266 .section "Redirection data" "SECID124"
21267 The router operates by interpreting a text string which it obtains either by
21268 expanding the contents of the &%data%& option, or by reading the entire
21269 contents of a file whose name is given in the &%file%& option. These two
21270 options are mutually exclusive. The first is commonly used for handling system
21271 aliases, in a configuration like this:
21272 .code
21273 system_aliases:
21274   driver = redirect
21275   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21276 .endd
21277 If the lookup fails, the expanded string in this example is empty. When the
21278 expansion of &%data%& results in an empty string, the router declines. A forced
21279 expansion failure also causes the router to decline; other expansion failures
21280 cause delivery to be deferred.
21281
21282 A configuration using &%file%& is commonly used for handling users'
21283 &_.forward_& files, like this:
21284 .code
21285 userforward:
21286   driver = redirect
21287   check_local_user
21288   file = $home/.forward
21289   no_verify
21290 .endd
21291 If the file does not exist, or causes no action to be taken (for example, it is
21292 empty or consists only of comments), the router declines. &*Warning*&: This
21293 is not the case when the file contains syntactically valid items that happen to
21294 yield empty addresses, for example, items containing only RFC 2822 address
21295 comments.
21296
21297 .cindex "tainted data" "in filenames"
21298 .cindex redirect "tainted data"
21299 Tainted data may not be used for a filename.
21300
21301 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21302 directly for redirection,
21303 as they are provided by a potential attacker.
21304 In the examples above, &$local_part$& is used for looking up data held locally
21305 on the system, and not used directly (the second example derives &$home$& via
21306 the passsword file or database, using &$local_part$&).
21307
21308
21309
21310 .section "Forward files and address verification" "SECID125"
21311 .cindex "address redirection" "while verifying"
21312 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21313 &_.forward_& files, as in the example above. There are two reasons for this:
21314
21315 .ilist
21316 When Exim is receiving an incoming SMTP message from a remote host, it is
21317 running under the Exim uid, not as root. Exim is unable to change uid to read
21318 the file as the user, and it may not be able to read it as the Exim user. So in
21319 practice the router may not be able to operate.
21320 .next
21321 However, even when the router can operate, the existence of a &_.forward_& file
21322 is unimportant when verifying an address. What should be checked is whether the
21323 local part is a valid user name or not. Cutting out the redirection processing
21324 saves some resources.
21325 .endlist
21326
21327
21328
21329
21330
21331
21332 .section "Interpreting redirection data" "SECID126"
21333 .cindex "Sieve filter" "specifying in redirection data"
21334 .cindex "filter" "specifying in redirection data"
21335 The contents of the data string, whether obtained from &%data%& or &%file%&,
21336 can be interpreted in two different ways:
21337
21338 .ilist
21339 If the &%allow_filter%& option is set true, and the data begins with the text
21340 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21341 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21342 respectively. Details of the syntax and semantics of filter files are described
21343 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21344 document is intended for use by end users.
21345 .next
21346 Otherwise, the data must be a comma-separated list of redirection items, as
21347 described in the next section.
21348 .endlist
21349
21350 When a message is redirected to a file (a &"mail folder"&), the filename given
21351 in a non-filter redirection list must always be an absolute path. A filter may
21352 generate a relative path &-- how this is handled depends on the transport's
21353 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21354 for the &(appendfile)& transport.
21355
21356
21357
21358 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21359 .cindex "address redirection" "non-filter list items"
21360 When the redirection data is not an Exim or Sieve filter, for example, if it
21361 comes from a conventional alias or forward file, it consists of a list of
21362 addresses, filenames, pipe commands, or certain special items (see section
21363 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21364 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21365 depending on their default values. The items in the list are separated by
21366 commas or newlines.
21367 If a comma is required in an item, the entire item must be enclosed in double
21368 quotes.
21369
21370 Lines starting with a # character are comments, and are ignored, and # may
21371 also appear following a comma, in which case everything between the # and the
21372 next newline character is ignored.
21373
21374 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21375 double quotes are retained because some forms of mail address require their use
21376 (but never to enclose the entire address). In the following description,
21377 &"item"& refers to what remains after any surrounding double quotes have been
21378 removed.
21379
21380 .vindex "&$local_part$&"
21381 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21382 and the expansion contains a reference to &$local_part$&, you should make use
21383 of the &%quote_local_part%& expansion operator, in case the local part contains
21384 special characters. For example, to redirect all mail for the domain
21385 &'obsolete.example'&, retaining the existing local part, you could use this
21386 setting:
21387 .code
21388 data = ${quote_local_part:$local_part}@newdomain.example
21389 .endd
21390
21391
21392 .section "Redirecting to a local mailbox" "SECTredlocmai"
21393 .cindex "routing" "loops in"
21394 .cindex "loop" "while routing, avoidance of"
21395 .cindex "address redirection" "to local mailbox"
21396 A redirection item may safely be the same as the address currently under
21397 consideration. This does not cause a routing loop, because a router is
21398 automatically skipped if any ancestor of the address that is being processed
21399 is the same as the current address and was processed by the current router.
21400 Such an address is therefore passed to the following routers, so it is handled
21401 as if there were no redirection. When making this loop-avoidance test, the
21402 complete local part, including any prefix or suffix, is used.
21403
21404 .cindex "address redirection" "local part without domain"
21405 Specifying the same local part without a domain is a common usage in personal
21406 filter files when the user wants to have messages delivered to the local
21407 mailbox and also forwarded elsewhere. For example, the user whose login is
21408 &'cleo'& might have a &_.forward_& file containing this:
21409 .code
21410 cleo, cleopatra@egypt.example
21411 .endd
21412 .cindex "backslash in alias file"
21413 .cindex "alias file" "backslash in"
21414 For compatibility with other MTAs, such unqualified local parts may be
21415 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21416 it does make a difference if more than one domain is being handled
21417 synonymously.
21418
21419 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21420 2822 address that does not include a domain, the item is qualified using the
21421 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21422 addresses are qualified using the value in &%qualify_recipient%&, but you can
21423 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21424
21425 Care must be taken if there are alias names for local users.
21426 Consider an MTA handling a single local domain where the system alias file
21427 contains:
21428 .code
21429 Sam.Reman: spqr
21430 .endd
21431 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21432 messages in the local mailbox, and also forward copies elsewhere. He creates
21433 this forward file:
21434 .code
21435 Sam.Reman, spqr@reme.elsewhere.example
21436 .endd
21437 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21438 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21439 second time round, because it has previously routed it,
21440 and the following routers presumably cannot handle the alias. The forward file
21441 should really contain
21442 .code
21443 spqr, spqr@reme.elsewhere.example
21444 .endd
21445 but because this is such a common error, the &%check_ancestor%& option (see
21446 below) exists to provide a way to get round it. This is normally set on a
21447 &(redirect)& router that is handling users' &_.forward_& files.
21448
21449
21450
21451 .section "Special items in redirection lists" "SECTspecitredli"
21452 In addition to addresses, the following types of item may appear in redirection
21453 lists (that is, in non-filter redirection data):
21454
21455 .ilist
21456 .cindex "pipe" "in redirection list"
21457 .cindex "address redirection" "to pipe"
21458 An item is treated as a pipe command if it begins with &"|"& and does not parse
21459 as a valid RFC 2822 address that includes a domain. A transport for running the
21460 command must be specified by the &%pipe_transport%& option.
21461 Normally, either the router or the transport specifies a user and a group under
21462 which to run the delivery. The default is to use the Exim user and group.
21463
21464 Single or double quotes can be used for enclosing the individual arguments of
21465 the pipe command; no interpretation of escapes is done for single quotes. If
21466 the command contains a comma character, it is necessary to put the whole item
21467 in double quotes, for example:
21468 .code
21469 "|/some/command ready,steady,go"
21470 .endd
21471 since items in redirection lists are terminated by commas. Do not, however,
21472 quote just the command. An item such as
21473 .code
21474 |"/some/command ready,steady,go"
21475 .endd
21476 is interpreted as a pipe with a rather strange command name, and no arguments.
21477
21478 Note that the above example assumes that the text comes from a lookup source
21479 of some sort, so that the quotes are part of the data.  If composing a
21480 redirect router with a &%data%& option directly specifying this command, the
21481 quotes will be used by the configuration parser to define the extent of one
21482 string, but will not be passed down into the redirect router itself.  There
21483 are two main approaches to get around this: escape quotes to be part of the
21484 data itself, or avoid using this mechanism and instead create a custom
21485 transport with the &%command%& option set and reference that transport from
21486 an &%accept%& router.
21487
21488 .next
21489 .cindex "file" "in redirection list"
21490 .cindex "address redirection" "to file"
21491 An item is interpreted as a path name if it begins with &"/"& and does not
21492 parse as a valid RFC 2822 address that includes a domain. For example,
21493 .code
21494 /home/world/minbari
21495 .endd
21496 is treated as a filename, but
21497 .code
21498 /s=molari/o=babylon/@x400gate.way
21499 .endd
21500 is treated as an address. For a filename, a transport must be specified using
21501 the &%file_transport%& option. However, if the generated path name ends with a
21502 forward slash character, it is interpreted as a directory name rather than a
21503 filename, and &%directory_transport%& is used instead.
21504
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 .cindex "&_/dev/null_&"
21509 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21510 bypassed at a high level, and the log entry shows &"**bypassed**"&
21511 instead of a transport name. In this case the user and group are not used.
21512
21513 .next
21514 .cindex "included address list"
21515 .cindex "address redirection" "included external list"
21516 If an item is of the form
21517 .code
21518 :include:<path name>
21519 .endd
21520 a list of further items is taken from the given file and included at that
21521 point. &*Note*&: Such a file can not be a filter file; it is just an
21522 out-of-line addition to the list. The items in the included list are separated
21523 by commas or newlines and are not subject to expansion. If this is the first
21524 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21525 the alias name. This example is incorrect:
21526 .code
21527 list1    :include:/opt/lists/list1
21528 .endd
21529 It must be given as
21530 .code
21531 list1:   :include:/opt/lists/list1
21532 .endd
21533 .cindex "tainted data" "in filenames"
21534 .cindex redirect "tainted data"
21535 Tainted data may not be used for a filename.
21536 .next
21537 .cindex "address redirection" "to black hole"
21538 .cindex "delivery" "discard"
21539 .cindex "delivery" "blackhole"
21540 .cindex "black hole"
21541 .cindex "abandoning mail"
21542 Sometimes you want to throw away mail to a particular local part.  Making the
21543 &%data%& option expand to an empty string does not work, because that causes
21544 the router to decline. Instead, the alias item
21545 .code
21546 :blackhole:
21547 .endd
21548 can be used. It does what its name implies. No delivery is
21549 done, and no error message is generated. This has the same effect as specifying
21550 &_/dev/null_& as a destination, but it can be independently disabled.
21551
21552 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21553 delivery is done for the original local part, even if other redirection items
21554 are present. If you are generating a multi-item list (for example, by reading a
21555 database) and need the ability to provide a no-op item, you must use
21556 &_/dev/null_&.
21557
21558 .next
21559 .cindex "delivery" "forcing failure"
21560 .cindex "delivery" "forcing deferral"
21561 .cindex "failing delivery" "forcing"
21562 .cindex "deferred delivery, forcing"
21563 .cindex "customizing" "failure message"
21564 An attempt to deliver a particular address can be deferred or forced to fail by
21565 redirection items of the form
21566 .code
21567 :defer:
21568 :fail:
21569 .endd
21570 respectively. When a redirection list contains such an item, it applies
21571 to the entire redirection; any other items in the list are ignored. Any
21572 text following &':fail:'& or &':defer:'& is placed in the error text
21573 associated with the failure. For example, an alias file might contain:
21574 .code
21575 X.Employee:  :fail: Gone away, no forwarding address
21576 .endd
21577 In the case of an address that is being verified from an ACL or as the subject
21578 of a
21579 .cindex "VRFY" "error text, display of"
21580 VRFY command, the text is included in the SMTP error response by
21581 default.
21582 .cindex "EXPN" "error text, display of"
21583 The text is not included in the response to an EXPN command. In non-SMTP cases
21584 the text is included in the error message that Exim generates.
21585
21586 .cindex "SMTP" "error codes"
21587 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21588 &':fail:'&. However, if the message starts with three digits followed by a
21589 space, optionally followed by an extended code of the form &'n.n.n'&, also
21590 followed by a space, and the very first digit is the same as the default error
21591 code, the code from the message is used instead. If the very first digit is
21592 incorrect, a panic error is logged, and the default code is used. You can
21593 suppress the use of the supplied code in a redirect router by setting the
21594 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21595 ignored.
21596
21597 .vindex "&$acl_verify_message$&"
21598 In an ACL, an explicitly provided message overrides the default, but the
21599 default message is available in the variable &$acl_verify_message$& and can
21600 therefore be included in a custom message if this is desired.
21601
21602 Normally the error text is the rest of the redirection list &-- a comma does
21603 not terminate it &-- but a newline does act as a terminator. Newlines are not
21604 normally present in alias expansions. In &(lsearch)& lookups they are removed
21605 as part of the continuation process, but they may exist in other kinds of
21606 lookup and in &':include:'& files.
21607
21608 During routing for message delivery (as opposed to verification), a redirection
21609 containing &':fail:'& causes an immediate failure of the incoming address,
21610 whereas &':defer:'& causes the message to remain in the queue so that a
21611 subsequent delivery attempt can happen at a later time. If an address is
21612 deferred for too long, it will ultimately fail, because the normal retry
21613 rules still apply.
21614
21615 .next
21616 .cindex "alias file" "exception to default"
21617 Sometimes it is useful to use a single-key search type with a default (see
21618 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21619 for exceptions to the default. These can be handled by aliasing them to
21620 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21621 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21622 results in an empty redirection list has the same effect.
21623 .endlist
21624
21625
21626 .section "Duplicate addresses" "SECTdupaddr"
21627 .cindex "duplicate addresses"
21628 .cindex "address duplicate, discarding"
21629 .cindex "pipe" "duplicated"
21630 Exim removes duplicate addresses from the list to which it is delivering, so as
21631 to deliver just one copy to each address. This does not apply to deliveries
21632 routed to pipes by different immediate parent addresses, but an indirect
21633 aliasing scheme of the type
21634 .code
21635 pipe:       |/some/command $local_part
21636 localpart1: pipe
21637 localpart2: pipe
21638 .endd
21639 does not work with a message that is addressed to both local parts, because
21640 when the second is aliased to the intermediate local part &"pipe"& it gets
21641 discarded as being the same as a previously handled address. However, a scheme
21642 such as
21643 .code
21644 localpart1: |/some/command $local_part
21645 localpart2: |/some/command $local_part
21646 .endd
21647 does result in two different pipe deliveries, because the immediate parents of
21648 the pipes are distinct.
21649
21650
21651
21652 .section "Repeated redirection expansion" "SECID128"
21653 .cindex "repeated redirection expansion"
21654 .cindex "address redirection" "repeated for each delivery attempt"
21655 When a message cannot be delivered to all of its recipients immediately,
21656 leading to two or more delivery attempts, redirection expansion is carried out
21657 afresh each time for those addresses whose children were not all previously
21658 delivered. If redirection is being used as a mailing list, this can lead to new
21659 members of the list receiving copies of old messages. The &%one_time%& option
21660 can be used to avoid this.
21661
21662
21663 .section "Errors in redirection lists" "SECID129"
21664 .cindex "address redirection" "errors"
21665 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21666 error is skipped, and an entry is written to the main log. This may be useful
21667 for mailing lists that are automatically managed. Otherwise, if an error is
21668 detected while generating the list of new addresses, the original address is
21669 deferred. See also &%syntax_errors_to%&.
21670
21671
21672
21673 .section "Private options for the redirect router" "SECID130"
21674
21675 .cindex "options" "&(redirect)& router"
21676 The private options for the &(redirect)& router are as follows:
21677
21678
21679 .option allow_defer redirect boolean false
21680 Setting this option allows the use of &':defer:'& in non-filter redirection
21681 data, or the &%defer%& command in an Exim filter file.
21682
21683
21684 .option allow_fail redirect boolean false
21685 .cindex "failing delivery" "from filter"
21686 If this option is true, the &':fail:'& item can be used in a redirection list,
21687 and the &%fail%& command may be used in an Exim filter file.
21688
21689
21690 .option allow_filter redirect boolean false
21691 .cindex "filter" "enabling use of"
21692 .cindex "Sieve filter" "enabling use of"
21693 Setting this option allows Exim to interpret redirection data that starts with
21694 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21695 are some features of Exim filter files that some administrators may wish to
21696 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21697
21698 It is also possible to lock out Exim filters or Sieve filters while allowing
21699 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21700
21701
21702 The filter is run using the uid and gid set by the generic &%user%& and
21703 &%group%& options. These take their defaults from the password data if
21704 &%check_local_user%& is set, so in the normal case of users' personal filter
21705 files, the filter is run as the relevant user. When &%allow_filter%& is set
21706 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21707
21708
21709
21710 .option allow_freeze redirect boolean false
21711 .cindex "freezing messages" "allowing in filter"
21712 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21713 This command is more normally encountered in system filters, and is disabled by
21714 default for redirection filters because it isn't something you usually want to
21715 let ordinary users do.
21716
21717
21718
21719 .option check_ancestor redirect boolean false
21720 This option is concerned with handling generated addresses that are the same
21721 as some address in the list of redirection ancestors of the current address.
21722 Although it is turned off by default in the code, it is set in the default
21723 configuration file for handling users' &_.forward_& files. It is recommended
21724 for this use of the &(redirect)& router.
21725
21726 When &%check_ancestor%& is set, if a generated address (including the domain)
21727 is the same as any ancestor of the current address, it is replaced by a copy of
21728 the current address. This helps in the case where local part A is aliased to B,
21729 and B has a &_.forward_& file pointing back to A. For example, within a single
21730 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21731 &_&~jb/.forward_& contains:
21732 .code
21733 \Joe.Bloggs, <other item(s)>
21734 .endd
21735 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21736 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21737 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21738 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21739 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21740 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21741 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21742 original address. See also the &%repeat_use%& option below.
21743
21744
21745 .option check_group redirect boolean "see below"
21746 When the &%file%& option is used, the group owner of the file is checked only
21747 when this option is set. The permitted groups are those listed in the
21748 &%owngroups%& option, together with the user's default group if
21749 &%check_local_user%& is set. If the file has the wrong group, routing is
21750 deferred. The default setting for this option is true if &%check_local_user%&
21751 is set and the &%modemask%& option permits the group write bit, or if the
21752 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21753
21754
21755
21756 .option check_owner redirect boolean "see below"
21757 When the &%file%& option is used, the owner of the file is checked only when
21758 this option is set. If &%check_local_user%& is set, the local user is
21759 permitted; otherwise the owner must be one of those listed in the &%owners%&
21760 option. The default value for this option is true if &%check_local_user%& or
21761 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21762
21763
21764 .option data redirect string&!! unset
21765 This option is mutually exclusive with &%file%&. One or other of them must be
21766 set, but not both. The contents of &%data%& are expanded, and then used as the
21767 list of forwarding items, or as a set of filtering instructions. If the
21768 expansion is forced to fail, or the result is an empty string or a string that
21769 has no effect (consists entirely of comments), the router declines.
21770
21771 When filtering instructions are used, the string must begin with &"#Exim
21772 filter"&, and all comments in the string, including this initial one, must be
21773 terminated with newline characters. For example:
21774 .code
21775 data = #Exim filter\n\
21776        if $h_to: contains Exim then save $home/mail/exim endif
21777 .endd
21778 If you are reading the data from a database where newlines cannot be included,
21779 you can use the &${sg}$& expansion item to turn the escape string of your
21780 choice into a newline.
21781
21782
21783 .option directory_transport redirect string&!! unset
21784 A &(redirect)& router sets up a direct delivery to a directory when a path name
21785 ending with a slash is specified as a new &"address"&. The transport used is
21786 specified by this option, which, after expansion, must be the name of a
21787 configured transport. This should normally be an &(appendfile)& transport.
21788
21789
21790 .option file redirect string&!! unset
21791 This option specifies the name of a file that contains the redirection data. It
21792 is mutually exclusive with the &%data%& option. The string is expanded before
21793 use; if the expansion is forced to fail, the router declines. Other expansion
21794 failures cause delivery to be deferred. The result of a successful expansion
21795 must be an absolute path. The entire file is read and used as the redirection
21796 data. If the data is an empty string or a string that has no effect (consists
21797 entirely of comments), the router declines.
21798
21799 .cindex "NFS" "checking for file existence"
21800 If the attempt to open the file fails with a &"does not exist"& error, Exim
21801 runs a check on the containing directory,
21802 unless &%ignore_enotdir%& is true (see below).
21803 If the directory does not appear to exist, delivery is deferred. This can
21804 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21805 is a mount problem. If the containing directory does exist, but the file does
21806 not, the router declines.
21807
21808
21809 .option file_transport redirect string&!! unset
21810 .vindex "&$address_file$&"
21811 A &(redirect)& router sets up a direct delivery to a file when a path name not
21812 ending in a slash is specified as a new &"address"&. The transport used is
21813 specified by this option, which, after expansion, must be the name of a
21814 configured transport. This should normally be an &(appendfile)& transport. When
21815 it is running, the filename is in &$address_file$&.
21816
21817
21818 .option filter_prepend_home redirect boolean true
21819 When this option is true, if a &(save)& command in an Exim filter specifies a
21820 relative path, and &$home$& is defined, it is automatically prepended to the
21821 relative path. If this option is set false, this action does not happen. The
21822 relative path is then passed to the transport unmodified.
21823
21824
21825 .option forbid_blackhole redirect boolean false
21826 .cindex "restricting access to features"
21827 .cindex "filter" "locking out certain features"
21828 If this option is true, the &':blackhole:'& item may not appear in a
21829 redirection list.
21830
21831
21832 .option forbid_exim_filter redirect boolean false
21833 .cindex "restricting access to features"
21834 .cindex "filter" "locking out certain features"
21835 If this option is set true, only Sieve filters are permitted when
21836 &%allow_filter%& is true.
21837
21838
21839
21840
21841 .option forbid_file redirect boolean false
21842 .cindex "restricting access to features"
21843 .cindex "delivery" "to file; forbidding"
21844 .cindex "filter" "locking out certain features"
21845 .cindex "Sieve filter" "forbidding delivery to a file"
21846 .cindex "Sieve filter" "&""keep""& facility; disabling"
21847 If this option is true, this router may not generate a new address that
21848 specifies delivery to a local file or directory, either from a filter or from a
21849 conventional forward file. This option is forced to be true if &%one_time%& is
21850 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21851 locks out the Sieve's &"keep"& facility.
21852
21853
21854 .option forbid_filter_dlfunc redirect boolean false
21855 .cindex "restricting access to features"
21856 .cindex "filter" "locking out certain features"
21857 If this option is true, string expansions in Exim filters are not allowed to
21858 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21859 functions.
21860
21861 .option forbid_filter_existstest redirect boolean false
21862 .cindex "restricting access to features"
21863 .cindex "filter" "locking out certain features"
21864 .cindex "expansion" "statting a file"
21865 If this option is true, string expansions in Exim filters are not allowed to
21866 make use of the &%exists%& condition or the &%stat%& expansion item.
21867
21868 .option forbid_filter_logwrite redirect boolean false
21869 .cindex "restricting access to features"
21870 .cindex "filter" "locking out certain features"
21871 If this option is true, use of the logging facility in Exim filters is not
21872 permitted. Logging is in any case available only if the filter is being run
21873 under some unprivileged uid (which is normally the case for ordinary users'
21874 &_.forward_& files).
21875
21876
21877 .option forbid_filter_lookup redirect boolean false
21878 .cindex "restricting access to features"
21879 .cindex "filter" "locking out certain features"
21880 If this option is true, string expansions in Exim filter files are not allowed
21881 to make use of &%lookup%& items.
21882
21883
21884 .option forbid_filter_perl redirect boolean false
21885 .cindex "restricting access to features"
21886 .cindex "filter" "locking out certain features"
21887 This option has an effect only if Exim is built with embedded Perl support. If
21888 it is true, string expansions in Exim filter files are not allowed to make use
21889 of the embedded Perl support.
21890
21891
21892 .option forbid_filter_readfile redirect boolean false
21893 .cindex "restricting access to features"
21894 .cindex "filter" "locking out certain features"
21895 If this option is true, string expansions in Exim filter files are not allowed
21896 to make use of &%readfile%& items.
21897
21898
21899 .option forbid_filter_readsocket redirect boolean false
21900 .cindex "restricting access to features"
21901 .cindex "filter" "locking out certain features"
21902 If this option is true, string expansions in Exim filter files are not allowed
21903 to make use of &%readsocket%& items.
21904
21905
21906 .option forbid_filter_reply redirect boolean false
21907 .cindex "restricting access to features"
21908 .cindex "filter" "locking out certain features"
21909 If this option is true, this router may not generate an automatic reply
21910 message. Automatic replies can be generated only from Exim or Sieve filter
21911 files, not from traditional forward files. This option is forced to be true if
21912 &%one_time%& is set.
21913
21914
21915 .option forbid_filter_run redirect boolean false
21916 .cindex "restricting access to features"
21917 .cindex "filter" "locking out certain features"
21918 If this option is true, string expansions in Exim filter files are not allowed
21919 to make use of &%run%& items.
21920
21921
21922 .option forbid_include redirect boolean false
21923 .cindex "restricting access to features"
21924 .cindex "filter" "locking out certain features"
21925 If this option is true, items of the form
21926 .code
21927 :include:<path name>
21928 .endd
21929 are not permitted in non-filter redirection lists.
21930
21931
21932 .option forbid_pipe redirect boolean false
21933 .cindex "restricting access to features"
21934 .cindex "filter" "locking out certain features"
21935 .cindex "delivery" "to pipe; forbidding"
21936 If this option is true, this router may not generate a new address which
21937 specifies delivery to a pipe, either from an Exim filter or from a conventional
21938 forward file. This option is forced to be true if &%one_time%& is set.
21939
21940
21941 .option forbid_sieve_filter redirect boolean false
21942 .cindex "restricting access to features"
21943 .cindex "filter" "locking out certain features"
21944 If this option is set true, only Exim filters are permitted when
21945 &%allow_filter%& is true.
21946
21947
21948 .cindex "SMTP" "error codes"
21949 .option forbid_smtp_code redirect boolean false
21950 If this option is set true, any SMTP error codes that are present at the start
21951 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21952 the default codes (451 and 550, respectively) are always used.
21953
21954
21955
21956
21957 .option hide_child_in_errmsg redirect boolean false
21958 .cindex "bounce message" "redirection details; suppressing"
21959 If this option is true, it prevents Exim from quoting a child address if it
21960 generates a bounce or delay message for it. Instead it says &"an address
21961 generated from <&'the top level address'&>"&. Of course, this applies only to
21962 bounces generated locally. If a message is forwarded to another host, &'its'&
21963 bounce may well quote the generated address.
21964
21965
21966 .option ignore_eacces redirect boolean false
21967 .cindex "EACCES"
21968 If this option is set and an attempt to open a redirection file yields the
21969 EACCES error (permission denied), the &(redirect)& router behaves as if the
21970 file did not exist.
21971
21972
21973 .option ignore_enotdir redirect boolean false
21974 .cindex "ENOTDIR"
21975 If this option is set and an attempt to open a redirection file yields the
21976 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21977 router behaves as if the file did not exist.
21978
21979 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21980 router that has the &%file%& option set discovers that the file does not exist
21981 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21982 against unmounted NFS directories. If the parent can not be statted, delivery
21983 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21984 is set, because that option tells Exim to ignore &"something on the path is not
21985 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21986 that some operating systems give ENOENT where others give ENOTDIR.
21987
21988
21989
21990 .option include_directory redirect string unset
21991 If this option is set, the path names of any &':include:'& items in a
21992 redirection list must start with this directory.
21993
21994
21995 .option modemask redirect "octal integer" 022
21996 This specifies mode bits which must not be set for a file specified by the
21997 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21998
21999
22000 .option one_time redirect boolean false
22001 .cindex "one-time aliasing/forwarding expansion"
22002 .cindex "alias file" "one-time expansion"
22003 .cindex "forward file" "one-time expansion"
22004 .cindex "mailing lists" "one-time expansion"
22005 .cindex "address redirection" "one-time expansion"
22006 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22007 files each time it tries to deliver a message causes a problem when one or more
22008 of the generated addresses fails be delivered at the first attempt. The problem
22009 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22010 but of what happens when the redirection list changes during the time that the
22011 message is on Exim's queue. This is particularly true in the case of mailing
22012 lists, where new subscribers might receive copies of messages that were posted
22013 before they subscribed.
22014
22015 If &%one_time%& is set and any addresses generated by the router fail to
22016 deliver at the first attempt, the failing addresses are added to the message as
22017 &"top level"& addresses, and the parent address that generated them is marked
22018 &"delivered"&. Thus, redirection does not happen again at the next delivery
22019 attempt.
22020
22021 &*Warning 1*&: Any header line addition or removal that is specified by this
22022 router would be lost if delivery did not succeed at the first attempt. For this
22023 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22024 permitted when &%one_time%& is set.
22025
22026 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22027 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22028 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22029
22030 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22031 &%one_time%&.
22032
22033 The original top-level address is remembered with each of the generated
22034 addresses, and is output in any log messages. However, any intermediate parent
22035 addresses are not recorded. This makes a difference to the log only if
22036 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22037 typically be used for mailing lists, where there is normally just one level of
22038 expansion.
22039
22040
22041 .option owners redirect "string list" unset
22042 .cindex "ownership" "alias file"
22043 .cindex "ownership" "forward file"
22044 .cindex "alias file" "ownership"
22045 .cindex "forward file" "ownership"
22046 This specifies a list of permitted owners for the file specified by &%file%&.
22047 This list is in addition to the local user when &%check_local_user%& is set.
22048 See &%check_owner%& above.
22049
22050
22051 .option owngroups redirect "string list" unset
22052 This specifies a list of permitted groups for the file specified by &%file%&.
22053 The list is in addition to the local user's primary group when
22054 &%check_local_user%& is set. See &%check_group%& above.
22055
22056
22057 .option pipe_transport redirect string&!! unset
22058 .vindex "&$address_pipe$&"
22059 A &(redirect)& router sets up a direct delivery to a pipe when a string
22060 starting with a vertical bar character is specified as a new &"address"&. The
22061 transport used is specified by this option, which, after expansion, must be the
22062 name of a configured transport. This should normally be a &(pipe)& transport.
22063 When the transport is run, the pipe command is in &$address_pipe$&.
22064
22065
22066 .option qualify_domain redirect string&!! unset
22067 .vindex "&$qualify_recipient$&"
22068 If this option is set, and an unqualified address (one without a domain) is
22069 generated, and that address would normally be qualified by the global setting
22070 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22071 expanding this string. If the expansion fails, the router declines. If you want
22072 to revert to the default, you can have the expansion generate
22073 &$qualify_recipient$&.
22074
22075 This option applies to all unqualified addresses generated by Exim filters,
22076 but for traditional &_.forward_& files, it applies only to addresses that are
22077 not preceded by a backslash. Sieve filters cannot generate unqualified
22078 addresses.
22079
22080 .option qualify_preserve_domain redirect boolean false
22081 .cindex "domain" "in redirection; preserving"
22082 .cindex "preserving domain in redirection"
22083 .cindex "address redirection" "domain; preserving"
22084 If this option is set, the router's local &%qualify_domain%& option must not be
22085 set (a configuration error occurs if it is). If an unqualified address (one
22086 without a domain) is generated, it is qualified with the domain of the parent
22087 address (the immediately preceding ancestor) instead of the global
22088 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22089 this applies whether or not the address is preceded by a backslash.
22090
22091
22092 .option repeat_use redirect boolean true
22093 If this option is set false, the router is skipped for a child address that has
22094 any ancestor that was routed by this router. This test happens before any of
22095 the other preconditions are tested. Exim's default anti-looping rules skip
22096 only when the ancestor is the same as the current address. See also
22097 &%check_ancestor%& above and the generic &%redirect_router%& option.
22098
22099
22100 .option reply_transport redirect string&!! unset
22101 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22102 &%vacation%& command is used in a filter file. The transport used is specified
22103 by this option, which, after expansion, must be the name of a configured
22104 transport. This should normally be an &(autoreply)& transport. Other transports
22105 are unlikely to do anything sensible or useful.
22106
22107
22108 .option rewrite redirect boolean true
22109 .cindex "address redirection" "disabling rewriting"
22110 If this option is set false, addresses generated by the router are not
22111 subject to address rewriting. Otherwise, they are treated like new addresses
22112 and are rewritten according to the global rewriting rules.
22113
22114
22115 .option sieve_subaddress redirect string&!! unset
22116 The value of this option is passed to a Sieve filter to specify the
22117 :subaddress part of an address.
22118
22119 .option sieve_useraddress redirect string&!! unset
22120 The value of this option is passed to a Sieve filter to specify the :user part
22121 of an address. However, if it is unset, the entire original local part
22122 (including any prefix or suffix) is used for :user.
22123
22124
22125 .option sieve_vacation_directory redirect string&!! unset
22126 .cindex "Sieve filter" "vacation directory"
22127 To enable the &"vacation"& extension for Sieve filters, you must set
22128 &%sieve_vacation_directory%& to the directory where vacation databases are held
22129 (do not put anything else in that directory), and ensure that the
22130 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22131 needs their own directory; Exim will create it if necessary.
22132
22133
22134
22135 .option skip_syntax_errors redirect boolean false
22136 .cindex "forward file" "broken"
22137 .cindex "address redirection" "broken files"
22138 .cindex "alias file" "broken"
22139 .cindex "broken alias or forward files"
22140 .cindex "ignoring faulty addresses"
22141 .cindex "skipping faulty addresses"
22142 .cindex "error" "skipping bad syntax"
22143 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22144 non-filter redirection data are skipped, and each failing address is logged. If
22145 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22146 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22147 are expanded and placed at the head of the error message generated by
22148 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22149 be the same address as the generic &%errors_to%& option. The
22150 &%skip_syntax_errors%& option is often used when handling mailing lists.
22151
22152 If all the addresses in a redirection list are skipped because of syntax
22153 errors, the router declines to handle the original address, and it is passed to
22154 the following routers.
22155
22156 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22157 error in the filter causes filtering to be abandoned without any action being
22158 taken. The incident is logged, and the router declines to handle the address,
22159 so it is passed to the following routers.
22160
22161 .cindex "Sieve filter" "syntax errors in"
22162 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22163 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22164 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22165
22166 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22167 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22168 option, used with an address that does not get redirected, can be used to
22169 notify users of these errors, by means of a router like this:
22170 .code
22171 userforward:
22172   driver = redirect
22173   allow_filter
22174   check_local_user
22175   file = $home/.forward
22176   file_transport = address_file
22177   pipe_transport = address_pipe
22178   reply_transport = address_reply
22179   no_verify
22180   skip_syntax_errors
22181   syntax_errors_to = real-$local_part@$domain
22182   syntax_errors_text = \
22183    This is an automatically generated message. An error has\n\
22184    been found in your .forward file. Details of the error are\n\
22185    reported below. While this error persists, you will receive\n\
22186    a copy of this message for every message that is addressed\n\
22187    to you. If your .forward file is a filter file, or if it is\n\
22188    a non-filter file containing no valid forwarding addresses,\n\
22189    a copy of each incoming message will be put in your normal\n\
22190    mailbox. If a non-filter file contains at least one valid\n\
22191    forwarding address, forwarding to the valid addresses will\n\
22192    happen, and those will be the only deliveries that occur.
22193 .endd
22194 You also need a router to ensure that local addresses that are prefixed by
22195 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22196 put this immediately before the &(userforward)& router:
22197 .code
22198 real_localuser:
22199   driver = accept
22200   check_local_user
22201   local_part_prefix = real-
22202   transport = local_delivery
22203 .endd
22204 For security, it would probably be a good idea to restrict the use of this
22205 router to locally-generated messages, using a condition such as this:
22206 .code
22207   condition = ${if match {$sender_host_address}\
22208                          {\N^(|127\.0\.0\.1)$\N}}
22209 .endd
22210
22211
22212 .option syntax_errors_text redirect string&!! unset
22213 See &%skip_syntax_errors%& above.
22214
22215
22216 .option syntax_errors_to redirect string unset
22217 See &%skip_syntax_errors%& above.
22218 .ecindex IIDredrou1
22219 .ecindex IIDredrou2
22220
22221
22222
22223
22224
22225
22226 . ////////////////////////////////////////////////////////////////////////////
22227 . ////////////////////////////////////////////////////////////////////////////
22228
22229 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22230          "Environment for local transports"
22231 .scindex IIDenvlotra1 "local transports" "environment for"
22232 .scindex IIDenvlotra2 "environment" "local transports"
22233 .scindex IIDenvlotra3 "transport" "local; environment for"
22234 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22235 transport can be thought of as similar to a pipe.) Exim always runs transports
22236 in subprocesses, under specified uids and gids. Typical deliveries to local
22237 mailboxes run under the uid and gid of the local user.
22238
22239 Exim also sets a specific current directory while running the transport; for
22240 some transports a home directory setting is also relevant. The &(pipe)&
22241 transport is the only one that sets up environment variables; see section
22242 &<<SECTpipeenv>>& for details.
22243
22244 The values used for the uid, gid, and the directories may come from several
22245 different places. In many cases, the router that handles the address associates
22246 settings with that address as a result of its &%check_local_user%&, &%group%&,
22247 or &%user%& options. However, values may also be given in the transport's own
22248 configuration, and these override anything that comes from the router.
22249
22250
22251
22252 .section "Concurrent deliveries" "SECID131"
22253 .cindex "concurrent deliveries"
22254 .cindex "simultaneous deliveries"
22255 If two different messages for the same local recipient arrive more or less
22256 simultaneously, the two delivery processes are likely to run concurrently. When
22257 the &(appendfile)& transport is used to write to a file, Exim applies locking
22258 rules to stop concurrent processes from writing to the same file at the same
22259 time.
22260
22261 However, when you use a &(pipe)& transport, it is up to you to arrange any
22262 locking that is needed. Here is a silly example:
22263 .code
22264 my_transport:
22265   driver = pipe
22266   command = /bin/sh -c 'cat >>/some/file'
22267 .endd
22268 This is supposed to write the message at the end of the file. However, if two
22269 messages arrive at the same time, the file will be scrambled. You can use the
22270 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22271 file using the same algorithm that Exim itself uses.
22272
22273
22274
22275
22276 .section "Uids and gids" "SECTenvuidgid"
22277 .cindex "local transports" "uid and gid"
22278 .cindex "transport" "local; uid and gid"
22279 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22280 overrides any group that the router set in the address, even if &%user%& is not
22281 set for the transport. This makes it possible, for example, to run local mail
22282 delivery under the uid of the recipient (set by the router), but in a special
22283 group (set by the transport). For example:
22284 .code
22285 # Routers ...
22286 # User/group are set by check_local_user in this router
22287 local_users:
22288   driver = accept
22289   check_local_user
22290   transport = group_delivery
22291
22292 # Transports ...
22293 # This transport overrides the group
22294 group_delivery:
22295   driver = appendfile
22296   file = /var/spool/mail/$local_part_data
22297   group = mail
22298 .endd
22299 If &%user%& is set for a transport, its value overrides what is set in the
22300 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22301 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22302 set.
22303
22304 .oindex "&%initgroups%&"
22305 When the uid is taken from the transport's configuration, the &[initgroups()]&
22306 function is called for the groups associated with that uid if the
22307 &%initgroups%& option is set for the transport. When the uid is not specified
22308 by the transport, but is associated with the address by a router, the option
22309 for calling &[initgroups()]& is taken from the router configuration.
22310
22311 .cindex "&(pipe)& transport" "uid for"
22312 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22313 is set and &%user%& is not set, the uid of the process that called Exim to
22314 receive the message is used, and if &%group%& is not set, the corresponding
22315 original gid is also used.
22316
22317 This is the detailed preference order for obtaining a gid; the first of the
22318 following that is set is used:
22319
22320 .ilist
22321 A &%group%& setting of the transport;
22322 .next
22323 A &%group%& setting of the router;
22324 .next
22325 A gid associated with a user setting of the router, either as a result of
22326 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22327 .next
22328 The group associated with a non-numeric &%user%& setting of the transport;
22329 .next
22330 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22331 the uid is the creator's uid;
22332 .next
22333 The Exim gid if the Exim uid is being used as a default.
22334 .endlist
22335
22336 If, for example, the user is specified numerically on the router and there are
22337 no group settings, no gid is available. In this situation, an error occurs.
22338 This is different for the uid, for which there always is an ultimate default.
22339 The first of the following that is set is used:
22340
22341 .ilist
22342 A &%user%& setting of the transport;
22343 .next
22344 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22345 .next
22346 A &%user%& setting of the router;
22347 .next
22348 A &%check_local_user%& setting of the router;
22349 .next
22350 The Exim uid.
22351 .endlist
22352
22353 Of course, an error will still occur if the uid that is chosen is on the
22354 &%never_users%& list.
22355
22356
22357
22358
22359
22360 .section "Current and home directories" "SECID132"
22361 .cindex "current directory for local transport"
22362 .cindex "home directory" "for local transport"
22363 .cindex "transport" "local; home directory for"
22364 .cindex "transport" "local; current directory for"
22365 Routers may set current and home directories for local transports by means of
22366 the &%transport_current_directory%& and &%transport_home_directory%& options.
22367 However, if the transport's &%current_directory%& or &%home_directory%& options
22368 are set, they override the router's values. In detail, the home directory
22369 for a local transport is taken from the first of these values that is set:
22370
22371 .ilist
22372 The &%home_directory%& option on the transport;
22373 .next
22374 The &%transport_home_directory%& option on the router;
22375 .next
22376 The password data if &%check_local_user%& is set on the router;
22377 .next
22378 The &%router_home_directory%& option on the router.
22379 .endlist
22380
22381 The current directory is taken from the first of these values that is set:
22382
22383 .ilist
22384 The &%current_directory%& option on the transport;
22385 .next
22386 The &%transport_current_directory%& option on the router.
22387 .endlist
22388
22389
22390 If neither the router nor the transport sets a current directory, Exim uses the
22391 value of the home directory, if it is set. Otherwise it sets the current
22392 directory to &_/_& before running a local transport.
22393
22394
22395
22396 .section "Expansion variables derived from the address" "SECID133"
22397 .vindex "&$domain$&"
22398 .vindex "&$local_part$&"
22399 .vindex "&$original_domain$&"
22400 Normally a local delivery is handling a single address, and in that case the
22401 variables such as &$domain$& and &$local_part$& are set during local
22402 deliveries. However, in some circumstances more than one address may be handled
22403 at once (for example, while writing batch SMTP for onward transmission by some
22404 other means). In this case, the variables associated with the local part are
22405 never set, &$domain$& is set only if all the addresses have the same domain,
22406 and &$original_domain$& is never set.
22407 .ecindex IIDenvlotra1
22408 .ecindex IIDenvlotra2
22409 .ecindex IIDenvlotra3
22410
22411
22412
22413
22414
22415
22416
22417 . ////////////////////////////////////////////////////////////////////////////
22418 . ////////////////////////////////////////////////////////////////////////////
22419
22420 .chapter "Generic options for transports" "CHAPtransportgeneric"
22421 .scindex IIDgenoptra1 "generic options" "transport"
22422 .scindex IIDgenoptra2 "options" "generic; for transports"
22423 .scindex IIDgenoptra3 "transport" "generic options for"
22424 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22425 prior to Exim 4.95 names would be silently truncated at this length, but now
22426 it is enforced.
22427
22428 The following generic options apply to all transports:
22429
22430
22431 .option body_only transports boolean false
22432 .cindex "transport" "body only"
22433 .cindex "message" "transporting body only"
22434 .cindex "body of message" "transporting"
22435 If this option is set, the message's headers are not transported. It is
22436 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22437 or &(pipe)& transports, the settings of &%message_prefix%& and
22438 &%message_suffix%& should be checked, because this option does not
22439 automatically suppress them.
22440
22441
22442 .option current_directory transports string&!! unset
22443 .cindex "transport" "current directory for"
22444 This specifies the current directory that is to be set while running the
22445 transport, overriding any value that may have been set by the router.
22446 If the expansion fails for any reason, including forced failure, an error is
22447 logged, and delivery is deferred.
22448
22449
22450 .option disable_logging transports boolean false
22451 If this option is set true, nothing is logged for any
22452 deliveries by the transport or for any
22453 transport errors. You should not set this option unless you really, really know
22454 what you are doing.
22455
22456
22457 .option debug_print transports string&!! unset
22458 .cindex "testing" "variables in drivers"
22459 If this option is set and debugging is enabled (see the &%-d%& command line
22460 option), the string is expanded and included in the debugging output when the
22461 transport is run.
22462 If expansion of the string fails, the error message is written to the debugging
22463 output, and Exim carries on processing.
22464 This facility is provided to help with checking out the values of variables and
22465 so on when debugging driver configurations. For example, if a &%headers_add%&
22466 option is not working properly, &%debug_print%& could be used to output the
22467 variables it references. A newline is added to the text if it does not end with
22468 one.
22469 The variables &$transport_name$& and &$router_name$& contain the name of the
22470 transport and the router that called it.
22471
22472 .option delivery_date_add transports boolean false
22473 .cindex "&'Delivery-date:'& header line"
22474 If this option is true, a &'Delivery-date:'& header is added to the message.
22475 This gives the actual time the delivery was made. As this is not a standard
22476 header, Exim has a configuration option (&%delivery_date_remove%&) which
22477 requests its removal from incoming messages, so that delivered messages can
22478 safely be resent to other recipients.
22479
22480
22481 .option driver transports string unset
22482 This specifies which of the available transport drivers is to be used.
22483 There is no default, and this option must be set for every transport.
22484
22485
22486 .option envelope_to_add transports boolean false
22487 .cindex "&'Envelope-to:'& header line"
22488 If this option is true, an &'Envelope-to:'& header is added to the message.
22489 This gives the original address(es) in the incoming envelope that caused this
22490 delivery to happen. More than one address may be present if the transport is
22491 configured to handle several addresses at once, or if more than one original
22492 address was redirected to the same final address. As this is not a standard
22493 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22494 its removal from incoming messages, so that delivered messages can safely be
22495 resent to other recipients.
22496
22497 &*Note:*& If used on a transport handling multiple recipients
22498 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22499 transport if &%batch_max%& is greater than 1)
22500 then information about Bcc recipients will be leaked.
22501 Doing so is generally not advised.
22502
22503
22504 .option event_action transports string&!! unset
22505 .cindex events
22506 This option declares a string to be expanded for Exim's events mechanism.
22507 For details see chapter &<<CHAPevents>>&.
22508
22509
22510 .option group transports string&!! "Exim group"
22511 .cindex "transport" "group; specifying"
22512 This option specifies a gid for running the transport process, overriding any
22513 value that the router supplies, and also overriding any value associated with
22514 &%user%& (see below).
22515
22516
22517 .option headers_add transports list&!! unset
22518 .cindex "header lines" "adding in transport"
22519 .cindex "transport" "header lines; adding"
22520 This option specifies a list of text headers,
22521 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22522 which are (separately) expanded and added to the header
22523 portion of a message as it is transported, as described in section
22524 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22525 routers. If the result of the expansion is an empty string, or if the expansion
22526 is forced to fail, no action is taken. Other expansion failures are treated as
22527 errors and cause the delivery to be deferred.
22528
22529 Unlike most options, &%headers_add%& can be specified multiple times
22530 for a transport; all listed headers are added.
22531
22532
22533 .option headers_only transports boolean false
22534 .cindex "transport" "header lines only"
22535 .cindex "message" "transporting headers only"
22536 .cindex "header lines" "transporting"
22537 If this option is set, the message's body is not transported. It is mutually
22538 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22539 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22540 checked, since this option does not automatically suppress them.
22541
22542
22543 .option headers_remove transports list&!! unset
22544 .cindex "header lines" "removing"
22545 .cindex "transport" "header lines; removing"
22546 This option specifies a list of text headers,
22547 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22548 to be removed from the message.
22549 However, the option has no effect when an address is just being verified.
22550 Each list item is separately expanded.
22551 If the result of the expansion is an empty string, or if the expansion
22552 is forced to fail, no action is taken. Other expansion failures are treated as
22553 errors and cause the delivery to be deferred.
22554 If an item ends in *, it will match any header with the given prefix.
22555
22556 Matching headers are omitted from the message as it is transported, as described
22557 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22558 routers.
22559
22560 Unlike most options, &%headers_remove%& can be specified multiple times
22561 for a transport; all listed headers are removed.
22562
22563 &*Warning*&: Because of the separate expansion of the list items,
22564 items that contain a list separator must have it doubled.
22565 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22566
22567
22568
22569 .option headers_rewrite transports string unset
22570 .cindex "transport" "header lines; rewriting"
22571 .cindex "rewriting" "at transport time"
22572 This option allows addresses in header lines to be rewritten at transport time,
22573 that is, as the message is being copied to its destination. The contents of the
22574 option are a colon-separated list of rewriting rules. Each rule is in exactly
22575 the same form as one of the general rewriting rules that are applied when a
22576 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22577 example,
22578 .code
22579 headers_rewrite = a@b c@d f : \
22580                   x@y w@z
22581 .endd
22582 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22583 &'w@z'& in all address-bearing header lines. The rules are applied to the
22584 header lines just before they are written out at transport time, so they affect
22585 only those copies of the message that pass through the transport. However, only
22586 the message's original header lines, and any that were added by a system
22587 filter, are rewritten. If a router or transport adds header lines, they are not
22588 affected by this option. These rewriting rules are &'not'& applied to the
22589 envelope. You can change the return path using &%return_path%&, but you cannot
22590 change envelope recipients at this time.
22591
22592
22593 .option home_directory transports string&!! unset
22594 .cindex "transport" "home directory for"
22595 .vindex "&$home$&"
22596 This option specifies a home directory setting for a local transport,
22597 overriding any value that may be set by the router. The home directory is
22598 placed in &$home$& while expanding the transport's private options. It is also
22599 used as the current directory if no current directory is set by the
22600 &%current_directory%& option on the transport or the
22601 &%transport_current_directory%& option on the router. If the expansion fails
22602 for any reason, including forced failure, an error is logged, and delivery is
22603 deferred.
22604
22605
22606 .option initgroups transports boolean false
22607 .cindex "additional groups"
22608 .cindex "groups" "additional"
22609 .cindex "transport" "group; additional"
22610 If this option is true and the uid for the delivery process is provided by the
22611 transport, the &[initgroups()]& function is called when running the transport
22612 to ensure that any additional groups associated with the uid are set up.
22613
22614
22615 .option max_parallel transports integer&!! unset
22616 .cindex limit "transport parallelism"
22617 .cindex transport "parallel processes"
22618 .cindex transport "concurrency limit"
22619 .cindex "delivery" "parallelism for transport"
22620 If this option is set and expands to an integer greater than zero
22621 it limits the number of concurrent runs of the transport.
22622 The control does not apply to shadow transports.
22623
22624 .cindex "hints database" "transport concurrency control"
22625 Exim implements this control by means of a hints database in which a record is
22626 incremented whenever a transport process is being created. The record
22627 is decremented and possibly removed when the process terminates.
22628 Obviously there is scope for
22629 records to get left lying around if there is a system or program crash. To
22630 guard against this, Exim ignores any records that are more than six hours old.
22631
22632 If you use this option, you should also arrange to delete the
22633 relevant hints database whenever your system reboots. The names of the files
22634 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22635 may be one or two files, depending on the type of DBM in use. The same files
22636 are used for ETRN and smtp transport serialization.
22637
22638
22639 .option message_size_limit transports string&!! 0
22640 .cindex "limit" "message size per transport"
22641 .cindex "size" "of message, limit"
22642 .cindex "transport" "message size; limiting"
22643 This option controls the size of messages passed through the transport. It is
22644 expanded before use; the result of the expansion must be a sequence of decimal
22645 digits, optionally followed by K or M. If the expansion fails for any reason,
22646 including forced failure, or if the result is not of the required form,
22647 delivery is deferred. If the value is greater than zero and the size of a
22648 message exceeds this limit, the address is failed. If there is any chance that
22649 the resulting bounce message could be routed to the same transport, you should
22650 ensure that &%return_size_limit%& is less than the transport's
22651 &%message_size_limit%&, as otherwise the bounce message will fail to get
22652 delivered.
22653
22654
22655
22656 .option rcpt_include_affixes transports boolean false
22657 .cindex "prefix" "for local part, including in envelope"
22658 .cindex "suffix for local part" "including in envelope"
22659 .cindex "local part" "prefix"
22660 .cindex "local part" "suffix"
22661 When this option is false (the default), and an address that has had any
22662 affixes (prefixes or suffixes) removed from the local part is delivered by any
22663 form of SMTP or LMTP, the affixes are not included. For example, if a router
22664 that contains
22665 .code
22666 local_part_prefix = *-
22667 .endd
22668 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22669 is delivered with
22670 .code
22671 RCPT TO:<xyz@some.domain>
22672 .endd
22673 This is also the case when an ACL-time callout is being used to verify a
22674 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22675 whole local part is included in the RCPT command. This option applies to BSMTP
22676 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22677 &(lmtp)& and &(smtp)& transports.
22678
22679
22680 .option retry_use_local_part transports boolean "see below"
22681 .cindex "hints database" "retry keys"
22682 When a delivery suffers a temporary failure, a retry record is created
22683 in Exim's hints database. For remote deliveries, the key for the retry record
22684 is based on the name and/or IP address of the failing remote host. For local
22685 deliveries, the key is normally the entire address, including both the local
22686 part and the domain. This is suitable for most common cases of local delivery
22687 temporary failure &-- for example, exceeding a mailbox quota should delay only
22688 deliveries to that mailbox, not to the whole domain.
22689
22690 However, in some special cases you may want to treat a temporary local delivery
22691 as a failure associated with the domain, and not with a particular local part.
22692 (For example, if you are storing all mail for some domain in files.) You can do
22693 this by setting &%retry_use_local_part%& false.
22694
22695 For all the local transports, its default value is true. For remote transports,
22696 the default value is false for tidiness, but changing the value has no effect
22697 on a remote transport in the current implementation.
22698
22699
22700 .option return_path transports string&!! unset
22701 .cindex "envelope sender"
22702 .cindex "envelope from"
22703 .cindex "transport" "return path; changing"
22704 .cindex "return path" "changing in transport"
22705 If this option is set, the string is expanded at transport time and replaces
22706 the existing return path (envelope sender) value in the copy of the message
22707 that is being delivered. An empty return path is permitted. This feature is
22708 designed for remote deliveries, where the value of this option is used in the
22709 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22710 only effect is to change the address that is placed in the &'Return-path:'&
22711 header line, if one is added to the message (see the next option).
22712
22713 &*Note:*& A changed return path is not logged unless you add
22714 &%return_path_on_delivery%& to the log selector.
22715
22716 .vindex "&$return_path$&"
22717 The expansion can refer to the existing value via &$return_path$&. This is
22718 either the message's envelope sender, or an address set by the
22719 &%errors_to%& option on a router. If the expansion is forced to fail, no
22720 replacement occurs; if it fails for another reason, delivery is deferred. This
22721 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22722 section &<<SECTverp>>&.
22723
22724 &*Note*&: If a delivery error is detected locally, including the case when a
22725 remote server rejects a message at SMTP time, the bounce message is not sent to
22726 the value of this option. It is sent to the previously set errors address.
22727 This defaults to the incoming sender address, but can be changed by setting
22728 &%errors_to%& in a router.
22729
22730
22731
22732 .option return_path_add transports boolean false
22733 .chindex Return-path:
22734 If this option is true, a &'Return-path:'& header is added to the message.
22735 Although the return path is normally available in the prefix line of BSD
22736 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22737 have easy access to it.
22738
22739 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22740 the delivery SMTP server makes the final delivery"&. This implies that this
22741 header should not be present in incoming messages. Exim has a configuration
22742 option, &%return_path_remove%&, which requests removal of this header from
22743 incoming messages, so that delivered messages can safely be resent to other
22744 recipients.
22745
22746
22747 .option shadow_condition transports string&!! unset
22748 See &%shadow_transport%& below.
22749
22750
22751 .option shadow_transport transports string unset
22752 .cindex "shadow transport"
22753 .cindex "transport" "shadow"
22754 A local transport may set the &%shadow_transport%& option to the name of
22755 another local transport. Shadow remote transports are not supported.
22756
22757 Whenever a delivery to the main transport succeeds, and either
22758 &%shadow_condition%& is unset, or its expansion does not result in the empty
22759 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22760 passed to the shadow transport, with the same delivery address or addresses. If
22761 expansion fails, no action is taken except that non-forced expansion failures
22762 cause a log line to be written.
22763
22764 The result of the shadow transport is discarded and does not affect the
22765 subsequent processing of the message. Only a single level of shadowing is
22766 provided; the &%shadow_transport%& option is ignored on any transport when it
22767 is running as a shadow. Options concerned with output from pipes are also
22768 ignored. The log line for the successful delivery has an item added on the end,
22769 of the form
22770 .code
22771 ST=<shadow transport name>
22772 .endd
22773 If the shadow transport did not succeed, the error message is put in
22774 parentheses afterwards. Shadow transports can be used for a number of different
22775 purposes, including keeping more detailed log information than Exim normally
22776 provides, and implementing automatic acknowledgment policies based on message
22777 headers that some sites insist on.
22778
22779
22780 .option transport_filter transports string&!! unset
22781 .cindex "transport" "filter"
22782 .cindex "filter" "transport filter"
22783 This option sets up a filtering (in the Unix shell sense) process for messages
22784 at transport time. It should not be confused with mail filtering as set up by
22785 individual users or via a system filter.
22786 If unset, or expanding to an empty string, no filtering is done.
22787
22788 When the message is about to be written out, the command specified by
22789 &%transport_filter%& is started up in a separate, parallel process, and
22790 the entire message, including the header lines, is passed to it on its standard
22791 input (this in fact is done from a third process, to avoid deadlock). The
22792 command must be specified as an absolute path.
22793
22794 The lines of the message that are written to the transport filter are
22795 terminated by newline (&"\n"&). The message is passed to the filter before any
22796 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22797 lines beginning with a dot, and also before any processing implied by the
22798 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22799 &(pipe)& transports.
22800
22801 The standard error for the filter process is set to the same destination as its
22802 standard output; this is read and written to the message's ultimate
22803 destination. The process that writes the message to the filter, the
22804 filter itself, and the original process that reads the result and delivers it
22805 are all run in parallel, like a shell pipeline.
22806
22807 The filter can perform any transformations it likes, but of course should take
22808 care not to break RFC 2822 syntax. Exim does not check the result, except to
22809 test for a final newline when SMTP is in use. All messages transmitted over
22810 SMTP must end with a newline, so Exim supplies one if it is missing.
22811
22812 .cindex "content scanning" "per user"
22813 A transport filter can be used to provide content-scanning on a per-user basis
22814 at delivery time if the only required effect of the scan is to modify the
22815 message. For example, a content scan could insert a new header line containing
22816 a spam score. This could be interpreted by a filter in the user's MUA. It is
22817 not possible to discard a message at this stage.
22818
22819 .cindex "SIZE" "ESMTP extension"
22820 A problem might arise if the filter increases the size of a message that is
22821 being sent down an SMTP connection. If the receiving SMTP server has indicated
22822 support for the SIZE parameter, Exim will have sent the size of the message
22823 at the start of the SMTP session. If what is actually sent is substantially
22824 more, the server might reject the message. This can be worked round by setting
22825 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22826 additions to the message, or to disable the use of SIZE altogether.
22827
22828 .vindex "&$pipe_addresses$&"
22829 The value of the &%transport_filter%& option is the command string for starting
22830 the filter, which is run directly from Exim, not under a shell. The string is
22831 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22832 Exim breaks it up into arguments and then expands each argument separately (see
22833 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22834 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22835 of arguments, one for each address that applies to this delivery. (This isn't
22836 an ideal name for this feature here, but as it was already implemented for the
22837 &(pipe)& transport, it seemed sensible not to change it.)
22838
22839 .vindex "&$host$&"
22840 .vindex "&$host_address$&"
22841 The expansion variables &$host$& and &$host_address$& are available when the
22842 transport is a remote one. They contain the name and IP address of the host to
22843 which the message is being sent. For example:
22844 . used to have $sender_address in this cmdline, but it's tainted
22845 .code
22846 transport_filter = /some/directory/transport-filter.pl \
22847   $host $host_address $pipe_addresses
22848 .endd
22849
22850 Two problems arise if you want to use more complicated expansion items to
22851 generate transport filter commands, both of which due to the fact that the
22852 command is split up &'before'& expansion.
22853 .ilist
22854 If an expansion item contains white space, you must quote it, so that it is all
22855 part of the same command item. If the entire option setting is one such
22856 expansion item, you have to take care what kind of quoting you use. For
22857 example:
22858 .code
22859 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22860 .endd
22861 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22862 &(/bin/cmd2)& otherwise.
22863
22864 Option strings in general have any fully-surrounding double quote wrapping
22865 removed early in parsing (see &<<SECTstrings>>&).
22866 Then, for this option, quotes protect against whitespace being
22867 regarded as a separator while splitting into the command argument vector.
22868 Either double or single quotes can be used here;
22869 the former interprets backlash-quoted charachters
22870 and the latter does not.
22871
22872 If double quotes had been used in this example, they would have been
22873 stripped by Exim when it read the option's value. When the value is used, if
22874 the single quotes were missing, the line would be split into two items,
22875 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22876 Exim tried to expand the first one.
22877 .next
22878 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22879 expansion cannot generate multiple arguments, or a command name followed by
22880 arguments. Consider this example:
22881 .code
22882 transport_filter = ${lookup{$host}lsearch{/a/file}\
22883                     {$value}{/bin/cat}}
22884 .endd
22885 The result of the lookup is interpreted as the name of the command, even
22886 if it contains white space. The simplest way round this is to use a shell:
22887 .code
22888 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22889                                {$value}{/bin/cat}}
22890 .endd
22891 .endlist
22892
22893 The filter process is run under the same uid and gid as the normal delivery.
22894 For remote deliveries this is the Exim uid/gid by default. The command should
22895 normally yield a zero return code. Transport filters are not supposed to fail.
22896 A non-zero code is taken to mean that the transport filter encountered some
22897 serious problem. Delivery of the message is deferred; the message remains on
22898 the queue and is tried again later. It is not possible to cause a message to be
22899 bounced from a transport filter.
22900
22901 If a transport filter is set on an autoreply transport, the original message is
22902 passed through the filter as it is being copied into the newly generated
22903 message, which happens if the &%return_message%& option is set.
22904
22905
22906 .option transport_filter_timeout transports time 5m
22907 .cindex "transport" "filter, timeout"
22908 When Exim is reading the output of a transport filter, it applies a timeout
22909 that can be set by this option. Exceeding the timeout is normally treated as a
22910 temporary delivery failure. However, if a transport filter is used with a
22911 &(pipe)& transport, a timeout in the transport filter is treated in the same
22912 way as a timeout in the pipe command itself. By default, a timeout is a hard
22913 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22914 becomes a temporary error.
22915
22916
22917 .option user transports string&!! "Exim user"
22918 .cindex "uid (user id)" "local delivery"
22919 .cindex "transport" "user, specifying"
22920 This option specifies the user under whose uid the delivery process is to be
22921 run, overriding any uid that may have been set by the router. If the user is
22922 given as a name, the uid is looked up from the password data, and the
22923 associated group is taken as the value of the gid to be used if the &%group%&
22924 option is not set.
22925
22926 For deliveries that use local transports, a user and group are normally
22927 specified explicitly or implicitly (for example, as a result of
22928 &%check_local_user%&) by the router or transport.
22929
22930 .cindex "hints database" "access by remote transport"
22931 For remote transports, you should leave this option unset unless you really are
22932 sure you know what you are doing. When a remote transport is running, it needs
22933 to be able to access Exim's hints databases, because each host may have its own
22934 retry data.
22935 .ecindex IIDgenoptra1
22936 .ecindex IIDgenoptra2
22937 .ecindex IIDgenoptra3
22938
22939
22940
22941
22942
22943
22944 . ////////////////////////////////////////////////////////////////////////////
22945 . ////////////////////////////////////////////////////////////////////////////
22946
22947 .chapter "Address batching in local transports" "CHAPbatching" &&&
22948          "Address batching"
22949 .cindex "transport" "local; address batching in"
22950 The only remote transport (&(smtp)&) is normally configured to handle more than
22951 one address at a time, so that when several addresses are routed to the same
22952 remote host, just one copy of the message is sent. Local transports, however,
22953 normally handle one address at a time. That is, a separate instance of the
22954 transport is run for each address that is routed to the transport. A separate
22955 copy of the message is delivered each time.
22956
22957 .cindex "batched local delivery"
22958 .oindex "&%batch_max%&"
22959 .oindex "&%batch_id%&"
22960 In special cases, it may be desirable to handle several addresses at once in a
22961 local transport, for example:
22962
22963 .ilist
22964 In an &(appendfile)& transport, when storing messages in files for later
22965 delivery by some other means, a single copy of the message with multiple
22966 recipients saves space.
22967 .next
22968 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22969 a single copy saves time, and is the normal way LMTP is expected to work.
22970 .next
22971 In a &(pipe)& transport, when passing the message
22972 to a scanner program or
22973 to some other delivery mechanism such as UUCP, multiple recipients may be
22974 acceptable.
22975 .endlist
22976
22977 These three local transports all have the same options for controlling multiple
22978 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22979 repeating the information for each transport, these options are described here.
22980
22981 The &%batch_max%& option specifies the maximum number of addresses that can be
22982 delivered together in a single run of the transport. Its default value is one
22983 (no batching). When more than one address is routed to a transport that has a
22984 &%batch_max%& value greater than one, the addresses are delivered in a batch
22985 (that is, in a single run of the transport with multiple recipients), subject
22986 to certain conditions:
22987
22988 .ilist
22989 .vindex "&$local_part$&"
22990 If any of the transport's options contain a reference to &$local_part$&, no
22991 batching is possible.
22992 .next
22993 .vindex "&$domain$&"
22994 If any of the transport's options contain a reference to &$domain$&, only
22995 addresses with the same domain are batched.
22996 .next
22997 .cindex "customizing" "batching condition"
22998 If &%batch_id%& is set, it is expanded for each address, and only those
22999 addresses with the same expanded value are batched. This allows you to specify
23000 customized batching conditions. Failure of the expansion for any reason,
23001 including forced failure, disables batching, but it does not stop the delivery
23002 from taking place.
23003 .next
23004 Batched addresses must also have the same errors address (where to send
23005 delivery errors), the same header additions and removals, the same user and
23006 group for the transport, and if a host list is present, the first host must
23007 be the same.
23008 .endlist
23009
23010 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23011 both when the file or pipe command is specified in the transport, and when it
23012 is specified by a &(redirect)& router, but all the batched addresses must of
23013 course be routed to the same file or pipe command. These two transports have an
23014 option called &%use_bsmtp%&, which causes them to deliver the message in
23015 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23016 &%check_string%& and &%escape_string%& options are forced to the values
23017 .code
23018 check_string = "."
23019 escape_string = ".."
23020 .endd
23021 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23022 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23023 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23024
23025 .cindex "&'Envelope-to:'& header line"
23026 If the generic &%envelope_to_add%& option is set for a batching transport, the
23027 &'Envelope-to:'& header that is added to the message contains all the addresses
23028 that are being processed together. If you are using a batching &(appendfile)&
23029 transport without &%use_bsmtp%&, the only way to preserve the recipient
23030 addresses is to set the &%envelope_to_add%& option.
23031
23032 .cindex "&(pipe)& transport" "with multiple addresses"
23033 .vindex "&$pipe_addresses$&"
23034 If you are using a &(pipe)& transport without BSMTP, and setting the
23035 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23036 the command. This is not a true variable; it is a bit of magic that causes each
23037 of the recipient addresses to be inserted into the command as a separate
23038 argument. This provides a way of accessing all the addresses that are being
23039 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23040 are specified by a &(redirect)& router.
23041
23042
23043
23044
23045 . ////////////////////////////////////////////////////////////////////////////
23046 . ////////////////////////////////////////////////////////////////////////////
23047
23048 .chapter "The appendfile transport" "CHAPappendfile"
23049 .scindex IIDapptra1 "&(appendfile)& transport"
23050 .scindex IIDapptra2 "transports" "&(appendfile)&"
23051 .cindex "directory creation"
23052 .cindex "creating directories"
23053 The &(appendfile)& transport delivers a message by appending it to an existing
23054 file, or by creating an entirely new file in a specified directory. Single
23055 files to which messages are appended can be in the traditional Unix mailbox
23056 format, or optionally in the MBX format supported by the Pine MUA and
23057 University of Washington IMAP daemon, &'inter alia'&. When each message is
23058 being delivered as a separate file, &"maildir"& format can optionally be used
23059 to give added protection against failures that happen part-way through the
23060 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23061 supported. For all file formats, Exim attempts to create as many levels of
23062 directory as necessary, provided that &%create_directory%& is set.
23063
23064 The code for the optional formats is not included in the Exim binary by
23065 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23066 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23067 included.
23068
23069 .cindex "quota" "system"
23070 Exim recognizes system quota errors, and generates an appropriate message. Exim
23071 also supports its own quota control within the transport, for use when the
23072 system facility is unavailable or cannot be used for some reason.
23073
23074 If there is an error while appending to a file (for example, quota exceeded or
23075 partition filled), Exim attempts to reset the file's length and last
23076 modification time back to what they were before. If there is an error while
23077 creating an entirely new file, the new file is removed.
23078
23079 Before appending to a file, a number of security checks are made, and the
23080 file is locked. A detailed description is given below, after the list of
23081 private options.
23082
23083 The &(appendfile)& transport is most commonly used for local deliveries to
23084 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23085 putting messages into files for remote delivery by some means other than Exim.
23086 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23087 option).
23088
23089
23090
23091 .section "The file and directory options" "SECTfildiropt"
23092 The &%file%& option specifies a single file, to which the message is appended;
23093 the &%directory%& option specifies a directory, in which a new file containing
23094 the message is created. Only one of these two options can be set, and for
23095 normal deliveries to mailboxes, one of them &'must'& be set.
23096
23097 .vindex "&$address_file$&"
23098 .vindex "&$local_part$&"
23099 However, &(appendfile)& is also used for delivering messages to files or
23100 directories whose names (or parts of names) are obtained from alias,
23101 forwarding, or filtering operations (for example, a &%save%& command in a
23102 user's Exim filter). When such a transport is running, &$local_part$& contains
23103 the local part that was aliased or forwarded, and &$address_file$& contains the
23104 name (or partial name) of the file or directory generated by the redirection
23105 operation. There are two cases:
23106
23107 .ilist
23108 If neither &%file%& nor &%directory%& is set, the redirection operation
23109 must specify an absolute path (one that begins with &`/`&). This is the most
23110 common case when users with local accounts use filtering to sort mail into
23111 different folders. See for example, the &(address_file)& transport in the
23112 default configuration. If the path ends with a slash, it is assumed to be the
23113 name of a directory. A delivery to a directory can also be forced by setting
23114 &%maildir_format%& or &%mailstore_format%&.
23115 .next
23116 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23117 used to determine the file or directory name for the delivery. Normally, the
23118 contents of &$address_file$& are used in some way in the string expansion.
23119 .endlist
23120 If the &%create_file%& option is set to a path which
23121 matches (see the option definition below for details)
23122 a file or directory name
23123 for the delivery, that name becomes de-tainted.
23124
23125 .cindex "tainted data" "in filenames"
23126 .cindex appendfile "tainted data"
23127 Tainted data may not be used for a file or directory name.
23128 This means that, for instance, &$local_part$& cannot be used directly
23129 as a component of a path.  It can however be used as the key for a lookup
23130 which returns a path (or component).
23131
23132
23133 .cindex "Sieve filter" "configuring &(appendfile)&"
23134 .cindex "Sieve filter" "relative mailbox path handling"
23135 As an example of the second case, consider an environment where users do not
23136 have home directories. They may be permitted to use Exim filter commands of the
23137 form:
23138 .code
23139 save folder23
23140 .endd
23141 or Sieve filter commands of the form:
23142 .code
23143 require "fileinto";
23144 fileinto "folder23";
23145 .endd
23146 In this situation, the expansion of &%file%& or &%directory%& in the transport
23147 must transform the relative path into an appropriate absolute filename. In the
23148 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23149 is used as a result of a &"keep"& action in the filter. This example shows one
23150 way of handling this requirement:
23151 .code
23152 file = ${if eq{$address_file}{inbox} \
23153             {/var/mail/$local_part_data} \
23154             {${if eq{${substr_0_1:$address_file}}{/} \
23155                   {$address_file} \
23156                   {$home/mail/$address_file} \
23157             }} \
23158        }
23159 .endd
23160 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23161 location, absolute paths are used without change, and other folders are in the
23162 &_mail_& directory within the home directory.
23163
23164 &*Note 1*&: While processing an Exim filter, a relative path such as
23165 &_folder23_& is turned into an absolute path if a home directory is known to
23166 the router. In particular, this is the case if &%check_local_user%& is set. If
23167 you want to prevent this happening at routing time, you can set
23168 &%router_home_directory%& empty. This forces the router to pass the relative
23169 path to the transport.
23170
23171 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23172 the &%file%& or &%directory%& option is still used if it is set.
23173
23174
23175
23176
23177 .section "Private options for appendfile" "SECID134"
23178 .cindex "options" "&(appendfile)& transport"
23179
23180
23181
23182 .option allow_fifo appendfile boolean false
23183 .cindex "fifo (named pipe)"
23184 .cindex "named pipe (fifo)"
23185 .cindex "pipe" "named (fifo)"
23186 Setting this option permits delivery to named pipes (FIFOs) as well as to
23187 regular files. If no process is reading the named pipe at delivery time, the
23188 delivery is deferred.
23189
23190
23191 .option allow_symlink appendfile boolean false
23192 .cindex "symbolic link" "to mailbox"
23193 .cindex "mailbox" "symbolic link"
23194 By default, &(appendfile)& will not deliver if the path name for the file is
23195 that of a symbolic link. Setting this option relaxes that constraint, but there
23196 are security issues involved in the use of symbolic links. Be sure you know
23197 what you are doing if you set this. Details of exactly what this option affects
23198 are included in the discussion which follows this list of options.
23199
23200
23201 .option batch_id appendfile string&!! unset
23202 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23203 However, batching is automatically disabled for &(appendfile)& deliveries that
23204 happen as a result of forwarding or aliasing or other redirection directly to a
23205 file.
23206
23207
23208 .option batch_max appendfile integer 1
23209 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23210
23211
23212 .option check_group appendfile boolean false
23213 When this option is set, the group owner of the file defined by the &%file%&
23214 option is checked to see that it is the same as the group under which the
23215 delivery process is running. The default setting is false because the default
23216 file mode is 0600, which means that the group is irrelevant.
23217
23218
23219 .option check_owner appendfile boolean true
23220 When this option is set, the owner of the file defined by the &%file%& option
23221 is checked to ensure that it is the same as the user under which the delivery
23222 process is running.
23223
23224
23225 .option check_string appendfile string "see below"
23226 .cindex "&""From""& line"
23227 As &(appendfile)& writes the message, the start of each line is tested for
23228 matching &%check_string%&, and if it does, the initial matching characters are
23229 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23230 a literal string, not a regular expression, and the case of any letters it
23231 contains is significant.
23232
23233 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23234 are forced to &"."& and &".."& respectively, and any settings in the
23235 configuration are ignored. Otherwise, they default to &"From&~"& and
23236 &">From&~"& when the &%file%& option is set, and unset when any of the
23237 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23238
23239 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23240 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23241 &"From&~"& indicates the start of a new message. All four options need changing
23242 if another format is used. For example, to deliver to mailboxes in MMDF format:
23243 .cindex "MMDF format mailbox"
23244 .cindex "mailbox" "MMDF format"
23245 .code
23246 check_string = "\1\1\1\1\n"
23247 escape_string = "\1\1\1\1 \n"
23248 message_prefix = "\1\1\1\1\n"
23249 message_suffix = "\1\1\1\1\n"
23250 .endd
23251 .option create_directory appendfile boolean true
23252 .cindex "directory creation"
23253 When this option is true, Exim attempts to create any missing superior
23254 directories for the file that it is about to write. A created directory's mode
23255 is given by the &%directory_mode%& option.
23256
23257 The group ownership of a newly created directory is highly dependent on the
23258 operating system (and possibly the file system) that is being used. For
23259 example, in Solaris, if the parent directory has the setgid bit set, its group
23260 is propagated to the child; if not, the currently set group is used. However,
23261 in FreeBSD, the parent's group is always used.
23262
23263
23264
23265 .option create_file appendfile string anywhere
23266 This option constrains the location of files and directories that are created
23267 by this transport. It applies to files defined by the &%file%& option and
23268 directories defined by the &%directory%& option. In the case of maildir
23269 delivery, it applies to the top level directory, not the maildir directories
23270 beneath.
23271
23272 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23273 &"belowhome"&, or to an absolute path.
23274
23275 In the second and third cases, a home directory must have been
23276 set for the transport, and the file or directory being created must
23277 reside within it.
23278 The "belowhome" checking additionally checks for attempts to use "../"
23279 to evade the testing.
23280 This option is not useful when an explicit filename is
23281 given for normal mailbox deliveries. It is intended for the case when filenames
23282 are generated from users' &_.forward_& files. These are usually handled
23283 by an &(appendfile)& transport called &%address_file%&. See also
23284 &%file_must_exist%&.
23285
23286 In the fourth case,
23287 the value given for this option must be an absolute path for an
23288 existing directory.
23289 The value is used for checking instead of a home directory;
23290 checking is done in "belowhome" mode.
23291
23292 .cindex "tainted data" "de-tainting"
23293 .cindex "de-tainting" "using appendfile create_file option"
23294 If "belowhome" checking is used, the file or directory path
23295 becomes de-tainted.
23296
23297
23298 .option directory appendfile string&!! unset
23299 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23300 or &%directory%& must be set, unless the delivery is the direct result of a
23301 redirection (see section &<<SECTfildiropt>>&).
23302
23303 When &%directory%& is set, the string is expanded, and the message is delivered
23304 into a new file or files in or below the given directory, instead of being
23305 appended to a single mailbox file. A number of different formats are provided
23306 (see &%maildir_format%& and &%mailstore_format%&), and see section
23307 &<<SECTopdir>>& for further details of this form of delivery.
23308
23309 The result of expansion must not be tainted, unless the &%create_file%& option
23310 specifies a path.
23311
23312
23313 .option directory_file appendfile string&!! "see below"
23314 .cindex "base62"
23315 .vindex "&$inode$&"
23316 When &%directory%& is set, but neither &%maildir_format%& nor
23317 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23318 whose name is obtained by expanding this string. The default value is:
23319 .code
23320 q${base62:$tod_epoch}-$inode
23321 .endd
23322 This generates a unique name from the current time, in base 62 form, and the
23323 inode of the file. The variable &$inode$& is available only when expanding this
23324 option.
23325
23326
23327 .option directory_mode appendfile "octal integer" 0700
23328 If &(appendfile)& creates any directories as a result of the
23329 &%create_directory%& option, their mode is specified by this option.
23330
23331
23332 .option escape_string appendfile string "see description"
23333 See &%check_string%& above.
23334
23335
23336 .option file appendfile string&!! unset
23337 This option is mutually exclusive with the &%directory%& option, but one of
23338 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23339 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23340 specifies a single file, to which the message is appended. One or more of
23341 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23342 &%file%&.
23343
23344 The result of expansion must not be tainted, unless the &%create_file%& option
23345 specifies a path.
23346
23347 .cindex "NFS" "lock file"
23348 .cindex "locking files"
23349 .cindex "lock files"
23350 If you are using more than one host to deliver over NFS into the same
23351 mailboxes, you should always use lock files.
23352
23353 The string value is expanded for each delivery, and must yield an absolute
23354 path. The most common settings of this option are variations on one of these
23355 examples:
23356 .code
23357 file = /var/spool/mail/$local_part_data
23358 file = /home/$local_part_data/inbox
23359 file = $home/inbox
23360 .endd
23361 .cindex "&""sticky""& bit"
23362 In the first example, all deliveries are done into the same directory. If Exim
23363 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23364 create a file in the directory, so the &"sticky"& bit must be turned on for
23365 deliveries to be possible, or alternatively the &%group%& option can be used to
23366 run the delivery under a group id which has write access to the directory.
23367
23368
23369
23370 .option file_format appendfile string unset
23371 .cindex "file" "mailbox; checking existing format"
23372 This option requests the transport to check the format of an existing file
23373 before adding to it. The check consists of matching a specific string at the
23374 start of the file. The value of the option consists of an even number of
23375 colon-separated strings. The first of each pair is the test string, and the
23376 second is the name of a transport. If the transport associated with a matched
23377 string is not the current transport, control is passed over to the other
23378 transport. For example, suppose the standard &(local_delivery)& transport has
23379 this added to it:
23380 .code
23381 file_format = "From       : local_delivery :\
23382                \1\1\1\1\n : local_mmdf_delivery"
23383 .endd
23384 Mailboxes that begin with &"From"& are still handled by this transport, but if
23385 a mailbox begins with four binary ones followed by a newline, control is passed
23386 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23387 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23388 is assumed to match the current transport. If the start of a mailbox doesn't
23389 match any string, or if the transport named for a given string is not defined,
23390 delivery is deferred.
23391
23392
23393 .option file_must_exist appendfile boolean false
23394 If this option is true, the file specified by the &%file%& option must exist.
23395 A temporary error occurs if it does not, causing delivery to be deferred.
23396 If this option is false, the file is created if it does not exist.
23397
23398
23399 .option lock_fcntl_timeout appendfile time 0s
23400 .cindex "timeout" "mailbox locking"
23401 .cindex "mailbox" "locking, blocking and non-blocking"
23402 .cindex "locking files"
23403 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23404 when locking an open mailbox file. If the call fails, the delivery process
23405 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23406 Non-blocking calls are used so that the file is not kept open during the wait
23407 for the lock; the reason for this is to make it as safe as possible for
23408 deliveries over NFS in the case when processes might be accessing an NFS
23409 mailbox without using a lock file. This should not be done, but
23410 misunderstandings and hence misconfigurations are not unknown.
23411
23412 On a busy system, however, the performance of a non-blocking lock approach is
23413 not as good as using a blocking lock with a timeout. In this case, the waiting
23414 is done inside the system call, and Exim's delivery process acquires the lock
23415 and can proceed as soon as the previous lock holder releases it.
23416
23417 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23418 timeout, are used. There may still be some retrying: the maximum number of
23419 retries is
23420 .code
23421 (lock_retries * lock_interval) / lock_fcntl_timeout
23422 .endd
23423 rounded up to the next whole number. In other words, the total time during
23424 which &(appendfile)& is trying to get a lock is roughly the same, unless
23425 &%lock_fcntl_timeout%& is set very large.
23426
23427 You should consider setting this option if you are getting a lot of delayed
23428 local deliveries because of errors of the form
23429 .code
23430 failed to lock mailbox /some/file (fcntl)
23431 .endd
23432
23433 .option lock_flock_timeout appendfile time 0s
23434 This timeout applies to file locking when using &[flock()]& (see
23435 &%use_flock%&); the timeout operates in a similar manner to
23436 &%lock_fcntl_timeout%&.
23437
23438
23439 .option lock_interval appendfile time 3s
23440 This specifies the time to wait between attempts to lock the file. See below
23441 for details of locking.
23442
23443
23444 .option lock_retries appendfile integer 10
23445 This specifies the maximum number of attempts to lock the file. A value of zero
23446 is treated as 1. See below for details of locking.
23447
23448
23449 .option lockfile_mode appendfile "octal integer" 0600
23450 This specifies the mode of the created lock file, when a lock file is being
23451 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23452
23453
23454 .option lockfile_timeout appendfile time 30m
23455 .cindex "timeout" "mailbox locking"
23456 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23457 exists and is older than this value, it is assumed to have been left behind by
23458 accident, and Exim attempts to remove it.
23459
23460
23461 .option mailbox_filecount appendfile string&!! unset
23462 .cindex "mailbox" "specifying size of"
23463 .cindex "size" "of mailbox"
23464 If this option is set, it is expanded, and the result is taken as the current
23465 number of files in the mailbox. It must be a decimal number, optionally
23466 followed by K or M. This provides a way of obtaining this information from an
23467 external source that maintains the data.
23468
23469
23470 .option mailbox_size appendfile string&!! unset
23471 .cindex "mailbox" "specifying size of"
23472 .cindex "size" "of mailbox"
23473 If this option is set, it is expanded, and the result is taken as the current
23474 size the mailbox. It must be a decimal number, optionally followed by K or M.
23475 This provides a way of obtaining this information from an external source that
23476 maintains the data. This is likely to be helpful for maildir deliveries where
23477 it is computationally expensive to compute the size of a mailbox.
23478
23479
23480
23481 .option maildir_format appendfile boolean false
23482 .cindex "maildir format" "specifying"
23483 If this option is set with the &%directory%& option, the delivery is into a new
23484 file, in the &"maildir"& format that is used by other mail software. When the
23485 transport is activated directly from a &(redirect)& router (for example, the
23486 &(address_file)& transport in the default configuration), setting
23487 &%maildir_format%& causes the path received from the router to be treated as a
23488 directory, whether or not it ends with &`/`&. This option is available only if
23489 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23490 &<<SECTmaildirdelivery>>& below for further details.
23491
23492
23493 .option maildir_quota_directory_regex appendfile string "See below"
23494 .cindex "maildir format" "quota; directories included in"
23495 .cindex "quota" "maildir; directories included in"
23496 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23497 a regular expression for specifying directories, relative to the quota
23498 directory (see &%quota_directory%&), that should be included in the quota
23499 calculation. The default value is:
23500 .code
23501 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23502 .endd
23503 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23504 (directories whose names begin with a dot). If you want to exclude the
23505 &_Trash_&
23506 folder from the count (as some sites do), you need to change this setting to
23507 .code
23508 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23509 .endd
23510 This uses a negative lookahead in the regular expression to exclude the
23511 directory whose name is &_.Trash_&. When a directory is excluded from quota
23512 calculations, quota processing is bypassed for any messages that are delivered
23513 directly into that directory.
23514
23515
23516 .option maildir_retries appendfile integer 10
23517 This option specifies the number of times to retry when writing a file in
23518 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23519
23520
23521 .option maildir_tag appendfile string&!! unset
23522 This option applies only to deliveries in maildir format, and is described in
23523 section &<<SECTmaildirdelivery>>& below.
23524
23525
23526 .option maildir_use_size_file appendfile&!! boolean false
23527 .cindex "maildir format" "&_maildirsize_& file"
23528 The result of string expansion for this option must be a valid boolean value.
23529 If it is true, it enables support for &_maildirsize_& files. Exim
23530 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23531 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23532 value is zero. See &%maildir_quota_directory_regex%& above and section
23533 &<<SECTmaildirdelivery>>& below for further details.
23534
23535 .option maildirfolder_create_regex appendfile string unset
23536 .cindex "maildir format" "&_maildirfolder_& file"
23537 .cindex "&_maildirfolder_&, creating"
23538 The value of this option is a regular expression. If it is unset, it has no
23539 effect. Otherwise, before a maildir delivery takes place, the pattern is
23540 matched against the name of the maildir directory, that is, the directory
23541 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23542 delivery. If there is a match, Exim checks for the existence of a file called
23543 &_maildirfolder_& in the directory, and creates it if it does not exist.
23544 See section &<<SECTmaildirdelivery>>& for more details.
23545
23546
23547 .option mailstore_format appendfile boolean false
23548 .cindex "mailstore format" "specifying"
23549 If this option is set with the &%directory%& option, the delivery is into two
23550 new files in  &"mailstore"& format. The option is available only if
23551 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23552 below for further details.
23553
23554
23555 .option mailstore_prefix appendfile string&!! unset
23556 This option applies only to deliveries in mailstore format, and is described in
23557 section &<<SECTopdir>>& below.
23558
23559
23560 .option mailstore_suffix appendfile string&!! unset
23561 This option applies only to deliveries in mailstore format, and is described in
23562 section &<<SECTopdir>>& below.
23563
23564
23565 .option mbx_format appendfile boolean false
23566 .cindex "locking files"
23567 .cindex "file" "locking"
23568 .cindex "file" "MBX format"
23569 .cindex "MBX format, specifying"
23570 This option is available only if Exim has been compiled with SUPPORT_MBX
23571 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23572 the message is appended to the mailbox file in MBX format instead of
23573 traditional Unix format. This format is supported by Pine4 and its associated
23574 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23575
23576 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23577 automatically changed by the use of &%mbx_format%&. They should normally be set
23578 empty when using MBX format, so this option almost always appears in this
23579 combination:
23580 .code
23581 mbx_format = true
23582 message_prefix =
23583 message_suffix =
23584 .endd
23585 If none of the locking options are mentioned in the configuration,
23586 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23587 is possible to specify the other kinds of locking with &%mbx_format%&, but
23588 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23589 interworks with &'c-client'&, providing for shared access to the mailbox. It
23590 should not be used if any program that does not use this form of locking is
23591 going to access the mailbox, nor should it be used if the mailbox file is NFS
23592 mounted, because it works only when the mailbox is accessed from a single host.
23593
23594 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23595 the standard version of &'c-client'&, because as long as it has a mailbox open
23596 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23597 append messages to it.
23598
23599
23600 .option message_prefix appendfile string&!! "see below"
23601 .cindex "&""From""& line"
23602 The string specified here is expanded and output at the start of every message.
23603 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23604 in which case it is:
23605 .code
23606 message_prefix = "From ${if def:return_path{$return_path}\
23607   {MAILER-DAEMON}} $tod_bsdinbox\n"
23608 .endd
23609 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23610 &`\n`& to &`\r\n`& in &%message_prefix%&.
23611
23612 .option message_suffix appendfile string&!! "see below"
23613 The string specified here is expanded and output at the end of every message.
23614 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23615 in which case it is a single newline character. The suffix can be suppressed by
23616 setting
23617 .code
23618 message_suffix =
23619 .endd
23620 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23621 &`\n`& to &`\r\n`& in &%message_suffix%&.
23622
23623 .option mode appendfile "octal integer" 0600
23624 If the output file is created, it is given this mode. If it already exists and
23625 has wider permissions, they are reduced to this mode. If it has narrower
23626 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23627 if the delivery is the result of a &%save%& command in a filter file specifying
23628 a particular mode, the mode of the output file is always forced to take that
23629 value, and this option is ignored.
23630
23631
23632 .option mode_fail_narrower appendfile boolean true
23633 This option applies in the case when an existing mailbox file has a narrower
23634 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23635 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23636 continues with the delivery attempt, using the existing mode of the file.
23637
23638
23639 .option notify_comsat appendfile boolean false
23640 If this option is true, the &'comsat'& daemon is notified after every
23641 successful delivery to a user mailbox. This is the daemon that notifies logged
23642 on users about incoming mail.
23643
23644
23645 .option quota appendfile string&!! unset
23646 .cindex "quota" "imposed by Exim"
23647 This option imposes a limit on the size of the file to which Exim is appending,
23648 or to the total space used in the directory tree when the &%directory%& option
23649 is set. In the latter case, computation of the space used is expensive, because
23650 all the files in the directory (and any sub-directories) have to be
23651 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23652 &%maildir_use_size_file%& for ways to avoid this in environments where users
23653 have no shell access to their mailboxes).
23654
23655 As there is no interlock against two simultaneous deliveries into a
23656 multi-file mailbox, it is possible for the quota to be overrun in this case.
23657 For single-file mailboxes, of course, an interlock is a necessity.
23658
23659 A file's size is taken as its &'used'& value. Because of blocking effects, this
23660 may be a lot less than the actual amount of disk space allocated to the file.
23661 If the sizes of a number of files are being added up, the rounding effect can
23662 become quite noticeable, especially on systems that have large block sizes.
23663 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23664 the obvious value which users understand most easily.
23665
23666 The value of the option is expanded, and must then be a numerical value
23667 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23668 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23669 and further option modifiers. If Exim is running on a system with
23670 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23671 be handled.
23672
23673 The option modifier &%no_check%& can be used to force delivery even if the over
23674 quota condition is met. The quota gets updated as usual.
23675
23676 &*Note*&: A value of zero is interpreted as &"no quota"&.
23677
23678 The expansion happens while Exim is running as root, before it changes uid for
23679 the delivery. This means that files that are inaccessible to the end user can
23680 be used to hold quota values that are looked up in the expansion. When delivery
23681 fails because this quota is exceeded, the handling of the error is as for
23682 system quota failures.
23683
23684 By default, Exim's quota checking mimics system quotas, and restricts the
23685 mailbox to the specified maximum size, though the value is not accurate to the
23686 last byte, owing to separator lines and additional headers that may get added
23687 during message delivery. When a mailbox is nearly full, large messages may get
23688 refused even though small ones are accepted, because the size of the current
23689 message is added to the quota when the check is made. This behaviour can be
23690 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23691 for exceeding the quota does not include the current message. Thus, deliveries
23692 continue until the quota has been exceeded; thereafter, no further messages are
23693 delivered. See also &%quota_warn_threshold%&.
23694
23695
23696 .option quota_directory appendfile string&!! unset
23697 This option defines the directory to check for quota purposes when delivering
23698 into individual files. The default is the delivery directory, or, if a file
23699 called &_maildirfolder_& exists in a maildir directory, the parent of the
23700 delivery directory.
23701
23702
23703 .option quota_filecount appendfile string&!! 0
23704 This option applies when the &%directory%& option is set. It limits the total
23705 number of files in the directory (compare the inode limit in system quotas). It
23706 can only be used if &%quota%& is also set. The value is expanded; an expansion
23707 failure causes delivery to be deferred. A value of zero is interpreted as
23708 &"no quota"&.
23709
23710 The option modifier &%no_check%& can be used to force delivery even if the over
23711 quota condition is met. The quota gets updated as usual.
23712
23713 .option quota_is_inclusive appendfile boolean true
23714 See &%quota%& above.
23715
23716
23717 .option quota_size_regex appendfile string unset
23718 This option applies when one of the delivery modes that writes a separate file
23719 for each message is being used. When Exim wants to find the size of one of
23720 these files in order to test the quota, it first checks &%quota_size_regex%&.
23721 If this is set to a regular expression that matches the filename, and it
23722 captures one string, that string is interpreted as a representation of the
23723 file's size. The value of &%quota_size_regex%& is not expanded.
23724
23725 This feature is useful only when users have no shell access to their mailboxes
23726 &-- otherwise they could defeat the quota simply by renaming the files. This
23727 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23728 the file length to the filename. For example:
23729 .code
23730 maildir_tag = ,S=$message_size
23731 quota_size_regex = ,S=(\d+)
23732 .endd
23733 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23734 number of lines in the message.
23735
23736 The regular expression should not assume that the length is at the end of the
23737 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23738 sometimes add other information onto the ends of message filenames.
23739
23740 Section &<<SECID136>>& contains further information.
23741
23742 This option should not be used when other message-handling software
23743 may duplicate messages by making hardlinks to the files.  When that is done Exim
23744 will count the message size once for each filename, in contrast with the actual
23745 disk usage.  When the option is not set, calculating total usage requires
23746 a system-call per file to get the size; the number of links is then available also
23747 as is used to adjust the effective size.
23748
23749
23750 .option quota_warn_message appendfile string&!! "see below"
23751 See below for the use of this option. If it is not set when
23752 &%quota_warn_threshold%& is set, it defaults to
23753 .code
23754 quota_warn_message = "\
23755   To: $local_part@$domain\n\
23756   Subject: Your mailbox\n\n\
23757   This message is automatically created \
23758   by mail delivery software.\n\n\
23759   The size of your mailbox has exceeded \
23760   a warning threshold that is\n\
23761   set by the system administrator.\n"
23762 .endd
23763
23764
23765 .option quota_warn_threshold appendfile string&!! 0
23766 .cindex "quota" "warning threshold"
23767 .cindex "mailbox" "size warning"
23768 .cindex "size" "of mailbox"
23769 This option is expanded in the same way as &%quota%& (see above). If the
23770 resulting value is greater than zero, and delivery of the message causes the
23771 size of the file or total space in the directory tree to cross the given
23772 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23773 may be specified as a percentage of it by following the value with a percent
23774 sign. For example:
23775 .code
23776 quota = 10M
23777 quota_warn_threshold = 75%
23778 .endd
23779 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23780 percent sign is ignored.
23781
23782 The warning message itself is specified by the &%quota_warn_message%& option,
23783 and it must start with a &'To:'& header line containing the recipient(s) of the
23784 warning message. These do not necessarily have to include the recipient(s) of
23785 the original message. A &'Subject:'& line should also normally be supplied. You
23786 can include any other header lines that you want. If you do not include a
23787 &'From:'& line, the default is:
23788 .code
23789 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23790 .endd
23791 .oindex &%errors_reply_to%&
23792 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23793 option.
23794
23795 The &%quota%& option does not have to be set in order to use this option; they
23796 are independent of one another except when the threshold is specified as a
23797 percentage.
23798
23799
23800 .option use_bsmtp appendfile boolean false
23801 .cindex "envelope from"
23802 .cindex "envelope sender"
23803 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23804 format, with the envelope sender and recipient(s) included as SMTP commands. If
23805 you want to include a leading HELO command with such messages, you can do
23806 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23807 for details of batch SMTP.
23808
23809
23810 .option use_crlf appendfile boolean false
23811 .cindex "carriage return"
23812 .cindex "linefeed"
23813 This option causes lines to be terminated with the two-character CRLF sequence
23814 (carriage return, linefeed) instead of just a linefeed character. In the case
23815 of batched SMTP, the byte sequence written to the file is then an exact image
23816 of what would be sent down a real SMTP connection.
23817
23818 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23819 (which are used to supply the traditional &"From&~"& and blank line separators
23820 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23821 carriage return characters if these are needed. In cases where these options
23822 have non-empty defaults, the values end with a single linefeed, so they must be
23823 changed to end with &`\r\n`& if &%use_crlf%& is set.
23824
23825
23826 .option use_fcntl_lock appendfile boolean "see below"
23827 This option controls the use of the &[fcntl()]& function to lock a file for
23828 exclusive use when a message is being appended. It is set by default unless
23829 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23830 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23831 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23832
23833
23834 .option use_flock_lock appendfile boolean false
23835 This option is provided to support the use of &[flock()]& for file locking, for
23836 the few situations where it is needed. Most modern operating systems support
23837 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23838 each other. Exim uses &[fcntl()]& locking by default.
23839
23840 This option is required only if you are using an operating system where
23841 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23842 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23843 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23844
23845 .cindex "Solaris" "&[flock()]& support"
23846 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23847 have it (and some, I think, provide a not quite right version built on top of
23848 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23849 the ability to use it, and any attempt to do so will cause a configuration
23850 error.
23851
23852 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23853 is just being mapped onto &[fcntl()]& by the OS).
23854
23855
23856 .option use_lockfile appendfile boolean "see below"
23857 If this option is turned off, Exim does not attempt to create a lock file when
23858 appending to a mailbox file. In this situation, the only locking is by
23859 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23860 sure that every MUA that is ever going to look at your users' mailboxes uses
23861 &[fcntl()]& rather than a lock file, and even then only when you are not
23862 delivering over NFS from more than one host.
23863
23864 .cindex "NFS" "lock file"
23865 In order to append to an NFS file safely from more than one host, it is
23866 necessary to take out a lock &'before'& opening the file, and the lock file
23867 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23868 file corruption.
23869
23870 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23871 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23872 except when &%mbx_format%& is set.
23873
23874
23875 .option use_mbx_lock appendfile boolean "see below"
23876 This option is available only if Exim has been compiled with SUPPORT_MBX
23877 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23878 locking rules be used. It is set by default if &%mbx_format%& is set and none
23879 of the locking options are mentioned in the configuration. The locking rules
23880 are the same as are used by the &'c-client'& library that underlies Pine and
23881 the IMAP4 and POP daemons that come with it (see the discussion below). The
23882 rules allow for shared access to the mailbox. However, this kind of locking
23883 does not work when the mailbox is NFS mounted.
23884
23885 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23886 &%use_flock_lock%& to control what kind of locking is used in implementing the
23887 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23888 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23889
23890
23891
23892
23893 .section "Operational details for appending" "SECTopappend"
23894 .cindex "appending to a file"
23895 .cindex "file" "appending"
23896 Before appending to a file, the following preparations are made:
23897
23898 .ilist
23899 If the name of the file is &_/dev/null_&, no action is taken, and a success
23900 return is given.
23901
23902 .next
23903 .cindex "directory creation"
23904 If any directories on the file's path are missing, Exim creates them if the
23905 &%create_directory%& option is set. A created directory's mode is given by the
23906 &%directory_mode%& option.
23907
23908 .next
23909 If &%file_format%& is set, the format of an existing file is checked. If this
23910 indicates that a different transport should be used, control is passed to that
23911 transport.
23912
23913 .next
23914 .cindex "file" "locking"
23915 .cindex "locking files"
23916 .cindex "NFS" "lock file"
23917 If &%use_lockfile%& is set, a lock file is built in a way that will work
23918 reliably over NFS, as follows:
23919
23920 .olist
23921 Create a &"hitching post"& file whose name is that of the lock file with the
23922 current time, primary host name, and process id added, by opening for writing
23923 as a new file. If this fails with an access error, delivery is deferred.
23924 .next
23925 Close the hitching post file, and hard link it to the lock filename.
23926 .next
23927 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23928 Unlink the hitching post name.
23929 .next
23930 Otherwise, use &[stat()]& to get information about the hitching post file, and
23931 then unlink hitching post name. If the number of links is exactly two, creation
23932 of the lock file succeeded but something (for example, an NFS server crash and
23933 restart) caused this fact not to be communicated to the &[link()]& call.
23934 .next
23935 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23936 up to &%lock_retries%& times. However, since any program that writes to a
23937 mailbox should complete its task very quickly, it is reasonable to time out old
23938 lock files that are normally the result of user agent and system crashes. If an
23939 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23940 it before trying again.
23941 .endlist olist
23942
23943 .next
23944 A call is made to &[lstat()]& to discover whether the main file exists, and if
23945 so, what its characteristics are. If &[lstat()]& fails for any reason other
23946 than non-existence, delivery is deferred.
23947
23948 .next
23949 .cindex "symbolic link" "to mailbox"
23950 .cindex "mailbox" "symbolic link"
23951 If the file does exist and is a symbolic link, delivery is deferred, unless the
23952 &%allow_symlink%& option is set, in which case the ownership of the link is
23953 checked, and then &[stat()]& is called to find out about the real file, which
23954 is then subjected to the checks below. The check on the top-level link
23955 ownership prevents one user creating a link for another's mailbox in a sticky
23956 directory, though allowing symbolic links in this case is definitely not a good
23957 idea. If there is a chain of symbolic links, the intermediate ones are not
23958 checked.
23959
23960 .next
23961 If the file already exists but is not a regular file, or if the file's owner
23962 and group (if the group is being checked &-- see &%check_group%& above) are
23963 different from the user and group under which the delivery is running,
23964 delivery is deferred.
23965
23966 .next
23967 If the file's permissions are more generous than specified, they are reduced.
23968 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23969 is set false, in which case the delivery is tried using the existing
23970 permissions.
23971
23972 .next
23973 The file's inode number is saved, and the file is then opened for appending.
23974 If this fails because the file has vanished, &(appendfile)& behaves as if it
23975 hadn't existed (see below). For any other failures, delivery is deferred.
23976
23977 .next
23978 If the file is opened successfully, check that the inode number hasn't
23979 changed, that it is still a regular file, and that the owner and permissions
23980 have not changed. If anything is wrong, defer delivery and freeze the message.
23981
23982 .next
23983 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23984 option is set. Otherwise, check that the file is being created in a permitted
23985 directory if the &%create_file%& option is set (deferring on failure), and then
23986 open for writing as a new file, with the O_EXCL and O_CREAT options,
23987 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23988 set). In this case, which can happen if the link points to a non-existent file,
23989 the file is opened for writing using O_CREAT but not O_EXCL, because
23990 that prevents link following.
23991
23992 .next
23993 .cindex "loop" "while file testing"
23994 If opening fails because the file exists, obey the tests given above for
23995 existing files. However, to avoid looping in a situation where the file is
23996 being continuously created and destroyed, the exists/not-exists loop is broken
23997 after 10 repetitions, and the message is then frozen.
23998
23999 .next
24000 If opening fails with any other error, defer delivery.
24001
24002 .next
24003 .cindex "file" "locking"
24004 .cindex "locking files"
24005 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24006 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24007 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24008 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24009 file, and an exclusive lock on the file whose name is
24010 .code
24011 /tmp/.<device-number>.<inode-number>
24012 .endd
24013 using the device and inode numbers of the open mailbox file, in accordance with
24014 the MBX locking rules. This file is created with a mode that is specified by
24015 the &%lockfile_mode%& option.
24016
24017 If Exim fails to lock the file, there are two possible courses of action,
24018 depending on the value of the locking timeout. This is obtained from
24019 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24020
24021 If the timeout value is zero, the file is closed, Exim waits for
24022 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24023 to lock it again. This happens up to &%lock_retries%& times, after which the
24024 delivery is deferred.
24025
24026 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24027 &[flock()]& are used (with the given timeout), so there has already been some
24028 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24029 immediately. It retries up to
24030 .code
24031 (lock_retries * lock_interval) / <timeout>
24032 .endd
24033 times (rounded up).
24034 .endlist
24035
24036 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24037 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24038
24039
24040 .section "Operational details for delivery to a new file" "SECTopdir"
24041 .cindex "delivery" "to single file"
24042 .cindex "&""From""& line"
24043 When the &%directory%& option is set instead of &%file%&, each message is
24044 delivered into a newly-created file or set of files. When &(appendfile)& is
24045 activated directly from a &(redirect)& router, neither &%file%& nor
24046 &%directory%& is normally set, because the path for delivery is supplied by the
24047 router. (See for example, the &(address_file)& transport in the default
24048 configuration.) In this case, delivery is to a new file if either the path name
24049 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24050
24051 No locking is required while writing the message to a new file, so the various
24052 locking options of the transport are ignored. The &"From"& line that by default
24053 separates messages in a single file is not normally needed, nor is the escaping
24054 of message lines that start with &"From"&, and there is no need to ensure a
24055 newline at the end of each message. Consequently, the default values for
24056 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24057 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24058
24059 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24060 the files in the delivery directory by default. However, you can specify a
24061 different directory by setting &%quota_directory%&. Also, for maildir
24062 deliveries (see below) the &_maildirfolder_& convention is honoured.
24063
24064
24065 .cindex "maildir format"
24066 .cindex "mailstore format"
24067 There are three different ways in which delivery to individual files can be
24068 done, controlled by the settings of the &%maildir_format%& and
24069 &%mailstore_format%& options. Note that code to support maildir or mailstore
24070 formats is not included in the binary unless SUPPORT_MAILDIR or
24071 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24072
24073 .cindex "directory creation"
24074 In all three cases an attempt is made to create the directory and any necessary
24075 sub-directories if they do not exist, provided that the &%create_directory%&
24076 option is set (the default). The location of a created directory can be
24077 constrained by setting &%create_file%&. A created directory's mode is given by
24078 the &%directory_mode%& option. If creation fails, or if the
24079 &%create_directory%& option is not set when creation is required, delivery is
24080 deferred.
24081
24082
24083
24084 .section "Maildir delivery" "SECTmaildirdelivery"
24085 .cindex "maildir format" "description of"
24086 If the &%maildir_format%& option is true, Exim delivers each message by writing
24087 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24088 directory that is defined by the &%directory%& option (the &"delivery
24089 directory"&). If the delivery is successful, the file is renamed into the
24090 &_new_& subdirectory.
24091
24092 In the filename, <&'stime'&> is the current time of day in seconds, and
24093 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24094 Exim checks that the time-of-day clock has moved on by at least one microsecond
24095 before terminating the delivery process. This guarantees uniqueness for the
24096 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24097 opening it. If any response other than ENOENT (does not exist) is given,
24098 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24099
24100 Before Exim carries out a maildir delivery, it ensures that subdirectories
24101 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24102 do not exist, Exim tries to create them and any superior directories in their
24103 path, subject to the &%create_directory%& and &%create_file%& options. If the
24104 &%maildirfolder_create_regex%& option is set, and the regular expression it
24105 contains matches the delivery directory, Exim also ensures that a file called
24106 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24107 &_maildirfolder_& file cannot be created, delivery is deferred.
24108
24109 These features make it possible to use Exim to create all the necessary files
24110 and directories in a maildir mailbox, including subdirectories for maildir++
24111 folders. Consider this example:
24112 .code
24113 maildir_format = true
24114 directory = /var/mail/$local_part_data\
24115            ${if eq{$local_part_suffix}{}{}\
24116            {/.${substr_1:$local_part_suffix}}}
24117 maildirfolder_create_regex = /\.[^/]+$
24118 .endd
24119 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24120 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24121 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24122 not match this name, so Exim will not look for or create the file
24123 &_/var/mail/pimbo/maildirfolder_&, though it will create
24124 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24125
24126 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24127 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24128 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24129 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24130 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24131
24132 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24133 not inadvertently match the toplevel maildir directory, because a
24134 &_maildirfolder_& file at top level would completely break quota calculations.
24135
24136 .cindex "quota" "in maildir delivery"
24137 .cindex "maildir++"
24138 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24139 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24140 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24141 Exim assumes the directory is a maildir++ folder directory, which is one level
24142 down from the user's top level mailbox directory. This causes it to start at
24143 the parent directory instead of the current directory when calculating the
24144 amount of space used.
24145
24146 One problem with delivering into a multi-file mailbox is that it is
24147 computationally expensive to compute the size of the mailbox for quota
24148 checking. Various approaches have been taken to reduce the amount of work
24149 needed. The next two sections describe two of them. A third alternative is to
24150 use some external process for maintaining the size data, and use the expansion
24151 of the &%mailbox_size%& option as a way of importing it into Exim.
24152
24153
24154
24155
24156 .section "Using tags to record message sizes" "SECID135"
24157 If &%maildir_tag%& is set, the string is expanded for each delivery.
24158 When the maildir file is renamed into the &_new_& sub-directory, the
24159 tag is added to its name. However, if adding the tag takes the length of the
24160 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24161 the tag is dropped and the maildir file is created with no tag.
24162
24163
24164 .vindex "&$message_size$&"
24165 Tags can be used to encode the size of files in their names; see
24166 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24167 happens after the message has been written. The value of the &$message_size$&
24168 variable is set to the number of bytes actually written. If the expansion is
24169 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24170 be deferred. The expanded tag may contain any printing characters except &"/"&.
24171 Non-printing characters in the string are ignored; if the resulting string is
24172 empty, it is ignored. If it starts with an alphanumeric character, a leading
24173 colon is inserted; this default has not proven to be the path that popular
24174 maildir implementations have chosen (but changing it in Exim would break
24175 backwards compatibility).
24176
24177 For one common implementation, you might set:
24178 .code
24179 maildir_tag = ,S=${message_size}
24180 .endd
24181 but you should check the documentation of the other software to be sure.
24182
24183 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24184 as this allows Exim to extract the size from your tag, instead of having to
24185 &[stat()]& each message file.
24186
24187
24188 .section "Using a maildirsize file" "SECID136"
24189 .cindex "quota" "in maildir delivery"
24190 .cindex "maildir format" "&_maildirsize_& file"
24191 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24192 storing quota and message size information in a file called &_maildirsize_&
24193 within the toplevel maildir directory. If this file does not exist, Exim
24194 creates it, setting the quota from the &%quota%& option of the transport. If
24195 the maildir directory itself does not exist, it is created before any attempt
24196 to write a &_maildirsize_& file.
24197
24198 The &_maildirsize_& file is used to hold information about the sizes of
24199 messages in the maildir, thus speeding up quota calculations. The quota value
24200 in the file is just a cache; if the quota is changed in the transport, the new
24201 value overrides the cached value when the next message is delivered. The cache
24202 is maintained for the benefit of other programs that access the maildir and
24203 need to know the quota.
24204
24205 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24206 file is maintained (with a zero quota setting), but no quota is imposed.
24207
24208 A regular expression is available for controlling which directories in the
24209 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24210 See the description of the &%maildir_quota_directory_regex%& option above for
24211 details.
24212
24213
24214 .section "Mailstore delivery" "SECID137"
24215 .cindex "mailstore format" "description of"
24216 If the &%mailstore_format%& option is true, each message is written as two
24217 files in the given directory. A unique base name is constructed from the
24218 message id and the current delivery process, and the files that are written use
24219 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24220 contains the message's envelope, and the &_.msg_& file contains the message
24221 itself. The base name is placed in the variable &$mailstore_basename$&.
24222
24223 During delivery, the envelope is first written to a file with the suffix
24224 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24225 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24226 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24227 file before accessing either of them. An alternative approach is to wait for
24228 the absence of a &_.tmp_& file.
24229
24230 The envelope file starts with any text defined by the &%mailstore_prefix%&
24231 option, expanded and terminated by a newline if there isn't one. Then follows
24232 the sender address on one line, then all the recipient addresses, one per line.
24233 There can be more than one recipient only if the &%batch_max%& option is set
24234 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24235 appended to the file, followed by a newline if it does not end with one.
24236
24237 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24238 failure, it is ignored. Other expansion errors are treated as serious
24239 configuration errors, and delivery is deferred. The variable
24240 &$mailstore_basename$& is available for use during these expansions.
24241
24242
24243 .section "Non-special new file delivery" "SECID138"
24244 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24245 file is created directly in the named directory. For example, when delivering
24246 messages into files in batched SMTP format for later delivery to some host (see
24247 section &<<SECTbatchSMTP>>&), a setting such as
24248 .code
24249 directory = /var/bsmtp/$host
24250 .endd
24251 might be used. A message is written to a file with a temporary name, which is
24252 then renamed when the delivery is complete. The final name is obtained by
24253 expanding the contents of the &%directory_file%& option.
24254 .ecindex IIDapptra1
24255 .ecindex IIDapptra2
24256
24257
24258
24259
24260
24261
24262 . ////////////////////////////////////////////////////////////////////////////
24263 . ////////////////////////////////////////////////////////////////////////////
24264
24265 .chapter "The autoreply transport" "CHID8"
24266 .scindex IIDauttra1 "transports" "&(autoreply)&"
24267 .scindex IIDauttra2 "&(autoreply)& transport"
24268 The &(autoreply)& transport is not a true transport in that it does not cause
24269 the message to be transmitted. Instead, it generates a new mail message as an
24270 automatic reply to the incoming message. &'References:'& and
24271 &'Auto-Submitted:'& header lines are included. These are constructed according
24272 to the rules in RFCs 2822 and 3834, respectively.
24273
24274 If the router that passes the message to this transport does not have the
24275 &%unseen%& option set, the original message (for the current recipient) is not
24276 delivered anywhere. However, when the &%unseen%& option is set on the router
24277 that passes the message to this transport, routing of the address continues, so
24278 another router can set up a normal message delivery.
24279
24280
24281 The &(autoreply)& transport is usually run as the result of mail filtering, a
24282 &"vacation"& message being the standard example. However, it can also be run
24283 directly from a router like any other transport. To reduce the possibility of
24284 message cascades, messages created by the &(autoreply)& transport always have
24285 empty envelope sender addresses, like bounce messages.
24286
24287 The parameters of the message to be sent can be specified in the configuration
24288 by options described below. However, these are used only when the address
24289 passed to the transport does not contain its own reply information. When the
24290 transport is run as a consequence of a
24291 &%mail%&
24292 or &%vacation%& command in a filter file, the parameters of the message are
24293 supplied by the filter, and passed with the address. The transport's options
24294 that define the message are then ignored (so they are not usually set in this
24295 case). The message is specified entirely by the filter or by the transport; it
24296 is never built from a mixture of options. However, the &%file_optional%&,
24297 &%mode%&, and &%return_message%& options apply in all cases.
24298
24299 &(Autoreply)& is implemented as a local transport. When used as a result of a
24300 command in a user's filter file, &(autoreply)& normally runs under the uid and
24301 gid of the user, and with appropriate current and home directories (see chapter
24302 &<<CHAPenvironment>>&).
24303
24304 There is a subtle difference between routing a message to a &(pipe)& transport
24305 that generates some text to be returned to the sender, and routing it to an
24306 &(autoreply)& transport. This difference is noticeable only if more than one
24307 address from the same message is so handled. In the case of a pipe, the
24308 separate outputs from the different addresses are gathered up and returned to
24309 the sender in a single message, whereas if &(autoreply)& is used, a separate
24310 message is generated for each address that is passed to it.
24311
24312 Non-printing characters are not permitted in the header lines generated for the
24313 message that &(autoreply)& creates, with the exception of newlines that are
24314 immediately followed by white space. If any non-printing characters are found,
24315 the transport defers.
24316 Whether characters with the top bit set count as printing characters or not is
24317 controlled by the &%print_topbitchars%& global option.
24318
24319 If any of the generic options for manipulating headers (for example,
24320 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24321 of the original message that is included in the generated message when
24322 &%return_message%& is set. They do not apply to the generated message itself.
24323
24324 .vindex "&$sender_address$&"
24325 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24326 the message, indicating that there were no recipients, it does not treat this
24327 as an error. This means that autoreplies sent to &$sender_address$& when this
24328 is empty (because the incoming message is a bounce message) do not cause
24329 problems. They are just discarded.
24330
24331
24332
24333 .section "Private options for autoreply" "SECID139"
24334 .cindex "options" "&(autoreply)& transport"
24335
24336 .option bcc autoreply string&!! unset
24337 This specifies the addresses that are to receive &"blind carbon copies"& of the
24338 message when the message is specified by the transport.
24339
24340
24341 .option cc autoreply string&!! unset
24342 This specifies recipients of the message and the contents of the &'Cc:'& header
24343 when the message is specified by the transport.
24344
24345
24346 .option file autoreply string&!! unset
24347 The contents of the file are sent as the body of the message when the message
24348 is specified by the transport. If both &%file%& and &%text%& are set, the text
24349 string comes first.
24350
24351
24352 .option file_expand autoreply boolean false
24353 If this is set, the contents of the file named by the &%file%& option are
24354 subjected to string expansion as they are added to the message.
24355
24356
24357 .option file_optional autoreply boolean false
24358 If this option is true, no error is generated if the file named by the &%file%&
24359 option or passed with the address does not exist or cannot be read.
24360
24361
24362 .option from autoreply string&!! unset
24363 This specifies the contents of the &'From:'& header when the message is
24364 specified by the transport.
24365
24366
24367 .option headers autoreply string&!! unset
24368 This specifies additional RFC 2822 headers that are to be added to the message
24369 when the message is specified by the transport. Several can be given by using
24370 &"\n"& to separate them. There is no check on the format.
24371
24372
24373 .option log autoreply string&!! unset
24374 This option names a file in which a record of every message sent is logged when
24375 the message is specified by the transport.
24376
24377
24378 .option mode autoreply "octal integer" 0600
24379 If either the log file or the &"once"& file has to be created, this mode is
24380 used.
24381
24382
24383 .option never_mail autoreply "address list&!!" unset
24384 If any run of the transport creates a message with a recipient that matches any
24385 item in the list, that recipient is quietly discarded. If all recipients are
24386 discarded, no message is created. This applies both when the recipients are
24387 generated by a filter and when they are specified in the transport.
24388
24389
24390
24391 .option once autoreply string&!! unset
24392 This option names a file or DBM database in which a record of each &'To:'&
24393 recipient is kept when the message is specified by the transport. &*Note*&:
24394 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24395
24396 If &%once%& is unset, or is set to an empty string, the message is always sent.
24397 By default, if &%once%& is set to a non-empty filename, the message
24398 is not sent if a potential recipient is already listed in the database.
24399 However, if the &%once_repeat%& option specifies a time greater than zero, the
24400 message is sent if that much time has elapsed since a message was last sent to
24401 this recipient. A setting of zero time for &%once_repeat%& (the default)
24402 prevents a message from being sent a second time &-- in this case, zero means
24403 infinity.
24404
24405 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24406 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24407 greater than zero, it changes the way Exim implements the &%once%& option.
24408 Instead of using a DBM file to record every recipient it sends to, it uses a
24409 regular file, whose size will never get larger than the given value.
24410
24411 In the file, Exim keeps a linear list of recipient addresses and the times at
24412 which they were sent messages. If the file is full when a new address needs to
24413 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24414 means that a given recipient may receive multiple messages, but at
24415 unpredictable intervals that depend on the rate of turnover of addresses in the
24416 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24417
24418
24419 .option once_file_size autoreply integer 0
24420 See &%once%& above.
24421
24422
24423 .option once_repeat autoreply time&!! 0s
24424 See &%once%& above.
24425 After expansion, the value of this option must be a valid time value.
24426
24427
24428 .option reply_to autoreply string&!! unset
24429 This specifies the contents of the &'Reply-To:'& header when the message is
24430 specified by the transport.
24431
24432
24433 .option return_message autoreply boolean false
24434 If this is set, a copy of the original message is returned with the new
24435 message, subject to the maximum size set in the &%return_size_limit%& global
24436 configuration option.
24437
24438
24439 .option subject autoreply string&!! unset
24440 This specifies the contents of the &'Subject:'& header when the message is
24441 specified by the transport. It is tempting to quote the original subject in
24442 automatic responses. For example:
24443 .code
24444 subject = Re: $h_subject:
24445 .endd
24446 There is a danger in doing this, however. It may allow a third party to
24447 subscribe your users to an opt-in mailing list, provided that the list accepts
24448 bounce messages as subscription confirmations. Well-managed lists require a
24449 non-bounce message to confirm a subscription, so the danger is relatively
24450 small.
24451
24452
24453
24454 .option text autoreply string&!! unset
24455 This specifies a single string to be used as the body of the message when the
24456 message is specified by the transport. If both &%text%& and &%file%& are set,
24457 the text comes first.
24458
24459
24460 .option to autoreply string&!! unset
24461 This specifies recipients of the message and the contents of the &'To:'& header
24462 when the message is specified by the transport.
24463 .ecindex IIDauttra1
24464 .ecindex IIDauttra2
24465
24466
24467
24468
24469 . ////////////////////////////////////////////////////////////////////////////
24470 . ////////////////////////////////////////////////////////////////////////////
24471
24472 .chapter "The lmtp transport" "CHAPLMTP"
24473 .cindex "transports" "&(lmtp)&"
24474 .cindex "&(lmtp)& transport"
24475 .cindex "LMTP" "over a pipe"
24476 .cindex "LMTP" "over a socket"
24477 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24478 specified command
24479 or by interacting with a Unix domain socket.
24480 This transport is something of a cross between the &(pipe)& and &(smtp)&
24481 transports. Exim also has support for using LMTP over TCP/IP; this is
24482 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24483 to be of minority interest, the default build-time configure in &_src/EDITME_&
24484 has it commented out. You need to ensure that
24485 .code
24486 TRANSPORT_LMTP=yes
24487 .endd
24488 .cindex "options" "&(lmtp)& transport"
24489 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24490 included in the Exim binary. The private options of the &(lmtp)& transport are
24491 as follows:
24492
24493 .option batch_id lmtp string&!! unset
24494 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24495
24496
24497 .option batch_max lmtp integer 1
24498 This limits the number of addresses that can be handled in a single delivery.
24499 Most LMTP servers can handle several addresses at once, so it is normally a
24500 good idea to increase this value. See the description of local delivery
24501 batching in chapter &<<CHAPbatching>>&.
24502
24503
24504 .option command lmtp string&!! unset
24505 This option must be set if &%socket%& is not set. The string is a command which
24506 is run in a separate process. It is split up into a command name and list of
24507 arguments, each of which is separately expanded (so expansion cannot change the
24508 number of arguments). The command is run directly, not via a shell. The message
24509 is passed to the new process using the standard input and output to operate the
24510 LMTP protocol.
24511
24512 .option ignore_quota lmtp boolean false
24513 .cindex "LMTP" "ignoring quota errors"
24514 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24515 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24516 in its response to the LHLO command.
24517
24518 .option socket lmtp string&!! unset
24519 This option must be set if &%command%& is not set. The result of expansion must
24520 be the name of a Unix domain socket. The transport connects to the socket and
24521 delivers the message to it using the LMTP protocol.
24522
24523
24524 .option timeout lmtp time 5m
24525 The transport is aborted if the created process or Unix domain socket does not
24526 respond to LMTP commands or message input within this timeout. Delivery
24527 is deferred, and will be tried again later. Here is an example of a typical
24528 LMTP transport:
24529 .code
24530 lmtp:
24531   driver = lmtp
24532   command = /some/local/lmtp/delivery/program
24533   batch_max = 20
24534   user = exim
24535 .endd
24536 This delivers up to 20 addresses at a time, in a mixture of domains if
24537 necessary, running as the user &'exim'&.
24538
24539
24540
24541 . ////////////////////////////////////////////////////////////////////////////
24542 . ////////////////////////////////////////////////////////////////////////////
24543
24544 .chapter "The pipe transport" "CHAPpipetransport"
24545 .scindex IIDpiptra1 "transports" "&(pipe)&"
24546 .scindex IIDpiptra2 "&(pipe)& transport"
24547 The &(pipe)& transport is used to deliver messages via a pipe to a command
24548 running in another process. One example is the use of &(pipe)& as a
24549 pseudo-remote transport for passing messages to some other delivery mechanism
24550 (such as UUCP). Another is the use by individual users to automatically process
24551 their incoming messages. The &(pipe)& transport can be used in one of the
24552 following ways:
24553
24554 .ilist
24555 .vindex "&$local_part$&"
24556 A router routes one address to a transport in the normal way, and the
24557 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24558 contains the local part of the address (as usual), and the command that is run
24559 is specified by the &%command%& option on the transport.
24560 .next
24561 .vindex "&$pipe_addresses$&"
24562 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24563 transport can handle more than one address in a single run. In this case, when
24564 more than one address is routed to the transport, &$local_part$& is not set
24565 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24566 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24567 that are routed to the transport.
24568 .next
24569 .vindex "&$address_pipe$&"
24570 A router redirects an address directly to a pipe command (for example, from an
24571 alias or forward file). In this case, &$address_pipe$& contains the text of the
24572 pipe command, and the &%command%& option on the transport is ignored unless
24573 &%force_command%& is set. If only one address is being transported
24574 (&%batch_max%& is not greater than one, or only one address was redirected to
24575 this pipe command), &$local_part$& contains the local part that was redirected.
24576 .endlist
24577
24578
24579 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24580 deliver messages over pipes using the LMTP interactive protocol. This is
24581 implemented by the &(lmtp)& transport.
24582
24583 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24584 &_.forward_& file, the command runs under the uid and gid of that user. In
24585 other cases, the uid and gid have to be specified explicitly, either on the
24586 transport or on the router that handles the address. Current and &"home"&
24587 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24588 details of the local delivery environment and chapter &<<CHAPbatching>>&
24589 for a discussion of local delivery batching.
24590
24591 .cindex "tainted data" "in pipe command"
24592 .cindex pipe "tainted data"
24593 Tainted data may not be used for the command name.
24594
24595
24596 .section "Concurrent delivery" "SECID140"
24597 If two messages arrive at almost the same time, and both are routed to a pipe
24598 delivery, the two pipe transports may be run concurrently. You must ensure that
24599 any pipe commands you set up are robust against this happening. If the commands
24600 write to a file, the &%exim_lock%& utility might be of use.
24601 Alternatively the &%max_parallel%& option could be used with a value
24602 of "1" to enforce serialization.
24603
24604
24605
24606
24607 .section "Returned status and data" "SECID141"
24608 .cindex "&(pipe)& transport" "returned data"
24609 If the command exits with a non-zero return code, the delivery is deemed to
24610 have failed, unless either the &%ignore_status%& option is set (in which case
24611 the return code is treated as zero), or the return code is one of those listed
24612 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24613 later"&. In this case, delivery is deferred. Details of a permanent failure are
24614 logged, but are not included in the bounce message, which merely contains
24615 &"local delivery failed"&.
24616
24617 If the command exits on a signal and the &%freeze_signal%& option is set then
24618 the message will be frozen in the queue. If that option is not set, a bounce
24619 will be sent as normal.
24620
24621 If the return code is greater than 128 and the command being run is a shell
24622 script, it normally means that the script was terminated by a signal whose
24623 value is the return code minus 128. The &%freeze_signal%& option does not
24624 apply in this case.
24625
24626 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24627 return code is set to 127. This is the value that a shell returns if it is
24628 asked to run a non-existent command. The wording for the log line suggests that
24629 a non-existent command may be the problem.
24630
24631 The &%return_output%& option can affect the result of a pipe delivery. If it is
24632 set and the command produces any output on its standard output or standard
24633 error streams, the command is considered to have failed, even if it gave a zero
24634 return code or if &%ignore_status%& is set. The output from the command is
24635 included as part of the bounce message. The &%return_fail_output%& option is
24636 similar, except that output is returned only when the command exits with a
24637 failure return code, that is, a value other than zero or a code that matches
24638 &%temp_errors%&.
24639
24640
24641
24642 .section "How the command is run" "SECThowcommandrun"
24643 .cindex "&(pipe)& transport" "path for command"
24644 The command line is (by default) broken down into a command name and arguments
24645 by the &(pipe)& transport itself. The &%allow_commands%& and
24646 &%restrict_to_path%& options can be used to restrict the commands that may be
24647 run.
24648
24649 .cindex "quoting" "in pipe command"
24650 Unquoted arguments are delimited by white space. If an argument appears in
24651 double quotes, backslash is interpreted as an escape character in the usual
24652 way. If an argument appears in single quotes, no escaping is done.
24653
24654 String expansion is applied to the command line except when it comes from a
24655 traditional &_.forward_& file (commands from a filter file are expanded). The
24656 expansion is applied to each argument in turn rather than to the whole line.
24657 For this reason, any string expansion item that contains white space must be
24658 quoted so as to be contained within a single argument. A setting such as
24659 .code
24660 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24661 .endd
24662 will not work, because the expansion item gets split between several
24663 arguments. You have to write
24664 .code
24665 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24666 .endd
24667 to ensure that it is all in one argument. The expansion is done in this way,
24668 argument by argument, so that the number of arguments cannot be changed as a
24669 result of expansion, and quotes or backslashes in inserted variables do not
24670 interact with external quoting. However, this leads to problems if you want to
24671 generate multiple arguments (or the command name plus arguments) from a single
24672 expansion. In this situation, the simplest solution is to use a shell. For
24673 example:
24674 .code
24675 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24676 .endd
24677
24678 .cindex "transport" "filter"
24679 .cindex "filter" "transport filter"
24680 .vindex "&$pipe_addresses$&"
24681 Special handling takes place when an argument consists of precisely the text
24682 &`$pipe_addresses`& (no quotes).
24683 This is not a general expansion variable; the only
24684 place this string is recognized is when it appears as an argument for a pipe or
24685 transport filter command. It causes each address that is being handled to be
24686 inserted in the argument list at that point &'as a separate argument'&. This
24687 avoids any problems with spaces or shell metacharacters, and is of use when a
24688 &(pipe)& transport is handling groups of addresses in a batch.
24689
24690 If &%force_command%& is enabled on the transport, special handling takes place
24691 for an argument that consists of precisely the text &`$address_pipe`&.  It
24692 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24693 argument is inserted in the argument list at that point
24694 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24695 the only item in the argument; in fact, if it were then &%force_command%&
24696 should behave as a no-op.  Rather, it should be used to adjust the command
24697 run while preserving the argument vector separation.
24698
24699 After splitting up into arguments and expansion, the resulting command is run
24700 in a subprocess directly from the transport, &'not'& under a shell. The
24701 message that is being delivered is supplied on the standard input, and the
24702 standard output and standard error are both connected to a single pipe that is
24703 read by Exim. The &%max_output%& option controls how much output the command
24704 may produce, and the &%return_output%& and &%return_fail_output%& options
24705 control what is done with it.
24706
24707 Not running the command under a shell (by default) lessens the security risks
24708 in cases when a command from a user's filter file is built out of data that was
24709 taken from an incoming message. If a shell is required, it can of course be
24710 explicitly specified as the command to be run. However, there are circumstances
24711 where existing commands (for example, in &_.forward_& files) expect to be run
24712 under a shell and cannot easily be modified. To allow for these cases, there is
24713 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24714 works. Instead of breaking up the command line as just described, it expands it
24715 as a single string and passes the result to &_/bin/sh_&. The
24716 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24717 with &%use_shell%&, and the whole mechanism is inherently less secure.
24718
24719
24720
24721 .section "Environment variables" "SECTpipeenv"
24722 .cindex "&(pipe)& transport" "environment for command"
24723 .cindex "environment" "&(pipe)& transport"
24724 The environment variables listed below are set up when the command is invoked.
24725 This list is a compromise for maximum compatibility with other MTAs. Note that
24726 the &%environment%& option can be used to add additional variables to this
24727 environment. The environment for the &(pipe)& transport is not subject
24728 to the &%add_environment%& and &%keep_environment%& main config options.
24729 &*Note*&: Using enviroment variables loses track of tainted data.
24730 Writers of &(pipe)& transport commands should be wary of data supplied
24731 by potential attackers.
24732 .display
24733 &`DOMAIN            `&   the domain of the address
24734 &`HOME              `&   the home directory, if set
24735 &`HOST              `&   the host name when called from a router (see below)
24736 &`LOCAL_PART        `&   see below
24737 &`LOCAL_PART_PREFIX `&   see below
24738 &`LOCAL_PART_SUFFIX `&   see below
24739 &`LOGNAME           `&   see below
24740 &`MESSAGE_ID        `&   Exim's local ID for the message
24741 &`PATH              `&   as specified by the &%path%& option below
24742 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24743 &`RECIPIENT         `&   the complete recipient address
24744 &`SENDER            `&   the sender of the message (empty if a bounce)
24745 &`SHELL             `&   &`/bin/sh`&
24746 &`TZ                `&   the value of the &%timezone%& option, if set
24747 &`USER              `&   see below
24748 .endd
24749 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24750 router, LOCAL_PART is set to the local part of the address. When it is
24751 called as a result of a forward or alias expansion, LOCAL_PART is set to
24752 the local part of the address that was expanded. In both cases, any affixes are
24753 removed from the local part, and made available in LOCAL_PART_PREFIX and
24754 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24755 same value as LOCAL_PART for compatibility with other MTAs.
24756
24757 .cindex "HOST"
24758 HOST is set only when a &(pipe)& transport is called from a router that
24759 associates hosts with an address, typically when using &(pipe)& as a
24760 pseudo-remote transport. HOST is set to the first host name specified by
24761 the router.
24762
24763 .cindex "HOME"
24764 If the transport's generic &%home_directory%& option is set, its value is used
24765 for the HOME environment variable. Otherwise, a home directory may be set
24766 by the router's &%transport_home_directory%& option, which defaults to the
24767 user's home directory if &%check_local_user%& is set.
24768
24769
24770 .section "Private options for pipe" "SECID142"
24771 .cindex "options" "&(pipe)& transport"
24772
24773
24774
24775 .option allow_commands pipe "string list&!!" unset
24776 .cindex "&(pipe)& transport" "permitted commands"
24777 The string is expanded, and is then interpreted as a colon-separated list of
24778 permitted commands. If &%restrict_to_path%& is not set, the only commands
24779 permitted are those in the &%allow_commands%& list. They need not be absolute
24780 paths; the &%path%& option is still used for relative paths. If
24781 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24782 in the &%allow_commands%& list, or a name without any slashes that is found on
24783 the path. In other words, if neither &%allow_commands%& nor
24784 &%restrict_to_path%& is set, there is no restriction on the command, but
24785 otherwise only commands that are permitted by one or the other are allowed. For
24786 example, if
24787 .code
24788 allow_commands = /usr/bin/vacation
24789 .endd
24790 and &%restrict_to_path%& is not set, the only permitted command is
24791 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24792 &%use_shell%& is set.
24793
24794
24795 .option batch_id pipe string&!! unset
24796 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24797
24798
24799 .option batch_max pipe integer 1
24800 This limits the number of addresses that can be handled in a single delivery.
24801 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24802
24803
24804 .option check_string pipe string unset
24805 As &(pipe)& writes the message, the start of each line is tested for matching
24806 &%check_string%&, and if it does, the initial matching characters are replaced
24807 by the contents of &%escape_string%&, provided both are set. The value of
24808 &%check_string%& is a literal string, not a regular expression, and the case of
24809 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24810 of &%check_string%& and &%escape_string%& are forced to values that implement
24811 the SMTP escaping protocol. Any settings made in the configuration file are
24812 ignored.
24813
24814
24815 .option command pipe string&!! unset
24816 This option need not be set when &(pipe)& is being used to deliver to pipes
24817 obtained directly from address redirections. In other cases, the option must be
24818 set, to provide a command to be run. It need not yield an absolute path (see
24819 the &%path%& option below). The command is split up into separate arguments by
24820 Exim, and each argument is separately expanded, as described in section
24821 &<<SECThowcommandrun>>& above.
24822
24823 .cindex "tainted data"
24824 No part of the resulting command may be tainted.
24825
24826
24827 .option environment pipe string&!! unset
24828 .cindex "&(pipe)& transport" "environment for command"
24829 .cindex "environment" "&(pipe)& transport"
24830 This option is used to add additional variables to the environment in which the
24831 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24832 a string which is expanded, and then interpreted as a colon-separated list of
24833 environment settings of the form <&'name'&>=<&'value'&>.
24834
24835
24836 .option escape_string pipe string unset
24837 See &%check_string%& above.
24838
24839
24840 .option freeze_exec_fail pipe boolean false
24841 .cindex "exec failure"
24842 .cindex "failure of exec"
24843 .cindex "&(pipe)& transport" "failure of exec"
24844 Failure to exec the command in a pipe transport is by default treated like
24845 any other failure while running the command. However, if &%freeze_exec_fail%&
24846 is set, failure to exec is treated specially, and causes the message to be
24847 frozen, whatever the setting of &%ignore_status%&.
24848
24849
24850 .option freeze_signal pipe boolean false
24851 .cindex "signal exit"
24852 .cindex "&(pipe)& transport", "signal exit"
24853 Normally if the process run by a command in a pipe transport exits on a signal,
24854 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24855 frozen in Exim's queue instead.
24856
24857
24858 .option force_command pipe boolean false
24859 .cindex "force command"
24860 .cindex "&(pipe)& transport", "force command"
24861 Normally when a router redirects an address directly to a pipe command
24862 the &%command%& option on the transport is ignored.  If &%force_command%&
24863 is set, the &%command%& option will used. This is especially
24864 useful for forcing a wrapper or additional argument to be added to the
24865 command. For example:
24866 .code
24867 command = /usr/bin/remote_exec myhost -- $address_pipe
24868 force_command
24869 .endd
24870
24871 Note that &$address_pipe$& is handled specially in &%command%& when
24872 &%force_command%& is set, expanding out to the original argument vector as
24873 separate items, similarly to a Unix shell &`"$@"`& construct.
24874
24875
24876 .option ignore_status pipe boolean false
24877 If this option is true, the status returned by the subprocess that is set up to
24878 run the command is ignored, and Exim behaves as if zero had been returned.
24879 Otherwise, a non-zero status or termination by signal causes an error return
24880 from the transport unless the status value is one of those listed in
24881 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24882
24883 &*Note*&: This option does not apply to timeouts, which do not return a status.
24884 See the &%timeout_defer%& option for how timeouts are handled.
24885
24886
24887 .option log_defer_output pipe boolean false
24888 .cindex "&(pipe)& transport" "logging output"
24889 If this option is set, and the status returned by the command is
24890 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24891 and any output was produced on stdout or stderr, the first line of it is
24892 written to the main log.
24893
24894
24895 .option log_fail_output pipe boolean false
24896 If this option is set, and the command returns any output on stdout or
24897 stderr, and also ends with a return code that is neither zero nor one of
24898 the return codes listed in &%temp_errors%& (that is, the delivery
24899 failed), the first line of output is written to the main log. This
24900 option and &%log_output%& are mutually exclusive.  Only one of them may
24901 be set.
24902
24903
24904 .option log_output pipe boolean false
24905 If this option is set and the command returns any output on stdout or
24906 stderr, the first line of output is written to the main log, whatever
24907 the return code. This option and &%log_fail_output%& are mutually
24908 exclusive. Only one of them may be set.
24909
24910
24911 .option max_output pipe integer 20K
24912 This specifies the maximum amount of output that the command may produce on its
24913 standard output and standard error file combined. If the limit is exceeded, the
24914 process running the command is killed. This is intended as a safety measure to
24915 catch runaway processes. The limit is applied independently of the settings of
24916 the options that control what is done with such output (for example,
24917 &%return_output%&). Because of buffering effects, the amount of output may
24918 exceed the limit by a small amount before Exim notices.
24919
24920
24921 .option message_prefix pipe string&!! "see below"
24922 The string specified here is expanded and output at the start of every message.
24923 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24924 .code
24925 message_prefix = \
24926   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24927   ${tod_bsdinbox}\n
24928 .endd
24929 .cindex "Cyrus"
24930 .cindex "&%tmail%&"
24931 .cindex "&""From""& line"
24932 This is required by the commonly used &_/usr/bin/vacation_& program.
24933 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24934 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24935 setting
24936 .code
24937 message_prefix =
24938 .endd
24939 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24940 &`\n`& to &`\r\n`& in &%message_prefix%&.
24941
24942
24943 .option message_suffix pipe string&!! "see below"
24944 The string specified here is expanded and output at the end of every message.
24945 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24946 The suffix can be suppressed by setting
24947 .code
24948 message_suffix =
24949 .endd
24950 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24951 &`\n`& to &`\r\n`& in &%message_suffix%&.
24952
24953
24954 .option path pipe string&!! "/bin:/usr/bin"
24955 This option is expanded and
24956 specifies the string that is set up in the PATH environment
24957 variable of the subprocess.
24958 If the &%command%& option does not yield an absolute path name, the command is
24959 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24960 apply to a command specified as a transport filter.
24961
24962
24963 .option permit_coredump pipe boolean false
24964 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24965 a core-dump of a pipe command, enable this command.  This enables core-dumps
24966 during delivery and affects both the Exim binary and the pipe command run.
24967 It is recommended that this option remain off unless and until you have a need
24968 for it and that this only be enabled when needed, as the risk of excessive
24969 resource consumption can be quite high.  Note also that Exim is typically
24970 installed as a setuid binary and most operating systems will inhibit coredumps
24971 of these by default, so further OS-specific action may be required.
24972
24973
24974 .option pipe_as_creator pipe boolean false
24975 .cindex "uid (user id)" "local delivery"
24976 If the generic &%user%& option is not set and this option is true, the delivery
24977 process is run under the uid that was in force when Exim was originally called
24978 to accept the message. If the group id is not otherwise set (via the generic
24979 &%group%& option), the gid that was in force when Exim was originally called to
24980 accept the message is used.
24981
24982
24983 .option restrict_to_path pipe boolean false
24984 When this option is set, any command name not listed in &%allow_commands%& must
24985 contain no slashes. The command is searched for only in the directories listed
24986 in the &%path%& option. This option is intended for use in the case when a pipe
24987 command has been generated from a user's &_.forward_& file. This is usually
24988 handled by a &(pipe)& transport called &%address_pipe%&.
24989
24990
24991 .option return_fail_output pipe boolean false
24992 If this option is true, and the command produced any output and ended with a
24993 return code other than zero or one of the codes listed in &%temp_errors%& (that
24994 is, the delivery failed), the output is returned in the bounce message.
24995 However, if the message has a null sender (that is, it is itself a bounce
24996 message), output from the command is discarded. This option and
24997 &%return_output%& are mutually exclusive. Only one of them may be set.
24998
24999
25000
25001 .option return_output pipe boolean false
25002 If this option is true, and the command produced any output, the delivery is
25003 deemed to have failed whatever the return code from the command, and the output
25004 is returned in the bounce message. Otherwise, the output is just discarded.
25005 However, if the message has a null sender (that is, it is a bounce message),
25006 output from the command is always discarded, whatever the setting of this
25007 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25008 of them may be set.
25009
25010
25011
25012 .option temp_errors pipe "string list" "see below"
25013 .cindex "&(pipe)& transport" "temporary failure"
25014 This option contains either a colon-separated list of numbers, or a single
25015 asterisk. If &%ignore_status%& is false
25016 and &%return_output%& is not set,
25017 and the command exits with a non-zero return code, the failure is treated as
25018 temporary and the delivery is deferred if the return code matches one of the
25019 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25020 codes are treated as permanent errors. The default setting contains the codes
25021 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25022 compiled on a system that does not define these macros, it assumes values of 75
25023 and 73, respectively.
25024
25025
25026 .option timeout pipe time 1h
25027 If the command fails to complete within this time, it is killed. This normally
25028 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25029 specifies no timeout. In order to ensure that any subprocesses created by the
25030 command are also killed, Exim makes the initial process a process group leader,
25031 and kills the whole process group on a timeout. However, this can be defeated
25032 if one of the processes starts a new process group.
25033
25034 .option timeout_defer pipe boolean false
25035 A timeout in a &(pipe)& transport, either in the command that the transport
25036 runs, or in a transport filter that is associated with it, is by default
25037 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25038 is set true, both kinds of timeout become temporary errors, causing the
25039 delivery to be deferred.
25040
25041 .option umask pipe "octal integer" 022
25042 This specifies the umask setting for the subprocess that runs the command.
25043
25044
25045 .option use_bsmtp pipe boolean false
25046 .cindex "envelope sender"
25047 If this option is set true, the &(pipe)& transport writes messages in &"batch
25048 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25049 commands. If you want to include a leading HELO command with such messages,
25050 you can do so by setting the &%message_prefix%& option. See section
25051 &<<SECTbatchSMTP>>& for details of batch SMTP.
25052
25053 .option use_classresources pipe boolean false
25054 .cindex "class resources (BSD)"
25055 This option is available only when Exim is running on FreeBSD, NetBSD, or
25056 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25057 resource limits when a &(pipe)& transport is run to perform a delivery. The
25058 limits for the uid under which the pipe is to run are obtained from the login
25059 class database.
25060
25061
25062 .option use_crlf pipe boolean false
25063 .cindex "carriage return"
25064 .cindex "linefeed"
25065 This option causes lines to be terminated with the two-character CRLF sequence
25066 (carriage return, linefeed) instead of just a linefeed character. In the case
25067 of batched SMTP, the byte sequence written to the pipe is then an exact image
25068 of what would be sent down a real SMTP connection.
25069
25070 The contents of the &%message_prefix%& and &%message_suffix%& options are
25071 written verbatim, so must contain their own carriage return characters if these
25072 are needed. When &%use_bsmtp%& is not set, the default values for both
25073 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25074 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25075
25076
25077 .option use_shell pipe boolean false
25078 .vindex "&$pipe_addresses$&"
25079 If this option is set, it causes the command to be passed to &_/bin/sh_&
25080 instead of being run directly from the transport, as described in section
25081 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25082 where the command is expected to be run under a shell and cannot easily be
25083 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25084 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25085 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25086 its &%-c%& option.
25087
25088
25089
25090 .section "Using an external local delivery agent" "SECID143"
25091 .cindex "local delivery" "using an external agent"
25092 .cindex "&'procmail'&"
25093 .cindex "external local delivery"
25094 .cindex "delivery" "&'procmail'&"
25095 .cindex "delivery" "by external agent"
25096 The &(pipe)& transport can be used to pass all messages that require local
25097 delivery to a separate local delivery agent such as &%procmail%&. When doing
25098 this, care must be taken to ensure that the pipe is run under an appropriate
25099 uid and gid. In some configurations one wants this to be a uid that is trusted
25100 by the delivery agent to supply the correct sender of the message. It may be
25101 necessary to recompile or reconfigure the delivery agent so that it trusts an
25102 appropriate user. The following is an example transport and router
25103 configuration for &%procmail%&:
25104 .code
25105 # transport
25106 procmail_pipe:
25107   driver = pipe
25108   command = /usr/local/bin/procmail -d $local_part_data
25109   return_path_add
25110   delivery_date_add
25111   envelope_to_add
25112   check_string = "From "
25113   escape_string = ">From "
25114   umask = 077
25115   user = $local_part_data
25116   group = mail
25117
25118 # router
25119 procmail:
25120   driver = accept
25121   check_local_user
25122   transport = procmail_pipe
25123 .endd
25124 In this example, the pipe is run as the local user, but with the group set to
25125 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25126 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25127 user to supply a correct sender address. If you do not specify either a
25128 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25129 home directory is the user's home directory by default.
25130
25131 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25132 .code
25133 IFS=" "
25134 .endd
25135 as shown in some &%procmail%& documentation, because Exim does not by default
25136 use a shell to run pipe commands.
25137
25138 .cindex "Cyrus"
25139 The next example shows a transport and a router for a system where local
25140 deliveries are handled by the Cyrus IMAP server.
25141 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25142 . but that suffix is tainted so cannot be used in a command arg
25143 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25144 .code
25145 # transport
25146 local_delivery_cyrus:
25147   driver = pipe
25148   command = /usr/cyrus/bin/deliver \
25149             -- $local_part_data
25150   user = cyrus
25151   group = mail
25152   return_output
25153   log_output
25154   message_prefix =
25155   message_suffix =
25156
25157 # router
25158 local_user_cyrus:
25159   driver = accept
25160   check_local_user
25161   transport = local_delivery_cyrus
25162 .endd
25163 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25164 &%return_output%& to cause any text written by Cyrus to be returned to the
25165 sender.
25166 .ecindex IIDpiptra1
25167 .ecindex IIDpiptra2
25168
25169
25170 . ////////////////////////////////////////////////////////////////////////////
25171 . ////////////////////////////////////////////////////////////////////////////
25172
25173 .chapter "The smtp transport" "CHAPsmtptrans"
25174 .scindex IIDsmttra1 "transports" "&(smtp)&"
25175 .scindex IIDsmttra2 "&(smtp)& transport"
25176 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25177 or LMTP protocol. The list of hosts to try can either be taken from the address
25178 that is being processed (having been set up by the router), or specified
25179 explicitly for the transport. Timeout and retry processing (see chapter
25180 &<<CHAPretry>>&) is applied to each IP address independently.
25181
25182
25183 .section "Multiple messages on a single connection" "SECID144"
25184 The sending of multiple messages over a single TCP/IP connection can arise in
25185 two ways:
25186
25187 .ilist
25188 If a message contains more than &%max_rcpt%& (see below) addresses that are
25189 routed to the same host, more than one copy of the message has to be sent to
25190 that host. In this situation, multiple copies may be sent in a single run of
25191 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25192 does when it has too many addresses to send in one message also depends on the
25193 value of the global &%remote_max_parallel%& option. Details are given in
25194 section &<<SECToutSMTPTCP>>&.)
25195 .next
25196 .cindex "hints database" "remembering routing"
25197 When a message has been successfully delivered over a TCP/IP connection, Exim
25198 looks in its hints database to see if there are any other messages awaiting a
25199 connection to the same host. If there are, a new delivery process is started
25200 for one of them, and the current TCP/IP connection is passed on to it. The new
25201 process may in turn send multiple copies and possibly create yet another
25202 process.
25203 .endlist
25204
25205
25206 For each copy sent over the same TCP/IP connection, a sequence counter is
25207 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25208 no further messages are sent over that connection.
25209
25210
25211
25212 .section "Use of the $host and $host_address variables" "SECID145"
25213 .vindex "&$host$&"
25214 .vindex "&$host_address$&"
25215 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25216 &$host_address$& are the name and IP address of the first host on the host list
25217 passed by the router. However, when the transport is about to connect to a
25218 specific host, and while it is connected to that host, &$host$& and
25219 &$host_address$& are set to the values for that host. These are the values
25220 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25221 &%serialize_hosts%&, and the various TLS options are expanded.
25222
25223
25224 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25225 .vindex &$tls_bits$&
25226 .vindex &$tls_cipher$&
25227 .vindex &$tls_peerdn$&
25228 .vindex &$tls_sni$&
25229 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25230 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25231 are the values that were set when the message was received.
25232 These are the values that are used for options that are expanded before any
25233 SMTP connections are made. Just before each connection is made, these four
25234 variables are emptied. If TLS is subsequently started, they are set to the
25235 appropriate values for the outgoing connection, and these are the values that
25236 are in force when any authenticators are run and when the
25237 &%authenticated_sender%& option is expanded.
25238
25239 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25240 and will be removed in a future release.
25241
25242
25243 .section "Private options for smtp" "SECID146"
25244 .cindex "options" "&(smtp)& transport"
25245 The private options of the &(smtp)& transport are as follows:
25246
25247
25248 .option address_retry_include_sender smtp boolean true
25249 .cindex "4&'xx'& responses" "retrying after"
25250 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25251 is the combination of sender and recipient that is delayed in subsequent queue
25252 runs until the retry time is reached. You can delay the recipient without
25253 reference to the sender (which is what earlier versions of Exim did), by
25254 setting &%address_retry_include_sender%& false. However, this can lead to
25255 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25256
25257 .option allow_localhost smtp boolean false
25258 .cindex "local host" "sending to"
25259 .cindex "fallback" "hosts specified on transport"
25260 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25261 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25262 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25263 the delivery anyway. This should be used only in special cases when the
25264 configuration ensures that no looping will result (for example, a differently
25265 configured Exim is listening on the port to which the message is sent).
25266
25267
25268 .option authenticated_sender smtp string&!! unset
25269 .cindex "Cyrus"
25270 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25271 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25272 overriding any existing authenticated sender value. If the string expansion is
25273 forced to fail, the option is ignored. Other expansion failures cause delivery
25274 to be deferred. If the result of expansion is an empty string, that is also
25275 ignored.
25276
25277 The expansion happens after the outgoing connection has been made and TLS
25278 started, if required. This means that the &$host$&, &$host_address$&,
25279 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25280 particular connection.
25281
25282 If the SMTP session is not authenticated, the expansion of
25283 &%authenticated_sender%& still happens (and can cause the delivery to be
25284 deferred if it fails), but no AUTH= item is added to MAIL commands
25285 unless &%authenticated_sender_force%& is true.
25286
25287 This option allows you to use the &(smtp)& transport in LMTP mode to
25288 deliver mail to Cyrus IMAP and provide the proper local part as the
25289 &"authenticated sender"&, via a setting such as:
25290 .code
25291 authenticated_sender = $local_part
25292 .endd
25293 This removes the need for IMAP subfolders to be assigned special ACLs to
25294 allow direct delivery to those subfolders.
25295
25296 Because of expected uses such as that just described for Cyrus (when no
25297 domain is involved), there is no checking on the syntax of the provided
25298 value.
25299
25300
25301 .option authenticated_sender_force smtp boolean false
25302 If this option is set true, the &%authenticated_sender%& option's value
25303 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25304 authenticated as a client.
25305
25306
25307 .option command_timeout smtp time 5m
25308 .cindex timeout "smtp transport command"
25309 This sets a timeout for receiving a response to an SMTP command that has been
25310 sent out. It is also used when waiting for the initial banner line from the
25311 remote host. Its value must not be zero.
25312
25313
25314 .option connect_timeout smtp time 5m
25315 .cindex timeout "smtp transport connect"
25316 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25317 to a remote host. A setting of zero allows the system timeout (typically
25318 several minutes) to act. To have any effect, the value of this option must be
25319 less than the system timeout. However, it has been observed that on some
25320 systems there is no system timeout, which is why the default value for this
25321 option is 5 minutes, a value recommended by RFC 1123.
25322
25323
25324 .option connection_max_messages smtp integer 500
25325 .cindex "SMTP" "passed connection"
25326 .cindex "SMTP" "multiple deliveries"
25327 .cindex "multiple SMTP deliveries"
25328 This controls the maximum number of separate message deliveries that are sent
25329 over a single TCP/IP connection. If the value is zero, there is no limit.
25330 For testing purposes, this value can be overridden by the &%-oB%& command line
25331 option.
25332
25333
25334 .option dane_require_tls_ciphers smtp string&!! unset
25335 .cindex "TLS" "requiring specific ciphers for DANE"
25336 .cindex "cipher" "requiring specific"
25337 .cindex DANE "TLS ciphers"
25338 This option may be used to override &%tls_require_ciphers%& for connections
25339 where DANE has been determined to be in effect.
25340 If not set, then &%tls_require_ciphers%& will be used.
25341 Normal SMTP delivery is not able to make strong demands of TLS cipher
25342 configuration, because delivery will fall back to plaintext.  Once DANE has
25343 been determined to be in effect, there is no plaintext fallback and making the
25344 TLS cipherlist configuration stronger will increase security, rather than
25345 counter-intuitively decreasing it.
25346 If the option expands to be empty or is forced to fail, then it will
25347 be treated as unset and &%tls_require_ciphers%& will be used instead.
25348
25349
25350 .option data_timeout smtp time 5m
25351 .cindex timeout "for transmitted SMTP data blocks"
25352 This sets a timeout for the transmission of each block in the data portion of
25353 the message. As a result, the overall timeout for a message depends on the size
25354 of the message. Its value must not be zero. See also &%final_timeout%&.
25355
25356
25357 .option dkim_canon smtp string&!! unset
25358 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25359 .option dkim_domain smtp "string list&!!" unset
25360 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25361 .option dkim_hash smtp string&!! sha256
25362 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25363 .option dkim_identity smtp string&!! unset
25364 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25365 .option dkim_private_key smtp string&!! unset
25366 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25367 .option dkim_selector smtp string&!! unset
25368 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25369 .option dkim_strict smtp string&!! unset
25370 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25371 .option dkim_sign_headers smtp string&!! "per RFC"
25372 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25373 .option dkim_timestamps smtp string&!! unset
25374 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25375
25376
25377 .option delay_after_cutoff smtp boolean true
25378 .cindex "final cutoff" "retries, controlling"
25379 .cindex retry "final cutoff"
25380 This option controls what happens when all remote IP addresses for a given
25381 domain have been inaccessible for so long that they have passed their retry
25382 cutoff times.
25383
25384 In the default state, if the next retry time has not been reached for any of
25385 them, the address is bounced without trying any deliveries. In other words,
25386 Exim delays retrying an IP address after the final cutoff time until a new
25387 retry time is reached, and can therefore bounce an address without ever trying
25388 a delivery, when machines have been down for a long time. Some people are
25389 unhappy at this prospect, so...
25390
25391 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25392 addresses are past their final cutoff time, Exim tries to deliver to those
25393 IP addresses that have not been tried since the message arrived. If there are
25394 none, of if they all fail, the address is bounced. In other words, it does not
25395 delay when a new message arrives, but immediately tries those expired IP
25396 addresses that haven't been tried since the message arrived. If there is a
25397 continuous stream of messages for the dead hosts, unsetting
25398 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25399 to them.
25400
25401
25402 .option dns_qualify_single smtp boolean true
25403 If the &%hosts%& or &%fallback_hosts%& option is being used,
25404 and the &%gethostbyname%& option is false,
25405 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25406 in chapter &<<CHAPdnslookup>>& for more details.
25407
25408
25409 .option dns_search_parents smtp boolean false
25410 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25411 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25412 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25413 details.
25414
25415
25416 .option dnssec_request_domains smtp "domain list&!!" *
25417 .cindex "MX record" "security"
25418 .cindex "DNSSEC" "MX lookup"
25419 .cindex "security" "MX lookup"
25420 .cindex "DNS" "DNSSEC"
25421 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25422 the DNSSEC request bit set. Setting this transport option is only useful if the
25423 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25424 router option.
25425
25426
25427
25428 .option dnssec_require_domains smtp "domain list&!!" unset
25429 .cindex "MX record" "security"
25430 .cindex "DNSSEC" "MX lookup"
25431 .cindex "security" "MX lookup"
25432 .cindex "DNS" "DNSSEC"
25433 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25434 the DNSSEC request bit set.  Setting this transport option is only
25435 useful if the transport overrides or sets the host names. See the
25436 &%dnssec_require_domains%& router option.
25437
25438
25439
25440 .option dscp smtp string&!! unset
25441 .cindex "DCSP" "outbound"
25442 This option causes the DSCP value associated with a socket to be set to one
25443 of a number of fixed strings or to numeric value.
25444 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25445 Common values include &`throughput`&, &`mincost`&, and on newer systems
25446 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25447
25448 The outbound packets from Exim will be marked with this value in the header
25449 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25450 that these values will have any effect, not be stripped by networking
25451 equipment, or do much of anything without cooperation with your Network
25452 Engineer and those of all network operators between the source and destination.
25453
25454
25455 .option fallback_hosts smtp "string list" unset
25456 .cindex "fallback" "hosts specified on transport"
25457 String expansion is not applied to this option. The argument must be a
25458 colon-separated list of host names or IP addresses, optionally also including
25459 port numbers, though the separator can be changed, as described in section
25460 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25461 item in a &%route_list%& setting for the &(manualroute)& router, as described
25462 in section &<<SECTformatonehostitem>>&.
25463
25464 Fallback hosts can also be specified on routers, which associate them with the
25465 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25466 &%fallback_hosts%& specified on the transport is used only if the address does
25467 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25468 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25469 However, &%hosts_randomize%& does apply to fallback host lists.
25470
25471 If Exim is unable to deliver to any of the hosts for a particular address, and
25472 the errors are not permanent rejections, the address is put on a separate
25473 transport queue with its host list replaced by the fallback hosts, unless the
25474 address was routed via MX records and the current host was in the original MX
25475 list. In that situation, the fallback host list is not used.
25476
25477 Once normal deliveries are complete, the fallback queue is delivered by
25478 re-running the same transports with the new host lists. If several failing
25479 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25480 copy of the message is sent.
25481
25482 The resolution of the host names on the fallback list is controlled by the
25483 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25484 both to cases when the host list comes with the address and when it is taken
25485 from &%hosts%&. This option provides a &"use a smart host only if delivery
25486 fails"& facility.
25487
25488
25489 .option final_timeout smtp time 10m
25490 .cindex timeout "for transmitted SMTP data accept"
25491 This is the timeout that applies while waiting for the response to the final
25492 line containing just &"."& that terminates a message. Its value must not be
25493 zero.
25494
25495 .option gethostbyname smtp boolean false
25496 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25497 being used, names are looked up using &[gethostbyname()]&
25498 (or &[getipnodebyname()]& when available)
25499 instead of using the DNS. Of course, that function may in fact use the DNS, but
25500 it may also consult other sources of information such as &_/etc/hosts_&.
25501
25502 .option gnutls_compat_mode smtp boolean unset
25503 This option controls whether GnuTLS is used in compatibility mode in an Exim
25504 server. This reduces security slightly, but improves interworking with older
25505 implementations of TLS.
25506
25507 .option helo_data smtp string&!! "see below"
25508 .cindex "HELO" "argument, setting"
25509 .cindex "EHLO" "argument, setting"
25510 .cindex "LHLO argument setting"
25511 The value of this option is expanded after a connection to a another host has
25512 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25513 command that starts the outgoing SMTP or LMTP session. The default value of the
25514 option is:
25515 .code
25516 $primary_hostname
25517 .endd
25518 During the expansion, the variables &$host$& and &$host_address$& are set to
25519 the identity of the remote host, and the variables &$sending_ip_address$& and
25520 &$sending_port$& are set to the local IP address and port number that are being
25521 used. These variables can be used to generate different values for different
25522 servers or different local IP addresses. For example, if you want the string
25523 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25524 interface address, you could use this:
25525 .code
25526 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25527   {${listextract{1}{<\n $value}}} \
25528   {$primary_hostname}}
25529 .endd
25530 The use of &%helo_data%& applies both to sending messages and when doing
25531 callouts.
25532
25533 .option host_name_extract smtp "string list&!!" "see below"
25534 .cindex "load balancer" "hosts behind"
25535 .cindex TLS resumption
25536 Some mail-accepting sites
25537 (notably Microsoft)
25538 operate many servers behind a network load-balancer.  When this is done,
25539 with separated TLS session caches, TLS session resuption becomes problematic.
25540 It will only succeed when the same server happens to be selected by the
25541 load-balancer, matching the session stored in the client's cache.
25542
25543 Exim can pull out a server name, if there is one, from the response to the
25544 client's SMTP EHLO command.
25545 The default value of this option:
25546 .code
25547     ${if and { {match {$host} {.outlook.com\$}} \
25548                {match {$item} {\N^250-([\w.]+)\s\N}} \
25549              } {$1}}
25550 .endd
25551 suffices for one known case.
25552 During the expansion of this option the &$item$& variable will have the
25553 server's EHLO response.
25554 The result of the option expansion is included in the key used to store and
25555 retrieve the TLS session, for session resumption.
25556
25557 Operators of high-load sites may wish to evaluate their logs for indications
25558 of other destination sites operating load-balancers, and develop a suitable
25559 expression for this option.
25560 The smtp:ehlo event and the &$tls_out_resumption$& variable
25561 will be useful for such work.
25562
25563 .option hosts smtp "string list&!!" unset
25564 Hosts are associated with an address by a router such as &(dnslookup)&, which
25565 finds the hosts by looking up the address domain in the DNS, or by
25566 &(manualroute)&, which has lists of hosts in its configuration. However,
25567 email addresses can be passed to the &(smtp)& transport by any router, and not
25568 all of them can provide an associated list of hosts.
25569
25570 The &%hosts%& option specifies a list of hosts to be used if the address being
25571 processed does not have any hosts associated with it. The hosts specified by
25572 &%hosts%& are also used, whether or not the address has its own hosts, if
25573 &%hosts_override%& is set.
25574
25575 The string is first expanded, before being interpreted as a colon-separated
25576 list of host names or IP addresses, possibly including port numbers. The
25577 separator may be changed to something other than colon, as described in section
25578 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25579 item in a &%route_list%& setting for the &(manualroute)& router, as described
25580 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25581 of the &(manualroute)& router is not available here.
25582
25583 If the expansion fails, delivery is deferred. Unless the failure was caused by
25584 the inability to complete a lookup, the error is logged to the panic log as
25585 well as the main log. Host names are looked up either by searching directly for
25586 address records in the DNS or by calling &[gethostbyname()]& (or
25587 &[getipnodebyname()]& when available), depending on the setting of the
25588 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25589 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25590 address are used.
25591
25592 During delivery, the hosts are tried in order, subject to their retry status,
25593 unless &%hosts_randomize%& is set.
25594
25595
25596 .option hosts_avoid_esmtp smtp "host list&!!" unset
25597 .cindex "ESMTP, avoiding use of"
25598 .cindex "HELO" "forcing use of"
25599 .cindex "EHLO" "avoiding use of"
25600 .cindex "PIPELINING" "avoiding the use of"
25601 This option is for use with broken hosts that announce ESMTP facilities (for
25602 example, PIPELINING) and then fail to implement them properly. When a host
25603 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25604 start of the SMTP session. This means that it cannot use any of the ESMTP
25605 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25606
25607
25608 .option hosts_avoid_pipelining smtp "host list&!!" unset
25609 .cindex "PIPELINING" "avoiding the use of"
25610 .cindex "ESMTP extensions" PIPELINING
25611 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25612 that matches this list, even if the server host advertises PIPELINING support.
25613
25614 .option hosts_pipe_connect smtp "host list&!!" unset
25615 .cindex "pipelining" "early connection"
25616 .cindex "pipelining" PIPECONNECT
25617 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25618 this option controls which to hosts the facility watched for
25619 and recorded, and used for subsequent connections.
25620
25621 The retry hints database is used for the record,
25622 and records are subject to the &%retry_data_expire%& option.
25623 When used, the pipelining saves on roundtrip times.
25624 It also turns SMTP into a client-first protocol
25625 so combines well with TCP Fast Open.
25626
25627 See also the &%pipelining_connect_advertise_hosts%& main option.
25628
25629 Note:
25630 When the facility is used, if the transport &%interface%& option is unset
25631 the &%helo_data%& option
25632 will be expanded before the &$sending_ip_address$& variable
25633 is filled in.
25634 A check is made for the use of that variable, without the
25635 presence of a &"def:"& test on it, but suitably complex coding
25636 can avoid the check and produce unexpected results.
25637 You have been warned.
25638
25639
25640 .option hosts_avoid_tls smtp "host list&!!" unset
25641 .cindex "TLS" "avoiding for certain hosts"
25642 Exim will not try to start a TLS session when delivering to any host that
25643 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25644
25645 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25646 .cindex "TLS" "avoiding for certain hosts"
25647 Exim will not try to start a TLS session for a verify callout,
25648 or when delivering in cutthrough mode,
25649 to any host that matches this list.
25650
25651
25652 .option hosts_max_try smtp integer 5
25653 .cindex "host" "maximum number to try"
25654 .cindex "limit" "number of hosts tried"
25655 .cindex "limit" "number of MX tried"
25656 .cindex "MX record" "maximum tried"
25657 This option limits the number of IP addresses that are tried for any one
25658 delivery in cases where there are temporary delivery errors. Section
25659 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25660
25661
25662 .option hosts_max_try_hardlimit smtp integer 50
25663 This is an additional check on the maximum number of IP addresses that Exim
25664 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25665 why it exists.
25666
25667
25668
25669 .option hosts_nopass_tls smtp "host list&!!" unset
25670 .cindex "TLS" "passing connection"
25671 .cindex "multiple SMTP deliveries"
25672 .cindex "TLS" "multiple message deliveries"
25673 For any host that matches this list, a connection on which a TLS session has
25674 been started will not be passed to a new delivery process for sending another
25675 message on the same connection. See section &<<SECTmulmessam>>& for an
25676 explanation of when this might be needed.
25677
25678 .option hosts_noproxy_tls smtp "host list&!!" unset
25679 .cindex "TLS" "passing connection"
25680 .cindex "multiple SMTP deliveries"
25681 .cindex "TLS" "multiple message deliveries"
25682 For any host that matches this list, a TLS session which has
25683 been started will not be passed to a new delivery process for sending another
25684 message on the same session.
25685
25686 The traditional implementation closes down TLS and re-starts it in the new
25687 process, on the same open TCP connection, for each successive message
25688 sent.  If permitted by this option a pipe to to the new process is set up
25689 instead, and the original process maintains the TLS connection and proxies
25690 the SMTP connection from and to the new process and any subsequents.
25691 The new process has no access to TLS information, so cannot include it in
25692 logging.
25693
25694
25695
25696 .option hosts_override smtp boolean false
25697 If this option is set and the &%hosts%& option is also set, any hosts that are
25698 attached to the address are ignored, and instead the hosts specified by the
25699 &%hosts%& option are always used. This option does not apply to
25700 &%fallback_hosts%&.
25701
25702
25703 .option hosts_randomize smtp boolean false
25704 .cindex "randomized host list"
25705 .cindex "host" "list of; randomized"
25706 .cindex "fallback" "randomized hosts"
25707 If this option is set, and either the list of hosts is taken from the
25708 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25709 were not obtained from MX records (this includes fallback hosts from the
25710 router), and were not randomized by the router, the order of trying the hosts
25711 is randomized each time the transport runs. Randomizing the order of a host
25712 list can be used to do crude load sharing.
25713
25714 When &%hosts_randomize%& is true, a host list may be split into groups whose
25715 order is separately randomized. This makes it possible to set up MX-like
25716 behaviour. The boundaries between groups are indicated by an item that is just
25717 &`+`& in the host list. For example:
25718 .code
25719 hosts = host1:host2:host3:+:host4:host5
25720 .endd
25721 The order of the first three hosts and the order of the last two hosts is
25722 randomized for each use, but the first three always end up before the last two.
25723 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25724
25725 .option hosts_require_auth smtp "host list&!!" unset
25726 .cindex "authentication" "required by client"
25727 This option provides a list of servers for which authentication must succeed
25728 before Exim will try to transfer a message. If authentication fails for
25729 servers which are not in this list, Exim tries to send unauthenticated. If
25730 authentication fails for one of these servers, delivery is deferred. This
25731 temporary error is detectable in the retry rules, so it can be turned into a
25732 hard failure if required. See also &%hosts_try_auth%&, and chapter
25733 &<<CHAPSMTPAUTH>>& for details of authentication.
25734
25735
25736 .option hosts_request_ocsp smtp "host list&!!" "see below"
25737 .cindex "TLS" "requiring for certain servers"
25738 Exim will request a Certificate Status on a
25739 TLS session for any host that matches this list.
25740 &%tls_verify_certificates%& should also be set for the transport.
25741
25742 .new
25743 The default is &"**"& if DANE is not in use for the connection,
25744 or if DANE-TA us used.
25745 It is empty if DANE-EE is used.
25746 .wen
25747
25748 .option hosts_require_alpn smtp "host list&!!" unset
25749 .cindex ALPN "require negotiation in client"
25750 .cindex TLS ALPN
25751 .cindex TLS "Application Layer Protocol Names"
25752 If the TLS library supports ALPN
25753 then a successful negotiation of ALPN will be required for any host
25754 matching the list, for TLS to be used.
25755 See also the &%tls_alpn%& option.
25756
25757 &*Note*&: prevention of fallback to in-clear connection is not
25758 managed by this option; see &%hosts_require_tls%&.
25759
25760 .option hosts_require_dane smtp "host list&!!" unset
25761 .cindex DANE "transport options"
25762 .cindex DANE "requiring for certain servers"
25763 If built with DANE support, Exim  will require that a DNSSEC-validated
25764 TLSA record is present for any host matching the list,
25765 and that a DANE-verified TLS connection is made.
25766 There will be no fallback to in-clear communication.
25767 See the &%dnssec_request_domains%& router and transport options.
25768 See section &<<SECDANE>>&.
25769
25770 .option hosts_require_ocsp smtp "host list&!!" unset
25771 .cindex "TLS" "requiring for certain servers"
25772 Exim will request, and check for a valid Certificate Status being given, on a
25773 TLS session for any host that matches this list.
25774 &%tls_verify_certificates%& should also be set for the transport.
25775
25776 .option hosts_require_tls smtp "host list&!!" unset
25777 .cindex "TLS" "requiring for certain servers"
25778 Exim will insist on using a TLS session when delivering to any host that
25779 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25780 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25781 incoming messages, use an appropriate ACL.
25782
25783 .option hosts_try_auth smtp "host list&!!" unset
25784 .cindex "authentication" "optional in client"
25785 This option provides a list of servers to which, provided they announce
25786 authentication support, Exim will attempt to authenticate as a client when it
25787 connects. If authentication fails
25788 and &%hosts_require_auth%& permits,
25789 Exim will try to transfer the message unauthenticated.
25790 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25791
25792 .option hosts_try_chunking smtp "host list&!!" *
25793 .cindex CHUNKING "enabling, in client"
25794 .cindex BDAT "SMTP command"
25795 .cindex "RFC 3030" "CHUNKING"
25796 This option provides a list of servers to which, provided they announce
25797 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25798 Unless DKIM signing is being done,
25799 BDAT will not be used in conjunction with a transport filter.
25800
25801 .option hosts_try_dane smtp "host list&!!" *
25802 .cindex DANE "transport options"
25803 .cindex DANE "attempting for certain servers"
25804 If built with DANE support, Exim  will look up a
25805 TLSA record for any host matching the list,
25806 If one is found and that lookup was DNSSEC-validated,
25807 then Exim requires that a DANE-verified TLS connection is made for that host;
25808 there will be no fallback to in-clear communication.
25809 See the &%dnssec_request_domains%& router and transport options.
25810 See section &<<SECDANE>>&.
25811
25812 .option hosts_try_fastopen smtp "host list&!!" *
25813 .cindex "fast open, TCP" "enabling, in client"
25814 .cindex "TCP Fast Open" "enabling, in client"
25815 .cindex "RFC 7413" "TCP Fast Open"
25816 This option provides a list of servers to which, provided
25817 the facility is supported by this system, Exim will attempt to
25818 perform a TCP Fast Open.
25819 No data is sent on the SYN segment but, if the remote server also
25820 supports the facility, it can send its SMTP banner immediately after
25821 the SYN,ACK segment.  This can save up to one round-trip time.
25822
25823 The facility is only active for previously-contacted servers,
25824 as the initiator must present a cookie in the SYN segment.
25825
25826 On (at least some) current Linux distributions the facility must be enabled
25827 in the kernel by the sysadmin before the support is usable.
25828 There is no option for control of the server side; if the system supports
25829 it it is always enabled.  Note that lengthy operations in the connect ACL,
25830 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25831
25832 .option hosts_try_prdr smtp "host list&!!" *
25833 .cindex "PRDR" "enabling, optional in client"
25834 .cindex "ESMTP extensions" PRDR
25835 This option provides a list of servers to which, provided they announce
25836 PRDR support, Exim will attempt to negotiate PRDR
25837 for multi-recipient messages.
25838 The option can usually be left as default.
25839
25840 .option interface smtp "string list&!!" unset
25841 .cindex "bind IP address"
25842 .cindex "IP address" "binding"
25843 .vindex "&$host$&"
25844 .vindex "&$host_address$&"
25845 This option specifies which interface to bind to when making an outgoing SMTP
25846 call. The value is an IP address, not an interface name such as
25847 &`eth0`&. Do not confuse this with the interface address that was used when a
25848 message was received, which is in &$received_ip_address$&, formerly known as
25849 &$interface_address$&. The name was changed to minimize confusion with the
25850 outgoing interface address. There is no variable that contains an outgoing
25851 interface address because, unless it is set by this option, its value is
25852 unknown.
25853
25854 During the expansion of the &%interface%& option the variables &$host$& and
25855 &$host_address$& refer to the host to which a connection is about to be made
25856 during the expansion of the string. Forced expansion failure, or an empty
25857 string result causes the option to be ignored. Otherwise, after expansion, the
25858 string must be a list of IP addresses, colon-separated by default, but the
25859 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25860 For example:
25861 .code
25862 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25863 .endd
25864 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25865 connection. If none of them are the correct type, the option is ignored. If
25866 &%interface%& is not set, or is ignored, the system's IP functions choose which
25867 interface to use if the host has more than one.
25868
25869
25870 .option keepalive smtp boolean true
25871 .cindex "keepalive" "on outgoing connection"
25872 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25873 connections. When set, it causes the kernel to probe idle connections
25874 periodically, by sending packets with &"old"& sequence numbers. The other end
25875 of the connection should send a acknowledgment if the connection is still okay
25876 or a reset if the connection has been aborted. The reason for doing this is
25877 that it has the beneficial effect of freeing up certain types of connection
25878 that can get stuck when the remote host is disconnected without tidying up the
25879 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25880 unreachable hosts.
25881
25882
25883 .option lmtp_ignore_quota smtp boolean false
25884 .cindex "LMTP" "ignoring quota errors"
25885 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25886 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25887 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25888
25889 .option max_rcpt smtp integer&!! 100
25890 .cindex "RCPT" "maximum number of outgoing"
25891 This option,
25892 .new
25893 after expansion,
25894 .wen
25895 limits the number of RCPT commands that are sent in a single
25896 SMTP message transaction.
25897 A value setting of zero disables the limit.
25898
25899 .new
25900 If a constant is given,
25901 .wen
25902 each set of addresses is treated independently, and
25903 so can cause parallel connections to the same host if &%remote_max_parallel%&
25904 permits this.
25905
25906
25907 .option message_linelength_limit smtp integer 998
25908 .cindex "line length" limit
25909 This option sets the maximum line length, in bytes, that the transport
25910 will send.  Any messages with lines exceeding the given value
25911 will fail and a failure-DSN ("bounce") message will if possible be returned
25912 to the sender.
25913 The default value is that defined by the SMTP standards.
25914
25915 It is generally wise to also check in the data ACL so that messages
25916 received via SMTP can be refused without producing a bounce.
25917
25918
25919 .option multi_domain smtp boolean&!! true
25920 .vindex "&$domain$&"
25921 When this option is set, the &(smtp)& transport can handle a number of
25922 addresses containing a mixture of different domains provided they all resolve
25923 to the same list of hosts. Turning the option off restricts the transport to
25924 handling only one domain at a time. This is useful if you want to use
25925 &$domain$& in an expansion for the transport, because it is set only when there
25926 is a single domain involved in a remote delivery.
25927
25928 It is expanded per-address and can depend on any of
25929 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25930 &$host$&, &$host_address$& and &$host_port$&.
25931
25932 If the connection is DANE-enabled then this option is ignored;
25933 only messages having the domain used for the DANE TLSA lookup are
25934 sent on the connection.
25935
25936 .option port smtp string&!! "see below"
25937 .cindex "port" "sending TCP/IP"
25938 .cindex "TCP/IP" "setting outgoing port"
25939 This option specifies the TCP/IP port on the server to which Exim connects.
25940 &*Note:*& Do not confuse this with the port that was used when a message was
25941 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25942 The name was changed to minimize confusion with the outgoing port. There is no
25943 variable that contains an outgoing port.
25944
25945 If the value of this option begins with a digit it is taken as a port number;
25946 otherwise it is looked up using &[getservbyname()]&. The default value is
25947 normally &"smtp"&,
25948 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25949 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25950 If the expansion fails, or if a port number cannot be found, delivery
25951 is deferred.
25952
25953 Note that at least one Linux distribution has been seen failing
25954 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25955
25956
25957
25958 .option protocol smtp string smtp
25959 .cindex "LMTP" "over TCP/IP"
25960 .cindex "ssmtp protocol" "outbound"
25961 .cindex "TLS" "SSL-on-connect outbound"
25962 .vindex "&$port$&"
25963 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25964 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25965 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25966 deliveries into closed message stores. Exim also has support for running LMTP
25967 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25968
25969 If this option is set to &"smtps"&, the default value for the &%port%& option
25970 changes to &"smtps"&, and the transport initiates TLS immediately after
25971 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25972 The Internet standards bodies used to strongly discourage use of this mode,
25973 but as of RFC 8314 it is preferred over STARTTLS for message submission
25974 (as distinct from MTA-MTA communication).
25975
25976
25977 .option retry_include_ip_address smtp boolean&!! true
25978 Exim normally includes both the host name and the IP address in the key it
25979 constructs for indexing retry data after a temporary delivery failure. This
25980 means that when one of several IP addresses for a host is failing, it gets
25981 tried periodically (controlled by the retry rules), but use of the other IP
25982 addresses is not affected.
25983
25984 However, in some dialup environments hosts are assigned a different IP address
25985 each time they connect. In this situation the use of the IP address as part of
25986 the retry key leads to undesirable behaviour. Setting this option false causes
25987 Exim to use only the host name.
25988 Since it is expanded it can be made to depend on the host or domain.
25989
25990
25991 .option serialize_hosts smtp "host list&!!" unset
25992 .cindex "serializing connections"
25993 .cindex "host" "serializing connections"
25994 Because Exim operates in a distributed manner, if several messages for the same
25995 host arrive at around the same time, more than one simultaneous connection to
25996 the remote host can occur. This is not usually a problem except when there is a
25997 slow link between the hosts. In that situation it may be helpful to restrict
25998 Exim to one connection at a time. This can be done by setting
25999 &%serialize_hosts%& to match the relevant hosts.
26000
26001 .cindex "hints database" "serializing deliveries to a host"
26002 Exim implements serialization by means of a hints database in which a record is
26003 written whenever a process connects to one of the restricted hosts. The record
26004 is deleted when the connection is completed. Obviously there is scope for
26005 records to get left lying around if there is a system or program crash. To
26006 guard against this, Exim ignores any records that are more than six hours old.
26007
26008 If you set up this kind of serialization, you should also arrange to delete the
26009 relevant hints database whenever your system reboots. The names of the files
26010 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26011 may be one or two files, depending on the type of DBM in use. The same files
26012 are used for ETRN serialization.
26013
26014 See also the &%max_parallel%& generic transport option.
26015
26016
26017 .option size_addition smtp integer 1024
26018 .cindex "SIZE" "ESMTP extension"
26019 .cindex "message" "size issue for transport filter"
26020 .cindex "size" "of message"
26021 .cindex "transport" "filter"
26022 .cindex "filter" "transport filter"
26023 If a remote SMTP server indicates that it supports the SIZE option of the
26024 MAIL command, Exim uses this to pass over the message size at the start of
26025 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26026 sends, to allow for headers and other text that may be added during delivery by
26027 configuration options or in a transport filter. It may be necessary to increase
26028 this if a lot of text is added to messages.
26029
26030 Alternatively, if the value of &%size_addition%& is set negative, it disables
26031 the use of the SIZE option altogether.
26032
26033
26034 .option socks_proxy smtp string&!! unset
26035 .cindex proxy SOCKS
26036 This option enables use of SOCKS proxies for connections made by the
26037 transport.  For details see section &<<SECTproxySOCKS>>&.
26038
26039
26040 .option tls_alpn smtp string&!! unset
26041 .cindex TLS "Application Layer Protocol Names"
26042 .cindex TLS ALPN
26043 .cindex ALPN "set name in client"
26044 If this option is set
26045 and the TLS library supports ALPN,
26046 the value given is used.
26047
26048 As of writing no value has been standardised for email use.
26049 The authors suggest using &"smtp"&.
26050
26051
26052
26053 .option tls_certificate smtp string&!! unset
26054 .cindex "TLS" "client certificate, location of"
26055 .cindex "certificate" "client, location of"
26056 .vindex "&$host$&"
26057 .vindex "&$host_address$&"
26058 The value of this option must be the absolute path to a file which contains the
26059 client's certificate, for possible use when sending a message over an encrypted
26060 connection. The values of &$host$& and &$host_address$& are set to the name and
26061 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26062 details of TLS.
26063
26064 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26065 certificate when sending messages as a client. The global option of the same
26066 name specifies the certificate for Exim as a server; it is not automatically
26067 assumed that the same certificate should be used when Exim is operating as a
26068 client.
26069
26070
26071 .option tls_crl smtp string&!! unset
26072 .cindex "TLS" "client certificate revocation list"
26073 .cindex "certificate" "revocation list for client"
26074 This option specifies a certificate revocation list. The expanded value must
26075 be the name of a file that contains a CRL in PEM format.
26076
26077
26078 .option tls_dh_min_bits smtp integer 1024
26079 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26080 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26081 key agreement is negotiated, the server will provide a large prime number
26082 for use.  This option establishes the minimum acceptable size of that number.
26083 If the parameter offered by the server is too small, then the TLS handshake
26084 will fail.
26085
26086 Only supported when using GnuTLS.
26087
26088
26089 .option tls_privatekey smtp string&!! unset
26090 .cindex "TLS" "client private key, location of"
26091 .vindex "&$host$&"
26092 .vindex "&$host_address$&"
26093 The value of this option must be the absolute path to a file which contains the
26094 client's private key. This is used when sending a message over an encrypted
26095 connection using a client certificate. The values of &$host$& and
26096 &$host_address$& are set to the name and address of the server during the
26097 expansion. If this option is unset, or the expansion is forced to fail, or the
26098 result is an empty string, the private key is assumed to be in the same file as
26099 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26100
26101
26102 .option tls_require_ciphers smtp string&!! unset
26103 .cindex "TLS" "requiring specific ciphers"
26104 .cindex "cipher" "requiring specific"
26105 .vindex "&$host$&"
26106 .vindex "&$host_address$&"
26107 The value of this option must be a list of permitted cipher suites, for use
26108 when setting up an outgoing encrypted connection. (There is a global option of
26109 the same name for controlling incoming connections.) The values of &$host$& and
26110 &$host_address$& are set to the name and address of the server during the
26111 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26112 is used in different ways by OpenSSL and GnuTLS (see sections
26113 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26114 ciphers is a preference order.
26115
26116
26117 .option tls_resumption_hosts smtp "host list&!!" unset
26118 .cindex TLS resumption
26119 This option controls which connections to use the TLS resumption feature.
26120 See &<<SECTresumption>>& for details.
26121
26122
26123
26124 .option tls_sni smtp string&!! unset
26125 .cindex "TLS" "Server Name Indication"
26126 .cindex "TLS" SNI
26127 .cindex SNI "setting in client"
26128 .vindex "&$tls_sni$&"
26129 If this option is set
26130 and the connection is not DANE-validated
26131 then it sets the $tls_out_sni variable and causes any
26132 TLS session to pass this value as the Server Name Indication extension to
26133 the remote side, which can be used by the remote side to select an appropriate
26134 certificate and private key for the session.
26135
26136 See &<<SECTtlssni>>& for more information.
26137
26138 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26139 TLS extensions.
26140
26141
26142
26143
26144 .option tls_tempfail_tryclear smtp boolean true
26145 .cindex "4&'xx'& responses" "to STARTTLS"
26146 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26147 setting up a TLS session, this option determines whether or not Exim should try
26148 to deliver the message unencrypted. If it is set false, delivery to the
26149 current host is deferred; if there are other hosts, they are tried. If this
26150 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26151 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26152 TLS negotiation fails, Exim closes the current connection (because it is in an
26153 unknown state), opens a new one to the same host, and then tries the delivery
26154 in clear.
26155
26156
26157 .option tls_try_verify_hosts smtp "host list&!!" *
26158 .cindex "TLS" "server certificate verification"
26159 .cindex "certificate" "verification of server"
26160 This option gives a list of hosts for which, on encrypted connections,
26161 certificate verification will be tried but need not succeed.
26162 The &%tls_verify_certificates%& option must also be set.
26163 Note that unless the host is in this list
26164 TLS connections will be denied to hosts using self-signed certificates
26165 when &%tls_verify_certificates%& is matched.
26166 The &$tls_out_certificate_verified$& variable is set when
26167 certificate verification succeeds.
26168
26169
26170 .option tls_verify_cert_hostnames smtp "host list&!!" *
26171 .cindex "TLS" "server certificate hostname verification"
26172 .cindex "certificate" "verification of server"
26173 This option give a list of hosts for which,
26174 while verifying the server certificate,
26175 checks will be included on the host name
26176 (note that this will generally be the result of a DNS MX lookup)
26177 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26178 Wildcard names are permitted,
26179 limited to being the initial component of a 3-or-more component FQDN.
26180
26181 There is no equivalent checking on client certificates.
26182
26183
26184 .option tls_verify_certificates smtp string&!! system
26185 .cindex "TLS" "server certificate verification"
26186 .cindex "certificate" "verification of server"
26187 .vindex "&$host$&"
26188 .vindex "&$host_address$&"
26189 The value of this option must be either the
26190 word "system"
26191 or the absolute path to
26192 a file or directory containing permitted certificates for servers,
26193 for use when setting up an encrypted connection.
26194
26195 The "system" value for the option will use a location compiled into the SSL library.
26196 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26197 is taken as empty and an explicit location
26198 must be specified.
26199
26200 The use of a directory for the option value is not available for GnuTLS versions
26201 preceding 3.3.6 and a single file must be used.
26202
26203 With OpenSSL the certificates specified
26204 explicitly
26205 either by file or directory
26206 are added to those given by the system default location.
26207
26208 The values of &$host$& and
26209 &$host_address$& are set to the name and address of the server during the
26210 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26211
26212 For back-compatibility,
26213 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26214 (a single-colon empty list counts as being set)
26215 and certificate verification fails the TLS connection is closed.
26216
26217
26218 .option tls_verify_hosts smtp "host list&!!" unset
26219 .cindex "TLS" "server certificate verification"
26220 .cindex "certificate" "verification of server"
26221 This option gives a list of hosts for which, on encrypted connections,
26222 certificate verification must succeed.
26223 The &%tls_verify_certificates%& option must also be set.
26224 If both this option and &%tls_try_verify_hosts%& are unset
26225 operation is as if this option selected all hosts.
26226 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26227 that connections use TLS.
26228 Fallback to in-clear communication will be done unless restricted by
26229 the &%hosts_require_tls%& option.
26230
26231 .option utf8_downconvert smtp integer&!! -1
26232 .cindex utf8 "address downconversion"
26233 .cindex i18n "utf8 address downconversion"
26234 If built with internationalization support,
26235 this option controls conversion of UTF-8 in message envelope addresses
26236 to a-label form.
26237 If, after expansion, the value is 1, 0, or -1 then this value overrides
26238 any value previously set for the message.  Otherwise, any previously
26239 set value is used.  To permit use of a previous value,
26240 set this option to an empty string.
26241 For details on the values see section &<<SECTi18nMTA>>&.
26242
26243
26244
26245
26246 .section "How the limits for the number of hosts to try are used" &&&
26247          "SECTvalhosmax"
26248 .cindex "host" "maximum number to try"
26249 .cindex "limit" "hosts; maximum number tried"
26250 There are two options that are concerned with the number of hosts that are
26251 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26252 &%hosts_max_try_hardlimit%&.
26253
26254
26255 The &%hosts_max_try%& option limits the number of hosts that are tried
26256 for a single delivery. However, despite the term &"host"& in its name, the
26257 option actually applies to each IP address independently. In other words, a
26258 multihomed host is treated as several independent hosts, just as it is for
26259 retrying.
26260
26261 Many of the larger ISPs have multiple MX records which often point to
26262 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26263 created as a result of routing one of these domains.
26264
26265 Trying every single IP address on such a long list does not seem sensible; if
26266 several at the top of the list fail, it is reasonable to assume there is some
26267 problem that is likely to affect all of them. Roughly speaking, the value of
26268 &%hosts_max_try%& is the maximum number that are tried before deferring the
26269 delivery. However, the logic cannot be quite that simple.
26270
26271 Firstly, IP addresses that are skipped because their retry times have not
26272 arrived do not count, and in addition, addresses that are past their retry
26273 limits are also not counted, even when they are tried. This means that when
26274 some IP addresses are past their retry limits, more than the value of
26275 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26276 that all IP addresses are considered before timing out an email address (but
26277 see below for an exception).
26278
26279 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26280 list to see if there is a subsequent host with a different (higher valued) MX.
26281 If there is, that host is considered next, and the current IP address is used
26282 but not counted. This behaviour helps in the case of a domain with a retry rule
26283 that hardly ever delays any hosts, as is now explained:
26284
26285 Consider the case of a long list of hosts with one MX value, and a few with a
26286 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26287 hosts at the top of the list are tried at first. With the default retry rule,
26288 which specifies increasing retry times, the higher MX hosts are eventually
26289 tried when those at the top of the list are skipped because they have not
26290 reached their retry times.
26291
26292 However, it is common practice to put a fixed short retry time on domains for
26293 large ISPs, on the grounds that their servers are rarely down for very long.
26294 Unfortunately, these are exactly the domains that tend to resolve to long lists
26295 of hosts. The short retry time means that the lowest MX hosts are tried every
26296 time. The attempts may be in a different order because of random sorting, but
26297 without the special MX check, the higher MX hosts would never be tried until
26298 all the lower MX hosts had timed out (which might be several days), because
26299 there are always some lower MX hosts that have reached their retry times. With
26300 the special check, Exim considers at least one IP address from each MX value at
26301 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26302 reached.
26303
26304 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26305 particular, Exim normally eventually tries all the IP addresses before timing
26306 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26307 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26308 been set up with hundreds of IP addresses for some domains. It can
26309 take a very long time indeed for an address to time out in these cases.
26310
26311 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26312 Exim never tries more than this number of IP addresses; if it hits this limit
26313 and they are all timed out, the email address is bounced, even though not all
26314 possible IP addresses have been tried.
26315 .ecindex IIDsmttra1
26316 .ecindex IIDsmttra2
26317
26318
26319
26320
26321
26322 . ////////////////////////////////////////////////////////////////////////////
26323 . ////////////////////////////////////////////////////////////////////////////
26324
26325 .chapter "Address rewriting" "CHAPrewrite"
26326 .scindex IIDaddrew "rewriting" "addresses"
26327 There are some circumstances in which Exim automatically rewrites domains in
26328 addresses. The two most common are when an address is given without a domain
26329 (referred to as an &"unqualified address"&) or when an address contains an
26330 abbreviated domain that is expanded by DNS lookup.
26331
26332 Unqualified envelope addresses are accepted only for locally submitted
26333 messages, or for messages that are received from hosts matching
26334 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26335 appropriate. Unqualified addresses in header lines are qualified if they are in
26336 locally submitted messages, or messages from hosts that are permitted to send
26337 unqualified envelope addresses. Otherwise, unqualified addresses in header
26338 lines are neither qualified nor rewritten.
26339
26340 One situation in which Exim does &'not'& automatically rewrite a domain is
26341 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26342 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26343 do this. The new RFCs do not contain this suggestion.
26344
26345
26346 .section "Explicitly configured address rewriting" "SECID147"
26347 This chapter describes the rewriting rules that can be used in the
26348 main rewrite section of the configuration file, and also in the generic
26349 &%headers_rewrite%& option that can be set on any transport.
26350
26351 Some people believe that configured address rewriting is a Mortal Sin.
26352 Others believe that life is not possible without it. Exim provides the
26353 facility; you do not have to use it.
26354
26355 The main rewriting rules that appear in the &"rewrite"& section of the
26356 configuration file are applied to addresses in incoming messages, both envelope
26357 addresses and addresses in header lines. Each rule specifies the types of
26358 address to which it applies.
26359
26360 Whether or not addresses in header lines are rewritten depends on the origin of
26361 the headers and the type of rewriting. Global rewriting, that is, rewriting
26362 rules from the rewrite section of the configuration file, is applied only to
26363 those headers that were received with the message. Header lines that are added
26364 by ACLs or by a system filter or by individual routers or transports (which
26365 are specific to individual recipient addresses) are not rewritten by the global
26366 rules.
26367
26368 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26369 applies all headers except those added by routers and transports. That is, as
26370 well as the headers that were received with the message, it also applies to
26371 headers that were added by an ACL or a system filter.
26372
26373
26374 In general, rewriting addresses from your own system or domain has some
26375 legitimacy. Rewriting other addresses should be done only with great care and
26376 in special circumstances. The author of Exim believes that rewriting should be
26377 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26378 Although it can sometimes be used as a routing tool, this is very strongly
26379 discouraged.
26380
26381 There are two commonly encountered circumstances where rewriting is used, as
26382 illustrated by these examples:
26383
26384 .ilist
26385 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26386 exchange mail with each other behind a firewall, but there is only a single
26387 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26388 &'hitch.fict.example'& when sending mail off-site.
26389 .next
26390 A host rewrites the local parts of its own users so that, for example,
26391 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26392 .endlist
26393
26394
26395
26396 .section "When does rewriting happen?" "SECID148"
26397 .cindex "rewriting" "timing of"
26398 .cindex "&ACL;" "rewriting addresses in"
26399 Configured address rewriting can take place at several different stages of a
26400 message's processing.
26401
26402 .vindex "&$sender_address$&"
26403 At the start of an ACL for MAIL, the sender address may have been rewritten
26404 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26405 ordinary rewrite rules have yet been applied. If, however, the sender address
26406 is verified in the ACL, it is rewritten before verification, and remains
26407 rewritten thereafter. The subsequent value of &$sender_address$& is the
26408 rewritten address. This also applies if sender verification happens in a
26409 RCPT ACL. Otherwise, when the sender address is not verified, it is
26410 rewritten as soon as a message's header lines have been received.
26411
26412 .vindex "&$domain$&"
26413 .vindex "&$local_part$&"
26414 Similarly, at the start of an ACL for RCPT, the current recipient's address
26415 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26416 rewrite rules have yet been applied to it. However, the behaviour is different
26417 from the sender address when a recipient is verified. The address is rewritten
26418 for the verification, but the rewriting is not remembered at this stage. The
26419 value of &$local_part$& and &$domain$& after verification are always the same
26420 as they were before (that is, they contain the unrewritten &-- except for
26421 SMTP-time rewriting &-- address).
26422
26423 As soon as a message's header lines have been received, all the envelope
26424 recipient addresses are permanently rewritten, and rewriting is also applied to
26425 the addresses in the header lines (if configured). This happens before adding
26426 any header lines that were specified in MAIL or RCPT ACLs, and
26427 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26428 before the DATA ACL and &[local_scan()]& functions are run.
26429
26430 When an address is being routed, either for delivery or for verification,
26431 rewriting is applied immediately to child addresses that are generated by
26432 redirection, unless &%no_rewrite%& is set on the router.
26433
26434 .cindex "envelope from"
26435 .cindex "envelope sender" "rewriting at transport time"
26436 .cindex "rewriting" "at transport time"
26437 .cindex "header lines" "rewriting at transport time"
26438 At transport time, additional rewriting of addresses in header lines can be
26439 specified by setting the generic &%headers_rewrite%& option on a transport.
26440 This option contains rules that are identical in form to those in the rewrite
26441 section of the configuration file. They are applied to the original message
26442 header lines and any that were added by ACLs or a system filter. They are not
26443 applied to header lines that are added by routers or the transport.
26444
26445 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26446 transport option. However, it is not possible to rewrite envelope recipients at
26447 transport time.
26448
26449
26450
26451
26452 .section "Testing the rewriting rules that apply on input" "SECID149"
26453 .cindex "rewriting" "testing"
26454 .cindex "testing" "rewriting"
26455 Exim's input rewriting configuration appears in a part of the runtime
26456 configuration file headed by &"begin rewrite"&. It can be tested by the
26457 &%-brw%& command line option. This takes an address (which can be a full RFC
26458 2822 address) as its argument. The output is a list of how the address would be
26459 transformed by the rewriting rules for each of the different places it might
26460 appear in an incoming message, that is, for each different header and for the
26461 envelope sender and recipient fields. For example,
26462 .code
26463 exim -brw ph10@exim.workshop.example
26464 .endd
26465 might produce the output
26466 .code
26467 sender: Philip.Hazel@exim.workshop.example
26468 from: Philip.Hazel@exim.workshop.example
26469 to: ph10@exim.workshop.example
26470 cc: ph10@exim.workshop.example
26471 bcc: ph10@exim.workshop.example
26472 reply-to: Philip.Hazel@exim.workshop.example
26473 env-from: Philip.Hazel@exim.workshop.example
26474 env-to: ph10@exim.workshop.example
26475 .endd
26476 which shows that rewriting has been set up for that address when used in any of
26477 the source fields, but not when it appears as a recipient address. At the
26478 present time, there is no equivalent way of testing rewriting rules that are
26479 set for a particular transport.
26480
26481
26482 .section "Rewriting rules" "SECID150"
26483 .cindex "rewriting" "rules"
26484 The rewrite section of the configuration file consists of lines of rewriting
26485 rules in the form
26486 .display
26487 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26488 .endd
26489 Rewriting rules that are specified for the &%headers_rewrite%& generic
26490 transport option are given as a colon-separated list. Each item in the list
26491 takes the same form as a line in the main rewriting configuration (except that
26492 any colons must be doubled, of course).
26493
26494 The formats of source patterns and replacement strings are described below.
26495 Each is terminated by white space, unless enclosed in double quotes, in which
26496 case normal quoting conventions apply inside the quotes. The flags are single
26497 characters which may appear in any order. Spaces and tabs between them are
26498 ignored.
26499
26500 For each address that could potentially be rewritten, the rules are scanned in
26501 order, and replacements for the address from earlier rules can themselves be
26502 replaced by later rules (but see the &"q"& and &"R"& flags).
26503
26504 The order in which addresses are rewritten is undefined, may change between
26505 releases, and must not be relied on, with one exception: when a message is
26506 received, the envelope sender is always rewritten first, before any header
26507 lines are rewritten. For example, the replacement string for a rewrite of an
26508 address in &'To:'& must not assume that the message's address in &'From:'& has
26509 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26510 that the envelope sender has already been rewritten.
26511
26512 .vindex "&$domain$&"
26513 .vindex "&$local_part$&"
26514 The variables &$local_part$& and &$domain$& can be used in the replacement
26515 string to refer to the address that is being rewritten. Note that lookup-driven
26516 rewriting can be done by a rule of the form
26517 .code
26518 *@*   ${lookup ...
26519 .endd
26520 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26521 refer to the address that is being rewritten.
26522
26523
26524 .section "Rewriting patterns" "SECID151"
26525 .cindex "rewriting" "patterns"
26526 .cindex "address list" "in a rewriting pattern"
26527 The source pattern in a rewriting rule is any item which may appear in an
26528 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26529 single-item address list, which means that it is expanded before being tested
26530 against the address. As always, if you use a regular expression as a pattern,
26531 you must take care to escape dollar and backslash characters, or use the &`\N`&
26532 facility to suppress string expansion within the regular expression.
26533
26534 Domains in patterns should be given in lower case. Local parts in patterns are
26535 case-sensitive. If you want to do case-insensitive matching of local parts, you
26536 can use a regular expression that starts with &`^(?i)`&.
26537
26538 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26539 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26540 depending on the type of match which occurred. These can be used in the
26541 replacement string to insert portions of the incoming address. &$0$& always
26542 refers to the complete incoming address. When a regular expression is used, the
26543 numerical variables are set from its capturing subexpressions. For other types
26544 of pattern they are set as follows:
26545
26546 .ilist
26547 If a local part or domain starts with an asterisk, the numerical variables
26548 refer to the character strings matched by asterisks, with &$1$& associated with
26549 the first asterisk, and &$2$& with the second, if present. For example, if the
26550 pattern
26551 .code
26552 *queen@*.fict.example
26553 .endd
26554 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26555 .code
26556 $0 = hearts-queen@wonderland.fict.example
26557 $1 = hearts-
26558 $2 = wonderland
26559 .endd
26560 Note that if the local part does not start with an asterisk, but the domain
26561 does, it is &$1$& that contains the wild part of the domain.
26562
26563 .next
26564 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26565 of the domain are placed in the next available numerical variables. Suppose,
26566 for example, that the address &'foo@bar.baz.example'& is processed by a
26567 rewriting rule of the form
26568 .display
26569 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26570 .endd
26571 and the key in the file that matches the domain is &`*.baz.example`&. Then
26572 .code
26573 $1 = foo
26574 $2 = bar
26575 $3 = baz.example
26576 .endd
26577 If the address &'foo@baz.example'& is looked up, this matches the same
26578 wildcard file entry, and in this case &$2$& is set to the empty string, but
26579 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26580 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26581 whole domain. For non-partial domain lookups, no numerical variables are set.
26582 .endlist
26583
26584
26585 .section "Rewriting replacements" "SECID152"
26586 .cindex "rewriting" "replacements"
26587 If the replacement string for a rule is a single asterisk, addresses that
26588 match the pattern and the flags are &'not'& rewritten, and no subsequent
26589 rewriting rules are scanned. For example,
26590 .code
26591 hatta@lookingglass.fict.example  *  f
26592 .endd
26593 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26594 &'From:'& headers.
26595
26596 .vindex "&$domain$&"
26597 .vindex "&$local_part$&"
26598 If the replacement string is not a single asterisk, it is expanded, and must
26599 yield a fully qualified address. Within the expansion, the variables
26600 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26601 Any letters they contain retain their original case &-- they are not lower
26602 cased. The numerical variables are set up according to the type of pattern that
26603 matched the address, as described above. If the expansion is forced to fail by
26604 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26605 current rule is abandoned, but subsequent rules may take effect. Any other
26606 expansion failure causes the entire rewriting operation to be abandoned, and an
26607 entry written to the panic log.
26608
26609
26610
26611 .subsection "Rewriting flags" "SSECID153"
26612 There are three different kinds of flag that may appear on rewriting rules:
26613
26614 .ilist
26615 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26616 c, f, h, r, s, t.
26617 .next
26618 A flag that specifies rewriting at SMTP time: S.
26619 .next
26620 Flags that control the rewriting process: Q, q, R, w.
26621 .endlist
26622
26623 For rules that are part of the &%headers_rewrite%& generic transport option,
26624 E, F, T, and S are not permitted.
26625
26626
26627
26628 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26629          "SSECID154"
26630 .cindex rewriting flags
26631 If none of the following flag letters, nor the &"S"& flag (see section
26632 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26633 and to both the sender and recipient fields of the envelope, whereas a
26634 transport-time rewriting rule just applies to all headers. Otherwise, the
26635 rewriting rule is skipped unless the relevant addresses are being processed.
26636 .display
26637 &`E`&       rewrite all envelope fields
26638 &`F`&       rewrite the envelope From field
26639 &`T`&       rewrite the envelope To field
26640 &`b`&       rewrite the &'Bcc:'& header
26641 &`c`&       rewrite the &'Cc:'& header
26642 &`f`&       rewrite the &'From:'& header
26643 &`h`&       rewrite all headers
26644 &`r`&       rewrite the &'Reply-To:'& header
26645 &`s`&       rewrite the &'Sender:'& header
26646 &`t`&       rewrite the &'To:'& header
26647 .endd
26648 "All headers" means all of the headers listed above that can be selected
26649 individually, plus their &'Resent-'& versions. It does not include
26650 other headers such as &'Subject:'& etc.
26651
26652 You should be particularly careful about rewriting &'Sender:'& headers, and
26653 restrict this to special known cases in your own domains.
26654
26655
26656 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26657 .cindex SMTP "rewriting malformed addresses"
26658 .cindex RCPT "rewriting argument of"
26659 .cindex MAIL "rewriting argument of"
26660 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26661 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26662 before any other processing; even before syntax checking. The pattern is
26663 required to be a regular expression, and it is matched against the whole of the
26664 data for the command, including any surrounding angle brackets.
26665
26666 .vindex "&$domain$&"
26667 .vindex "&$local_part$&"
26668 This form of rewrite rule allows for the handling of addresses that are not
26669 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26670 input). Because the input is not required to be a syntactically valid address,
26671 the variables &$local_part$& and &$domain$& are not available during the
26672 expansion of the replacement string. The result of rewriting replaces the
26673 original address in the MAIL or RCPT command.
26674
26675
26676 .subsection "Flags controlling the rewriting process" SSECID155
26677 There are four flags which control the way the rewriting process works. These
26678 take effect only when a rule is invoked, that is, when the address is of the
26679 correct type (matches the flags) and matches the pattern:
26680
26681 .ilist
26682 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26683 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26684 absence of &"Q"& the rewritten address must always include a domain.
26685 .next
26686 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26687 even if no rewriting actually takes place because of a &"fail"& in the
26688 expansion. The &"q"& flag is not effective if the address is of the wrong type
26689 (does not match the flags) or does not match the pattern.
26690 .next
26691 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26692 address, up to ten times. It can be combined with the &"q"& flag, to stop
26693 rewriting once it fails to match (after at least one successful rewrite).
26694 .next
26695 .cindex "rewriting" "whole addresses"
26696 When an address in a header is rewritten, the rewriting normally applies only
26697 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26698 left unchanged. For example, rewriting might change
26699 .code
26700 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26701 .endd
26702 into
26703 .code
26704 From: Ford Prefect <prefectf@hitch.fict.example>
26705 .endd
26706 .cindex "RFC 2047"
26707 Sometimes there is a need to replace the whole address item, and this can be
26708 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26709 causes an address in a header line to be rewritten, the entire address is
26710 replaced, not just the working part. The replacement must be a complete RFC
26711 2822 address, including the angle brackets if necessary. If text outside angle
26712 brackets contains a character whose value is greater than 126 or less than 32
26713 (except for tab), the text is encoded according to RFC 2047. The character set
26714 is taken from &%headers_charset%&, which gets its default at build time.
26715
26716 When the &"w"& flag is set on a rule that causes an envelope address to be
26717 rewritten, all but the working part of the replacement address is discarded.
26718 .endlist
26719
26720
26721 .section "Rewriting examples" "SECID156"
26722 Here is an example of the two common rewriting paradigms:
26723 .code
26724 *@*.hitch.fict.example  $1@hitch.fict.example
26725 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26726                      {$value}fail}@hitch.fict.example bctfrF
26727 .endd
26728 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26729 the string expansion to fail if the lookup does not succeed. In this context it
26730 has the effect of leaving the original address unchanged, but Exim goes on to
26731 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26732 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26733 explicitly, which would cause the rewritten address to be the same as before,
26734 at the cost of a small bit of processing. Not supplying either of these is an
26735 error, since the rewritten address would then contain no local part.
26736
26737 The first example above replaces the domain with a superior, more general
26738 domain. This may not be desirable for certain local parts. If the rule
26739 .code
26740 root@*.hitch.fict.example  *
26741 .endd
26742 were inserted before the first rule, rewriting would be suppressed for the
26743 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26744
26745 Rewriting can be made conditional on a number of tests, by making use of
26746 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26747 messages that originate outside the local host:
26748 .code
26749 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26750                          {$1@hitch.fict.example}fail}"
26751 .endd
26752 The replacement string is quoted in this example because it contains white
26753 space.
26754
26755 .cindex "rewriting" "bang paths"
26756 .cindex "bang paths" "rewriting"
26757 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26758 an address it treats it as an unqualified local part which it qualifies with
26759 the local qualification domain (if the source of the message is local or if the
26760 remote host is permitted to send unqualified addresses). Rewriting can
26761 sometimes be used to handle simple bang paths with a fixed number of
26762 components. For example, the rule
26763 .code
26764 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26765 .endd
26766 rewrites a two-component bang path &'host.name!user'& as the domain address
26767 &'user@host.name'&. However, there is a security implication in using this as
26768 a global rewriting rule for envelope addresses. It can provide a backdoor
26769 method for using your system as a relay, because the incoming addresses appear
26770 to be local. If the bang path addresses are received via SMTP, it is safer to
26771 use the &"S"& flag to rewrite them as they are received, so that relay checking
26772 can be done on the rewritten addresses.
26773 .ecindex IIDaddrew
26774
26775
26776
26777
26778
26779 . ////////////////////////////////////////////////////////////////////////////
26780 . ////////////////////////////////////////////////////////////////////////////
26781
26782 .chapter "Retry configuration" "CHAPretry"
26783 .scindex IIDretconf1 "retry" "configuration, description of"
26784 .scindex IIDregconf2 "configuration file" "retry section"
26785 The &"retry"& section of the runtime configuration file contains a list of
26786 retry rules that control how often Exim tries to deliver messages that cannot
26787 be delivered at the first attempt. If there are no retry rules (the section is
26788 empty or not present), there are no retries. In this situation, temporary
26789 errors are treated as permanent. The default configuration contains a single,
26790 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26791 line option can be used to test which retry rule will be used for a given
26792 address, domain and error.
26793
26794 The most common cause of retries is temporary failure to deliver to a remote
26795 host because the host is down, or inaccessible because of a network problem.
26796 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26797 address) basis, not on a per-message basis. Thus, if one message has recently
26798 been delayed, delivery of a new message to the same host is not immediately
26799 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26800 log selector is set, the message
26801 .cindex "retry" "time not reached"
26802 &"retry time not reached"& is written to the main log whenever a delivery is
26803 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26804 the handling of errors during remote deliveries.
26805
26806 Retry processing applies to routing as well as to delivering, except as covered
26807 in the next paragraph. The retry rules do not distinguish between these
26808 actions. It is not possible, for example, to specify different behaviour for
26809 failures to route the domain &'snark.fict.example'& and failures to deliver to
26810 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26811 added complication, so did not implement it. However, although they share the
26812 same retry rule, the actual retry times for routing and transporting a given
26813 domain are maintained independently.
26814
26815 When a delivery is not part of a queue run (typically an immediate delivery on
26816 receipt of a message), the routers are always run, and local deliveries are
26817 always attempted, even if retry times are set for them. This makes for better
26818 behaviour if one particular message is causing problems (for example, causing
26819 quota overflow, or provoking an error in a filter file). If such a delivery
26820 suffers a temporary failure, the retry data is updated as normal, and
26821 subsequent delivery attempts from queue runs occur only when the retry time for
26822 the local address is reached.
26823
26824 .section "Changing retry rules" "SECID157"
26825 If you change the retry rules in your configuration, you should consider
26826 whether or not to delete the retry data that is stored in Exim's spool area in
26827 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26828 always safe; that is why they are called &"hints"&.
26829
26830 The hints retry data contains suggested retry times based on the previous
26831 rules. In the case of a long-running problem with a remote host, it might
26832 record the fact that the host has timed out. If your new rules increase the
26833 timeout time for such a host, you should definitely remove the old retry data
26834 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26835 messages that it should now be retaining.
26836
26837
26838
26839 .section "Format of retry rules" "SECID158"
26840 .cindex "retry" "rules"
26841 Each retry rule occupies one line and consists of three or four parts,
26842 separated by white space: a pattern, an error name, an optional list of sender
26843 addresses, and a list of retry parameters. The pattern and sender lists must be
26844 enclosed in double quotes if they contain white space. The rules are searched
26845 in order until one is found where the pattern, error name, and sender list (if
26846 present) match the failing host or address, the error that occurred, and the
26847 message's sender, respectively.
26848
26849
26850 The pattern is any single item that may appear in an address list (see section
26851 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26852 which means that it is expanded before being tested against the address that
26853 has been delayed. A negated address list item is permitted. Address
26854 list processing treats a plain domain name as if it were preceded by &"*@"&,
26855 which makes it possible for many retry rules to start with just a domain. For
26856 example,
26857 .code
26858 lookingglass.fict.example        *  F,24h,30m;
26859 .endd
26860 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26861 whereas
26862 .code
26863 alice@lookingglass.fict.example  *  F,24h,30m;
26864 .endd
26865 applies only to temporary failures involving the local part &%alice%&.
26866 In practice, almost all rules start with a domain name pattern without a local
26867 part.
26868
26869 .cindex "regular expressions" "in retry rules"
26870 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26871 must match a complete address, not just a domain, because that is how regular
26872 expressions work in address lists.
26873 .display
26874 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26875 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26876 .endd
26877
26878
26879 .section "Choosing which retry rule to use for address errors" "SECID159"
26880 When Exim is looking for a retry rule after a routing attempt has failed (for
26881 example, after a DNS timeout), each line in the retry configuration is tested
26882 against the complete address only if &%retry_use_local_part%& is set for the
26883 router. Otherwise, only the domain is used, except when matching against a
26884 regular expression, when the local part of the address is replaced with &"*"&.
26885 A domain on its own can match a domain pattern, or a pattern that starts with
26886 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26887 &%check_local_user%& is true, and false for other routers.
26888
26889 Similarly, when Exim is looking for a retry rule after a local delivery has
26890 failed (for example, after a mailbox full error), each line in the retry
26891 configuration is tested against the complete address only if
26892 &%retry_use_local_part%& is set for the transport (it defaults true for all
26893 local transports).
26894
26895 .cindex "4&'xx'& responses" "retry rules for"
26896 However, when Exim is looking for a retry rule after a remote delivery attempt
26897 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26898 whole address is always used as the key when searching the retry rules. The
26899 rule that is found is used to create a retry time for the combination of the
26900 failing address and the message's sender. It is the combination of sender and
26901 recipient that is delayed in subsequent queue runs until its retry time is
26902 reached. You can delay the recipient without regard to the sender by setting
26903 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26904 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26905 commands.
26906
26907
26908
26909 .section "Choosing which retry rule to use for host and message errors" &&&
26910          "SECID160"
26911 For a temporary error that is not related to an individual address (for
26912 example, a connection timeout), each line in the retry configuration is checked
26913 twice. First, the name of the remote host is used as a domain name (preceded by
26914 &"*@"& when matching a regular expression). If this does not match the line,
26915 the domain from the email address is tried in a similar fashion. For example,
26916 suppose the MX records for &'a.b.c.example'& are
26917 .code
26918 a.b.c.example  MX  5  x.y.z.example
26919                MX  6  p.q.r.example
26920                MX  7  m.n.o.example
26921 .endd
26922 and the retry rules are
26923 .code
26924 p.q.r.example    *      F,24h,30m;
26925 a.b.c.example    *      F,4d,45m;
26926 .endd
26927 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26928 first rule matches neither the host nor the domain, so Exim looks at the second
26929 rule. This does not match the host, but it does match the domain, so it is used
26930 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26931 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26932 first retry rule is used, because it matches the host.
26933
26934 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26935 first rule to determine retry times, but for all the other hosts for the domain
26936 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26937 routing to &'a.b.c.example'& suffers a temporary failure.
26938
26939 &*Note*&: The host name is used when matching the patterns, not its IP address.
26940 However, if a message is routed directly to an IP address without the use of a
26941 host name, for example, if a &(manualroute)& router contains a setting such as:
26942 .code
26943 route_list = *.a.example  192.168.34.23
26944 .endd
26945 then the &"host name"& that is used when searching for a retry rule is the
26946 textual form of the IP address.
26947
26948 .section "Retry rules for specific errors" "SECID161"
26949 .cindex "retry" "specific errors; specifying"
26950 The second field in a retry rule is the name of a particular error, or an
26951 asterisk, which matches any error. The errors that can be tested for are:
26952
26953 .vlist
26954 .vitem &%auth_failed%&
26955 Authentication failed when trying to send to a host in the
26956 &%hosts_require_auth%& list in an &(smtp)& transport.
26957
26958 .vitem &%data_4xx%&
26959 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26960 after the command, or after sending the message's data.
26961
26962 .vitem &%mail_4xx%&
26963 A 4&'xx'& error was received for an outgoing MAIL command.
26964
26965 .vitem &%rcpt_4xx%&
26966 A 4&'xx'& error was received for an outgoing RCPT command.
26967 .endlist
26968
26969 For the three 4&'xx'& errors, either the first or both of the x's can be given
26970 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26971 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26972 and have retries every ten minutes with a one-hour timeout, you could set up a
26973 retry rule of this form:
26974 .code
26975 the.domain.name  rcpt_452   F,1h,10m
26976 .endd
26977 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26978 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26979
26980 .vlist
26981 .vitem &%lost_connection%&
26982 A server unexpectedly closed the SMTP connection. There may, of course,
26983 legitimate reasons for this (host died, network died), but if it repeats a lot
26984 for the same host, it indicates something odd.
26985
26986 .vitem &%lookup%&
26987 A DNS lookup for a host failed.
26988 Note that a &%dnslookup%& router will need to have matched
26989 its &%fail_defer_domains%& option for this retry type to be usable.
26990 Also note that a &%manualroute%& router will probably need
26991 its &%host_find_failed%& option set to &%defer%&.
26992
26993 .vitem &%refused_MX%&
26994 A connection to a host obtained from an MX record was refused.
26995
26996 .vitem &%refused_A%&
26997 A connection to a host not obtained from an MX record was refused.
26998
26999 .vitem &%refused%&
27000 A connection was refused.
27001
27002 .vitem &%timeout_connect_MX%&
27003 A connection attempt to a host obtained from an MX record timed out.
27004
27005 .vitem &%timeout_connect_A%&
27006 A connection attempt to a host not obtained from an MX record timed out.
27007
27008 .vitem &%timeout_connect%&
27009 A connection attempt timed out.
27010
27011 .vitem &%timeout_MX%&
27012 There was a timeout while connecting or during an SMTP session with a host
27013 obtained from an MX record.
27014
27015 .vitem &%timeout_A%&
27016 There was a timeout while connecting or during an SMTP session with a host not
27017 obtained from an MX record.
27018
27019 .vitem &%timeout%&
27020 There was a timeout while connecting or during an SMTP session.
27021
27022 .vitem &%tls_required%&
27023 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27024 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27025 to STARTTLS, or there was a problem setting up the TLS connection.
27026
27027 .vitem &%quota%&
27028 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27029 transport.
27030
27031 .vitem &%quota_%&<&'time'&>
27032 .cindex "quota" "error testing in retry rule"
27033 .cindex "retry" "quota error testing"
27034 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27035 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27036 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27037 for four days.
27038 .endlist
27039
27040 .cindex "mailbox" "time of last read"
27041 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27042 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27043 it should be based on the last time that the user accessed the mailbox.
27044 However, it is not always possible to determine this. Exim uses the following
27045 heuristic rules:
27046
27047 .ilist
27048 If the mailbox is a single file, the time of last access (the &"atime"&) is
27049 used. As no new messages are being delivered (because the mailbox is over
27050 quota), Exim does not access the file, so this is the time of last user access.
27051 .next
27052 .cindex "maildir format" "time of last read"
27053 For a maildir delivery, the time of last modification of the &_new_&
27054 subdirectory is used. As the mailbox is over quota, no new files are created in
27055 the &_new_& subdirectory, because no new messages are being delivered. Any
27056 change to the &_new_& subdirectory is therefore assumed to be the result of an
27057 MUA moving a new message to the &_cur_& directory when it is first read. The
27058 time that is used is therefore the last time that the user read a new message.
27059 .next
27060 For other kinds of multi-file mailbox, the time of last access cannot be
27061 obtained, so a retry rule that uses this type of error field is never matched.
27062 .endlist
27063
27064 The quota errors apply both to system-enforced quotas and to Exim's own quota
27065 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27066 when a local delivery is deferred because a partition is full (the ENOSPC
27067 error).
27068
27069
27070
27071 .section "Retry rules for specified senders" "SECID162"
27072 .cindex "retry" "rules; sender-specific"
27073 You can specify retry rules that apply only when the failing message has a
27074 specific sender. In particular, this can be used to define retry rules that
27075 apply only to bounce messages. The third item in a retry rule can be of this
27076 form:
27077 .display
27078 &`senders=`&<&'address list'&>
27079 .endd
27080 The retry timings themselves are then the fourth item. For example:
27081 .code
27082 *   rcpt_4xx   senders=:   F,1h,30m
27083 .endd
27084 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27085 host. If the address list contains white space, it must be enclosed in quotes.
27086 For example:
27087 .code
27088 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27089 .endd
27090 &*Warning*&: This facility can be unhelpful if it is used for host errors
27091 (which do not depend on the recipient). The reason is that the sender is used
27092 only to match the retry rule. Once the rule has been found for a host error,
27093 its contents are used to set a retry time for the host, and this will apply to
27094 all messages, not just those with specific senders.
27095
27096 When testing retry rules using &%-brt%&, you can supply a sender using the
27097 &%-f%& command line option, like this:
27098 .code
27099 exim -f "" -brt user@dom.ain
27100 .endd
27101 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27102 list is never matched.
27103
27104
27105
27106
27107
27108 .section "Retry parameters" "SECID163"
27109 .cindex "retry" "parameters in rules"
27110 The third (or fourth, if a senders list is present) field in a retry rule is a
27111 sequence of retry parameter sets, separated by semicolons. Each set consists of
27112 .display
27113 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27114 .endd
27115 The letter identifies the algorithm for computing a new retry time; the cutoff
27116 time is the time beyond which this algorithm no longer applies, and the
27117 arguments vary the algorithm's action. The cutoff time is measured from the
27118 time that the first failure for the domain (combined with the local part if
27119 relevant) was detected, not from the time the message was received.
27120
27121 .cindex "retry" "algorithms"
27122 .cindex "retry" "fixed intervals"
27123 .cindex "retry" "increasing intervals"
27124 .cindex "retry" "random intervals"
27125 The available algorithms are:
27126
27127 .ilist
27128 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27129 the interval.
27130 .next
27131 &'G'&: retry at geometrically increasing intervals. The first argument
27132 specifies a starting value for the interval, and the second a multiplier, which
27133 is used to increase the size of the interval at each retry.
27134 .next
27135 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27136 retry, the previous interval is multiplied by the factor in order to get a
27137 maximum for the next interval. The minimum interval is the first argument of
27138 the parameter, and an actual interval is chosen randomly between them. Such a
27139 rule has been found to be helpful in cluster configurations when all the
27140 members of the cluster restart at once, and may therefore synchronize their
27141 queue processing times.
27142 .endlist
27143
27144 When computing the next retry time, the algorithm definitions are scanned in
27145 order until one whose cutoff time has not yet passed is reached. This is then
27146 used to compute a new retry time that is later than the current time. In the
27147 case of fixed interval retries, this simply means adding the interval to the
27148 current time. For geometrically increasing intervals, retry intervals are
27149 computed from the rule's parameters until one that is greater than the previous
27150 interval is found. The main configuration variable
27151 .cindex "limit" "retry interval"
27152 .cindex "retry" "interval, maximum"
27153 .oindex "&%retry_interval_max%&"
27154 &%retry_interval_max%& limits the maximum interval between retries. It
27155 cannot be set greater than &`24h`&, which is its default value.
27156
27157 A single remote domain may have a number of hosts associated with it, and each
27158 host may have more than one IP address. Retry algorithms are selected on the
27159 basis of the domain name, but are applied to each IP address independently. If,
27160 for example, a host has two IP addresses and one is unusable, Exim will
27161 generate retry times for it and will not try to use it until its next retry
27162 time comes. Thus the good IP address is likely to be tried first most of the
27163 time.
27164
27165 .cindex "hints database" "use for retrying"
27166 Retry times are hints rather than promises. Exim does not make any attempt to
27167 run deliveries exactly at the computed times. Instead, a queue runner process
27168 starts delivery processes for delayed messages periodically, and these attempt
27169 new deliveries only for those addresses that have passed their next retry time.
27170 If a new message arrives for a deferred address, an immediate delivery attempt
27171 occurs only if the address has passed its retry time. In the absence of new
27172 messages, the minimum time between retries is the interval between queue runner
27173 processes. There is not much point in setting retry times of five minutes if
27174 your queue runners happen only once an hour, unless there are a significant
27175 number of incoming messages (which might be the case on a system that is
27176 sending everything to a smart host, for example).
27177
27178 The data in the retry hints database can be inspected by using the
27179 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27180 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27181 &'exinext'& utility script can be used to find out what the next retry times
27182 are for the hosts associated with a particular mail domain, and also for local
27183 deliveries that have been deferred.
27184
27185
27186 .section "Retry rule examples" "SECID164"
27187 Here are some example retry rules:
27188 .code
27189 alice@wonderland.fict.example quota_5d  F,7d,3h
27190 wonderland.fict.example       quota_5d
27191 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27192 lookingglass.fict.example     *         F,24h,30m;
27193 *                 refused_A   F,2h,20m;
27194 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27195 .endd
27196 The first rule sets up special handling for mail to
27197 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27198 mailbox has not been read for at least 5 days. Retries continue every three
27199 hours for 7 days. The second rule handles over-quota errors for all other local
27200 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27201 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27202 fail are bounced immediately if the mailbox has not been read for at least 5
27203 days.
27204
27205 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27206 happen every 15 minutes for an hour, then with geometrically increasing
27207 intervals until two days have passed since a delivery first failed. After the
27208 first hour there is a delay of one hour, then two hours, then four hours, and
27209 so on (this is a rather extreme example).
27210
27211 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27212 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27213 all other domains, with special action for connection refusal from hosts that
27214 were not obtained from an MX record.
27215
27216 The final rule in a retry configuration should always have asterisks in the
27217 first two fields so as to provide a general catch-all for any addresses that do
27218 not have their own special handling. This example tries every 15 minutes for 2
27219 hours, then with intervals starting at one hour and increasing by a factor of
27220 1.5 up to 16 hours, then every 8 hours up to 5 days.
27221
27222
27223
27224 .section "Timeout of retry data" "SECID165"
27225 .cindex "timeout" "of retry data"
27226 .oindex "&%retry_data_expire%&"
27227 .cindex "hints database" "data expiry"
27228 .cindex "retry" "timeout of data"
27229 Exim timestamps the data that it writes to its retry hints database. When it
27230 consults the data during a delivery it ignores any that is older than the value
27231 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27232 been tried for 7 days, Exim will try to deliver to it immediately a message
27233 arrives, and if that fails, it will calculate a retry time as if it were
27234 failing for the first time.
27235
27236 This improves the behaviour for messages routed to rarely-used hosts such as MX
27237 backups. If such a host was down at one time, and happens to be down again when
27238 Exim tries a month later, using the old retry data would imply that it had been
27239 down all the time, which is not a justified assumption.
27240
27241 If a host really is permanently dead, this behaviour causes a burst of retries
27242 every now and again, but only if messages routed to it are rare. If there is a
27243 message at least once every 7 days the retry data never expires.
27244
27245
27246
27247
27248 .section "Long-term failures" "SECID166"
27249 .cindex "delivery failure, long-term"
27250 .cindex "retry" "after long-term failure"
27251 Special processing happens when an email address has been failing for so long
27252 that the cutoff time for the last algorithm is reached. For example, using the
27253 default retry rule:
27254 .code
27255 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27256 .endd
27257 the cutoff time is four days. Reaching the retry cutoff is independent of how
27258 long any specific message has been failing; it is the length of continuous
27259 failure for the recipient address that counts.
27260
27261 When the cutoff time is reached for a local delivery, or for all the IP
27262 addresses associated with a remote delivery, a subsequent delivery failure
27263 causes Exim to give up on the address, and a bounce message is generated.
27264 In order to cater for new messages that use the failing address, a next retry
27265 time is still computed from the final algorithm, and is used as follows:
27266
27267 For local deliveries, one delivery attempt is always made for any subsequent
27268 messages. If this delivery fails, the address fails immediately. The
27269 post-cutoff retry time is not used.
27270
27271 .cindex "final cutoff" "retries, controlling"
27272 .cindex retry "final cutoff"
27273 If the delivery is remote, there are two possibilities, controlled by the
27274 .oindex "&%delay_after_cutoff%&"
27275 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27276 default. Until the post-cutoff retry time for one of the IP addresses,
27277 as set by the &%retry_data_expire%& option, is
27278 reached, the failing email address is bounced immediately, without a delivery
27279 attempt taking place. After that time, one new delivery attempt is made to
27280 those IP addresses that are past their retry times, and if that still fails,
27281 the address is bounced and new retry times are computed.
27282
27283 In other words, when all the hosts for a given email address have been failing
27284 for a long time, Exim bounces rather then defers until one of the hosts' retry
27285 times is reached. Then it tries once, and bounces if that attempt fails. This
27286 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27287 to a broken destination, but if the host does recover, Exim will eventually
27288 notice.
27289
27290 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27291 addresses are past their final cutoff time, Exim tries to deliver to those IP
27292 addresses that have not been tried since the message arrived. If there are
27293 no suitable IP addresses, or if they all fail, the address is bounced. In other
27294 words, it does not delay when a new message arrives, but tries the expired
27295 addresses immediately, unless they have been tried since the message arrived.
27296 If there is a continuous stream of messages for the failing domains, setting
27297 &%delay_after_cutoff%& false means that there will be many more attempts to
27298 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27299 true.
27300
27301 .section "Deliveries that work intermittently" "SECID167"
27302 .cindex "retry" "intermittently working deliveries"
27303 Some additional logic is needed to cope with cases where a host is
27304 intermittently available, or when a message has some attribute that prevents
27305 its delivery when others to the same address get through. In this situation,
27306 because some messages are successfully delivered, the &"retry clock"& for the
27307 host or address keeps getting reset by the successful deliveries, and so
27308 failing messages remain in the queue for ever because the cutoff time is never
27309 reached.
27310
27311 Two exceptional actions are applied to prevent this happening. The first
27312 applies to errors that are related to a message rather than a remote host.
27313 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27314 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27315 commands, and quota failures. For this type of error, if a message's arrival
27316 time is earlier than the &"first failed"& time for the error, the earlier time
27317 is used when scanning the retry rules to decide when to try next and when to
27318 time out the address.
27319
27320 The exceptional second action applies in all cases. If a message has been on
27321 the queue for longer than the cutoff time of any applicable retry rule for a
27322 given address, a delivery is attempted for that address, even if it is not yet
27323 time, and if this delivery fails, the address is timed out. A new retry time is
27324 not computed in this case, so that other messages for the same address are
27325 considered immediately.
27326 .ecindex IIDretconf1
27327 .ecindex IIDregconf2
27328
27329
27330
27331
27332
27333
27334 . ////////////////////////////////////////////////////////////////////////////
27335 . ////////////////////////////////////////////////////////////////////////////
27336
27337 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27338 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27339 .scindex IIDauthconf2 "authentication"
27340 The &"authenticators"& section of Exim's runtime configuration is concerned
27341 with SMTP authentication. This facility is an extension to the SMTP protocol,
27342 described in RFC 2554, which allows a client SMTP host to authenticate itself
27343 to a server. This is a common way for a server to recognize clients that are
27344 permitted to use it as a relay. SMTP authentication is not of relevance to the
27345 transfer of mail between servers that have no managerial connection with each
27346 other.
27347
27348 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27349 prior to Exim 4.95 names would be silently truncated at this length, but now
27350 it is enforced.
27351
27352 .cindex "AUTH" "description of"
27353 .cindex "ESMTP extensions" AUTH
27354 Very briefly, the way SMTP authentication works is as follows:
27355
27356 .olist
27357 The server advertises a number of authentication &'mechanisms'& in response to
27358 the client's EHLO command.
27359 .next
27360 The client issues an AUTH command, naming a specific mechanism. The command
27361 may, optionally, contain some authentication data.
27362 .next
27363 The server may issue one or more &'challenges'&, to which the client must send
27364 appropriate responses. In simple authentication mechanisms, the challenges are
27365 just prompts for user names and passwords. The server does not have to issue
27366 any challenges &-- in some mechanisms the relevant data may all be transmitted
27367 with the AUTH command.
27368 .next
27369 The server either accepts or denies authentication.
27370 .next
27371 If authentication succeeds, the client may optionally make use of the AUTH
27372 option on the MAIL command to pass an authenticated sender in subsequent
27373 mail transactions. Authentication lasts for the remainder of the SMTP
27374 connection.
27375 .next
27376 If authentication fails, the client may give up, or it may try a different
27377 authentication mechanism, or it may try transferring mail over the
27378 unauthenticated connection.
27379 .endlist
27380
27381 If you are setting up a client, and want to know which authentication
27382 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27383 SMTP port) on the server, and issue an EHLO command. The response to this
27384 includes the list of supported mechanisms. For example:
27385 .display
27386 &`$ `&&*&`telnet server.example 25`&*&
27387 &`Trying 192.168.34.25...`&
27388 &`Connected to server.example.`&
27389 &`Escape character is &#x0027;^]&#x0027;.`&
27390 &`220 server.example ESMTP Exim 4.20 ...`&
27391 &*&`ehlo client.example`&*&
27392 &`250-server.example Hello client.example [10.8.4.5]`&
27393 &`250-SIZE 52428800`&
27394 &`250-PIPELINING`&
27395 &`250-AUTH PLAIN`&
27396 &`250 HELP`&
27397 .endd
27398 The second-last line of this example output shows that the server supports
27399 authentication using the PLAIN mechanism. In Exim, the different authentication
27400 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27401 routers and transports, which authenticators are included in the binary is
27402 controlled by build-time definitions. The following are currently available,
27403 included by setting
27404 .code
27405 AUTH_CRAM_MD5=yes
27406 AUTH_CYRUS_SASL=yes
27407 AUTH_DOVECOT=yes
27408 AUTH_EXTERNAL=yes
27409 AUTH_GSASL=yes
27410 AUTH_HEIMDAL_GSSAPI=yes
27411 AUTH_PLAINTEXT=yes
27412 AUTH_SPA=yes
27413 AUTH_TLS=yes
27414 .endd
27415 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27416 authentication mechanism (RFC 2195), and the second provides an interface to
27417 the Cyrus SASL authentication library.
27418 The third is an interface to Dovecot's authentication system, delegating the
27419 work via a socket interface.
27420 The fourth provides for negotiation of authentication done via non-SMTP means,
27421 as defined by RFC 4422 Appendix A.
27422 The fifth provides an interface to the GNU SASL authentication library, which
27423 provides mechanisms but typically not data sources.
27424 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27425 supporting setting a server keytab.
27426 The seventh can be configured to support
27427 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27428 not formally documented, but used by several MUAs.
27429 The eighth authenticator
27430 supports Microsoft's &'Secure Password Authentication'& mechanism.
27431 The last is an Exim authenticator but not an SMTP one;
27432 instead it can use information from a TLS negotiation.
27433
27434 The authenticators are configured using the same syntax as other drivers (see
27435 section &<<SECTfordricon>>&). If no authenticators are required, no
27436 authentication section need be present in the configuration file. Each
27437 authenticator can in principle have both server and client functions. When Exim
27438 is receiving SMTP mail, it is acting as a server; when it is sending out
27439 messages over SMTP, it is acting as a client. Authenticator configuration
27440 options are provided for use in both these circumstances.
27441
27442 To make it clear which options apply to which situation, the prefixes
27443 &%server_%& and &%client_%& are used on option names that are specific to
27444 either the server or the client function, respectively. Server and client
27445 functions are disabled if none of their options are set. If an authenticator is
27446 to be used for both server and client functions, a single definition, using
27447 both sets of options, is required. For example:
27448 .code
27449 cram:
27450   driver = cram_md5
27451   public_name = CRAM-MD5
27452   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27453   client_name = ph10
27454   client_secret = secret2
27455 .endd
27456 The &%server_%& option is used when Exim is acting as a server, and the
27457 &%client_%& options when it is acting as a client.
27458
27459 Descriptions of the individual authenticators are given in subsequent chapters.
27460 The remainder of this chapter covers the generic options for the
27461 authenticators, followed by general discussion of the way authentication works
27462 in Exim.
27463
27464 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27465 per-mechanism basis.  Please read carefully to determine which variables hold
27466 account labels such as usercodes and which hold passwords or other
27467 authenticating data.
27468
27469 Note that some mechanisms support two different identifiers for accounts: the
27470 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27471 and &'authz'& are commonly encountered.  The American spelling is standard here.
27472 Conceptually, authentication data such as passwords are tied to the identifier
27473 used to authenticate; servers may have rules to permit one user to act as a
27474 second user, so that after login the session is treated as though that second
27475 user had logged in.  That second user is the &'authorization id'&.  A robust
27476 configuration might confirm that the &'authz'& field is empty or matches the
27477 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27478 as verified data, the &'authz'& as an unverified request which the server might
27479 choose to honour.
27480
27481 A &'realm'& is a text string, typically a domain name, presented by a server
27482 to a client to help it select an account and credentials to use.  In some
27483 mechanisms, the client and server provably agree on the realm, but clients
27484 typically can not treat the realm as secure data to be blindly trusted.
27485
27486
27487
27488 .section "Generic options for authenticators" "SECID168"
27489 .cindex "authentication" "generic options"
27490 .cindex "options" "generic; for authenticators"
27491
27492 .option client_condition authenticators string&!! unset
27493 When Exim is authenticating as a client, it skips any authenticator whose
27494 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27495 used, for example, to skip plain text authenticators when the connection is not
27496 encrypted by a setting such as:
27497 .code
27498 client_condition = ${if !eq{$tls_out_cipher}{}}
27499 .endd
27500
27501
27502 .option client_set_id authenticators string&!! unset
27503 When client authentication succeeds, this condition is expanded; the
27504 result is used in the log lines for outbound messages.
27505 Typically it will be the user name used for authentication.
27506
27507
27508 .option driver authenticators string unset
27509 This option must always be set. It specifies which of the available
27510 authenticators is to be used.
27511
27512
27513 .option public_name authenticators string unset
27514 This option specifies the name of the authentication mechanism that the driver
27515 implements, and by which it is known to the outside world. These names should
27516 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27517 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27518 defaults to the driver's instance name.
27519
27520
27521 .option server_advertise_condition authenticators string&!! unset
27522 When a server is about to advertise an authentication mechanism, the condition
27523 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27524 mechanism is not advertised.
27525 If the expansion fails, the mechanism is not advertised. If the failure was not
27526 forced, and was not caused by a lookup defer, the incident is logged.
27527 See section &<<SECTauthexiser>>& below for further discussion.
27528
27529
27530 .option server_condition authenticators string&!! unset
27531 This option must be set for a &%plaintext%& server authenticator, where it
27532 is used directly to control authentication. See section &<<SECTplainserver>>&
27533 for details.
27534
27535 For the &(gsasl)& authenticator, this option is required for various
27536 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27537
27538 For the other authenticators, &%server_condition%& can be used as an additional
27539 authentication or authorization mechanism that is applied after the other
27540 authenticator conditions succeed. If it is set, it is expanded when the
27541 authenticator would otherwise return a success code. If the expansion is forced
27542 to fail, authentication fails. Any other expansion failure causes a temporary
27543 error code to be returned. If the result of a successful expansion is an empty
27544 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27545 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27546 other result, a temporary error code is returned, with the expanded string as
27547 the error text.
27548
27549
27550 .option server_debug_print authenticators string&!! unset
27551 If this option is set and authentication debugging is enabled (see the &%-d%&
27552 command line option), the string is expanded and included in the debugging
27553 output when the authenticator is run as a server. This can help with checking
27554 out the values of variables.
27555 If expansion of the string fails, the error message is written to the debugging
27556 output, and Exim carries on processing.
27557
27558
27559 .option server_set_id authenticators string&!! unset
27560 .vindex "&$authenticated_id$&"
27561 .vindex "&$authenticated_fail_id$&"
27562 When an Exim server successfully authenticates a client, this string is
27563 expanded using data from the authentication, and preserved for any incoming
27564 messages in the variable &$authenticated_id$&. It is also included in the log
27565 lines for incoming messages. For example, a user/password authenticator
27566 configuration might preserve the user name that was used to authenticate, and
27567 refer to it subsequently during delivery of the message.
27568 On a failing authentication the expansion result is instead saved in
27569 the &$authenticated_fail_id$& variable.
27570 If expansion fails, the option is ignored.
27571
27572
27573 .option server_mail_auth_condition authenticators string&!! unset
27574 This option allows a server to discard authenticated sender addresses supplied
27575 as part of MAIL commands in SMTP connections that are authenticated by the
27576 driver on which &%server_mail_auth_condition%& is set. The option is not used
27577 as part of the authentication process; instead its (unexpanded) value is
27578 remembered for later use.
27579 How it is used is described in the following section.
27580
27581
27582
27583
27584
27585 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27586 .cindex "authentication" "sender; authenticated"
27587 .cindex "AUTH" "on MAIL command"
27588 When a client supplied an AUTH= item on a MAIL command, Exim applies
27589 the following checks before accepting it as the authenticated sender of the
27590 message:
27591
27592 .ilist
27593 If the connection is not using extended SMTP (that is, HELO was used rather
27594 than EHLO), the use of AUTH= is a syntax error.
27595 .next
27596 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27597 .next
27598 .vindex "&$authenticated_sender$&"
27599 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27600 running, the value of &$authenticated_sender$& is set to the value obtained
27601 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27602 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27603 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27604 given for the MAIL command.
27605 .next
27606 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27607 is accepted and placed in &$authenticated_sender$& only if the client has
27608 authenticated.
27609 .next
27610 If the AUTH= value was accepted by either of the two previous rules, and
27611 the client has authenticated, and the authenticator has a setting for the
27612 &%server_mail_auth_condition%&, the condition is checked at this point. The
27613 valued that was saved from the authenticator is expanded. If the expansion
27614 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27615 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27616 the value of &$authenticated_sender$& is retained and passed on with the
27617 message.
27618 .endlist
27619
27620
27621 When &$authenticated_sender$& is set for a message, it is passed on to other
27622 hosts to which Exim authenticates as a client. Do not confuse this value with
27623 &$authenticated_id$&, which is a string obtained from the authentication
27624 process, and which is not usually a complete email address.
27625
27626 .vindex "&$sender_address$&"
27627 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27628 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27629 therefore make use of &$authenticated_sender$&. The converse is not true: the
27630 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27631 ACL is run.
27632
27633
27634
27635 .section "Authentication on an Exim server" "SECTauthexiser"
27636 .cindex "authentication" "on an Exim server"
27637 When Exim receives an EHLO command, it advertises the public names of those
27638 authenticators that are configured as servers, subject to the following
27639 conditions:
27640
27641 .ilist
27642 The client host must match &%auth_advertise_hosts%& (default *).
27643 .next
27644 If the &%server_advertise_condition%& option is set, its expansion must not
27645 yield the empty string, &"0"&, &"no"&, or &"false"&.
27646 .endlist
27647
27648 The order in which the authenticators are defined controls the order in which
27649 the mechanisms are advertised.
27650
27651 Some mail clients (for example, some versions of Netscape) require the user to
27652 provide a name and password for authentication whenever AUTH is advertised,
27653 even though authentication may not in fact be needed (for example, Exim may be
27654 set up to allow unconditional relaying from the client by an IP address check).
27655 You can make such clients more friendly by not advertising AUTH to them.
27656 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27657 that runs for RCPT) to relay without authentication, you should set
27658 .code
27659 auth_advertise_hosts = ! 10.9.8.0/24
27660 .endd
27661 so that no authentication mechanisms are advertised to them.
27662
27663 The &%server_advertise_condition%& controls the advertisement of individual
27664 authentication mechanisms. For example, it can be used to restrict the
27665 advertisement of a particular mechanism to encrypted connections, by a setting
27666 such as:
27667 .code
27668 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27669 .endd
27670 .vindex "&$tls_in_cipher$&"
27671 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27672 yields &"yes"&, which allows the advertisement to happen.
27673
27674 When an Exim server receives an AUTH command from a client, it rejects it
27675 immediately if AUTH was not advertised in response to an earlier EHLO
27676 command. This is the case if
27677
27678 .ilist
27679 The client host does not match &%auth_advertise_hosts%&; or
27680 .next
27681 No authenticators are configured with server options; or
27682 .next
27683 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27684 server authenticators.
27685 .endlist
27686
27687
27688 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27689 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27690 AUTH is accepted from any client host.
27691
27692 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27693 server authentication mechanism that was advertised in response to EHLO and
27694 that matches the one named in the AUTH command. If it finds one, it runs
27695 the appropriate authentication protocol, and authentication either succeeds or
27696 fails. If there is no matching advertised mechanism, the AUTH command is
27697 rejected with a 504 error.
27698
27699 .vindex "&$received_protocol$&"
27700 .vindex "&$sender_host_authenticated$&"
27701 When a message is received from an authenticated host, the value of
27702 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27703 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27704 public name) of the authenticator driver that successfully authenticated the
27705 client from which the message was received. This variable is empty if there was
27706 no successful authentication.
27707
27708 .cindex authentication "expansion item"
27709 Successful authentication sets up information used by the
27710 &%authresults%& expansion item.
27711
27712 .new
27713 .cindex authentication "failure event, server"
27714 If an authenticator is run and does not succeed,
27715 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27716 While the event is being processed the variables
27717 &$sender_host_authenticated$& (with the authenticator name)
27718 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27719 will be valid.
27720 If the event is serviced and a string is returned then the string will be logged
27721 instead of the default log line.
27722 See <<CHAPevents>> for details on events.
27723 .wen
27724
27725
27726 .section "Testing server authentication" "SECID169"
27727 .cindex "authentication" "testing a server"
27728 .cindex "AUTH" "testing a server"
27729 .cindex "base64 encoding" "creating authentication test data"
27730 Exim's &%-bh%& option can be useful for testing server authentication
27731 configurations. The data for the AUTH command has to be sent using base64
27732 encoding. A quick way to produce such data for testing is the following Perl
27733 script:
27734 .code
27735 use MIME::Base64;
27736 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27737 .endd
27738 .cindex "binary zero" "in authentication data"
27739 This interprets its argument as a Perl string, and then encodes it. The
27740 interpretation as a Perl string allows binary zeros, which are required for
27741 some kinds of authentication, to be included in the data. For example, a
27742 command line to run this script on such data might be
27743 .code
27744 encode '\0user\0password'
27745 .endd
27746 Note the use of single quotes to prevent the shell interpreting the
27747 backslashes, so that they can be interpreted by Perl to specify characters
27748 whose code value is zero.
27749
27750 &*Warning 1*&: If either of the user or password strings starts with an octal
27751 digit, you must use three zeros instead of one after the leading backslash. If
27752 you do not, the octal digit that starts your string will be incorrectly
27753 interpreted as part of the code for the first character.
27754
27755 &*Warning 2*&: If there are characters in the strings that Perl interprets
27756 specially, you must use a Perl escape to prevent them being misinterpreted. For
27757 example, a command such as
27758 .code
27759 encode '\0user@domain.com\0pas$$word'
27760 .endd
27761 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27762
27763 If you have the &%mimencode%& command installed, another way to produce
27764 base64-encoded strings is to run the command
27765 .code
27766 echo -e -n `\0user\0password' | mimencode
27767 .endd
27768 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27769 in the argument, and the &%-n%& option specifies no newline at the end of its
27770 output. However, not all versions of &%echo%& recognize these options, so you
27771 should check your version before relying on this suggestion.
27772
27773
27774
27775 .section "Authentication by an Exim client" "SECID170"
27776 .cindex "authentication" "on an Exim client"
27777 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27778 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27779 announces support for authentication, and the host matches an entry in either
27780 of these options, Exim (as a client) tries to authenticate as follows:
27781
27782 .ilist
27783 For each authenticator that is configured as a client, in the order in which
27784 they are defined in the configuration, it searches the authentication
27785 mechanisms announced by the server for one whose name matches the public name
27786 of the authenticator.
27787 .next
27788 .vindex "&$host$&"
27789 .vindex "&$host_address$&"
27790 When it finds one that matches, it runs the authenticator's client code. The
27791 variables &$host$& and &$host_address$& are available for any string expansions
27792 that the client might do. They are set to the server's name and IP address. If
27793 any expansion is forced to fail, the authentication attempt is abandoned, and
27794 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27795 delivery to be deferred.
27796 .next
27797 If the result of the authentication attempt is a temporary error or a timeout,
27798 Exim abandons trying to send the message to the host for the moment. It will
27799 try again later. If there are any backup hosts available, they are tried in the
27800 usual way.
27801
27802 .new
27803 .next
27804 .cindex authentication "failure event, client"
27805 If the response to authentication is a permanent error (5&'xx'& code),
27806 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27807 While the event is being processed the variable
27808 &$sender_host_authenticated$& (with the authenticator name)
27809 will be valid.
27810 If the event is serviced and a string is returned then the string will be logged.
27811 See <<CHAPevents>> for details on events.
27812 .wen
27813
27814 .next
27815 If the response to authentication is a permanent error (5&'xx'& code), Exim
27816 carries on searching the list of authenticators and tries another one if
27817 possible. If all authentication attempts give permanent errors, or if there are
27818 no attempts because no mechanisms match (or option expansions force failure),
27819 what happens depends on whether the host matches &%hosts_require_auth%& or
27820 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27821 delivery is deferred. The error can be detected in the retry rules, and thereby
27822 turned into a permanent error if you wish. In the second case, Exim tries to
27823 deliver the message unauthenticated.
27824 .endlist
27825
27826 Note that the hostlist test for whether to do authentication can be
27827 confused if name-IP lookups change between the time the peer is decided
27828 upon and the time that the transport runs.  For example, with a manualroute
27829 router given a host name, and with DNS "round-robin" used by that name: if
27830 the local resolver cache times out between the router and the transport
27831 running, the transport may get an IP for the name for its authentication
27832 check which does not match the connection peer IP.
27833 No authentication will then be done, despite the names being identical.
27834
27835 For such cases use a separate transport which always authenticates.
27836
27837 .cindex "AUTH" "on MAIL command"
27838 When Exim has authenticated itself to a remote server, it adds the AUTH
27839 parameter to the MAIL commands it sends, if it has an authenticated sender for
27840 the message. If the message came from a remote host, the authenticated sender
27841 is the one that was receiving on an incoming MAIL command, provided that the
27842 incoming connection was authenticated and the &%server_mail_auth%& condition
27843 allowed the authenticated sender to be retained. If a local process calls Exim
27844 to send a message, the sender address that is built from the login name and
27845 &%qualify_domain%& is treated as authenticated. However, if the
27846 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27847 the authenticated sender that was received with the message.
27848 .ecindex IIDauthconf1
27849 .ecindex IIDauthconf2
27850
27851
27852
27853
27854
27855
27856 . ////////////////////////////////////////////////////////////////////////////
27857 . ////////////////////////////////////////////////////////////////////////////
27858
27859 .chapter "The plaintext authenticator" "CHAPplaintext"
27860 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27861 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27862 The &(plaintext)& authenticator can be configured to support the PLAIN and
27863 LOGIN authentication mechanisms, both of which transfer authentication data as
27864 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27865 security risk; you are strongly advised to insist on the use of SMTP encryption
27866 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27867 use unencrypted plain text, you should not use the same passwords for SMTP
27868 connections as you do for login accounts.
27869
27870 .section "Avoiding cleartext use" "SECTplain_TLS"
27871 The following generic option settings will disable &(plaintext)& authenticators when
27872 TLS is not being used:
27873 .code
27874   server_advertise_condition = ${if def:tls_in_cipher }
27875   client_condition =           ${if def:tls_out_cipher}
27876 .endd
27877
27878 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27879 but is still vulnerable to a Man In The Middle attack unless certificates
27880 (including their names) have been properly verified.
27881
27882 .section "Plaintext server options" "SECID171"
27883 .cindex "options" "&(plaintext)& authenticator (server)"
27884 When configured as a server, &(plaintext)& uses the following options:
27885
27886 .option server_condition authenticators string&!! unset
27887 This is actually a global authentication option, but it must be set in order to
27888 configure the &(plaintext)& driver as a server. Its use is described below.
27889
27890 .option server_prompts plaintext "string list&!!" unset
27891 The contents of this option, after expansion, must be a colon-separated list of
27892 prompt strings. If expansion fails, a temporary authentication rejection is
27893 given.
27894
27895 .section "Using plaintext in a server" "SECTplainserver"
27896 .cindex "AUTH" "in &(plaintext)& authenticator"
27897 .cindex "binary zero" "in &(plaintext)& authenticator"
27898 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27899         "in &(plaintext)& authenticator"
27900 .vindex "&$auth1$&, &$auth2$&, etc"
27901 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27902
27903 When running as a server, &(plaintext)& performs the authentication test by
27904 expanding a string. The data sent by the client with the AUTH command, or in
27905 response to subsequent prompts, is base64 encoded, and so may contain any byte
27906 values when decoded. If any data is supplied with the command, it is treated as
27907 a list of strings, separated by NULs (binary zeros), the first three of which
27908 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27909 (neither LOGIN nor PLAIN uses more than three strings).
27910
27911 For compatibility with previous releases of Exim, the values are also placed in
27912 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27913 variables for this purpose is now deprecated, as it can lead to confusion in
27914 string expansions that also use them for other things.
27915
27916 If there are more strings in &%server_prompts%& than the number of strings
27917 supplied with the AUTH command, the remaining prompts are used to obtain more
27918 data. Each response from the client may be a list of NUL-separated strings.
27919
27920 .vindex "&$authenticated_id$&"
27921 Once a sufficient number of data strings have been received,
27922 &%server_condition%& is expanded. If the expansion is forced to fail,
27923 authentication fails. Any other expansion failure causes a temporary error code
27924 to be returned. If the result of a successful expansion is an empty string,
27925 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27926 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27927 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27928 For any other result, a temporary error code is returned, with the expanded
27929 string as the error text.
27930
27931 &*Warning*&: If you use a lookup in the expansion to find the user's
27932 password, be sure to make the authentication fail if the user is unknown.
27933 There are good and bad examples at the end of the next section.
27934
27935
27936
27937 .section "The PLAIN authentication mechanism" "SECID172"
27938 .cindex "PLAIN authentication mechanism"
27939 .cindex authentication PLAIN
27940 .cindex "binary zero" "in &(plaintext)& authenticator"
27941 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27942 sent as one item of data (that is, one combined string containing two NUL
27943 separators). The data is sent either as part of the AUTH command, or
27944 subsequently in response to an empty prompt from the server.
27945
27946 The second and third strings are a user name and a corresponding password.
27947 Using a single fixed user name and password as an example, this could be
27948 configured as follows:
27949 .code
27950 fixed_plain:
27951   driver = plaintext
27952   public_name = PLAIN
27953   server_prompts = :
27954   server_condition = \
27955     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27956   server_set_id = $auth2
27957 .endd
27958 Note that the default result strings from &%if%& (&"true"& or an empty string)
27959 are exactly what we want here, so they need not be specified. Obviously, if the
27960 password contains expansion-significant characters such as dollar, backslash,
27961 or closing brace, they have to be escaped.
27962
27963 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27964 the end of a string list are ignored). If all the data comes as part of the
27965 AUTH command, as is commonly the case, the prompt is not used. This
27966 authenticator is advertised in the response to EHLO as
27967 .code
27968 250-AUTH PLAIN
27969 .endd
27970 and a client host can authenticate itself by sending the command
27971 .code
27972 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27973 .endd
27974 As this contains three strings (more than the number of prompts), no further
27975 data is required from the client. Alternatively, the client may just send
27976 .code
27977 AUTH PLAIN
27978 .endd
27979 to initiate authentication, in which case the server replies with an empty
27980 prompt. The client must respond with the combined data string.
27981
27982 The data string is base64 encoded, as required by the RFC. This example,
27983 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27984 represents a zero byte. This is split up into three strings, the first of which
27985 is empty. The &%server_condition%& option in the authenticator checks that the
27986 second two are &`username`& and &`mysecret`& respectively.
27987
27988 Having just one fixed user name and password, as in this example, is not very
27989 realistic, though for a small organization with only a handful of
27990 authenticating clients it could make sense.
27991
27992 A more sophisticated instance of this authenticator could use the user name in
27993 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27994 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27995 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27996 This is an incorrect example:
27997 .code
27998 server_condition = \
27999   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28000 .endd
28001 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28002 which it then compares to the supplied password (&$auth3$&). Why is this example
28003 incorrect? It works fine for existing users, but consider what happens if a
28004 non-existent user name is given. The lookup fails, but as no success/failure
28005 strings are given for the lookup, it yields an empty string. Thus, to defeat
28006 the authentication, all a client has to do is to supply a non-existent user
28007 name and an empty password. The correct way of writing this test is:
28008 .code
28009 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28010   {${if eq{$value}{$auth3}}} {false}}
28011 .endd
28012 In this case, if the lookup succeeds, the result is checked; if the lookup
28013 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28014 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28015 always fails if its second argument is empty. However, the second way of
28016 writing the test makes the logic clearer.
28017
28018
28019 .section "The LOGIN authentication mechanism" "SECID173"
28020 .cindex "LOGIN authentication mechanism"
28021 .cindex authentication LOGIN
28022 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28023 in a number of programs. No data is sent with the AUTH command. Instead, a
28024 user name and password are supplied separately, in response to prompts. The
28025 plaintext authenticator can be configured to support this as in this example:
28026 .code
28027 fixed_login:
28028   driver = plaintext
28029   public_name = LOGIN
28030   server_prompts = User Name : Password
28031   server_condition = \
28032     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28033   server_set_id = $auth1
28034 .endd
28035 Because of the way plaintext operates, this authenticator accepts data supplied
28036 with the AUTH command (in contravention of the specification of LOGIN), but
28037 if the client does not supply it (as is the case for LOGIN clients), the prompt
28038 strings are used to obtain two data items.
28039
28040 Some clients are very particular about the precise text of the prompts. For
28041 example, Outlook Express is reported to recognize only &"Username:"& and
28042 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28043 strings. It uses the &%ldapauth%& expansion condition to check the user
28044 name and password by binding to an LDAP server:
28045 .code
28046 login:
28047   driver = plaintext
28048   public_name = LOGIN
28049   server_prompts = Username:: : Password::
28050   server_condition = ${if and{{ \
28051     !eq{}{$auth1} }{ \
28052     ldapauth{\
28053       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28054       pass=${quote:$auth2} \
28055       ldap://ldap.example.org/} }} }
28056   server_set_id = uid=$auth1,ou=people,o=example.org
28057 .endd
28058 We have to check that the username is not empty before using it, because LDAP
28059 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28060 operator to correctly quote the DN for authentication. However, the basic
28061 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28062 correct one to use for the password, because quoting is needed only to make
28063 the password conform to the Exim syntax. At the LDAP level, the password is an
28064 uninterpreted string.
28065
28066
28067 .section "Support for different kinds of authentication" "SECID174"
28068 A number of string expansion features are provided for the purpose of
28069 interfacing to different ways of user authentication. These include checking
28070 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28071 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28072 &<<SECTexpcond>>&.
28073
28074
28075
28076
28077 .section "Using plaintext in a client" "SECID175"
28078 .cindex "options" "&(plaintext)& authenticator (client)"
28079 The &(plaintext)& authenticator has two client options:
28080
28081 .option client_ignore_invalid_base64 plaintext boolean false
28082 If the client receives a server prompt that is not a valid base64 string,
28083 authentication is abandoned by default. However, if this option is set true,
28084 the error in the challenge is ignored and the client sends the response as
28085 usual.
28086
28087 .option client_send plaintext string&!! unset
28088 The string is a colon-separated list of authentication data strings. Each
28089 string is independently expanded before being sent to the server. The first
28090 string is sent with the AUTH command; any more strings are sent in response
28091 to prompts from the server. Before each string is expanded, the value of the
28092 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28093 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28094 way. Thus, the prompt that is received in response to sending the first string
28095 (with the AUTH command) can be used in the expansion of the second string, and
28096 so on. If an invalid base64 string is received when
28097 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28098 &$auth$&<&'n'&> variable.
28099
28100 &*Note*&: You cannot use expansion to create multiple strings, because
28101 splitting takes priority and happens first.
28102
28103 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28104 the data, further processing is applied to each string before it is sent. If
28105 there are any single circumflex characters in the string, they are converted to
28106 NULs. Should an actual circumflex be required as data, it must be doubled in
28107 the string.
28108
28109 This is an example of a client configuration that implements the PLAIN
28110 authentication mechanism with a fixed user name and password:
28111 .code
28112 fixed_plain:
28113   driver = plaintext
28114   public_name = PLAIN
28115   client_send = ^username^mysecret
28116 .endd
28117 The lack of colons means that the entire text is sent with the AUTH
28118 command, with the circumflex characters converted to NULs.
28119 Note that due to the ambiguity of parsing three consectutive circumflex characters
28120 there is no way to provide a password having a leading circumflex.
28121
28122
28123 A similar example
28124 that uses the LOGIN mechanism is:
28125 .code
28126 fixed_login:
28127   driver = plaintext
28128   public_name = LOGIN
28129   client_send = : username : mysecret
28130 .endd
28131 The initial colon means that the first string is empty, so no data is sent with
28132 the AUTH command itself. The remaining strings are sent in response to
28133 prompts.
28134 .ecindex IIDplaiauth1
28135 .ecindex IIDplaiauth2
28136
28137
28138
28139
28140 . ////////////////////////////////////////////////////////////////////////////
28141 . ////////////////////////////////////////////////////////////////////////////
28142
28143 .chapter "The cram_md5 authenticator" "CHID9"
28144 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28145 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28146 .cindex "CRAM-MD5 authentication mechanism"
28147 .cindex authentication CRAM-MD5
28148 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28149 sends a challenge string to the client, and the response consists of a user
28150 name and the CRAM-MD5 digest of the challenge string combined with a secret
28151 string (password) which is known to both server and client. Thus, the secret
28152 is not sent over the network as plain text, which makes this authenticator more
28153 secure than &(plaintext)&. However, the downside is that the secret has to be
28154 available in plain text at either end.
28155
28156
28157 .section "Using cram_md5 as a server" "SECID176"
28158 .cindex "options" "&(cram_md5)& authenticator (server)"
28159 This authenticator has one server option, which must be set to configure the
28160 authenticator as a server:
28161
28162 .option server_secret cram_md5 string&!! unset
28163 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28164 When the server receives the client's response, the user name is placed in
28165 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28166 obtain the password for that user. The server then computes the CRAM-MD5 digest
28167 that the client should have sent, and checks that it received the correct
28168 string. If the expansion of &%server_secret%& is forced to fail, authentication
28169 fails. If the expansion fails for some other reason, a temporary error code is
28170 returned to the client.
28171
28172 For compatibility with previous releases of Exim, the user name is also placed
28173 in &$1$&. However, the use of this variables for this purpose is now
28174 deprecated, as it can lead to confusion in string expansions that also use
28175 numeric variables for other things.
28176
28177 For example, the following authenticator checks that the user name given by the
28178 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28179 user name, authentication fails.
28180 .code
28181 fixed_cram:
28182   driver = cram_md5
28183   public_name = CRAM-MD5
28184   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28185   server_set_id = $auth1
28186 .endd
28187 .vindex "&$authenticated_id$&"
28188 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28189 name in &$authenticated_id$&. A more typical configuration might look up the
28190 secret string in a file, using the user name as the key. For example:
28191 .code
28192 lookup_cram:
28193   driver = cram_md5
28194   public_name = CRAM-MD5
28195   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28196                   {$value}fail}
28197   server_set_id = $auth1
28198 .endd
28199 Note that this expansion explicitly forces failure if the lookup fails
28200 because &$auth1$& contains an unknown user name.
28201
28202 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28203 using the relevant libraries, you need to know the realm to specify in the
28204 lookup and then ask for the &"userPassword"& attribute for that user in that
28205 realm, with:
28206 .code
28207 cyrusless_crammd5:
28208   driver = cram_md5
28209   public_name = CRAM-MD5
28210   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28211                   dbmjz{/etc/sasldb2}{$value}fail}
28212   server_set_id = $auth1
28213 .endd
28214
28215 .section "Using cram_md5 as a client" "SECID177"
28216 .cindex "options" "&(cram_md5)& authenticator (client)"
28217 When used as a client, the &(cram_md5)& authenticator has two options:
28218
28219
28220
28221 .option client_name cram_md5 string&!! "the primary host name"
28222 This string is expanded, and the result used as the user name data when
28223 computing the response to the server's challenge.
28224
28225
28226 .option client_secret cram_md5 string&!! unset
28227 This option must be set for the authenticator to work as a client. Its value is
28228 expanded and the result used as the secret string when computing the response.
28229
28230
28231 .vindex "&$host$&"
28232 .vindex "&$host_address$&"
28233 Different user names and secrets can be used for different servers by referring
28234 to &$host$& or &$host_address$& in the options. Forced failure of either
28235 expansion string is treated as an indication that this authenticator is not
28236 prepared to handle this case. Exim moves on to the next configured client
28237 authenticator. Any other expansion failure causes Exim to give up trying to
28238 send the message to the current server.
28239
28240 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28241 strings, is:
28242 .code
28243 fixed_cram:
28244   driver = cram_md5
28245   public_name = CRAM-MD5
28246   client_name = ph10
28247   client_secret = secret
28248 .endd
28249 .ecindex IIDcramauth1
28250 .ecindex IIDcramauth2
28251
28252
28253
28254 . ////////////////////////////////////////////////////////////////////////////
28255 . ////////////////////////////////////////////////////////////////////////////
28256
28257 .chapter "The cyrus_sasl authenticator" "CHID10"
28258 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28259 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28260 .cindex "Cyrus" "SASL library"
28261 .cindex "Kerberos"
28262 The code for this authenticator was provided by Matthew Byng-Maddick while
28263 at A L Digital Ltd.
28264
28265 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28266 library implementation of the RFC 2222 (&"Simple Authentication and Security
28267 Layer"&). This library supports a number of authentication mechanisms,
28268 including PLAIN and LOGIN, but also several others that Exim does not support
28269 directly. In particular, there is support for Kerberos authentication.
28270
28271 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28272 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28273 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28274 name of the driver to determine which mechanism to support.
28275
28276 Where access to some kind of secret file is required, for example, in GSSAPI
28277 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28278 user, and that the Cyrus SASL library has no way of escalating privileges
28279 by default. You may also find you need to set environment variables,
28280 depending on the driver you are using.
28281
28282 The application name provided by Exim is &"exim"&, so various SASL options may
28283 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28284 Kerberos, note that because of limitations in the GSSAPI interface,
28285 changing the server keytab might need to be communicated down to the Kerberos
28286 layer independently. The mechanism for doing so is dependent upon the Kerberos
28287 implementation.
28288
28289 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28290 may be set to point to an alternative keytab file. Exim will pass this
28291 variable through from its own inherited environment when started as root or the
28292 Exim user. The keytab file needs to be readable by the Exim user.
28293 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28294 environment variable.  In practice, for those releases, the Cyrus authenticator
28295 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28296 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28297
28298
28299 .section "Using cyrus_sasl as a server" "SECID178"
28300 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28301 (on a successful authentication) into &$auth1$&. For compatibility with
28302 previous releases of Exim, the username is also placed in &$1$&. However, the
28303 use of this variable for this purpose is now deprecated, as it can lead to
28304 confusion in string expansions that also use numeric variables for other
28305 things.
28306
28307
28308 .option server_hostname cyrus_sasl string&!! "see below"
28309 This option selects the hostname that is used when communicating with the
28310 library. The default value is &`$primary_hostname`&. It is up to the underlying
28311 SASL plug-in what it does with this data.
28312
28313
28314 .option server_mech cyrus_sasl string "see below"
28315 This option selects the authentication mechanism this driver should use. The
28316 default is the value of the generic &%public_name%& option. This option allows
28317 you to use a different underlying mechanism from the advertised name. For
28318 example:
28319 .code
28320 sasl:
28321   driver = cyrus_sasl
28322   public_name = X-ANYTHING
28323   server_mech = CRAM-MD5
28324   server_set_id = $auth1
28325 .endd
28326
28327 .option server_realm cyrus_sasl string&!! unset
28328 This specifies the SASL realm that the server claims to be in.
28329
28330
28331 .option server_service cyrus_sasl string &`smtp`&
28332 This is the SASL service that the server claims to implement.
28333
28334
28335 For straightforward cases, you do not need to set any of the authenticator's
28336 private options. All you need to do is to specify an appropriate mechanism as
28337 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28338 PLAIN, you could have two authenticators as follows:
28339 .code
28340 sasl_cram_md5:
28341   driver = cyrus_sasl
28342   public_name = CRAM-MD5
28343   server_set_id = $auth1
28344
28345 sasl_plain:
28346   driver = cyrus_sasl
28347   public_name = PLAIN
28348   server_set_id = $auth2
28349 .endd
28350 Cyrus SASL does implement the LOGIN authentication method, even though it is
28351 not a standard method. It is disabled by default in the source distribution,
28352 but it is present in many binary distributions.
28353 .ecindex IIDcyrauth1
28354 .ecindex IIDcyrauth2
28355
28356
28357
28358
28359 . ////////////////////////////////////////////////////////////////////////////
28360 . ////////////////////////////////////////////////////////////////////////////
28361 .chapter "The dovecot authenticator" "CHAPdovecot"
28362 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28363 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28364 This authenticator is an interface to the authentication facility of the
28365 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28366 Note that Dovecot must be configured to use auth-client not auth-userdb.
28367 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28368 to use the same mechanisms for SMTP authentication. This is a server
28369 authenticator only. There is only one non-generic option:
28370
28371 .option server_socket dovecot string unset
28372
28373 This option must specify the UNIX socket that is the interface to Dovecot
28374 authentication. The &%public_name%& option must specify an authentication
28375 mechanism that Dovecot is configured to support. You can have several
28376 authenticators for different mechanisms. For example:
28377 .code
28378 dovecot_plain:
28379   driver = dovecot
28380   public_name = PLAIN
28381   server_advertise_condition = ${if def:tls_in_cipher}
28382   server_socket = /var/run/dovecot/auth-client
28383   server_set_id = $auth1
28384
28385 dovecot_ntlm:
28386   driver = dovecot
28387   public_name = NTLM
28388   server_socket = /var/run/dovecot/auth-client
28389   server_set_id = $auth1
28390 .endd
28391
28392 .new
28393 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28394 should not be advertised on cleartext SMTP connections.
28395 See the discussion in section &<<SECTplain_TLS>>&.
28396 .wen
28397
28398 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28399 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28400 option is passed in the Dovecot authentication command. If, for a TLS
28401 connection, a client certificate has been verified, the &"valid-client-cert"&
28402 option is passed. When authentication succeeds, the identity of the user
28403 who authenticated is placed in &$auth1$&.
28404
28405 The Dovecot configuration to match the above will look
28406 something like:
28407 .code
28408 conf.d/10-master.conf :-
28409
28410 service auth {
28411 ...
28412 #SASL
28413   unix_listener auth-client {
28414     mode = 0660
28415     user = mail
28416   }
28417 ...
28418 }
28419
28420 conf.d/10-auth.conf :-
28421
28422 auth_mechanisms = plain login ntlm
28423 .endd
28424
28425 .ecindex IIDdcotauth1
28426 .ecindex IIDdcotauth2
28427
28428
28429 . ////////////////////////////////////////////////////////////////////////////
28430 . ////////////////////////////////////////////////////////////////////////////
28431 .chapter "The gsasl authenticator" "CHAPgsasl"
28432 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28433 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28434 .cindex "authentication" "GNU SASL"
28435 .cindex "authentication" "SASL"
28436 .cindex "authentication" "EXTERNAL"
28437 .cindex "authentication" "ANONYMOUS"
28438 .cindex "authentication" "PLAIN"
28439 .cindex "authentication" "LOGIN"
28440 .cindex "authentication" "DIGEST-MD5"
28441 .cindex "authentication" "CRAM-MD5"
28442 .cindex "authentication" "SCRAM family"
28443 The &(gsasl)& authenticator provides integration for the GNU SASL
28444 library and the mechanisms it provides.  This is new as of the 4.80 release
28445 and there are a few areas where the library does not let Exim smoothly
28446 scale to handle future authentication mechanisms, so no guarantee can be
28447 made that any particular new authentication mechanism will be supported
28448 without code changes in Exim.
28449
28450 The library is expected to add support in an upcoming
28451 realease for the SCRAM-SHA-256 method.
28452 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28453 when this happens.
28454
28455 To see the list of mechanisms supported by the library run Exim with "auth" debug
28456 enabled and look for a line containing "GNU SASL supports".
28457 Note however that some may not have been tested from Exim.
28458
28459
28460 .option client_authz gsasl string&!! unset
28461 This option can be used to supply an &'authorization id'&
28462 which is different to the &'authentication_id'& provided
28463 by &%client_username%& option.
28464 If unset or (after expansion) empty it is not used,
28465 which is the common case.
28466
28467 .option client_channelbinding gsasl boolean false
28468 See &%server_channelbinding%& below.
28469
28470 .option client_password gsasl string&!! unset
28471 This option is exapanded before use, and should result in
28472 the password to be used, in clear.
28473
28474 .option client_username gsasl string&!! unset
28475 This option is exapanded before use, and should result in
28476 the account name to be used.
28477
28478
28479 .option client_spassword gsasl string&!! unset
28480 This option is only supported for library versions 1.9.1 and greater.
28481 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28482
28483 If a SCRAM mechanism is being used and this option is set
28484 and correctly sized
28485 it is used in preference to &%client_password%&.
28486 The value after expansion should be
28487 a 40 (for SHA-1) or 64 (for SHA-256) character string
28488 with the PBKDF2-prepared password, hex-encoded.
28489
28490 Note that this value will depend on the salt and iteration-count
28491 supplied by the server.
28492 The option is expanded before use.
28493 During the expansion &$auth1$& is set with the client username,
28494 &$auth2$& with the iteration count, and
28495 &$auth3$& with the salt.
28496
28497 The intent of this option
28498 is to support clients that can cache thes salted password
28499 to save on recalculation costs.
28500 The cache lookup should return an unusable value
28501 (eg. an empty string)
28502 if the salt or iteration count has changed
28503
28504 If the authentication succeeds then the above variables are set,
28505 .vindex "&$auth4$&"
28506 plus the calculated salted password value value in &$auth4$&,
28507 during the expansion of the &%client_set_id%& option.
28508 A side-effect of this expansion can be used to prime the cache.
28509
28510
28511 .option server_channelbinding gsasl boolean false
28512 Some authentication mechanisms are able to use external context at both ends
28513 of the session to bind the authentication to that context, and fail the
28514 authentication process if that context differs.  Specifically, some TLS
28515 ciphersuites can provide identifying information about the cryptographic
28516 context.
28517
28518 This should have meant that certificate identity and verification becomes a
28519 non-issue, as a man-in-the-middle attack will cause the correct client and
28520 server to see different identifiers and authentication will fail.
28521
28522 This is
28523 only usable by mechanisms which support "channel binding"; at time of
28524 writing, that's the SCRAM family.
28525 When using this feature the "-PLUS" variants of the method names need to be used.
28526
28527 This defaults off to ensure smooth upgrade across Exim releases, in case
28528 this option causes some clients to start failing.  Some future release
28529 of Exim might have switched the default to be true.
28530
28531 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28532 . Do not plan to rely upon this feature for security, ever, without consulting
28533 . with a subject matter expert (a cryptographic engineer).
28534
28535 This option was deprecated in previous releases due to doubts over
28536 the "Triple Handshake" vulnerability.
28537 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28538 Session Resumption was used) for safety.
28539
28540
28541 .option server_hostname gsasl string&!! "see below"
28542 This option selects the hostname that is used when communicating with the
28543 library. The default value is &`$primary_hostname`&.
28544 Some mechanisms will use this data.
28545
28546
28547 .option server_mech gsasl string "see below"
28548 This option selects the authentication mechanism this driver should use. The
28549 default is the value of the generic &%public_name%& option. This option allows
28550 you to use a different underlying mechanism from the advertised name. For
28551 example:
28552 .code
28553 sasl:
28554   driver = gsasl
28555   public_name = X-ANYTHING
28556   server_mech = CRAM-MD5
28557   server_set_id = $auth1
28558 .endd
28559
28560
28561 .option server_password gsasl string&!! unset
28562 Various mechanisms need access to the cleartext password on the server, so
28563 that proof-of-possession can be demonstrated on the wire, without sending
28564 the password itself.
28565
28566 The data available for lookup varies per mechanism.
28567 In all cases, &$auth1$& is set to the &'authentication id'&.
28568 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28569 if available, else the empty string.
28570 The &$auth3$& variable will always be the &'realm'& if available,
28571 else the empty string.
28572
28573 A forced failure will cause authentication to defer.
28574
28575 If using this option, it may make sense to set the &%server_condition%&
28576 option to be simply "true".
28577
28578
28579 .option server_realm gsasl string&!! unset
28580 This specifies the SASL realm that the server claims to be in.
28581 Some mechanisms will use this data.
28582
28583
28584 .option server_scram_iter gsasl string&!! 4096
28585 This option provides data for the SCRAM family of mechanisms.
28586 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28587 when this option is expanded.
28588
28589 The result of expansion should be a decimal number,
28590 and represents both a lower-bound on the security, and
28591 a compute cost factor imposed on the client
28592 (if it does not cache results, or the server changes
28593 either the iteration count or the salt).
28594 A minimum value of 4096 is required by the standards
28595 for all current SCRAM mechanism variants.
28596
28597 .option server_scram_salt gsasl string&!! unset
28598 This option provides data for the SCRAM family of mechanisms.
28599 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28600 when this option is expanded.
28601 The value should be a base64-encoded string,
28602 of random data typically 4-to-16 bytes long.
28603 If unset or empty after expansion the library will provides a value for the
28604 protocol conversation.
28605
28606
28607 .option server_key gsasl string&!! unset
28608 .option server_skey gsasl string&!! unset
28609 These options can be used for the SCRAM family of mechanisms
28610 to provide stored information related to a password,
28611 the storage of which is preferable to plaintext.
28612
28613 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28614 &%server_skey%& is StoredKey.
28615
28616 They are only available for version 1.9.0 (or later) of the gsasl library.
28617 When this is so, the macros
28618 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28619 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28620 will be defined.
28621
28622 The &$authN$& variables are available when these options are expanded.
28623
28624 If set, the results of expansion should for each
28625 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28626 of base64-coded data, and will be used in preference to the
28627 &%server_password%& option.
28628 If unset or not of the right length, &%server_password%& will be used.
28629
28630 The libgsasl library release includes a utility &'gsasl'& which can be used
28631 to generate these values.
28632
28633
28634 .option server_service gsasl string &`smtp`&
28635 This is the SASL service that the server claims to implement.
28636 Some mechanisms will use this data.
28637
28638
28639 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28640 .vindex "&$auth1$&, &$auth2$&, etc"
28641 These may be set when evaluating specific options, as detailed above.
28642 They will also be set when evaluating &%server_condition%&.
28643
28644 Unless otherwise stated below, the &(gsasl)& integration will use the following
28645 meanings for these variables:
28646
28647 .ilist
28648 .vindex "&$auth1$&"
28649 &$auth1$&: the &'authentication id'&
28650 .next
28651 .vindex "&$auth2$&"
28652 &$auth2$&: the &'authorization id'&
28653 .next
28654 .vindex "&$auth3$&"
28655 &$auth3$&: the &'realm'&
28656 .endlist
28657
28658 On a per-mechanism basis:
28659
28660 .ilist
28661 .cindex "authentication" "EXTERNAL"
28662 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28663 the &%server_condition%& option must be present.
28664 .next
28665 .cindex "authentication" "ANONYMOUS"
28666 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28667 the &%server_condition%& option must be present.
28668 .next
28669 .cindex "authentication" "GSSAPI"
28670 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28671 &$auth2$& will be set to the &'authorization id'&,
28672 the &%server_condition%& option must be present.
28673 .endlist
28674
28675 An &'anonymous token'& is something passed along as an unauthenticated
28676 identifier; this is analogous to FTP anonymous authentication passing an
28677 email address, or software-identifier@, as the "password".
28678
28679
28680 An example showing the password having the realm specified in the callback
28681 and demonstrating a Cyrus SASL to GSASL migration approach is:
28682 .code
28683 gsasl_cyrusless_crammd5:
28684   driver = gsasl
28685   public_name = CRAM-MD5
28686   server_realm = imap.example.org
28687   server_password = ${lookup{$auth1:$auth3:userPassword}\
28688                     dbmjz{/etc/sasldb2}{$value}fail}
28689   server_set_id = ${quote:$auth1}
28690   server_condition = yes
28691 .endd
28692
28693
28694 . ////////////////////////////////////////////////////////////////////////////
28695 . ////////////////////////////////////////////////////////////////////////////
28696
28697 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28698 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28699 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28700 .cindex "authentication" "GSSAPI"
28701 .cindex "authentication" "Kerberos"
28702 The &(heimdal_gssapi)& authenticator provides server integration for the
28703 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28704 reliably.
28705
28706 .option server_hostname heimdal_gssapi string&!! "see below"
28707 This option selects the hostname that is used, with &%server_service%&,
28708 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28709 identifier.  The default value is &`$primary_hostname`&.
28710
28711 .option server_keytab heimdal_gssapi string&!! unset
28712 If set, then Heimdal will not use the system default keytab (typically
28713 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28714 The value should be a pathname, with no &"file:"& prefix.
28715
28716 .option server_service heimdal_gssapi string&!! "smtp"
28717 This option specifies the service identifier used, in conjunction with
28718 &%server_hostname%&, for building the identifier for finding credentials
28719 from the keytab.
28720
28721
28722 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28723 Beware that these variables will typically include a realm, thus will appear
28724 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28725 not verified, so a malicious client can set it to anything.
28726
28727 The &$auth1$& field should be safely trustable as a value from the Key
28728 Distribution Center.  Note that these are not quite email addresses.
28729 Each identifier is for a role, and so the left-hand-side may include a
28730 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28731
28732 .vindex "&$auth1$&, &$auth2$&, etc"
28733 .ilist
28734 .vindex "&$auth1$&"
28735 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28736 .next
28737 .vindex "&$auth2$&"
28738 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28739 authentication.  If that was empty, this will also be set to the
28740 GSS Display Name.
28741 .endlist
28742
28743
28744 . ////////////////////////////////////////////////////////////////////////////
28745 . ////////////////////////////////////////////////////////////////////////////
28746
28747 .chapter "The spa authenticator" "CHAPspa"
28748 .scindex IIDspaauth1 "&(spa)& authenticator"
28749 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28750 .cindex "authentication" "Microsoft Secure Password"
28751 .cindex "authentication" "NTLM"
28752 .cindex "Microsoft Secure Password Authentication"
28753 .cindex "NTLM authentication"
28754 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28755 Password Authentication'& mechanism,
28756 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28757 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28758 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28759 server side was subsequently contributed by Tom Kistner. The mechanism works as
28760 follows:
28761
28762 .ilist
28763 After the AUTH command has been accepted, the client sends an SPA
28764 authentication request based on the user name and optional domain.
28765 .next
28766 The server sends back a challenge.
28767 .next
28768 The client builds a challenge response which makes use of the user's password
28769 and sends it to the server, which then accepts or rejects it.
28770 .endlist
28771
28772 Encryption is used to protect the password in transit.
28773
28774
28775
28776 .section "Using spa as a server" "SECID179"
28777 .cindex "options" "&(spa)& authenticator (server)"
28778 The &(spa)& authenticator has just one server option:
28779
28780 .option server_password spa string&!! unset
28781 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28782 This option is expanded, and the result must be the cleartext password for the
28783 authenticating user, whose name is at this point in &$auth1$&. For
28784 compatibility with previous releases of Exim, the user name is also placed in
28785 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28786 it can lead to confusion in string expansions that also use numeric variables
28787 for other things. For example:
28788 .code
28789 spa:
28790   driver = spa
28791   public_name = NTLM
28792   server_password = \
28793     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28794 .endd
28795 If the expansion is forced to fail, authentication fails. Any other expansion
28796 failure causes a temporary error code to be returned.
28797
28798
28799
28800
28801
28802 .section "Using spa as a client" "SECID180"
28803 .cindex "options" "&(spa)& authenticator (client)"
28804 The &(spa)& authenticator has the following client options:
28805
28806
28807
28808 .option client_domain spa string&!! unset
28809 This option specifies an optional domain for the authentication.
28810
28811
28812 .option client_password spa string&!! unset
28813 This option specifies the user's password, and must be set.
28814
28815
28816 .option client_username spa string&!! unset
28817 This option specifies the user name, and must be set. Here is an example of a
28818 configuration of this authenticator for use with the mail servers at
28819 &'msn.com'&:
28820 .code
28821 msn:
28822   driver = spa
28823   public_name = MSN
28824   client_username = msn/msn_username
28825   client_password = msn_plaintext_password
28826   client_domain = DOMAIN_OR_UNSET
28827 .endd
28828 .ecindex IIDspaauth1
28829 .ecindex IIDspaauth2
28830
28831
28832
28833
28834
28835 . ////////////////////////////////////////////////////////////////////////////
28836 . ////////////////////////////////////////////////////////////////////////////
28837
28838 .chapter "The external authenticator" "CHAPexternauth"
28839 .scindex IIDexternauth1 "&(external)& authenticator"
28840 .scindex IIDexternauth2 "authenticators" "&(external)&"
28841 .cindex "authentication" "Client Certificate"
28842 .cindex "authentication" "X509"
28843 .cindex "Certificate-based authentication"
28844 The &(external)& authenticator provides support for
28845 authentication based on non-SMTP information.
28846 The specification is in RFC 4422 Appendix A
28847 (&url(https://tools.ietf.org/html/rfc4422)).
28848 It is only a transport and negotiation mechanism;
28849 the process of authentication is entirely controlled
28850 by the server configuration.
28851
28852 The client presents an identity in-clear.
28853 It is probably wise for a server to only advertise,
28854 and for clients to only attempt,
28855 this authentication method on a secure (eg. under TLS) connection.
28856
28857 One possible use, compatible with the
28858 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28859 is for using X509 client certificates.
28860
28861 It thus overlaps in function with the TLS authenticator
28862 (see &<<CHAPtlsauth>>&)
28863 but is a full SMTP SASL authenticator
28864 rather than being implicit for TLS-connection carried
28865 client certificates only.
28866
28867 The examples and discussion in this chapter assume that
28868 client-certificate authentication is being done.
28869
28870 The client must present a certificate,
28871 for which it must have been requested via the
28872 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28873 (see &<<CHAPTLS>>&).
28874 For authentication to be effective the certificate should be
28875 verifiable against a trust-anchor certificate known to the server.
28876
28877 .section "External options" "SECTexternsoptions"
28878 .cindex "options" "&(external)& authenticator (server)"
28879 The &(external)& authenticator has two server options:
28880
28881 .option server_param2 external string&!! unset
28882 .option server_param3 external string&!! unset
28883 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28884 These options are expanded before the &%server_condition%& option
28885 and the result are placed in &$auth2$& and &$auth3$& resectively.
28886 If the expansion is forced to fail, authentication fails. Any other expansion
28887 failure causes a temporary error code to be returned.
28888
28889 They can be used to clarify the coding of a complex &%server_condition%&.
28890
28891 .section "Using external in a server" "SECTexternserver"
28892 .cindex "AUTH" "in &(external)& authenticator"
28893 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28894         "in &(external)& authenticator"
28895 .vindex "&$auth1$&, &$auth2$&, etc"
28896 .cindex "base64 encoding" "in &(external)& authenticator"
28897
28898 When running as a server, &(external)& performs the authentication test by
28899 expanding a string. The data sent by the client with the AUTH command, or in
28900 response to subsequent prompts, is base64 encoded, and so may contain any byte
28901 values when decoded. The decoded value is treated as
28902 an identity for authentication and
28903 placed in the expansion variable &$auth1$&.
28904
28905 For compatibility with previous releases of Exim, the value is also placed in
28906 the expansion variable &$1$&. However, the use of this
28907 variable for this purpose is now deprecated, as it can lead to confusion in
28908 string expansions that also use them for other things.
28909
28910 .vindex "&$authenticated_id$&"
28911 Once an identity has been received,
28912 &%server_condition%& is expanded. If the expansion is forced to fail,
28913 authentication fails. Any other expansion failure causes a temporary error code
28914 to be returned. If the result of a successful expansion is an empty string,
28915 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28916 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28917 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28918 For any other result, a temporary error code is returned, with the expanded
28919 string as the error text.
28920
28921 Example:
28922 .code
28923 ext_ccert_san_mail:
28924   driver =            external
28925   public_name =       EXTERNAL
28926
28927   server_advertise_condition = $tls_in_certificate_verified
28928   server_param2 =     ${certextract {subj_altname,mail,>:} \
28929                                     {$tls_in_peercert}}
28930   server_condition =  ${if forany {$auth2} \
28931                             {eq {$item}{$auth1}}}
28932   server_set_id =     $auth1
28933 .endd
28934 This accepts a client certificate that is verifiable against any
28935 of your configured trust-anchors
28936 (which usually means the full set of public CAs)
28937 and which has a mail-SAN matching the claimed identity sent by the client.
28938
28939 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28940 The account name is therefore guessable by an opponent.
28941 TLS 1.3 protects both server and client certificates, and is not vulnerable
28942 in this way.
28943
28944
28945 .section "Using external in a client" "SECTexternclient"
28946 .cindex "options" "&(external)& authenticator (client)"
28947 The &(external)& authenticator has one client option:
28948
28949 .option client_send external string&!! unset
28950 This option is expanded and sent with the AUTH command as the
28951 identity being asserted.
28952
28953 Example:
28954 .code
28955 ext_ccert:
28956   driver =      external
28957   public_name = EXTERNAL
28958
28959   client_condition = ${if !eq{$tls_out_cipher}{}}
28960   client_send = myaccount@smarthost.example.net
28961 .endd
28962
28963
28964 .ecindex IIDexternauth1
28965 .ecindex IIDexternauth2
28966
28967
28968
28969
28970
28971 . ////////////////////////////////////////////////////////////////////////////
28972 . ////////////////////////////////////////////////////////////////////////////
28973
28974 .chapter "The tls authenticator" "CHAPtlsauth"
28975 .scindex IIDtlsauth1 "&(tls)& authenticator"
28976 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28977 .cindex "authentication" "Client Certificate"
28978 .cindex "authentication" "X509"
28979 .cindex "Certificate-based authentication"
28980 The &(tls)& authenticator provides server support for
28981 authentication based on client certificates.
28982
28983 It is not an SMTP authentication mechanism and is not
28984 advertised by the server as part of the SMTP EHLO response.
28985 It is an Exim authenticator in the sense that it affects
28986 the protocol element of the log line, can be tested for
28987 by the &%authenticated%& ACL condition, and can set
28988 the &$authenticated_id$& variable.
28989
28990 The client must present a verifiable certificate,
28991 for which it must have been requested via the
28992 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28993 (see &<<CHAPTLS>>&).
28994
28995 If an authenticator of this type is configured it is
28996 run immediately after a TLS connection being negotiated
28997 (due to either STARTTLS or TLS-on-connect)
28998 and can authenticate the connection.
28999 If it does, SMTP authentication is not subsequently offered.
29000
29001 A maximum of one authenticator of this type may be present.
29002
29003
29004 .cindex "options" "&(tls)& authenticator (server)"
29005 The &(tls)& authenticator has three server options:
29006
29007 .option server_param1 tls string&!! unset
29008 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29009 This option is expanded after the TLS negotiation and
29010 the result is placed in &$auth1$&.
29011 If the expansion is forced to fail, authentication fails. Any other expansion
29012 failure causes a temporary error code to be returned.
29013
29014 .option server_param2 tls string&!! unset
29015 .option server_param3 tls string&!! unset
29016 As above, for &$auth2$& and &$auth3$&.
29017
29018 &%server_param1%& may also be spelled &%server_param%&.
29019
29020
29021 Example:
29022 .code
29023 tls:
29024   driver = tls
29025   server_param1 =     ${certextract {subj_altname,mail,>:} \
29026                                     {$tls_in_peercert}}
29027   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29028                                  {forany {$auth1} \
29029                             {!= {0} \
29030                                 {${lookup ldap{ldap:///\
29031                          mailname=${quote_ldap_dn:${lc:$item}},\
29032                          ou=users,LDAP_DC?mailid} {$value}{0} \
29033                        }    }  } }}}
29034   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29035 .endd
29036 This accepts a client certificate that is verifiable against any
29037 of your configured trust-anchors
29038 (which usually means the full set of public CAs)
29039 and which has a SAN with a good account name.
29040
29041 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29042 The account name is therefore guessable by an opponent.
29043 TLS 1.3 protects both server and client certificates, and is not vulnerable
29044 in this way.
29045 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29046
29047 . An alternative might use
29048 . .code
29049 .   server_param1 = ${sha256:$tls_in_peercert}
29050 . .endd
29051 . to require one of a set of specific certs that define a given account
29052 . (the verification is still required, but mostly irrelevant).
29053 . This would help for per-device use.
29054 .
29055 . However, for the future we really need support for checking a
29056 . user cert in LDAP - which probably wants a base-64 DER.
29057
29058 .ecindex IIDtlsauth1
29059 .ecindex IIDtlsauth2
29060
29061
29062 Note that because authentication is traditionally an SMTP operation,
29063 the &%authenticated%& ACL condition cannot be used in
29064 a connect- or helo-ACL.
29065
29066
29067
29068 . ////////////////////////////////////////////////////////////////////////////
29069 . ////////////////////////////////////////////////////////////////////////////
29070
29071 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29072          "Encrypted SMTP connections"
29073 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29074 .scindex IIDencsmtp2 "SMTP" "encryption"
29075 .cindex "TLS" "on SMTP connection"
29076 .cindex "OpenSSL"
29077 .cindex "GnuTLS"
29078 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29079 Sockets Layer), is implemented by making use of the OpenSSL library or the
29080 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29081 cryptographic code in the Exim distribution itself for implementing TLS. In
29082 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29083 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29084 You also need to understand the basic concepts of encryption at a managerial
29085 level, and in particular, the way that public keys, private keys, and
29086 certificates are used.
29087
29088 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29089 connection is established, the client issues a STARTTLS command. If the
29090 server accepts this, the client and the server negotiate an encryption
29091 mechanism. If the negotiation succeeds, the data that subsequently passes
29092 between them is encrypted.
29093
29094 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29095 and if so, what cipher suite is in use, whether the client supplied a
29096 certificate, and whether or not that certificate was verified. This makes it
29097 possible for an Exim server to deny or accept certain commands based on the
29098 encryption state.
29099
29100 &*Warning*&: Certain types of firewall and certain anti-virus products can
29101 disrupt TLS connections. You need to turn off SMTP scanning for these products
29102 in order to get TLS to work.
29103
29104
29105
29106 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29107          "SECID284"
29108 .cindex "submissions protocol"
29109 .cindex "ssmtp protocol"
29110 .cindex "smtps protocol"
29111 .cindex "SMTP" "submissions protocol"
29112 .cindex "SMTP" "ssmtp protocol"
29113 .cindex "SMTP" "smtps protocol"
29114 The history of port numbers for TLS in SMTP is a little messy and has been
29115 contentious.  As of RFC 8314, the common practice of using the historically
29116 allocated port 465 for "email submission but with TLS immediately upon connect
29117 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29118 by them in preference to STARTTLS.
29119
29120 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29121 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29122 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29123
29124 This approach was, for a while, officially abandoned when encrypted SMTP was
29125 standardized, but many clients kept using it, even as the TCP port number was
29126 reassigned for other use.
29127 Thus you may encounter guidance claiming that you shouldn't enable use of
29128 this port.
29129 In practice, a number of mail-clients have only ever supported submissions,
29130 not submission with STARTTLS upgrade.
29131 Ideally, offer both submission (587) and submissions (465) service.
29132
29133 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29134 global option. Its value must be a list of port numbers;
29135 the most common use is expected to be:
29136 .code
29137 tls_on_connect_ports = 465
29138 .endd
29139 The port numbers specified by this option apply to all SMTP connections, both
29140 via the daemon and via &'inetd'&. You still need to specify all the ports that
29141 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29142 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29143 an extra port &-- rather, it specifies different behaviour on a port that is
29144 defined elsewhere.
29145
29146 There is also a &%-tls-on-connect%& command line option. This overrides
29147 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29148
29149
29150
29151
29152
29153
29154 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29155 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29156 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29157 To build Exim to use OpenSSL you need to set
29158 .code
29159 USE_OPENSSL=yes
29160 .endd
29161 in Local/Makefile.
29162
29163 To build Exim to use GnuTLS, you need to set
29164 .code
29165 USE_GNUTLS=yes
29166 .endd
29167 in Local/Makefile.
29168
29169 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29170 include files and libraries for GnuTLS can be found.
29171
29172 There are some differences in usage when using GnuTLS instead of OpenSSL:
29173
29174 .ilist
29175 The &%tls_verify_certificates%& option
29176 cannot be the path of a directory
29177 for GnuTLS versions before 3.3.6
29178 (for later versions, or OpenSSL, it can be either).
29179 .next
29180 The default value for &%tls_dhparam%& differs for historical reasons.
29181 .next
29182 .vindex "&$tls_in_peerdn$&"
29183 .vindex "&$tls_out_peerdn$&"
29184 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29185 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29186 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29187 .next
29188 OpenSSL identifies cipher suites using hyphens as separators, for example:
29189 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29190 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29191 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29192 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29193 to handle its own older variants) when processing lists of cipher suites in the
29194 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29195 option).
29196 .next
29197 The &%tls_require_ciphers%& options operate differently, as described in the
29198 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29199 .next
29200 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29201 When using OpenSSL, this option is ignored.
29202 (If an API is found to let OpenSSL be configured in this way,
29203 let the Exim Maintainers know and we'll likely use it).
29204 .next
29205 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29206 main option, it must be ordered to match the &%tls_certificate%& list.
29207 .next
29208 Some other recently added features may only be available in one or the other.
29209 This should be documented with the feature.  If the documentation does not
29210 explicitly state that the feature is infeasible in the other TLS
29211 implementation, then patches are welcome.
29212 .next
29213 The output from "exim -bV" will show which (if any) support was included
29214 in the build.
29215 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29216 .endlist
29217
29218
29219 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29220 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29221 an explicit path; if the latter, then the text about generation still applies,
29222 but not the chosen filename.
29223 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29224 See the documentation of &%tls_dhparam%& for more information.
29225
29226 GnuTLS uses D-H parameters that may take a substantial amount of time
29227 to compute. It is unreasonable to re-compute them for every TLS session.
29228 Therefore, Exim keeps this data in a file in its spool directory, called
29229 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29230 of bits requested.
29231 The file is owned by the Exim user and is readable only by
29232 its owner. Every Exim process that start up GnuTLS reads the D-H
29233 parameters from this file. If the file does not exist, the first Exim process
29234 that needs it computes the data and writes it to a temporary file which is
29235 renamed once it is complete. It does not matter if several Exim processes do
29236 this simultaneously (apart from wasting a few resources). Once a file is in
29237 place, new Exim processes immediately start using it.
29238
29239 For maximum security, the parameters that are stored in this file should be
29240 recalculated periodically, the frequency depending on your paranoia level.
29241 If you are avoiding using the fixed D-H primes published in RFCs, then you
29242 are concerned about some advanced attacks and will wish to do this; if you do
29243 not regenerate then you might as well stick to the standard primes.
29244
29245 Arranging this is easy in principle; just delete the file when you want new
29246 values to be computed. However, there may be a problem. The calculation of new
29247 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29248 If the system is not very active, &_/dev/random_& may delay returning data
29249 until enough randomness (entropy) is available. This may cause Exim to hang for
29250 a substantial amount of time, causing timeouts on incoming connections.
29251
29252 The solution is to generate the parameters externally to Exim. They are stored
29253 in &_gnutls-params-N_& in PEM format, which means that they can be
29254 generated externally using the &(certtool)& command that is part of GnuTLS.
29255
29256 To replace the parameters with new ones, instead of deleting the file
29257 and letting Exim re-create it, you can generate new parameters using
29258 &(certtool)& and, when this has been done, replace Exim's cache file by
29259 renaming. The relevant commands are something like this:
29260 .code
29261 # ls
29262 [ look for file; assume gnutls-params-2236 is the most recent ]
29263 # rm -f new-params
29264 # touch new-params
29265 # chown exim:exim new-params
29266 # chmod 0600 new-params
29267 # certtool --generate-dh-params --bits 2236 >>new-params
29268 # openssl dhparam -noout -text -in new-params | head
29269 [ check the first line, make sure it's not more than 2236;
29270   if it is, then go back to the start ("rm") and repeat
29271   until the size generated is at most the size requested ]
29272 # chmod 0400 new-params
29273 # mv new-params gnutls-params-2236
29274 .endd
29275 If Exim never has to generate the parameters itself, the possibility of
29276 stalling is removed.
29277
29278 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29279 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29280 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29281 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29282 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29283 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29284 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29285 which applies to all D-H usage, client or server.  If the value returned by
29286 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29287 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29288 limit, which is still much higher than Exim historically used.
29289
29290 The filename and bits used will change as the GnuTLS maintainers change the
29291 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29292 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29293 2432 bits, while NSS is limited to 2236 bits.
29294
29295 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29296 increase the chance of the generated prime actually being within acceptable
29297 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29298 procedure above.  There is no sane procedure available to Exim to double-check
29299 the size of the generated prime, so it might still be too large.
29300
29301
29302 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29303 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29304 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29305 There is a function in the OpenSSL library that can be passed a list of cipher
29306 suites before the cipher negotiation takes place. This specifies which ciphers
29307 are acceptable for TLS versions prior to 1.3.
29308 The list is colon separated and may contain names like
29309 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29310 directly to this function call.
29311 Many systems will install the OpenSSL manual-pages, so you may have
29312 &'ciphers(1)'& available to you.
29313 The following quotation from the OpenSSL
29314 documentation specifies what forms of item are allowed in the cipher string:
29315
29316 .ilist
29317 It can consist of a single cipher suite such as RC4-SHA.
29318 .next
29319 It can represent a list of cipher suites containing a certain algorithm,
29320 or cipher suites of a certain type. For example SHA1 represents all
29321 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29322 SSL v3 algorithms.
29323 .next
29324 Lists of cipher suites can be combined in a single cipher string using
29325 the + character. This is used as a logical and operation. For example
29326 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29327 algorithms.
29328 .endlist
29329
29330 Each cipher string can be optionally preceded by one of the characters &`!`&,
29331 &`-`& or &`+`&.
29332 .ilist
29333 If &`!`& is used, the ciphers are permanently deleted from the list. The
29334 ciphers deleted can never reappear in the list even if they are explicitly
29335 stated.
29336 .next
29337 If &`-`& is used, the ciphers are deleted from the list, but some or all
29338 of the ciphers can be added again by later options.
29339 .next
29340 If &`+`& is used, the ciphers are moved to the end of the list. This
29341 option does not add any new ciphers; it just moves matching existing ones.
29342 .endlist
29343
29344 If none of these characters is present, the string is interpreted as
29345 a list of ciphers to be appended to the current preference list. If the list
29346 includes any ciphers already present they will be ignored: that is, they will
29347 not be moved to the end of the list.
29348 .endlist
29349
29350 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29351 string:
29352 .code
29353 # note single-quotes to get ! past any shell history expansion
29354 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29355 .endd
29356
29357 This example will let the library defaults be permitted on the MX port, where
29358 there's probably no identity verification anyway, but ups the ante on the
29359 submission ports where the administrator might have some influence on the
29360 choice of clients used:
29361 .code
29362 # OpenSSL variant; see man ciphers(1)
29363 tls_require_ciphers = ${if =={$received_port}{25}\
29364                            {DEFAULT}\
29365                            {HIGH:!MD5:!SHA1}}
29366 .endd
29367
29368 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29369 .code
29370 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29371 .endd
29372
29373 For TLS version 1.3 the control available is less fine-grained
29374 and Exim does not provide access to it at present.
29375 The value of the &%tls_require_ciphers%& option is ignored when
29376 TLS version 1.3 is negotiated.
29377
29378 As of writing the library default cipher suite list for TLSv1.3 is
29379 .code
29380 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29381 .endd
29382
29383
29384 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29385          "SECTreqciphgnu"
29386 .cindex "GnuTLS" "specifying parameters for"
29387 .cindex "TLS" "specifying ciphers (GnuTLS)"
29388 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29389 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29390 .cindex "TLS" "specifying protocols (GnuTLS)"
29391 .cindex "TLS" "specifying priority string (GnuTLS)"
29392 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29393 The GnuTLS library allows the caller to provide a "priority string", documented
29394 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29395 ciphersuite specification in OpenSSL.
29396
29397 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29398 and controls both protocols and ciphers.
29399
29400 The &%tls_require_ciphers%& option is available both as an global option,
29401 controlling how Exim behaves as a server, and also as an option of the
29402 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29403 the value is string expanded.  The resulting string is not an Exim list and
29404 the string is given to the GnuTLS library, so that Exim does not need to be
29405 aware of future feature enhancements of GnuTLS.
29406
29407 Documentation of the strings accepted may be found in the GnuTLS manual, under
29408 "Priority strings".  This is online as
29409 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29410 but beware that this relates to GnuTLS 3, which may be newer than the version
29411 installed on your system.  If you are using GnuTLS 3,
29412 then the example code
29413 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29414 on that site can be used to test a given string.
29415
29416 For example:
29417 .code
29418 # Disable older versions of protocols
29419 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29420 .endd
29421
29422 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29423 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29424 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29425
29426 This example will let the library defaults be permitted on the MX port, where
29427 there's probably no identity verification anyway, and lowers security further
29428 by increasing compatibility; but this ups the ante on the submission ports
29429 where the administrator might have some influence on the choice of clients
29430 used:
29431 .code
29432 # GnuTLS variant
29433 tls_require_ciphers = ${if =={$received_port}{25}\
29434                            {NORMAL:%COMPAT}\
29435                            {SECURE128}}
29436 .endd
29437
29438
29439 .section "Configuring an Exim server to use TLS" "SECID182"
29440 .cindex "TLS" "configuring an Exim server"
29441 .cindex "ESMTP extensions" STARTTLS
29442 When Exim has been built with TLS support, it advertises the availability of
29443 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29444 but not to any others. The default value of this option is *, which means
29445 that STARTTLS is always advertised.  Set it to blank to never advertise;
29446 this is reasonable for systems that want to use TLS only as a client.
29447
29448 If STARTTLS is to be used you
29449 need to set some other options in order to make TLS available.
29450
29451 If a client issues a STARTTLS command and there is some configuration
29452 problem in the server, the command is rejected with a 454 error. If the client
29453 persists in trying to issue SMTP commands, all except QUIT are rejected
29454 with the error
29455 .code
29456 554 Security failure
29457 .endd
29458 If a STARTTLS command is issued within an existing TLS session, it is
29459 rejected with a 554 error code.
29460
29461 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29462 must be set to match some hosts. The default is * which matches all hosts.
29463
29464 If this is all you do, TLS encryption will be enabled but not authentication -
29465 meaning that the peer has no assurance it is actually you he is talking to.
29466 You gain protection from a passive sniffer listening on the wire but not
29467 from someone able to intercept the communication.
29468
29469 Further protection requires some further configuration at the server end.
29470
29471 To make TLS work you need to set, in the server,
29472 .code
29473 tls_certificate = /some/file/name
29474 tls_privatekey = /some/file/name
29475 .endd
29476 These options are, in fact, expanded strings, so you can make them depend on
29477 the identity of the client that is connected if you wish. The first file
29478 contains the server's X509 certificate, and the second contains the private key
29479 that goes with it. These files need to be
29480 PEM format and readable by the Exim user, and must
29481 always be given as full path names.
29482 The key must not be password-protected.
29483 They can be the same file if both the
29484 certificate and the key are contained within it. If &%tls_privatekey%& is not
29485 set, or if its expansion is forced to fail or results in an empty string, this
29486 is assumed to be the case. The certificate file may also contain intermediate
29487 certificates that need to be sent to the client to enable it to authenticate
29488 the server's certificate.
29489
29490 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29491 colon-separated lists of file paths.  Ciphers using given authentication
29492 algorithms require the presence of a suitable certificate to supply the
29493 public-key.  The server selects among the certificates to present to the
29494 client depending on the selected cipher, hence the priority ordering for
29495 ciphers will affect which certificate is used.
29496
29497 If you do not understand about certificates and keys, please try to find a
29498 source of this background information, which is not Exim-specific. (There are a
29499 few comments below in section &<<SECTcerandall>>&.)
29500
29501 &*Note*&: These options do not apply when Exim is operating as a client &--
29502 they apply only in the case of a server. If you need to use a certificate in an
29503 Exim client, you must set the options of the same names in an &(smtp)&
29504 transport.
29505
29506 With just these options, an Exim server will be able to use TLS. It does not
29507 require the client to have a certificate (but see below for how to insist on
29508 this). There is one other option that may be needed in other situations. If
29509 .code
29510 tls_dhparam = /some/file/name
29511 .endd
29512 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29513 with the parameters contained in the file.
29514 Set this to &`none`& to disable use of DH entirely, by making no prime
29515 available:
29516 .code
29517 tls_dhparam = none
29518 .endd
29519 This may also be set to a string identifying a standard prime to be used for
29520 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29521 used is &`ike23`&.  There are a few standard primes available, see the
29522 documentation for &%tls_dhparam%& for the complete list.
29523
29524 See the command
29525 .code
29526 openssl dhparam
29527 .endd
29528 for a way of generating file data.
29529
29530 The strings supplied for these three options are expanded every time a client
29531 host connects. It is therefore possible to use different certificates and keys
29532 for different hosts, if you so wish, by making use of the client's IP address
29533 in &$sender_host_address$& to control the expansion. If a string expansion is
29534 forced to fail, Exim behaves as if the option is not set.
29535
29536 .cindex "cipher" "logging"
29537 .cindex "log" "TLS cipher"
29538 .vindex "&$tls_in_cipher$&"
29539 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29540 an incoming TLS connection. It is included in the &'Received:'& header of an
29541 incoming message (by default &-- you can, of course, change this), and it is
29542 also included in the log line that records a message's arrival, keyed by
29543 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29544 condition can be used to test for specific cipher suites in ACLs.
29545
29546 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29547 can check the name of the cipher suite and vary their actions accordingly. The
29548 cipher suite names vary, depending on which TLS library is being used. For
29549 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29550 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29551 documentation for more details.
29552
29553 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29554 (again depending on the &%tls_cipher%& log selector).
29555
29556
29557 .subsection "Requesting and verifying client certificates"
29558 .cindex "certificate" "verification of client"
29559 .cindex "TLS" "client certificate verification"
29560 If you want an Exim server to request a certificate when negotiating a TLS
29561 session with a client, you must set either &%tls_verify_hosts%& or
29562 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29563 apply to all TLS connections. For any host that matches one of these options,
29564 Exim requests a certificate as part of the setup of the TLS session. The
29565 contents of the certificate are verified by comparing it with a list of
29566 expected trust-anchors or certificates.
29567 These may be the system default set (depending on library version),
29568 an explicit file or,
29569 depending on library version, a directory, identified by
29570 &%tls_verify_certificates%&.
29571
29572 A file can contain multiple certificates, concatenated end to end. If a
29573 directory is used
29574 (OpenSSL only),
29575 each certificate must be in a separate file, with a name (or a symbolic link)
29576 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29577 certificate. You can compute the relevant hash by running the command
29578 .code
29579 openssl x509 -hash -noout -in /cert/file
29580 .endd
29581 where &_/cert/file_& contains a single certificate.
29582
29583 There is no checking of names of the client against the certificate
29584 Subject Name or Subject Alternate Names.
29585
29586 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29587 what happens if the client does not supply a certificate, or if the certificate
29588 does not match any of the certificates in the collection named by
29589 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29590 attempt to set up a TLS session is aborted, and the incoming connection is
29591 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29592 session continues. ACLs that run for subsequent SMTP commands can detect the
29593 fact that no certificate was verified, and vary their actions accordingly. For
29594 example, you can insist on a certificate before accepting a message for
29595 relaying, but not when the message is destined for local delivery.
29596
29597 .vindex "&$tls_in_peerdn$&"
29598 When a client supplies a certificate (whether it verifies or not), the value of
29599 the Distinguished Name of the certificate is made available in the variable
29600 &$tls_in_peerdn$& during subsequent processing of the message.
29601
29602 .cindex "log" "distinguished name"
29603 Because it is often a long text string, it is not included in the log line or
29604 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29605 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29606 &%received_header_text%& to change the &'Received:'& header. When no
29607 certificate is supplied, &$tls_in_peerdn$& is empty.
29608
29609
29610 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29611 .cindex certificate caching
29612 .cindex privatekey caching
29613 .cindex crl caching
29614 .cindex ocsp caching
29615 .cindex ciphers caching
29616 .cindex "CA bundle" caching
29617 .cindex "certificate authorities" caching
29618 .cindex tls_certificate caching
29619 .cindex tls_privatekey caching
29620 .cindex tls_crl caching
29621 .cindex tls_ocsp_file caching
29622 .cindex tls_require_ciphers caching
29623 .cindex tls_verify_certificate caching
29624 .cindex caching certificate
29625 .cindex caching privatekey
29626 .cindex caching crl
29627 .cindex caching ocsp
29628 .cindex caching ciphers
29629 .cindex caching "certificate authorities
29630 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29631 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29632 expandable elements,
29633 then the associated information is loaded at daemon startup.
29634 It is made available
29635 to child processes forked for handling received SMTP connections.
29636
29637 This caching is currently only supported under Linux and FreeBSD.
29638
29639 If caching is not possible, for example if an item has to be dependent
29640 on the peer host so contains a &$sender_host_name$& expansion, the load
29641 of the associated information is done at the startup of the TLS connection.
29642
29643 The cache is invalidated and reloaded after any changes to the directories
29644 containing files specified by these options.
29645
29646 The information specified by the main option &%tls_verify_certificates%&
29647 is similarly cached so long as it specifies files explicitly
29648 or (under GnuTLS) is the string &"system,cache"&.
29649 The latter case is not automatically invalidated;
29650 it is the operator's responsibility to arrange for a daemon restart
29651 any time the system certificate authority bundle is updated.
29652 A HUP signal is sufficient for this.
29653 The value &"system"& results in no caching under GnuTLS.
29654
29655 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29656 is acceptable in configurations for the Exim executavble.
29657
29658 Caching of the system Certificate Authorities bundle can
29659 save siginificant time and processing on every TLS connection
29660 accepted by Exim.
29661
29662
29663
29664
29665 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29666 .cindex "cipher" "logging"
29667 .cindex "log" "TLS cipher"
29668 .cindex "log" "distinguished name"
29669 .cindex "TLS" "configuring an Exim client"
29670 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29671 deliveries as well as to incoming, the latter one causing logging of the
29672 server certificate's DN. The remaining client configuration for TLS is all
29673 within the &(smtp)& transport.
29674
29675 .cindex "ESMTP extensions" STARTTLS
29676 It is not necessary to set any options to have TLS work in the &(smtp)&
29677 transport. If Exim is built with TLS support, and TLS is advertised by a
29678 server, the &(smtp)& transport always tries to start a TLS session. However,
29679 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29680 transport) to a list of server hosts for which TLS should not be used.
29681
29682 If you do not want Exim to attempt to send messages unencrypted when an attempt
29683 to set up an encrypted connection fails in any way, you can set
29684 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29685 those hosts, delivery is always deferred if an encrypted connection cannot be
29686 set up. If there are any other hosts for the address, they are tried in the
29687 usual way.
29688
29689 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29690 the message unencrypted. It always does this if the response to STARTTLS is
29691 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29692 session after a success response code, what happens is controlled by the
29693 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29694 delivery to this host is deferred, and other hosts (if available) are tried. If
29695 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29696 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29697 negotiation fails, Exim closes the current connection (because it is in an
29698 unknown state), opens a new one to the same host, and then tries the delivery
29699 unencrypted.
29700
29701 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29702 transport provide the client with a certificate, which is passed to the server
29703 if it requests it.
29704 This is an optional thing for TLS connections, although either end
29705 may insist on it.
29706 If the server is Exim, it will request a certificate only if
29707 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29708
29709 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29710 for client use (they are usable for server use).
29711 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29712 in failed connections.
29713
29714 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29715 specifies a collection of expected server certificates.
29716 These may be
29717 the system default set (depending on library version),
29718 a file,
29719 or (depending on library version) a directory.
29720 The client verifies the server's certificate
29721 against this collection, taking into account any revoked certificates that are
29722 in the list defined by &%tls_crl%&.
29723 Failure to verify fails the TLS connection unless either of the
29724 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29725
29726 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29727 certificate verification to the listed servers.  Verification either must
29728 or need not succeed respectively.
29729
29730 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29731 name checks are made on the server certificate.
29732 The match against this list is, as per other Exim usage, the
29733 IP for the host.  That is most closely associated with the
29734 name on the DNS A (or AAAA) record for the host.
29735 However, the name that needs to be in the certificate
29736 is the one at the head of any CNAME chain leading to the A record.
29737 The option defaults to always checking.
29738
29739 The &(smtp)& transport has two OCSP-related options:
29740 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29741 is requested and required for the connection to proceed.  The default
29742 value is empty.
29743 &%hosts_request_ocsp%&; a host-list for which (additionally)
29744 a Certificate Status is requested (but not necessarily verified).  The default
29745 value is "*" meaning that requests are made unless configured
29746 otherwise.
29747
29748 The host(s) should also be in &%hosts_require_tls%&, and
29749 &%tls_verify_certificates%& configured for the transport,
29750 for OCSP to be relevant.
29751
29752 If
29753 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29754 list of permitted cipher suites. If either of these checks fails, delivery to
29755 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29756 alternative hosts, if any.
29757
29758  &*Note*&:
29759 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29760 is operating as a client. Exim does not assume that a server certificate (set
29761 by the global options of the same name) should also be used when operating as a
29762 client.
29763
29764 .vindex "&$host$&"
29765 .vindex "&$host_address$&"
29766 All the TLS options in the &(smtp)& transport are expanded before use, with
29767 &$host$& and &$host_address$& containing the name and address of the server to
29768 which the client is connected. Forced failure of an expansion causes Exim to
29769 behave as if the relevant option were unset.
29770
29771 .vindex &$tls_out_bits$&
29772 .vindex &$tls_out_cipher$&
29773 .vindex &$tls_out_peerdn$&
29774 .vindex &$tls_out_sni$&
29775 Before an SMTP connection is established, the
29776 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29777 variables are emptied. (Until the first connection, they contain the values
29778 that were set when the message was received.) If STARTTLS is subsequently
29779 successfully obeyed, these variables are set to the relevant values for the
29780 outgoing connection.
29781
29782
29783
29784 .subsection "Caching of static client configuration items" SECTclientTLScache
29785 .cindex certificate caching
29786 .cindex privatekey caching
29787 .cindex crl caching
29788 .cindex ciphers caching
29789 .cindex "CA bundle" caching
29790 .cindex "certificate authorities" caching
29791 .cindex tls_certificate caching
29792 .cindex tls_privatekey caching
29793 .cindex tls_crl caching
29794 .cindex tls_require_ciphers caching
29795 .cindex tls_verify_certificate caching
29796 .cindex caching certificate
29797 .cindex caching privatekey
29798 .cindex caching crl
29799 .cindex caching ciphers
29800 .cindex caching "certificate authorities
29801 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29802 and &%tls_crl%& have values with no
29803 expandable elements,
29804 then the associated information is loaded per smtp transport
29805 at daemon startup, at the start of a queue run, or on a
29806 command-line specified message delivery.
29807 It is made available
29808 to child processes forked for handling making SMTP connections.
29809
29810 This caching is currently only supported under Linux.
29811
29812 If caching is not possible, the load
29813 of the associated information is done at the startup of the TLS connection.
29814
29815 The cache is invalidated in the daemon
29816 and reloaded after any changes to the directories
29817 containing files specified by these options.
29818
29819 The information specified by the main option &%tls_verify_certificates%&
29820 is similarly cached so long as it specifies files explicitly
29821 or (under GnuTLS) is the string &"system,cache"&.
29822 The latter case is not automatically invaludated;
29823 it is the operator's responsibility to arrange for a daemon restart
29824 any time the system certificate authority bundle is updated.
29825 A HUP signal is sufficient for this.
29826 The value &"system"& results in no caching under GnuTLS.
29827
29828 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29829 is acceptable in configurations for the Exim executavble.
29830
29831 Caching of the system Certificate Authorities bundle can
29832 save siginificant time and processing on every TLS connection
29833 initiated by Exim.
29834
29835
29836
29837
29838 .section "Use of TLS Server Name Indication" "SECTtlssni"
29839 .cindex "TLS" "Server Name Indication"
29840 .cindex "TLS" SNI
29841 .cindex SNI
29842 .vindex "&$tls_in_sni$&"
29843 .oindex "&%tls_in_sni%&"
29844 With TLS1.0 or above, there is an extension mechanism by which extra
29845 information can be included at various points in the protocol.  One of these
29846 extensions, documented in RFC 6066 (and before that RFC 4366) is
29847 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29848 client in the initial handshake, so that the server can examine the servername
29849 within and possibly choose to use different certificates and keys (and more)
29850 for this session.
29851
29852 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29853 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29854 address.
29855
29856 With SMTP to MX, there are the same problems here as in choosing the identity
29857 against which to validate a certificate: you can't rely on insecure DNS to
29858 provide the identity which you then cryptographically verify.  So this will
29859 be of limited use in that environment.
29860
29861 With SMTP to Submission, there is a well-defined hostname which clients are
29862 connecting to and can validate certificates against.  Thus clients &*can*&
29863 choose to include this information in the TLS negotiation.  If this becomes
29864 wide-spread, then hosters can choose to present different certificates to
29865 different clients.  Or even negotiate different cipher suites.
29866
29867 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29868 if not empty, will be sent on a TLS session as part of the handshake.  There's
29869 nothing more to it.  Choosing a sensible value not derived insecurely is the
29870 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29871 for the lifetime of the client connection (including during authentication).
29872
29873 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29874 is forced to the name of the destination host, after any MX- or CNAME-following.
29875
29876 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29877 received from a client.
29878 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29879
29880 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29881 option (prior to expansion) then the following options will be re-expanded
29882 during TLS session handshake, to permit alternative values to be chosen:
29883
29884 .ilist
29885 &%tls_certificate%&
29886 .next
29887 &%tls_crl%&
29888 .next
29889 &%tls_privatekey%&
29890 .next
29891 &%tls_verify_certificates%&
29892 .next
29893 &%tls_ocsp_file%&
29894 .endlist
29895
29896 Great care should be taken to deal with matters of case, various injection
29897 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29898 can always be referenced; it is important to remember that &$tls_in_sni$& is
29899 arbitrary unverified data provided prior to authentication.
29900 Further, the initial certificate is loaded before SNI has arrived, so
29901 an expansion for &%tls_certificate%& must have a default which is used
29902 when &$tls_in_sni$& is empty.
29903
29904 The Exim developers are proceeding cautiously and so far no other TLS options
29905 are re-expanded.
29906
29907 When Exim is built against OpenSSL, OpenSSL must have been built with support
29908 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29909 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29910 see &`-servername`& in the output, then OpenSSL has support.
29911
29912 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29913 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29914 built, then you have SNI support).
29915
29916 .subsection ALPN
29917 .cindex TLS ALPN
29918 .cindex ALPN "general information"
29919 .cindex TLS "Application Layer Protocol Names"
29920 There is a TLS feature related to SNI
29921 called Application Layer Protocol Name (ALPN).
29922 This is intended to declare, or select, what protocol layer will be using a TLS
29923 connection.
29924 The client for the connection proposes a set of protocol names, and
29925 the server responds with a selected one.
29926 It is not, as of 2021, commonly used for SMTP connections.
29927 However, to guard against misdirected or malicious use of web clients
29928 (which often do use ALPN) against MTA ports, Exim by default check that
29929 there is no incompatible ALPN specified by a client for a TLS connection.
29930 If there is, the connection is rejected.
29931
29932 As a client Exim does not supply ALPN by default.
29933 The behaviour of both client and server can be configured using the options
29934 &%tls_alpn%& and &%hosts_require_alpn%&.
29935 There are no variables providing observability.
29936 Some feature-specific logging may appear on denied connections, but this
29937 depends on the behaviour of the peer
29938 (not all peers can send a feature-specific TLS Alert).
29939
29940 This feature is available when Exim is built with
29941 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29942 the macro _HAVE_TLS_ALPN will be defined when this is so.
29943
29944
29945
29946 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29947          "SECTmulmessam"
29948 .cindex "multiple SMTP deliveries with TLS"
29949 .cindex "TLS" "multiple message deliveries"
29950 Exim sends multiple messages down the same TCP/IP connection by starting up
29951 an entirely new delivery process for each message, passing the socket from
29952 one process to the next. This implementation does not fit well with the use
29953 of TLS, because there is quite a lot of state information associated with a TLS
29954 connection, not just a socket identification. Passing all the state information
29955 to a new process is not feasible. Consequently, for sending using TLS Exim
29956 starts an additional proxy process for handling the encryption, piping the
29957 unencrypted data stream from and to the delivery processes.
29958
29959 An older mode of operation can be enabled on a per-host basis by the
29960 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29961 this list the proxy process described above is not used; instead Exim
29962 shuts down an existing TLS session being run by the delivery process
29963 before passing the socket to a new process. The new process may then
29964 try to start a new TLS session, and if successful, may try to re-authenticate
29965 if AUTH is in use, before sending the next message.
29966
29967 The RFC is not clear as to whether or not an SMTP session continues in clear
29968 after TLS has been shut down, or whether TLS may be restarted again later, as
29969 just described. However, if the server is Exim, this shutdown and
29970 reinitialization works. It is not known which (if any) other servers operate
29971 successfully if the client closes a TLS session and continues with unencrypted
29972 SMTP, but there are certainly some that do not work. For such servers, Exim
29973 should not pass the socket to another process, because the failure of the
29974 subsequent attempt to use it would cause Exim to record a temporary host error,
29975 and delay other deliveries to that host.
29976
29977 To test for this case, Exim sends an EHLO command to the server after
29978 closing down the TLS session. If this fails in any way, the connection is
29979 closed instead of being passed to a new delivery process, but no retry
29980 information is recorded.
29981
29982 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29983 &(smtp)& transport to match those hosts for which Exim should not pass
29984 connections to new processes if TLS has been used.
29985
29986
29987
29988
29989 .section "Certificates and all that" "SECTcerandall"
29990 .cindex "certificate" "references to discussion"
29991 In order to understand fully how TLS works, you need to know about
29992 certificates, certificate signing, and certificate authorities.
29993 This is a large topic and an introductory guide is unsuitable for the Exim
29994 reference manual, so instead we provide pointers to existing documentation.
29995
29996 The Apache web-server was for a long time the canonical guide, so their
29997 documentation is a good place to start; their SSL module's Introduction
29998 document is currently at
29999 .display
30000 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30001 .endd
30002 and their FAQ is at
30003 .display
30004 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30005 .endd
30006
30007 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30008 0-201-61598-3) in 2001, contains both introductory and more in-depth
30009 descriptions.
30010 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30011 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30012 Ivan is the author of the popular TLS testing tools at
30013 &url(https://www.ssllabs.com/).
30014
30015
30016 .subsection "Certificate chains" SECID186
30017 A file named by &%tls_certificate%& may contain more than one
30018 certificate. This is useful in the case where the certificate that is being
30019 sent is validated by an intermediate certificate which the other end does
30020 not have. Multiple certificates must be in the correct order in the file.
30021 First the host's certificate itself, then the first intermediate
30022 certificate to validate the issuer of the host certificate, then the next
30023 intermediate certificate to validate the issuer of the first intermediate
30024 certificate, and so on, until finally (optionally) the root certificate.
30025 The root certificate must already be trusted by the recipient for
30026 validation to succeed, of course, but if it's not preinstalled, sending the
30027 root certificate along with the rest makes it available for the user to
30028 install if the receiving end is a client MUA that can interact with a user.
30029
30030 Note that certificates using MD5 are unlikely to work on today's Internet;
30031 even if your libraries allow loading them for use in Exim when acting as a
30032 server, increasingly clients will not accept such certificates.  The error
30033 diagnostics in such a case can be frustratingly vague.
30034
30035
30036
30037 .subsection "Self-signed certificates" SECID187
30038 .cindex "certificate" "self-signed"
30039 You can create a self-signed certificate using the &'req'& command provided
30040 with OpenSSL, like this:
30041 . ==== Do not shorten the duration here without reading and considering
30042 . ==== the text below.  Please leave it at 9999 days.
30043 .code
30044 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30045             -days 9999 -nodes
30046 .endd
30047 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30048 delimited and so can be identified independently. The &%-days%& option
30049 specifies a period for which the certificate is valid. The &%-nodes%& option is
30050 important: if you do not set it, the key is encrypted with a passphrase
30051 that you are prompted for, and any use that is made of the key causes more
30052 prompting for the passphrase. This is not helpful if you are going to use
30053 this certificate and key in an MTA, where prompting is not possible.
30054
30055 . ==== I expect to still be working 26 years from now.  The less technical
30056 . ==== debt I create, in terms of storing up trouble for my later years, the
30057 . ==== happier I will be then.  We really have reached the point where we
30058 . ==== should start, at the very least, provoking thought and making folks
30059 . ==== pause before proceeding, instead of leaving all the fixes until two
30060 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30061 . ==== -pdp, 2012
30062 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30063 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30064 the above command might produce a date in the past.  Think carefully about
30065 the lifetime of the systems you're deploying, and either reduce the duration
30066 of the certificate or reconsider your platform deployment.  (At time of
30067 writing, reducing the duration is the most likely choice, but the inexorable
30068 progression of time takes us steadily towards an era where this will not
30069 be a sensible resolution).
30070
30071 A self-signed certificate made in this way is sufficient for testing, and
30072 may be adequate for all your requirements if you are mainly interested in
30073 encrypting transfers, and not in secure identification.
30074
30075 However, many clients require that the certificate presented by the server be a
30076 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30077 certificate. In this situation, the self-signed certificate described above
30078 must be installed on the client host as a trusted root &'certification
30079 authority'& (CA), and the certificate used by Exim must be a user certificate
30080 signed with that self-signed certificate.
30081
30082 For information on creating self-signed CA certificates and using them to sign
30083 user certificates, see the &'General implementation overview'& chapter of the
30084 Open-source PKI book, available online at
30085 &url(https://sourceforge.net/projects/ospkibook/).
30086
30087
30088 .subsection "Revoked certificates"
30089 .cindex "TLS" "revoked certificates"
30090 .cindex "revocation list"
30091 .cindex "certificate" "revocation list"
30092 .cindex "OCSP" "stapling"
30093 There are three ways for a certificate to be made unusable
30094 before its expiry.
30095
30096 .ilist
30097 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30098 certificates are revoked. If you have such a list, you can pass it to an Exim
30099 server using the global option called &%tls_crl%& and to an Exim client using
30100 an identically named option for the &(smtp)& transport. In each case, the value
30101 of the option is expanded and must then be the name of a file that contains a
30102 CRL in PEM format.
30103 The downside is that clients have to periodically re-download a potentially huge
30104 file from every certificate authority they know of.
30105
30106 .next
30107 The way with most moving parts at query time is Online Certificate
30108 Status Protocol (OCSP), where the client verifies the certificate
30109 against an OCSP server run by the CA.  This lets the CA track all
30110 usage of the certs.  It requires running software with access to the
30111 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30112 is based on HTTP and can be proxied accordingly.
30113
30114 The only widespread OCSP server implementation (known to this writer)
30115 comes as part of OpenSSL and aborts on an invalid request, such as
30116 connecting to the port and then disconnecting.  This requires
30117 re-entering the passphrase each time some random client does this.
30118
30119 .next
30120 The third way is OCSP Stapling; in this, the server using a certificate
30121 issued by the CA periodically requests an OCSP proof of validity from
30122 the OCSP server, then serves it up inline as part of the TLS
30123 negotiation.   This approach adds no extra round trips, does not let the
30124 CA track users, scales well with number of certs issued by the CA and is
30125 resilient to temporary OCSP server failures, as long as the server
30126 starts retrying to fetch an OCSP proof some time before its current
30127 proof expires.  The downside is that it requires server support.
30128
30129 Unless Exim is built with the support disabled,
30130 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30131 support for OCSP stapling is included.
30132
30133 There is a global option called &%tls_ocsp_file%&.
30134 The file specified therein is expected to be in DER format, and contain
30135 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30136 option will be re-expanded for SNI, if the &%tls_certificate%& option
30137 contains &`tls_in_sni`&, as per other TLS options.
30138
30139 Exim does not at this time implement any support for fetching a new OCSP
30140 proof.  The burden is on the administrator to handle this, outside of
30141 Exim.  The file specified should be replaced atomically, so that the
30142 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30143 on each connection, so a new file will be handled transparently on the
30144 next connection.
30145
30146 When built with OpenSSL Exim will check for a valid next update timestamp
30147 in the OCSP proof; if not present, or if the proof has expired, it will be
30148 ignored.
30149
30150 For the client to be able to verify the stapled OCSP the server must
30151 also supply, in its stapled information, any intermediate
30152 certificates for the chain leading to the OCSP proof from the signer
30153 of the server certificate.  There may be zero or one such. These
30154 intermediate certificates should be added to the server OCSP stapling
30155 file named by &%tls_ocsp_file%&.
30156
30157 Note that the proof only covers the terminal server certificate,
30158 not any of the chain from CA to it.
30159
30160 There is no current way to staple a proof for a client certificate.
30161
30162 .code
30163   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30164   OCSP server is supplied.  The server URL may be included in the
30165   server certificate, if the CA is helpful.
30166
30167   One failure mode seen was the OCSP Signer cert expiring before the end
30168   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30169   noted this as invalid overall, but the re-fetch script did not.
30170 .endd
30171 .endlist
30172
30173
30174 .ecindex IIDencsmtp1
30175 .ecindex IIDencsmtp2
30176
30177
30178 .section "TLS Resumption" "SECTresumption"
30179 .cindex TLS resumption
30180 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30181 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30182 (or later).
30183
30184 Session resumption (this is the "stateless" variant) involves the server sending
30185 a "session ticket" to the client on one connection, which can be stored by the
30186 client and used for a later session.  The ticket contains sufficient state for
30187 the server to reconstruct the TLS session, avoiding some expensive crypto
30188 calculation and (on TLS1.2) one full packet roundtrip time.
30189
30190 .ilist
30191 Operational cost/benefit:
30192
30193  The extra data being transmitted costs a minor amount, and the client has
30194  extra costs in storing and retrieving the data.
30195
30196  In the Exim/Gnutls implementation the extra cost on an initial connection
30197  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30198  The saved cost on a subsequent connection is about 4ms; three or more
30199  connections become a net win.  On longer network paths, two or more
30200  connections will have an average lower startup time thanks to the one
30201  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30202  packet roundtrips.
30203
30204 .cindex "hints database" tls
30205  Since a new hints DB is used on the TLS client,
30206  the hints DB maintenance should be updated to additionally handle "tls".
30207
30208 .next
30209 Security aspects:
30210
30211  The session ticket is encrypted, but is obviously an additional security
30212  vulnarability surface.  An attacker able to decrypt it would have access
30213  all connections using the resumed session.
30214  The session ticket encryption key is not committed to storage by the server
30215  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30216  overlap; GnuTLS 6hr but does not specify any overlap).
30217  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30218  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30219
30220  There is a question-mark over the security of the Diffie-Helman parameters
30221  used for session negotiation.
30222
30223 .next
30224 Observability:
30225
30226  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30227  element.
30228
30229  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30230  have bits 0-4 indicating respectively
30231  support built, client requested ticket, client offered session,
30232  server issued ticket, resume used.  A suitable decode list is provided
30233  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30234
30235 .next
30236 Control:
30237
30238 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30239 exim, operating as a server, will offer resumption to clients.
30240 Current best practice is to not offer the feature to MUA connection.
30241 Commonly this can be done like this:
30242 .code
30243 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30244 .endd
30245 If the peer host matches the list after expansion then resumption
30246 is offered and/or accepted.
30247
30248 The &%tls_resumption_hosts%& smtp transport option performs the
30249 equivalent function for operation as a client.
30250 If the peer host matches the list after expansion then resumption
30251 is attempted (if a stored session is available) or the information
30252 stored (if supplied by the peer).
30253
30254
30255 .next
30256 Issues:
30257
30258  In a resumed session:
30259 .ilist
30260   The variables &$tls_{in,out}_cipher$& will have values different
30261  to the original (under GnuTLS).
30262 .next
30263   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30264  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30265 . XXX need to do something with that hosts_require_ocsp
30266 .endlist
30267
30268 .endlist
30269
30270
30271 .section DANE "SECDANE"
30272 .cindex DANE
30273 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30274 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30275 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30276 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30277 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30278 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30279
30280 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30281 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30282 by (a) is thought to be smaller than that of the set of root CAs.
30283
30284 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30285 fail to pass on a server's STARTTLS.
30286
30287 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30288 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30289 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30290
30291 DANE requires a server operator to do three things:
30292 .olist
30293 Run DNSSEC.  This provides assurance to clients
30294 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30295 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30296 DNSSEC.
30297 .next
30298 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30299 .next
30300 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30301 .endlist
30302
30303 There are no changes to Exim specific to server-side operation of DANE.
30304 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30305 in &_Local/Makefile_&.
30306 If it has been included, the macro "_HAVE_DANE" will be defined.
30307
30308 .subsection "DNS records"
30309 A TLSA record consist of 4 fields, the "Certificate Usage", the
30310 "Selector", the "Matching type", and the "Certificate Association Data".
30311 For a detailed description of the TLSA record see
30312 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30313
30314 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30315 These are the "Trust Anchor" and "End Entity" variants.
30316 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30317 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30318 this is appropriate for a single system, using a self-signed certificate.
30319 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30320 well-known one.
30321 A private CA at simplest is just a self-signed certificate (with certain
30322 attributes) which is used to sign server certificates, but running one securely
30323 does require careful arrangement.
30324 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30325 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30326 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30327 all of which point to a single TLSA record.
30328 DANE-TA and DANE-EE can both be used together.
30329
30330 Our recommendation is to use DANE with a certificate from a public CA,
30331 because this enables a variety of strategies for remote clients to verify
30332 your certificate.
30333 You can then publish information both via DANE and another technology,
30334 "MTA-STS", described below.
30335
30336 When you use DANE-TA to publish trust anchor information, you ask entities
30337 outside your administrative control to trust the Certificate Authority for
30338 connections to you.
30339 If using a private CA then you should expect others to still apply the
30340 technical criteria they'd use for a public CA to your certificates.
30341 In particular, you should probably try to follow current best practices for CA
30342 operation around hash algorithms and key sizes.
30343 Do not expect other organizations to lower their security expectations just
30344 because a particular profile might be reasonable for your own internal use.
30345
30346 When this text was last updated, this in practice means to avoid use of SHA-1
30347 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30348 than 4096, for interoperability); to use keyUsage fields correctly; to use
30349 random serial numbers.
30350 The list of requirements is subject to change as best practices evolve.
30351 If you're not already using a private CA, or it doesn't meet these
30352 requirements, then we encourage you to avoid all these issues and use a public
30353 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30354
30355 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30356 a "Matching Type" (3rd) field of SHA2-512(2).
30357
30358 For the "Certificate Authority Data" (4th) field, commands like
30359
30360 .code
30361   openssl x509 -pubkey -noout <certificate.pem \
30362   | openssl rsa -outform der -pubin 2>/dev/null \
30363   | openssl sha512 \
30364   | awk '{print $2}'
30365 .endd
30366
30367 are workable to create a hash of the certificate's public key.
30368
30369 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30370
30371 .code
30372   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30373 .endd
30374
30375 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30376 is useful for quickly generating TLSA records.
30377
30378
30379 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30380
30381 The Certificate issued by the CA published in the DANE-TA model should be
30382 issued using a strong hash algorithm.
30383 Exim, and importantly various other MTAs sending to you, will not
30384 re-enable hash algorithms which have been disabled by default in TLS
30385 libraries.
30386 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30387 interoperability (and probably the maximum too, in 2018).
30388
30389 .subsection "Interaction with OCSP"
30390 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30391 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30392 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30393
30394 .code
30395   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30396                                  {= {4}{$tls_out_tlsa_usage}} } \
30397                          {*}{}}
30398 .endd
30399
30400 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30401 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30402 found. If the definition of &%hosts_request_ocsp%& includes the
30403 string "tls_out_tlsa_usage", they are re-expanded in time to
30404 control the OCSP request.
30405
30406 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30407 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30408
30409
30410 .subsection "Client configuration"
30411 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30412 and &%dane_require_tls_ciphers%&.
30413 The &"require"& variant will result in failure if the target host is not
30414 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30415 the &%dnssec_request_domains%& router or transport option.
30416
30417 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30418
30419 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30420 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30421 will be required for the host.  If it does not, the host will not
30422 be used; there is no fallback to non-DANE or non-TLS.
30423
30424 If DANE is requested and usable, then the TLS cipher list configuration
30425 prefers to use the option &%dane_require_tls_ciphers%& and falls
30426 back to &%tls_require_ciphers%& only if that is unset.
30427 This lets you configure "decent crypto" for DANE and "better than nothing
30428 crypto" as the default.  Note though that while GnuTLS lets the string control
30429 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30430 limited to ciphersuite constraints.
30431
30432 If DANE is requested and useable (see above) the following transport options are ignored:
30433 .code
30434   hosts_require_tls
30435   tls_verify_hosts
30436   tls_try_verify_hosts
30437   tls_verify_certificates
30438   tls_crl
30439   tls_verify_cert_hostnames
30440   tls_sni
30441 .endd
30442
30443 If DANE is not usable, whether requested or not, and CA-anchored
30444 verification evaluation is wanted, the above variables should be set appropriately.
30445
30446 The router and transport option &%dnssec_request_domains%& must not be
30447 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30448
30449 .subsection Observability
30450 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30451
30452 There is a new variable &$tls_out_dane$& which will have "yes" if
30453 verification succeeded using DANE and "no" otherwise (only useful
30454 in combination with events; see &<<CHAPevents>>&),
30455 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30456
30457 .cindex DANE reporting
30458 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30459 to achieve DANE-verified connection, if one was either requested and offered, or
30460 required.  This is intended to support TLS-reporting as defined in
30461 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30462 The &$event_data$& will be one of the Result Types defined in
30463 Section 4.3 of that document.
30464
30465 .subsection General
30466 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30467
30468 DANE is specified in published RFCs and decouples certificate authority trust
30469 selection from a "race to the bottom" of "you must trust everything for mail
30470 to get through".
30471 There is an alternative technology called MTA-STS, which
30472 instead publishes MX trust anchor information on an HTTPS website.  At the
30473 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30474 Exim has no support for MTA-STS as a client, but Exim mail server operators
30475 can choose to publish information describing their TLS configuration using
30476 MTA-STS to let those clients who do use that protocol derive trust
30477 information.
30478
30479 The MTA-STS design requires a certificate from a public Certificate Authority
30480 which is recognized by clients sending to you.
30481 That selection of which CAs are trusted by others is outside your control.
30482
30483 The most interoperable course of action is probably to use
30484 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30485 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30486 records for DANE clients (such as Exim and Postfix) and to publish anchor
30487 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30488 domain itself (with caveats around occasionally broken MTA-STS because of
30489 incompatible specification changes prior to reaching RFC status).
30490
30491
30492
30493 . ////////////////////////////////////////////////////////////////////////////
30494 . ////////////////////////////////////////////////////////////////////////////
30495
30496 .chapter "Access control lists" "CHAPACL"
30497 .scindex IIDacl "&ACL;" "description"
30498 .cindex "control of incoming mail"
30499 .cindex "message" "controlling incoming"
30500 .cindex "policy control" "access control lists"
30501 Access Control Lists (ACLs) are defined in a separate section of the runtime
30502 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30503 name, terminated by a colon. Here is a complete ACL section that contains just
30504 one very small ACL:
30505 .code
30506 begin acl
30507 small_acl:
30508   accept   hosts = one.host.only
30509 .endd
30510 You can have as many lists as you like in the ACL section, and the order in
30511 which they appear does not matter. The lists are self-terminating.
30512
30513 The majority of ACLs are used to control Exim's behaviour when it receives
30514 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30515 when a local process submits a message using SMTP by specifying the &%-bs%&
30516 option. The most common use is for controlling which recipients are accepted
30517 in incoming messages. In addition, you can define an ACL that is used to check
30518 local non-SMTP messages. The default configuration file contains an example of
30519 a realistic ACL for checking RCPT commands. This is discussed in chapter
30520 &<<CHAPdefconfil>>&.
30521
30522
30523 .section "Testing ACLs" "SECID188"
30524 The &%-bh%& command line option provides a way of testing your ACL
30525 configuration locally by running a fake SMTP session with which you interact.
30526
30527
30528 .section "Specifying when ACLs are used" "SECID189"
30529 .cindex "&ACL;" "options for specifying"
30530 In order to cause an ACL to be used, you have to name it in one of the relevant
30531 options in the main part of the configuration. These options are:
30532 .cindex "AUTH" "ACL for"
30533 .cindex "DATA" "ACLs for"
30534 .cindex "ETRN" "ACL for"
30535 .cindex "EXPN" "ACL for"
30536 .cindex "HELO" "ACL for"
30537 .cindex "EHLO" "ACL for"
30538 .cindex "DKIM" "ACL for"
30539 .cindex "MAIL" "ACL for"
30540 .cindex "QUIT, ACL for"
30541 .cindex "RCPT" "ACL for"
30542 .cindex "STARTTLS, ACL for"
30543 .cindex "VRFY" "ACL for"
30544 .cindex "SMTP" "connection, ACL for"
30545 .cindex "non-SMTP messages" "ACLs for"
30546 .cindex "MIME content scanning" "ACL for"
30547 .cindex "PRDR" "ACL for"
30548
30549 .table2 140pt
30550 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30551 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30552 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30553 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30554 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30555 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30556 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30557 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30558 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30559 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30560 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30561 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30562 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30563 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30564 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30565 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30566 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30567 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30568 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30569 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30570 .endtable
30571
30572 For example, if you set
30573 .code
30574 acl_smtp_rcpt = small_acl
30575 .endd
30576 the little ACL defined above is used whenever Exim receives a RCPT command
30577 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30578 done when RCPT commands arrive. A rejection of RCPT should cause the
30579 sending MTA to give up on the recipient address contained in the RCPT
30580 command, whereas rejection at other times may cause the client MTA to keep on
30581 trying to deliver the message. It is therefore recommended that you do as much
30582 testing as possible at RCPT time.
30583
30584
30585 .subsection "The non-SMTP ACLs" SECID190
30586 .cindex "non-SMTP messages" "ACLs for"
30587 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30588 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30589 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30590 the state of the SMTP connection such as encryption and authentication) are not
30591 relevant and are forbidden in these ACLs. However, the sender and recipients
30592 are known, so the &%senders%& and &%sender_domains%& conditions and the
30593 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30594 &$authenticated_sender$& are also available. You can specify added header lines
30595 in any of these ACLs.
30596
30597 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30598 non-SMTP message, before any of the message has been read. (This is the
30599 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30600 batched SMTP input, it runs after the DATA command has been reached. The
30601 result of this ACL is ignored; it cannot be used to reject a message. If you
30602 really need to, you could set a value in an ACL variable here and reject based
30603 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30604 controls, and in particular, it can be used to set
30605 .code
30606 control = suppress_local_fixups
30607 .endd
30608 This cannot be used in the other non-SMTP ACLs because by the time they are
30609 run, it is too late.
30610
30611 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30612 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30613
30614 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30615 kind of rejection is treated as permanent, because there is no way of sending a
30616 temporary error for these kinds of message.
30617
30618
30619 .subsection "The SMTP connect ACL" SECID191
30620 .cindex "SMTP" "connection, ACL for"
30621 .oindex &%smtp_banner%&
30622 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30623 session, after the test specified by &%host_reject_connection%& (which is now
30624 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30625 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30626 the message override the banner message that is otherwise specified by the
30627 &%smtp_banner%& option.
30628
30629 .new
30630 For tls-on-connect connections, the ACL is run before the TLS connection
30631 is accepted; if the ACL does not accept then the TCP connection is dropped without
30632 any TLS startup attempt and without any SMTP response being transmitted.
30633 .wen
30634
30635
30636 .subsection "The EHLO/HELO ACL" SECID192
30637 .cindex "EHLO" "ACL for"
30638 .cindex "HELO" "ACL for"
30639 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30640 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30641 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30642 Note that a client may issue more than one EHLO or HELO command in an SMTP
30643 session, and indeed is required to issue a new EHLO or HELO after successfully
30644 setting up encryption following a STARTTLS command.
30645
30646 Note also that a deny neither forces the client to go away nor means that
30647 mail will be refused on the connection.  Consider checking for
30648 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30649
30650 If the command is accepted by an &%accept%& verb that has a &%message%&
30651 modifier, the message may not contain more than one line (it will be truncated
30652 at the first newline and a panic logged if it does). Such a message cannot
30653 affect the EHLO options that are listed on the second and subsequent lines of
30654 an EHLO response.
30655
30656
30657 .subsection "The DATA ACLs" SECID193
30658 .cindex "DATA" "ACLs for"
30659 Two ACLs are associated with the DATA command, because it is two-stage
30660 command, with two responses being sent to the client.
30661 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30662 is obeyed. This gives you control after all the RCPT commands, but before
30663 the message itself is received. It offers the opportunity to give a negative
30664 response to the DATA command before the data is transmitted. Header lines
30665 added by MAIL or RCPT ACLs are not visible at this time, but any that
30666 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30667
30668 You cannot test the contents of the message, for example, to verify addresses
30669 in the headers, at RCPT time or when the DATA command is received. Such
30670 tests have to appear in the ACL that is run after the message itself has been
30671 received, before the final response to the DATA command is sent. This is
30672 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30673 associated with the DATA command.
30674
30675 .cindex CHUNKING "BDAT command"
30676 .cindex BDAT "SMTP command"
30677 .cindex "RFC 3030" CHUNKING
30678 If CHUNKING was advertised and a BDAT command sequence is received,
30679 the &%acl_smtp_predata%& ACL is not run.
30680 . XXX why not?  It should be possible, for the first BDAT.
30681 The &%acl_smtp_data%& is run after the last BDAT command and all of
30682 the data specified is received.
30683
30684 For both of these ACLs, it is not possible to reject individual recipients. An
30685 error response rejects the entire message. Unfortunately, it is known that some
30686 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30687 before or after the data) correctly &-- they keep the message on their queues
30688 and try again later, but that is their problem, though it does waste some of
30689 your resources.
30690
30691 The &%acl_smtp_data%& ACL is run after
30692 the &%acl_smtp_data_prdr%&,
30693 the &%acl_smtp_dkim%&
30694 and the &%acl_smtp_mime%& ACLs.
30695
30696 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30697 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30698 enabled (which is the default).
30699
30700 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30701 received, and is executed for each DKIM signature found in a message.  If not
30702 otherwise specified, the default action is to accept.
30703
30704 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30705
30706 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30707
30708
30709 .subsection "The SMTP MIME ACL" SECID194
30710 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30711 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30712
30713 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30714
30715
30716 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30717 .cindex "PRDR" "ACL for"
30718 .oindex "&%prdr_enable%&"
30719 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30720 with PRDR support enabled (which is the default).
30721 It becomes active only when the PRDR feature is negotiated between
30722 client and server for a message, and more than one recipient
30723 has been accepted.
30724
30725 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30726 has been received, and is executed once for each recipient of the message
30727 with &$local_part$& and &$domain$& valid.
30728 The test may accept, defer or deny for individual recipients.
30729 The &%acl_smtp_data%& will still be called after this ACL and
30730 can reject the message overall, even if this ACL has accepted it
30731 for some or all recipients.
30732
30733 PRDR may be used to support per-user content filtering.  Without it
30734 one must defer any recipient after the first that has a different
30735 content-filter configuration.  With PRDR, the RCPT-time check
30736 .cindex "PRDR" "variable for"
30737 for this can be disabled when the variable &$prdr_requested$&
30738 is &"yes"&.
30739 Any required difference in behaviour of the main DATA-time
30740 ACL should however depend on the PRDR-time ACL having run, as Exim
30741 will avoid doing so in some situations (e.g. single-recipient mails).
30742
30743 See also the &%prdr_enable%& global option
30744 and the &%hosts_try_prdr%& smtp transport option.
30745
30746 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30747 If the ACL is not defined, processing completes as if
30748 the feature was not requested by the client.
30749
30750 .subsection "The QUIT ACL" SECTQUITACL
30751 .cindex "QUIT, ACL for"
30752 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30753 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30754 does not in fact control any access.
30755 For this reason, it may only accept
30756 or warn as its final result.
30757
30758 This ACL can be used for tasks such as custom logging at the end of an SMTP
30759 session. For example, you can use ACL variables in other ACLs to count
30760 messages, recipients, etc., and log the totals at QUIT time using one or
30761 more &%logwrite%& modifiers on a &%warn%& verb.
30762
30763 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30764 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30765
30766 You do not need to have a final &%accept%&, but if you do, you can use a
30767 &%message%& modifier to specify custom text that is sent as part of the 221
30768 response to QUIT.
30769
30770 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30771 failure (for example, failure to open a log file, or when Exim is bombing out
30772 because it has detected an unrecoverable error), all SMTP commands from the
30773 client are given temporary error responses until QUIT is received or the
30774 connection is closed. In these special cases, the QUIT ACL does not run.
30775
30776
30777 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30778 .vindex &$acl_smtp_notquit$&
30779 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30780 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30781 trouble, such as being unable to write to its log files, this ACL is not run,
30782 because it might try to do things (such as write to log files) that make the
30783 situation even worse.
30784
30785 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30786 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30787 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30788 and &%warn%&.
30789
30790 .vindex &$smtp_notquit_reason$&
30791 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30792 to a string that indicates the reason for the termination of the SMTP
30793 connection. The possible values are:
30794 .table2
30795 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30796 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30797 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30798 .irow &`connection-lost`&          "The SMTP connection has been lost"
30799 .irow &`data-timeout`&             "Timeout while reading message data"
30800 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30801 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30802 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30803 .irow &`synchronization-error`&    "SMTP synchronization error"
30804 .irow &`tls-failed`&               "TLS failed to start"
30805 .endtable
30806 In most cases when an SMTP connection is closed without having received QUIT,
30807 Exim sends an SMTP response message before actually closing the connection.
30808 With the exception of the &`acl-drop`& case, the default message can be
30809 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30810 &%drop%& verb in another ACL, it is the message from the other ACL that is
30811 used.
30812
30813
30814 .section "Finding an ACL to use" "SECID195"
30815 .cindex "&ACL;" "finding which to use"
30816 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30817 you can use different ACLs in different circumstances. For example,
30818 .code
30819 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30820                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30821 .endd
30822 In the default configuration file there are some example settings for
30823 providing an RFC 4409 message &"submission"& service on port 587 and
30824 an RFC 8314 &"submissions"& service on port 465. You can use a string
30825 expansion like this to choose an ACL for MUAs on these ports which is
30826 more appropriate for this purpose than the default ACL on port 25.
30827
30828 The expanded string does not have to be the name of an ACL in the
30829 configuration file; there are other possibilities. Having expanded the
30830 string, Exim searches for an ACL as follows:
30831
30832 .ilist
30833 If the string begins with a slash, Exim uses it as a filename, and reads its
30834 contents as an ACL. The lines are processed in the same way as lines in the
30835 Exim configuration file. In particular, continuation lines are supported, blank
30836 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30837 If the file does not exist or cannot be read, an error occurs (typically
30838 causing a temporary failure of whatever caused the ACL to be run). For example:
30839 .code
30840 acl_smtp_data = /etc/acls/\
30841   ${lookup{$sender_host_address}lsearch\
30842   {/etc/acllist}{$value}{default}}
30843 .endd
30844 This looks up an ACL file to use on the basis of the host's IP address, falling
30845 back to a default if the lookup fails. If an ACL is successfully read from a
30846 file, it is retained in memory for the duration of the Exim process, so that it
30847 can be re-used without having to re-read the file.
30848 .next
30849 If the string does not start with a slash, and does not contain any spaces,
30850 Exim searches the ACL section of the configuration for an ACL whose name
30851 matches the string.
30852 .next
30853 If no named ACL is found, or if the string contains spaces, Exim parses
30854 the string as an inline ACL. This can save typing in cases where you just
30855 want to have something like
30856 .code
30857 acl_smtp_vrfy = accept
30858 .endd
30859 in order to allow free use of the VRFY command. Such a string may contain
30860 newlines; it is processed in the same way as an ACL that is read from a file.
30861 .endlist
30862
30863
30864
30865
30866 .section "ACL return codes" "SECID196"
30867 .cindex "&ACL;" "return codes"
30868 Except for the QUIT ACL, which does not affect the SMTP return code (see
30869 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30870 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30871 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30872 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30873 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30874 This also causes a 4&'xx'& return code.
30875
30876 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30877 &"deny"&, because there is no mechanism for passing temporary errors to the
30878 submitters of non-SMTP messages.
30879
30880
30881 ACLs that are relevant to message reception may also return &"discard"&. This
30882 has the effect of &"accept"&, but causes either the entire message or an
30883 individual recipient address to be discarded. In other words, it is a
30884 blackholing facility. Use it with care.
30885
30886 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30887 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30888 RCPT ACL is to discard just the one recipient address. If there are no
30889 recipients left when the message's data is received, the DATA ACL is not
30890 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30891 remaining recipients. The &"discard"& return is not permitted for the
30892 &%acl_smtp_predata%& ACL.
30893
30894 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30895 is done on the address and the result determines the SMTP response.
30896
30897
30898 .cindex "&[local_scan()]& function" "when all recipients discarded"
30899 The &[local_scan()]& function is always run, even if there are no remaining
30900 recipients; it may create new recipients.
30901
30902
30903
30904 .section "Unset ACL options" "SECID197"
30905 .cindex "&ACL;" "unset options"
30906 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30907 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30908 not defined at all. For any defined ACL, the default action when control
30909 reaches the end of the ACL statements is &"deny"&.
30910
30911 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30912 these two are ACLs that are used only for their side effects. They cannot be
30913 used to accept or reject anything.
30914
30915 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30916 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30917 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30918 when the ACL is not defined is &"accept"&.
30919
30920 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30921 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30922 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30923 messages over an SMTP connection. For an example, see the ACL in the default
30924 configuration file.
30925
30926
30927
30928
30929 .section "Data for message ACLs" "SECID198"
30930 .cindex "&ACL;" "data for message ACL"
30931 .vindex &$domain$&
30932 .vindex &$local_part$&
30933 .vindex &$sender_address$&
30934 .vindex &$sender_host_address$&
30935 .vindex &$smtp_command$&
30936 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30937 that contain information about the host and the message's sender (for example,
30938 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30939 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30940 &$local_part$& are set from the argument address. The entire SMTP command
30941 is available in &$smtp_command$&.
30942
30943 When an ACL for the AUTH parameter of MAIL is running, the variables that
30944 contain information about the host are set, but &$sender_address$& is not yet
30945 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30946 how it is used.
30947
30948 .vindex "&$message_size$&"
30949 The &$message_size$& variable is set to the value of the SIZE parameter on
30950 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30951 that parameter is not given. The value is updated to the true message size by
30952 the time the final DATA ACL is run (after the message data has been
30953 received).
30954
30955 .vindex "&$rcpt_count$&"
30956 .vindex "&$recipients_count$&"
30957 The &$rcpt_count$& variable increases by one for each RCPT command received.
30958 The &$recipients_count$& variable increases by one each time a RCPT command is
30959 accepted, so while an ACL for RCPT is being processed, it contains the number
30960 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30961 &$rcpt_count$& contains the total number of RCPT commands, and
30962 &$recipients_count$& contains the total number of accepted recipients.
30963
30964
30965
30966
30967
30968 .section "Data for non-message ACLs" "SECTdatfornon"
30969 .cindex "&ACL;" "data for non-message ACL"
30970 .vindex &$smtp_command_argument$&
30971 .vindex &$smtp_command$&
30972 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30973 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30974 and the entire SMTP command is available in &$smtp_command$&.
30975 These variables can be tested using a &%condition%& condition. For example,
30976 here is an ACL for use with AUTH, which insists that either the session is
30977 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30978 does not permit authentication methods that use cleartext passwords on
30979 unencrypted connections.
30980 .code
30981 acl_check_auth:
30982   accept encrypted = *
30983   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30984                      {CRAM-MD5}}
30985   deny   message   = TLS encryption or CRAM-MD5 required
30986 .endd
30987 (Another way of applying this restriction is to arrange for the authenticators
30988 that use cleartext passwords not to be advertised when the connection is not
30989 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30990 option to do this.)
30991
30992
30993
30994 .section "Format of an ACL" "SECID199"
30995 .cindex "&ACL;" "format of"
30996 .cindex "&ACL;" "verbs, definition of"
30997 An individual ACL consists of a number of statements. Each statement starts
30998 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30999 Modifiers can change the way the verb operates, define error and log messages,
31000 set variables, insert delays, and vary the processing of accepted messages.
31001
31002 If all the conditions are met, the verb is obeyed. The same condition may be
31003 used (with different arguments) more than once in the same statement. This
31004 provides a means of specifying an &"and"& conjunction between conditions. For
31005 example:
31006 .code
31007 deny  dnslists = list1.example
31008       dnslists = list2.example
31009 .endd
31010 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31011 the conditions and modifiers when it reaches a condition that fails. What
31012 happens then depends on the verb (and in one case, on a special modifier). Not
31013 all the conditions make sense at every testing point. For example, you cannot
31014 test a sender address in the ACL that is run for a VRFY command.
31015
31016
31017 .section "ACL verbs" "SECID200"
31018 The ACL verbs are as follows:
31019
31020 .ilist
31021 .cindex "&%accept%& ACL verb"
31022 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31023 of the conditions are not met, what happens depends on whether &%endpass%&
31024 appears among the conditions (for syntax see below). If the failing condition
31025 is before &%endpass%&, control is passed to the next ACL statement; if it is
31026 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31027 check a RCPT command:
31028 .code
31029 accept domains = +local_domains
31030        endpass
31031        verify = recipient
31032 .endd
31033 If the recipient domain does not match the &%domains%& condition, control
31034 passes to the next statement. If it does match, the recipient is verified, and
31035 the command is accepted if verification succeeds. However, if verification
31036 fails, the ACL yields &"deny"&, because the failing condition is after
31037 &%endpass%&.
31038
31039 The &%endpass%& feature has turned out to be confusing to many people, so its
31040 use is not recommended nowadays. It is always possible to rewrite an ACL so
31041 that &%endpass%& is not needed, and it is no longer used in the default
31042 configuration.
31043
31044 .cindex "&%message%& ACL modifier" "with &%accept%&"
31045 If a &%message%& modifier appears on an &%accept%& statement, its action
31046 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31047 (when an &%accept%& verb either accepts or passes control to the next
31048 statement), &%message%& can be used to vary the message that is sent when an
31049 SMTP command is accepted. For example, in a RCPT ACL you could have:
31050 .display
31051 &`accept  `&<&'some conditions'&>
31052 &`        message = OK, I will allow you through today`&
31053 .endd
31054 You can specify an SMTP response code, optionally followed by an &"extended
31055 response code"& at the start of the message, but the first digit must be the
31056 same as would be sent by default, which is 2 for an &%accept%& verb.
31057
31058 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31059 an error message that is used when access is denied. This behaviour is retained
31060 for backward compatibility, but current &"best practice"& is to avoid the use
31061 of &%endpass%&.
31062
31063
31064 .next
31065 .cindex "&%defer%& ACL verb"
31066 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31067 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31068 &%defer%& is the same as &%deny%&, because there is no way of sending a
31069 temporary error. For a RCPT command, &%defer%& is much the same as using a
31070 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31071 be used in any ACL, and even for a recipient it might be a simpler approach.
31072
31073
31074 .next
31075 .cindex "&%deny%& ACL verb"
31076 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31077 the conditions are not met, control is passed to the next ACL statement. For
31078 example,
31079 .code
31080 deny dnslists = blackholes.mail-abuse.org
31081 .endd
31082 rejects commands from hosts that are on a DNS black list.
31083
31084
31085 .next
31086 .cindex "&%discard%& ACL verb"
31087 &%discard%&: This verb behaves like &%accept%&, except that it returns
31088 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31089 that are concerned with receiving messages. When all the conditions are true,
31090 the sending entity receives a &"success"& response. However, &%discard%& causes
31091 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31092 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31093 message's recipients are discarded. Recipients that are discarded before DATA
31094 do not appear in the log line when the &%received_recipients%& log selector is set.
31095
31096 If the &%log_message%& modifier is set when &%discard%& operates,
31097 its contents are added to the line that is automatically written to the log.
31098 The &%message%& modifier operates exactly as it does for &%accept%&.
31099
31100
31101 .next
31102 .cindex "&%drop%& ACL verb"
31103 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31104 forcibly closed after the 5&'xx'& error message has been sent. For example:
31105 .code
31106 drop   condition = ${if > {$rcpt_count}{20}}
31107        message   = I don't take more than 20 RCPTs
31108 .endd
31109 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31110 The connection is always dropped after sending a 550 response.
31111
31112 .next
31113 .cindex "&%require%& ACL verb"
31114 &%require%&: If all the conditions are met, control is passed to the next ACL
31115 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31116 example, when checking a RCPT command,
31117 .code
31118 require message = Sender did not verify
31119         verify  = sender
31120 .endd
31121 passes control to subsequent statements only if the message's sender can be
31122 verified. Otherwise, it rejects the command. Note the positioning of the
31123 &%message%& modifier, before the &%verify%& condition. The reason for this is
31124 discussed in section &<<SECTcondmodproc>>&.
31125
31126 .next
31127 .cindex "&%warn%& ACL verb"
31128 &%warn%&: If all the conditions are true, a line specified by the
31129 &%log_message%& modifier is written to Exim's main log. Control always passes
31130 to the next ACL statement. If any condition is false, the log line is not
31131 written. If an identical log line is requested several times in the same
31132 message, only one copy is actually written to the log. If you want to force
31133 duplicates to be written, use the &%logwrite%& modifier instead.
31134
31135 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31136 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31137 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31138 first failing condition. There is more about adding header lines in section
31139 &<<SECTaddheadacl>>&.
31140
31141 If any condition on a &%warn%& statement cannot be completed (that is, there is
31142 some sort of defer), the log line specified by &%log_message%& is not written.
31143 This does not include the case of a forced failure from a lookup, which
31144 is considered to be a successful completion. After a defer, no further
31145 conditions or modifiers in the &%warn%& statement are processed. The incident
31146 is logged, and the ACL continues to be processed, from the next statement
31147 onwards.
31148
31149
31150 .vindex "&$acl_verify_message$&"
31151 When one of the &%warn%& conditions is an address verification that fails, the
31152 text of the verification failure message is in &$acl_verify_message$&. If you
31153 want this logged, you must set it up explicitly. For example:
31154 .code
31155 warn   !verify = sender
31156        log_message = sender verify failed: $acl_verify_message
31157 .endd
31158 .endlist
31159
31160 At the end of each ACL there is an implicit unconditional &%deny%&.
31161
31162 As you can see from the examples above, the conditions and modifiers are
31163 written one to a line, with the first one on the same line as the verb, and
31164 subsequent ones on following lines. If you have a very long condition, you can
31165 continue it onto several physical lines by the usual backslash continuation
31166 mechanism. It is conventional to align the conditions vertically.
31167
31168
31169
31170 .section "ACL variables" "SECTaclvariables"
31171 .cindex "&ACL;" "variables"
31172 There are some special variables that can be set during ACL processing. They
31173 can be used to pass information between different ACLs, different invocations
31174 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31175 transports, and filters that are used to deliver a message. The names of these
31176 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31177 an underscore, but the remainder of the name can be any sequence of
31178 alphanumeric characters and underscores that you choose. There is no limit on
31179 the number of ACL variables. The two sets act as follows:
31180 .ilist
31181 The values of those variables whose names begin with &$acl_c$& persist
31182 throughout an SMTP connection. They are never reset. Thus, a value that is set
31183 while receiving one message is still available when receiving the next message
31184 on the same SMTP connection.
31185 .next
31186 The values of those variables whose names begin with &$acl_m$& persist only
31187 while a message is being received. They are reset afterwards. They are also
31188 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31189 .endlist
31190
31191 When a message is accepted, the current values of all the ACL variables are
31192 preserved with the message and are subsequently made available at delivery
31193 time. The ACL variables are set by a modifier called &%set%&. For example:
31194 .code
31195 accept hosts = whatever
31196        set acl_m4 = some value
31197 accept authenticated = *
31198        set acl_c_auth = yes
31199 .endd
31200 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31201 be set. If you want to set a variable without taking any action, you can use a
31202 &%warn%& verb without any other modifiers or conditions.
31203
31204 .oindex &%strict_acl_vars%&
31205 What happens if a syntactically valid but undefined ACL variable is
31206 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31207 false (the default), an empty string is substituted; if it is true, an
31208 error is generated.
31209
31210 Versions of Exim before 4.64 have a limited set of numbered variables, but
31211 their names are compatible, so there is no problem with upgrading.
31212
31213
31214 .section "Condition and modifier processing" "SECTcondmodproc"
31215 .cindex "&ACL;" "conditions; processing"
31216 .cindex "&ACL;" "modifiers; processing"
31217 An exclamation mark preceding a condition negates its result. For example:
31218 .code
31219 deny   domains = *.dom.example
31220       !verify  = recipient
31221 .endd
31222 causes the ACL to return &"deny"& if the recipient domain ends in
31223 &'dom.example'& and the recipient address cannot be verified. Sometimes
31224 negation can be used on the right-hand side of a condition. For example, these
31225 two statements are equivalent:
31226 .code
31227 deny  hosts = !192.168.3.4
31228 deny !hosts =  192.168.3.4
31229 .endd
31230 However, for many conditions (&%verify%& being a good example), only left-hand
31231 side negation of the whole condition is possible.
31232
31233 The arguments of conditions and modifiers are expanded. A forced failure
31234 of an expansion causes a condition to be ignored, that is, it behaves as if the
31235 condition is true. Consider these two statements:
31236 .code
31237 accept  senders = ${lookup{$host_name}lsearch\
31238                   {/some/file}{$value}fail}
31239 accept  senders = ${lookup{$host_name}lsearch\
31240                   {/some/file}{$value}{}}
31241 .endd
31242 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31243 the returned list is searched, but if the lookup fails the behaviour is
31244 different in the two cases. The &%fail%& in the first statement causes the
31245 condition to be ignored, leaving no further conditions. The &%accept%& verb
31246 therefore succeeds. The second statement, however, generates an empty list when
31247 the lookup fails. No sender can match an empty list, so the condition fails,
31248 and therefore the &%accept%& also fails.
31249
31250 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31251 specify actions that are taken as the conditions for a statement are checked;
31252 others specify text for messages that are used when access is denied or a
31253 warning is generated. The &%control%& modifier affects the way an incoming
31254 message is handled.
31255
31256 The positioning of the modifiers in an ACL statement is important, because the
31257 processing of a verb ceases as soon as its outcome is known. Only those
31258 modifiers that have already been encountered will take effect. For example,
31259 consider this use of the &%message%& modifier:
31260 .code
31261 require message = Can't verify sender
31262         verify  = sender
31263         message = Can't verify recipient
31264         verify  = recipient
31265         message = This message cannot be used
31266 .endd
31267 If sender verification fails, Exim knows that the result of the statement is
31268 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31269 so its text is used as the error message. If sender verification succeeds, but
31270 recipient verification fails, the second message is used. If recipient
31271 verification succeeds, the third message becomes &"current"&, but is never used
31272 because there are no more conditions to cause failure.
31273
31274 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31275 modifier that is used, because all the conditions must be true for rejection to
31276 happen. Specifying more than one &%message%& modifier does not make sense, and
31277 the message can even be specified after all the conditions. For example:
31278 .code
31279 deny   hosts = ...
31280       !senders = *@my.domain.example
31281        message = Invalid sender from client host
31282 .endd
31283 The &"deny"& result does not happen until the end of the statement is reached,
31284 by which time Exim has set up the message.
31285
31286
31287
31288 .section "ACL modifiers" "SECTACLmodi"
31289 .cindex "&ACL;" "modifiers; list of"
31290 The ACL modifiers are as follows:
31291
31292 .vlist
31293 .vitem &*add_header*&&~=&~<&'text'&>
31294 This modifier specifies one or more header lines that are to be added to an
31295 incoming message, assuming, of course, that the message is ultimately
31296 accepted. For details, see section &<<SECTaddheadacl>>&.
31297
31298 .vitem &*continue*&&~=&~<&'text'&>
31299 .cindex "&%continue%& ACL modifier"
31300 .cindex "database" "updating in ACL"
31301 This modifier does nothing of itself, and processing of the ACL always
31302 continues with the next condition or modifier. The value of &%continue%& is in
31303 the side effects of expanding its argument. Typically this could be used to
31304 update a database. It is really just a syntactic tidiness, to avoid having to
31305 write rather ugly lines like this:
31306 .display
31307 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31308 .endd
31309 Instead, all you need is
31310 .display
31311 &`continue = `&<&'some expansion'&>
31312 .endd
31313
31314 .vitem &*control*&&~=&~<&'text'&>
31315 .cindex "&%control%& ACL modifier"
31316 This modifier affects the subsequent processing of the SMTP connection or of an
31317 incoming message that is accepted. The effect of the first type of control
31318 lasts for the duration of the connection, whereas the effect of the second type
31319 lasts only until the current message has been received. The message-specific
31320 controls always apply to the whole message, not to individual recipients,
31321 even if the &%control%& modifier appears in a RCPT ACL.
31322
31323 As there are now quite a few controls that can be applied, they are described
31324 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31325 in several different ways. For example:
31326
31327 . ==== As this is a nested list, any displays it contains must be indented
31328 . ==== as otherwise they are too far to the left. That comment applies only
31329 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31330 . ==== way.
31331
31332 .ilist
31333 It can be at the end of an &%accept%& statement:
31334 .code
31335     accept  ...some conditions
31336             control = queue
31337 .endd
31338 In this case, the control is applied when this statement yields &"accept"&, in
31339 other words, when the conditions are all true.
31340
31341 .next
31342 It can be in the middle of an &%accept%& statement:
31343 .code
31344     accept  ...some conditions...
31345             control = queue
31346             ...some more conditions...
31347 .endd
31348 If the first set of conditions are true, the control is applied, even if the
31349 statement does not accept because one of the second set of conditions is false.
31350 In this case, some subsequent statement must yield &"accept"& for the control
31351 to be relevant.
31352
31353 .next
31354 It can be used with &%warn%& to apply the control, leaving the
31355 decision about accepting or denying to a subsequent verb. For
31356 example:
31357 .code
31358     warn    ...some conditions...
31359             control = freeze
31360     accept  ...
31361 .endd
31362 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31363 &%logwrite%&, so it does not add anything to the message and does not write a
31364 log entry.
31365
31366 .next
31367 If you want to apply a control unconditionally, you can use it with a
31368 &%require%& verb. For example:
31369 .code
31370     require  control = no_multiline_responses
31371 .endd
31372 .endlist
31373
31374 .vitem &*delay*&&~=&~<&'time'&>
31375 .cindex "&%delay%& ACL modifier"
31376 .oindex "&%-bh%&"
31377 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31378 the time interval before proceeding. However, when testing Exim using the
31379 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31380 output instead). The time is given in the usual Exim notation, and the delay
31381 happens as soon as the modifier is processed. In an SMTP session, pending
31382 output is flushed before the delay is imposed.
31383
31384 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31385 example:
31386 .code
31387 deny    ...some conditions...
31388         delay = 30s
31389 .endd
31390 The delay happens if all the conditions are true, before the statement returns
31391 &"deny"&. Compare this with:
31392 .code
31393 deny    delay = 30s
31394         ...some conditions...
31395 .endd
31396 which waits for 30s before processing the conditions. The &%delay%& modifier
31397 can also be used with &%warn%& and together with &%control%&:
31398 .code
31399 warn    ...some conditions...
31400         delay = 2m
31401         control = freeze
31402 accept  ...
31403 .endd
31404
31405 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31406 responses to several commands are no longer buffered and sent in one packet (as
31407 they would normally be) because all output is flushed before imposing the
31408 delay. This optimization is disabled so that a number of small delays do not
31409 appear to the client as one large aggregated delay that might provoke an
31410 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31411 using a &%control%& modifier to set &%no_delay_flush%&.
31412
31413
31414 .vitem &*endpass*&
31415 .cindex "&%endpass%& ACL modifier"
31416 This modifier, which has no argument, is recognized only in &%accept%& and
31417 &%discard%& statements. It marks the boundary between the conditions whose
31418 failure causes control to pass to the next statement, and the conditions whose
31419 failure causes the ACL to return &"deny"&. This concept has proved to be
31420 confusing to some people, so the use of &%endpass%& is no longer recommended as
31421 &"best practice"&. See the description of &%accept%& above for more details.
31422
31423
31424 .vitem &*log_message*&&~=&~<&'text'&>
31425 .cindex "&%log_message%& ACL modifier"
31426 This modifier sets up a message that is used as part of the log message if the
31427 ACL denies access or a &%warn%& statement's conditions are true. For example:
31428 .code
31429 require log_message = wrong cipher suite $tls_in_cipher
31430         encrypted   = DES-CBC3-SHA
31431 .endd
31432 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31433 example:
31434 .display
31435 &`discard `&<&'some conditions'&>
31436 &`        log_message = Discarded $local_part@$domain because...`&
31437 .endd
31438 When access is denied, &%log_message%& adds to any underlying error message
31439 that may exist because of a condition failure. For example, while verifying a
31440 recipient address, a &':fail:'& redirection might have already set up a
31441 message.
31442
31443 The message may be defined before the conditions to which it applies, because
31444 the string expansion does not happen until Exim decides that access is to be
31445 denied. This means that any variables that are set by the condition are
31446 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31447 variables are set after a DNS black list lookup succeeds. If the expansion of
31448 &%log_message%& fails, or if the result is an empty string, the modifier is
31449 ignored.
31450
31451 .vindex "&$acl_verify_message$&"
31452 If you want to use a &%warn%& statement to log the result of an address
31453 verification, you can use &$acl_verify_message$& to include the verification
31454 error message.
31455
31456 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31457 the start of the logged message. If the same warning log message is requested
31458 more than once while receiving  a single email message, only one copy is
31459 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31460 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31461 is logged for a successful &%warn%& statement.
31462
31463 If &%log_message%& is not present and there is no underlying error message (for
31464 example, from the failure of address verification), but &%message%& is present,
31465 the &%message%& text is used for logging rejections. However, if any text for
31466 logging contains newlines, only the first line is logged. In the absence of
31467 both &%log_message%& and &%message%&, a default built-in message is used for
31468 logging rejections.
31469
31470
31471 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31472 .cindex "&%log_reject_target%& ACL modifier"
31473 .cindex "logging in ACL" "specifying which log"
31474 This modifier makes it possible to specify which logs are used for messages
31475 about ACL rejections. Its argument is a colon-separated list of words that can
31476 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31477 may be empty, in which case a rejection is not logged at all. For example, this
31478 ACL fragment writes no logging information when access is denied:
31479 .display
31480 &`deny `&<&'some conditions'&>
31481 &`     log_reject_target =`&
31482 .endd
31483 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31484 permanent and temporary rejections. Its effect lasts for the rest of the
31485 current ACL.
31486
31487
31488 .vitem &*logwrite*&&~=&~<&'text'&>
31489 .cindex "&%logwrite%& ACL modifier"
31490 .cindex "logging in ACL" "immediate"
31491 This modifier writes a message to a log file as soon as it is encountered when
31492 processing an ACL. (Compare &%log_message%&, which, except in the case of
31493 &%warn%& and &%discard%&, is used only if the ACL statement denies
31494 access.) The &%logwrite%& modifier can be used to log special incidents in
31495 ACLs. For example:
31496 .display
31497 &`accept `&<&'some special conditions'&>
31498 &`       control  = freeze`&
31499 &`       logwrite = froze message because ...`&
31500 .endd
31501 By default, the message is written to the main log. However, it may begin
31502 with a colon, followed by a comma-separated list of log names, and then
31503 another colon, to specify exactly which logs are to be written. For
31504 example:
31505 .code
31506 logwrite = :main,reject: text for main and reject logs
31507 logwrite = :panic: text for panic log only
31508 .endd
31509
31510
31511 .vitem &*message*&&~=&~<&'text'&>
31512 .cindex "&%message%& ACL modifier"
31513 This modifier sets up a text string that is expanded and used as a response
31514 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31515 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31516 there is some complication if &%endpass%& is involved; see the description of
31517 &%accept%& for details.)
31518
31519 The expansion of the message happens at the time Exim decides that the ACL is
31520 to end, not at the time it processes &%message%&. If the expansion fails, or
31521 generates an empty string, the modifier is ignored. Here is an example where
31522 &%message%& must be specified first, because the ACL ends with a rejection if
31523 the &%hosts%& condition fails:
31524 .code
31525 require  message = Host not recognized
31526          hosts = 10.0.0.0/8
31527 .endd
31528 (Once a condition has failed, no further conditions or modifiers are
31529 processed.)
31530
31531 .cindex "SMTP" "error codes"
31532 .oindex "&%smtp_banner%&
31533 For ACLs that are triggered by SMTP commands, the message is returned as part
31534 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31535 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31536 is accepted. In the case of the connect ACL, accepting with a message modifier
31537 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31538 accept message may not contain more than one line (otherwise it will be
31539 truncated at the first newline and a panic logged), and it cannot affect the
31540 EHLO options.
31541
31542 When SMTP is involved, the message may begin with an overriding response code,
31543 consisting of three digits optionally followed by an &"extended response code"&
31544 of the form &'n.n.n'&, each code being followed by a space. For example:
31545 .code
31546 deny  message = 599 1.2.3 Host not welcome
31547       hosts = 192.168.34.0/24
31548 .endd
31549 The first digit of the supplied response code must be the same as would be sent
31550 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31551 access, but for the predata ACL, note that the default success code is 354, not
31552 2&'xx'&.
31553
31554 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31555 the message modifier cannot override the 221 response code.
31556
31557 The text in a &%message%& modifier is literal; any quotes are taken as
31558 literals, but because the string is expanded, backslash escapes are processed
31559 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31560 response.
31561
31562 .vindex "&$acl_verify_message$&"
31563 While the text is being expanded, the &$acl_verify_message$& variable
31564 contains any message previously set.
31565 Afterwards, &$acl_verify_message$& is cleared.
31566
31567 If &%message%& is used on a statement that verifies an address, the message
31568 specified overrides any message that is generated by the verification process.
31569 However, the original message is available in the variable
31570 &$acl_verify_message$&, so you can incorporate it into your message if you
31571 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31572 routers to be passed back as part of the SMTP response, you should either not
31573 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31574
31575 For compatibility with previous releases of Exim, a &%message%& modifier that
31576 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31577 modifier, but this usage is now deprecated. However, &%message%& acts only when
31578 all the conditions are true, wherever it appears in an ACL command, whereas
31579 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31580 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31581 effect.
31582
31583
31584 .vitem &*queue*&&~=&~<&'text'&>
31585 .cindex "&%queue%& ACL modifier"
31586 .cindex "named queues" "selecting in ACL"
31587 This modifier specifies the use of a named queue for spool files
31588 for the message.
31589 It can only be used before the message is received (i.e. not in
31590 the DATA ACL).
31591 This could be used, for example, for known high-volume burst sources
31592 of traffic, or for quarantine of messages.
31593 Separate queue-runner processes will be needed for named queues.
31594 If the text after expansion is empty, the default queue is used.
31595
31596
31597 .vitem &*remove_header*&&~=&~<&'text'&>
31598 This modifier specifies one or more header names in a colon-separated list
31599  that are to be removed from an incoming message, assuming, of course, that
31600 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31601
31602
31603 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31604 .cindex "&%set%& ACL modifier"
31605 This modifier puts a value into one of the ACL variables (see section
31606 &<<SECTaclvariables>>&).
31607
31608
31609 .vitem &*udpsend*&&~=&~<&'parameters'&>
31610 .cindex "UDP communications"
31611 This modifier sends a UDP packet, for purposes such as statistics
31612 collection or behaviour monitoring. The parameters are expanded, and
31613 the result of the expansion must be a colon-separated list consisting
31614 of a destination server, port number, and the packet contents. The
31615 server can be specified as a host name or IPv4 or IPv6 address. The
31616 separator can be changed with the usual angle bracket syntax. For
31617 example, you might want to collect information on which hosts connect
31618 when:
31619 .code
31620 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31621              $tod_zulu $sender_host_address
31622 .endd
31623 .endlist
31624
31625
31626
31627
31628 .section "Use of the control modifier" "SECTcontrols"
31629 .cindex "&%control%& ACL modifier"
31630 The &%control%& modifier supports the following settings:
31631
31632 .vlist
31633 .vitem &*control&~=&~allow_auth_unadvertised*&
31634 This modifier allows a client host to use the SMTP AUTH command even when it
31635 has not been advertised in response to EHLO. Furthermore, because there are
31636 apparently some really broken clients that do this, Exim will accept AUTH after
31637 HELO (rather than EHLO) when this control is set. It should be used only if you
31638 really need it, and you should limit its use to those broken clients that do
31639 not work without it. For example:
31640 .code
31641 warn hosts   = 192.168.34.25
31642      control = allow_auth_unadvertised
31643 .endd
31644 Normally, when an Exim server receives an AUTH command, it checks the name of
31645 the authentication mechanism that is given in the command to ensure that it
31646 matches an advertised mechanism. When this control is set, the check that a
31647 mechanism has been advertised is bypassed. Any configured mechanism can be used
31648 by the client. This control is permitted only in the connection and HELO ACLs.
31649
31650
31651 .vitem &*control&~=&~caseful_local_part*& &&&
31652        &*control&~=&~caselower_local_part*&
31653 .cindex "&ACL;" "case of local part in"
31654 .cindex "case of local parts"
31655 .vindex "&$local_part$&"
31656 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31657 (that is, during RCPT processing). By default, the contents of &$local_part$&
31658 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31659 any uppercase letters in the original local part are restored in &$local_part$&
31660 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31661 is encountered.
31662
31663 These controls affect only the current recipient. Moreover, they apply only to
31664 local part handling that takes place directly in the ACL (for example, as a key
31665 in lookups). If a test to verify the recipient is obeyed, the case-related
31666 handling of the local part during the verification is controlled by the router
31667 configuration (see the &%caseful_local_part%& generic router option).
31668
31669 This facility could be used, for example, to add a spam score to local parts
31670 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31671 spam score:
31672 .code
31673 warn  control = caseful_local_part
31674       set acl_m4 = ${eval:\
31675                      $acl_m4 + \
31676                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31677                     }
31678       control = caselower_local_part
31679 .endd
31680 Notice that we put back the lower cased version afterwards, assuming that
31681 is what is wanted for subsequent tests.
31682
31683
31684 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31685 .cindex "&ACL;" "cutthrough routing"
31686 .cindex "cutthrough" "requesting"
31687 This option requests delivery be attempted while the item is being received.
31688
31689 The option is usable in the RCPT ACL.
31690 If enabled for a message received via smtp and routed to an smtp transport,
31691 and only one transport, interface, destination host and port combination
31692 is used for all recipients of the message,
31693 then the delivery connection is made while the receiving connection is open
31694 and data is copied from one to the other.
31695
31696 An attempt to set this option for any recipient but the first
31697 for a mail will be quietly ignored.
31698 If a recipient-verify callout
31699 (with use_sender)
31700 connection is subsequently
31701 requested in the same ACL it is held open and used for
31702 any subsequent recipients and the data,
31703 otherwise one is made after the initial RCPT ACL completes.
31704
31705 Note that routers are used in verify mode,
31706 and cannot depend on content of received headers.
31707 Note also that headers cannot be
31708 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31709 Headers may be modified by routers (subject to the above) and transports.
31710 The &'Received-By:'& header is generated as soon as the body reception starts,
31711 rather than the traditional time after the full message is received;
31712 this will affect the timestamp.
31713
31714 All the usual ACLs are called; if one results in the message being
31715 rejected, all effort spent in delivery (including the costs on
31716 the ultimate destination) will be wasted.
31717 Note that in the case of data-time ACLs this includes the entire
31718 message body.
31719
31720 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31721 of outgoing messages is done, because it sends data to the ultimate destination
31722 before the entire message has been received from the source.
31723 It is not supported for messages received with the SMTP PRDR
31724 or CHUNKING
31725 options in use.
31726
31727 Should the ultimate destination system positively accept or reject the mail,
31728 a corresponding indication is given to the source system and nothing is queued.
31729 If the item is successfully delivered in cutthrough mode
31730 the delivery log lines are tagged with ">>" rather than "=>" and appear
31731 before the acceptance "<=" line.
31732
31733 If there is a temporary error the item is queued for later delivery in the
31734 usual fashion.
31735 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31736 to the control; the default value is &"spool"& and the alternate value
31737 &"pass"& copies an SMTP defer response from the target back to the initiator
31738 and does not queue the message.
31739 Note that this is independent of any recipient verify conditions in the ACL.
31740
31741 Delivery in this mode avoids the generation of a bounce mail to a
31742 (possibly faked)
31743 sender when the destination system is doing content-scan based rejection.
31744
31745
31746 .vitem &*control&~=&~debug/*&<&'options'&>
31747 .cindex "&ACL;" "enabling debug logging"
31748 .cindex "debugging" "enabling from an ACL"
31749 This control turns on debug logging, almost as though Exim had been invoked
31750 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31751 by default called &'debuglog'&.
31752
31753 Logging set up by the control will be maintained across spool residency.
31754
31755 Options are a slash-separated list.
31756 If an option takes an argument, the option name and argument are separated by
31757 an equals character.
31758 Several options are supported:
31759 .display
31760 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31761                      The argument, which may access any variables already defined,
31762                      is appended to the default name.
31763
31764 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31765                      using the same values as the &`-d`& command-line option.
31766
31767 stop                 Logging started with this control may be
31768                      stopped by using this option.
31769
31770 kill                 Logging started with this control may be
31771                      stopped by using this option.
31772                      Additionally the debug file will be removed,
31773                      providing one means for speculative debug tracing.
31774
31775 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31776                      for pre-trigger debug capture.
31777                      Debug lines are recorded in the buffer until
31778                      and if) a trigger occurs; at which time they are
31779                      dumped to the debug file.  Newer lines displace the
31780                      oldest if the buffer is full.  After a trigger,
31781                      immediate writes to file are done as normal.
31782
31783 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31784                      see above) to be copied to file.  A reason of &*now*&
31785                      take effect immediately; one of &*paniclog*& triggers
31786                      on a write to the panic log.
31787 .endd
31788
31789 Some examples (which depend on variables that don't exist in all
31790 contexts):
31791 .code
31792       control = debug
31793       control = debug/tag=.$sender_host_address
31794       control = debug/opts=+expand+acl
31795       control = debug/tag=.$message_exim_id/opts=+expand
31796       control = debug/kill
31797       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31798       control = debug/trigger=now
31799 .endd
31800
31801
31802 .vitem &*control&~=&~dkim_disable_verify*&
31803 .cindex "disable DKIM verify"
31804 .cindex "DKIM" "disable verify"
31805 This control turns off DKIM verification processing entirely.  For details on
31806 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31807
31808
31809 .vitem &*control&~=&~dmarc_disable_verify*&
31810 .cindex "disable DMARC verify"
31811 .cindex "DMARC" "disable verify"
31812 This control turns off DMARC verification processing entirely.  For details on
31813 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31814
31815
31816 .vitem &*control&~=&~dscp/*&<&'value'&>
31817 .cindex "&ACL;" "setting DSCP value"
31818 .cindex "DSCP" "inbound"
31819 This option causes the DSCP value associated with the socket for the inbound
31820 connection to be adjusted to a given value, given as one of a number of fixed
31821 strings or to numeric value.
31822 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31823 Common values include &`throughput`&, &`mincost`&, and on newer systems
31824 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31825
31826 The outbound packets from Exim will be marked with this value in the header
31827 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31828 that these values will have any effect, not be stripped by networking
31829 equipment, or do much of anything without cooperation with your Network
31830 Engineer and those of all network operators between the source and destination.
31831
31832
31833 .vitem &*control&~=&~enforce_sync*& &&&
31834        &*control&~=&~no_enforce_sync*&
31835 .cindex "SMTP" "synchronization checking"
31836 .cindex "synchronization checking in SMTP"
31837 These controls make it possible to be selective about when SMTP synchronization
31838 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31839 state of the switch (it is true by default). See the description of this option
31840 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31841
31842 The effect of these two controls lasts for the remainder of the SMTP
31843 connection. They can appear in any ACL except the one for the non-SMTP
31844 messages. The most straightforward place to put them is in the ACL defined by
31845 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31846 before the first synchronization check. The expected use is to turn off the
31847 synchronization checks for badly-behaved hosts that you nevertheless need to
31848 work with.
31849
31850
31851 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31852 .cindex "fake defer"
31853 .cindex "defer, fake"
31854 This control works in exactly the same way as &%fakereject%& (described below)
31855 except that it causes an SMTP 450 response after the message data instead of a
31856 550 response. You must take care when using &%fakedefer%& because it causes the
31857 messages to be duplicated when the sender retries. Therefore, you should not
31858 use &%fakedefer%& if the message is to be delivered normally.
31859
31860 .vitem &*control&~=&~fakereject/*&<&'message'&>
31861 .cindex "fake rejection"
31862 .cindex "rejection, fake"
31863 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31864 words, only when an SMTP message is being received. If Exim accepts the
31865 message, instead the final 250 response, a 550 rejection message is sent.
31866 However, Exim proceeds to deliver the message as normal. The control applies
31867 only to the current message, not to any subsequent ones that may be received in
31868 the same SMTP connection.
31869
31870 The text for the 550 response is taken from the &%control%& modifier. If no
31871 message is supplied, the following is used:
31872 .code
31873 550-Your message has been rejected but is being
31874 550-kept for evaluation.
31875 550-If it was a legitimate message, it may still be
31876 550 delivered to the target recipient(s).
31877 .endd
31878 This facility should be used with extreme caution.
31879
31880 .vitem &*control&~=&~freeze*&
31881 .cindex "frozen messages" "forcing in ACL"
31882 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31883 other words, only when a message is being received. If the message is accepted,
31884 it is placed on Exim's queue and frozen. The control applies only to the
31885 current message, not to any subsequent ones that may be received in the same
31886 SMTP connection.
31887
31888 This modifier can optionally be followed by &`/no_tell`&. If the global option
31889 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31890 is told about the freezing), provided all the &*control=freeze*& modifiers that
31891 are obeyed for the current message have the &`/no_tell`& option.
31892
31893 .vitem &*control&~=&~no_delay_flush*&
31894 .cindex "SMTP" "output flushing, disabling for delay"
31895 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31896 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31897 use. This control, as long as it is encountered before the &%delay%& modifier,
31898 disables such output flushing.
31899
31900 .vitem &*control&~=&~no_callout_flush*&
31901 .cindex "SMTP" "output flushing, disabling for callout"
31902 Exim normally flushes SMTP output before performing a callout in an ACL, to
31903 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31904 use. This control, as long as it is encountered before the &%verify%& condition
31905 that causes the callout, disables such output flushing.
31906
31907 .vitem &*control&~=&~no_mbox_unspool*&
31908 This control is available when Exim is compiled with the content scanning
31909 extension. Content scanning may require a copy of the current message, or parts
31910 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31911 or spam scanner. Normally, such copies are deleted when they are no longer
31912 needed. If this control is set, the copies are not deleted. The control applies
31913 only to the current message, not to any subsequent ones that may be received in
31914 the same SMTP connection. It is provided for debugging purposes and is unlikely
31915 to be useful in production.
31916
31917 .vitem &*control&~=&~no_multiline_responses*&
31918 .cindex "multiline responses, suppressing"
31919 This control is permitted for any ACL except the one for non-SMTP messages.
31920 It seems that there are broken clients in use that cannot handle multiline
31921 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31922
31923 If this control is set, multiline SMTP responses from ACL rejections are
31924 suppressed. One way of doing this would have been to put out these responses as
31925 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31926 (&"use multiline responses for more"& it says &-- ha!), and some of the
31927 responses might get close to that. So this facility, which is after all only a
31928 sop to broken clients, is implemented by doing two very easy things:
31929
31930 .ilist
31931 Extra information that is normally output as part of a rejection caused by
31932 sender verification failure is omitted. Only the final line (typically &"sender
31933 verification failed"&) is sent.
31934 .next
31935 If a &%message%& modifier supplies a multiline response, only the first
31936 line is output.
31937 .endlist
31938
31939 The setting of the switch can, of course, be made conditional on the
31940 calling host. Its effect lasts until the end of the SMTP connection.
31941
31942 .vitem &*control&~=&~no_pipelining*&
31943 .cindex "PIPELINING" "suppressing advertising"
31944 .cindex "ESMTP extensions" PIPELINING
31945 This control turns off the advertising of the PIPELINING extension to SMTP in
31946 the current session. To be useful, it must be obeyed before Exim sends its
31947 response to an EHLO command. Therefore, it should normally appear in an ACL
31948 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31949 &%pipelining_advertise_hosts%&.
31950
31951 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31952        &*control&~=&~queue_only*&
31953 .oindex "&%queue%&"
31954 .oindex "&%queue_only%&"
31955 .cindex "queueing incoming messages"
31956 .cindex queueing "forcing in ACL"
31957 .cindex "first pass routing"
31958 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31959 other words, only when a message is being received. If the message is accepted,
31960 it is placed on Exim's queue and left there for delivery by a subsequent queue
31961 runner.
31962 If used with no options set,
31963 no immediate delivery process is started. In other words, it has the
31964 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31965
31966 If the &'first_pass_route'& option is given then
31967 the behaviour is like the command-line &'-oqds'& option;
31968 a delivery process is started which stops short of making
31969 any SMTP delivery.  The benefit is that the hints database will be updated for
31970 the message being waiting for a specific host, and a later queue run will be
31971 able to send all such messages on a single connection.
31972
31973 The control only applies to the current message, not to any subsequent ones that
31974  may be received in the same SMTP connection.
31975
31976 .vitem &*control&~=&~submission/*&<&'options'&>
31977 .cindex "message" "submission"
31978 .cindex "submission mode"
31979 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31980 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31981 the current message is a submission from a local MUA. In this case, Exim
31982 operates in &"submission mode"&, and applies certain fixups to the message if
31983 necessary. For example, it adds a &'Date:'& header line if one is not present.
31984 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31985 late (the message has already been created).
31986
31987 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31988 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31989 submission mode; the available options for this control are described there.
31990 The control applies only to the current message, not to any subsequent ones
31991 that may be received in the same SMTP connection.
31992
31993 .vitem &*control&~=&~suppress_local_fixups*&
31994 .cindex "submission fixups, suppressing"
31995 This control applies to locally submitted (non TCP/IP) messages, and is the
31996 complement of &`control = submission`&. It disables the fixups that are
31997 normally applied to locally-submitted messages. Specifically:
31998
31999 .ilist
32000 Any &'Sender:'& header line is left alone (in this respect, it is a
32001 dynamic version of &%local_sender_retain%&).
32002 .next
32003 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32004 .next
32005 There is no check that &'From:'& corresponds to the actual sender.
32006 .endlist ilist
32007
32008 This control may be useful when a remotely-originated message is accepted,
32009 passed to some scanning program, and then re-submitted for delivery. It can be
32010 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32011 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32012 data is read.
32013
32014 &*Note:*& This control applies only to the current message, not to any others
32015 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32016
32017 .vitem &*control&~=&~utf8_downconvert*&
32018 This control enables conversion of UTF-8 in message envelope addresses
32019 to a-label form.
32020 For details see section &<<SECTi18nMTA>>&.
32021 .endlist vlist
32022
32023
32024 .section "Summary of message fixup control" "SECTsummesfix"
32025 All four possibilities for message fixups can be specified:
32026
32027 .ilist
32028 Locally submitted, fixups applied: the default.
32029 .next
32030 Locally submitted, no fixups applied: use
32031 &`control = suppress_local_fixups`&.
32032 .next
32033 Remotely submitted, no fixups applied: the default.
32034 .next
32035 Remotely submitted, fixups applied: use &`control = submission`&.
32036 .endlist
32037
32038
32039
32040 .section "Adding header lines in ACLs" "SECTaddheadacl"
32041 .cindex "header lines" "adding in an ACL"
32042 .cindex "header lines" "position of added lines"
32043 .cindex "&%add_header%& ACL modifier"
32044 The &%add_header%& modifier can be used to add one or more extra header lines
32045 to an incoming message, as in this example:
32046 .code
32047 warn dnslists = sbl.spamhaus.org : \
32048                 dialup.mail-abuse.org
32049      add_header = X-blacklisted-at: $dnslist_domain
32050 .endd
32051 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32052 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32053 receiving a message). The message must ultimately be accepted for
32054 &%add_header%& to have any significant effect. You can use &%add_header%& with
32055 any ACL verb, including &%deny%& (though this is potentially useful only in a
32056 RCPT ACL).
32057
32058 Headers will not be added to the message if the modifier is used in
32059 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32060
32061 Leading and trailing newlines are removed from
32062 the data for the &%add_header%& modifier; if it then
32063 contains one or more newlines that
32064 are not followed by a space or a tab, it is assumed to contain multiple header
32065 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32066 front of any line that is not a valid header line.
32067
32068 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32069 They are added to the message before processing the DATA and MIME ACLs.
32070 However, if an identical header line is requested more than once, only one copy
32071 is actually added to the message. Further header lines may be accumulated
32072 during the DATA and MIME ACLs, after which they are added to the message, again
32073 with duplicates suppressed. Thus, it is possible to add two identical header
32074 lines to an SMTP message, but only if one is added before DATA and one after.
32075 In the case of non-SMTP messages, new headers are accumulated during the
32076 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32077 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32078 are included in the entry that is written to the reject log.
32079
32080 .cindex "header lines" "added; visibility of"
32081 Header lines are not visible in string expansions
32082 of message headers
32083 until they are added to the
32084 message. It follows that header lines defined in the MAIL, RCPT, and predata
32085 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32086 header lines that are added by the DATA or MIME ACLs are not visible in those
32087 ACLs. Because of this restriction, you cannot use header lines as a way of
32088 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32089 this, you can use ACL variables, as described in section
32090 &<<SECTaclvariables>>&.
32091
32092 The list of headers yet to be added is given by the &%$headers_added%& variable.
32093
32094 The &%add_header%& modifier acts immediately as it is encountered during the
32095 processing of an ACL. Notice the difference between these two cases:
32096 .display
32097 &`accept add_header = ADDED: some text`&
32098 &`       `&<&'some condition'&>
32099
32100 &`accept `&<&'some condition'&>
32101 &`       add_header = ADDED: some text`&
32102 .endd
32103 In the first case, the header line is always added, whether or not the
32104 condition is true. In the second case, the header line is added only if the
32105 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32106 ACL statement. All those that are encountered before a condition fails are
32107 honoured.
32108
32109 .cindex "&%warn%& ACL verb"
32110 For compatibility with previous versions of Exim, a &%message%& modifier for a
32111 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32112 effect only if all the conditions are true, even if it appears before some of
32113 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32114 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32115 are present on a &%warn%& verb, both are processed according to their
32116 specifications.
32117
32118 By default, new header lines are added to a message at the end of the existing
32119 header lines. However, you can specify that any particular header line should
32120 be added right at the start (before all the &'Received:'& lines), immediately
32121 after the first block of &'Received:'& lines, or immediately before any line
32122 that is not a &'Received:'& or &'Resent-something:'& header.
32123
32124 This is done by specifying &":at_start:"&, &":after_received:"&, or
32125 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32126 header line, respectively. (Header text cannot start with a colon, as there has
32127 to be a header name first.) For example:
32128 .code
32129 warn add_header = \
32130        :after_received:X-My-Header: something or other...
32131 .endd
32132 If more than one header line is supplied in a single &%add_header%& modifier,
32133 each one is treated independently and can therefore be placed differently. If
32134 you add more than one line at the start, or after the Received: block, they end
32135 up in reverse order.
32136
32137 &*Warning*&: This facility currently applies only to header lines that are
32138 added in an ACL. It does NOT work for header lines that are added in a
32139 system filter or in a router or transport.
32140
32141
32142
32143 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32144 .cindex "header lines" "removing in an ACL"
32145 .cindex "header lines" "position of removed lines"
32146 .cindex "&%remove_header%& ACL modifier"
32147 The &%remove_header%& modifier can be used to remove one or more header lines
32148 from an incoming message, as in this example:
32149 .code
32150 warn   message        = Remove internal headers
32151        remove_header  = x-route-mail1 : x-route-mail2
32152 .endd
32153 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32154 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32155 receiving a message). The message must ultimately be accepted for
32156 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32157 with any ACL verb, including &%deny%&, though this is really not useful for
32158 any verb that doesn't result in a delivered message.
32159
32160 Headers will not be removed from the message if the modifier is used in
32161 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32162
32163 More than one header can be removed at the same time by using a colon separated
32164 list of header specifiers.
32165 .new
32166 If a specifier does not start with a circumflex (^)
32167 then it is treated as a header name.
32168 The header name matching is case insensitive.
32169 If it does, then it is treated as a (front-anchored)
32170 regular expression applied to the whole header.
32171
32172 &*Note*&: The colon terminating a header name will need to be doubled
32173 if used in an RE, and there can legitimately be whitepace before it.
32174
32175 Example:
32176 .code
32177 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32178 .endd
32179 .wen
32180
32181 List expansion is not performed, so you cannot use hostlists to
32182 create a list of headers, however both connection and message variable expansion
32183 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32184 .code
32185 warn   hosts           = +internal_hosts
32186        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32187 warn   message         = Remove internal headers
32188        remove_header   = $acl_c_ihdrs
32189 .endd
32190 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32191 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32192 If multiple header lines match, all are removed.
32193 There is no harm in attempting to remove the same header twice nor in removing
32194 a non-existent header. Further header specifiers for removal may be accumulated
32195 during the DATA and MIME ACLs, after which matching headers are removed
32196 if present. In the case of non-SMTP messages, remove speifiers are
32197 accumulated during the non-SMTP ACLs, and are acted on after
32198 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32199 ACL, there really is no effect because there is no logging of what headers
32200 would have been removed.
32201
32202 .cindex "header lines" "removed; visibility of"
32203 Header lines are not visible in string expansions until the DATA phase when it
32204 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32205 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32206 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32207 this restriction, you cannot use header lines as a way of controlling data
32208 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32209 you should instead use ACL variables, as described in section
32210 &<<SECTaclvariables>>&.
32211
32212 The &%remove_header%& modifier acts immediately as it is encountered during the
32213 processing of an ACL. Notice the difference between these two cases:
32214 .display
32215 &`accept remove_header = X-Internal`&
32216 &`       `&<&'some condition'&>
32217
32218 &`accept `&<&'some condition'&>
32219 &`       remove_header = X-Internal`&
32220 .endd
32221 In the first case, the header line is always removed, whether or not the
32222 condition is true. In the second case, the header line is removed only if the
32223 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32224 same ACL statement. All those that are encountered before a condition fails
32225 are honoured.
32226
32227 &*Warning*&: This facility currently applies only to header lines that are
32228 present during ACL processing. It does NOT remove header lines that are added
32229 in a system filter or in a router or transport.
32230
32231
32232
32233
32234 .section "ACL conditions" "SECTaclconditions"
32235 .cindex "&ACL;" "conditions; list of"
32236 Some of the conditions listed in this section are available only when Exim is
32237 compiled with the content-scanning extension. They are included here briefly
32238 for completeness. More detailed descriptions can be found in the discussion on
32239 content scanning in chapter &<<CHAPexiscan>>&.
32240
32241 Not all conditions are relevant in all circumstances. For example, testing
32242 senders and recipients does not make sense in an ACL that is being run as the
32243 result of the arrival of an ETRN command, and checks on message headers can be
32244 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32245 can use the same condition (with different parameters) more than once in the
32246 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32247 The conditions are as follows:
32248
32249
32250 .vlist
32251 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32252 .cindex "&ACL;" "nested"
32253 .cindex "&ACL;" "indirect"
32254 .cindex "&ACL;" "arguments"
32255 .cindex "&%acl%& ACL condition"
32256 The possible values of the argument are the same as for the
32257 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32258 &"accept"& the condition is true; if it returns &"deny"& the condition is
32259 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32260 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32261 condition false. This means that further processing of the &%warn%& verb
32262 ceases, but processing of the ACL continues.
32263
32264 If the argument is a named ACL, up to nine space-separated optional values
32265 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32266 and $acl_narg is set to the count of values.
32267 Previous values of these variables are restored after the call returns.
32268 The name and values are expanded separately.
32269 Note that spaces in complex expansions which are used as arguments
32270 will act as argument separators.
32271
32272 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32273 the connection is dropped. If it returns &"discard"&, the verb must be
32274 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32275 conditions are tested.
32276
32277 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32278 loops. This condition allows you to use different ACLs in different
32279 circumstances. For example, different ACLs can be used to handle RCPT commands
32280 for different local users or different local domains.
32281
32282 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32283 .cindex "&%authenticated%& ACL condition"
32284 .cindex "authentication" "ACL checking"
32285 .cindex "&ACL;" "testing for authentication"
32286 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32287 the name of the authenticator is tested against the list. To test for
32288 authentication by any authenticator, you can set
32289 .code
32290 authenticated = *
32291 .endd
32292
32293 .vitem &*condition&~=&~*&<&'string'&>
32294 .cindex "&%condition%& ACL condition"
32295 .cindex "customizing" "ACL condition"
32296 .cindex "&ACL;" "customized test"
32297 .cindex "&ACL;" "testing, customized"
32298 This feature allows you to make up custom conditions. If the result of
32299 expanding the string is an empty string, the number zero, or one of the strings
32300 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32301 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32302 any other value, some error is assumed to have occurred, and the ACL returns
32303 &"defer"&. However, if the expansion is forced to fail, the condition is
32304 ignored. The effect is to treat it as true, whether it is positive or
32305 negative.
32306
32307 .vitem &*decode&~=&~*&<&'location'&>
32308 .cindex "&%decode%& ACL condition"
32309 This condition is available only when Exim is compiled with the
32310 content-scanning extension, and it is allowed only in the ACL defined by
32311 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32312 If all goes well, the condition is true. It is false only if there are
32313 problems such as a syntax error or a memory shortage. For more details, see
32314 chapter &<<CHAPexiscan>>&.
32315
32316 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32317 .cindex "&%dnslists%& ACL condition"
32318 .cindex "DNS list" "in ACL"
32319 .cindex "black list (DNS)"
32320 .cindex "&ACL;" "testing a DNS list"
32321 This condition checks for entries in DNS black lists. These are also known as
32322 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32323 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32324 different variants of this condition to describe briefly here. See sections
32325 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32326
32327 .vitem &*domains&~=&~*&<&'domain&~list'&>
32328 .cindex "&%domains%& ACL condition"
32329 .cindex "domain" "ACL checking"
32330 .cindex "&ACL;" "testing a recipient domain"
32331 .vindex "&$domain_data$&"
32332 This condition is relevant only in a RCPT ACL. It checks that the domain
32333 of the recipient address is in the domain list. If percent-hack processing is
32334 enabled, it is done before this test is done. If the check succeeds with a
32335 lookup, the result of the lookup is placed in &$domain_data$& until the next
32336 &%domains%& test.
32337
32338 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32339 use &%domains%& in a DATA ACL.
32340
32341
32342 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32343 .cindex "&%encrypted%& ACL condition"
32344 .cindex "encryption" "checking in an ACL"
32345 .cindex "&ACL;" "testing for encryption"
32346 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32347 name of the cipher suite in use is tested against the list. To test for
32348 encryption without testing for any specific cipher suite(s), set
32349 .code
32350 encrypted = *
32351 .endd
32352
32353
32354 .vitem &*hosts&~=&~*&<&'host&~list'&>
32355 .cindex "&%hosts%& ACL condition"
32356 .cindex "host" "ACL checking"
32357 .cindex "&ACL;" "testing the client host"
32358 This condition tests that the calling host matches the host list. If you have
32359 name lookups or wildcarded host names and IP addresses in the same host list,
32360 you should normally put the IP addresses first. For example, you could have:
32361 .code
32362 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32363 .endd
32364 The lookup in this example uses the host name for its key. This is implied by
32365 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32366 and it wouldn't matter which way round you had these two items.)
32367
32368 The reason for the problem with host names lies in the left-to-right way that
32369 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32370 but when it reaches an item that requires a host name, it fails if it cannot
32371 find a host name to compare with the pattern. If the above list is given in the
32372 opposite order, the &%accept%& statement fails for a host whose name cannot be
32373 found, even if its IP address is 10.9.8.7.
32374
32375 If you really do want to do the name check first, and still recognize the IP
32376 address even if the name lookup fails, you can rewrite the ACL like this:
32377 .code
32378 accept hosts = dbm;/etc/friendly/hosts
32379 accept hosts = 10.9.8.7
32380 .endd
32381 The default action on failing to find the host name is to assume that the host
32382 is not in the list, so the first &%accept%& statement fails. The second
32383 statement can then check the IP address.
32384
32385 .vindex "&$host_data$&"
32386 If a &%hosts%& condition is satisfied by means of a lookup, the result
32387 of the lookup is made available in the &$host_data$& variable. This
32388 allows you, for example, to set up a statement like this:
32389 .code
32390 deny  hosts = net-lsearch;/some/file
32391       message = $host_data
32392 .endd
32393 which gives a custom error message for each denied host.
32394
32395 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32396 .cindex "&%local_parts%& ACL condition"
32397 .cindex "local part" "ACL checking"
32398 .cindex "&ACL;" "testing a local part"
32399 .vindex "&$local_part_data$&"
32400 This condition is relevant only in a RCPT ACL. It checks that the local
32401 part of the recipient address is in the list. If percent-hack processing is
32402 enabled, it is done before this test. If the check succeeds with a lookup, the
32403 result of the lookup is placed in &$local_part_data$&, which remains set until
32404 the next &%local_parts%& test.
32405
32406 .vitem &*malware&~=&~*&<&'option'&>
32407 .cindex "&%malware%& ACL condition"
32408 .cindex "&ACL;" "virus scanning"
32409 .cindex "&ACL;" "scanning for viruses"
32410 This condition is available only when Exim is compiled with the
32411 content-scanning extension
32412 and only after a DATA command.
32413 It causes the incoming message to be scanned for
32414 viruses. For details, see chapter &<<CHAPexiscan>>&.
32415
32416 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32417 .cindex "&%mime_regex%& ACL condition"
32418 .cindex "&ACL;" "testing by regex matching"
32419 This condition is available only when Exim is compiled with the
32420 content-scanning extension, and it is allowed only in the ACL defined by
32421 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32422 with any of the regular expressions. For details, see chapter
32423 &<<CHAPexiscan>>&.
32424
32425 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32426 .cindex "rate limiting"
32427 This condition can be used to limit the rate at which a user or host submits
32428 messages. Details are given in section &<<SECTratelimiting>>&.
32429
32430 .vitem &*recipients&~=&~*&<&'address&~list'&>
32431 .cindex "&%recipients%& ACL condition"
32432 .cindex "recipient" "ACL checking"
32433 .cindex "&ACL;" "testing a recipient"
32434 This condition is relevant only in a RCPT ACL. It checks the entire
32435 recipient address against a list of recipients.
32436
32437 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32438 .cindex "&%regex%& ACL condition"
32439 .cindex "&ACL;" "testing by regex matching"
32440 This condition is available only when Exim is compiled with the
32441 content-scanning extension, and is available only in the DATA, MIME, and
32442 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32443 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32444
32445 .vitem &*seen&~=&~*&<&'parameters'&>
32446 .cindex "&%seen%& ACL condition"
32447 This condition can be used to test if a situation has been previously met,
32448 for example for greylisting.
32449 Details are given in section &<<SECTseen>>&.
32450
32451 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32452 .cindex "&%sender_domains%& ACL condition"
32453 .cindex "sender" "ACL checking"
32454 .cindex "&ACL;" "testing a sender domain"
32455 .vindex "&$domain$&"
32456 .vindex "&$sender_address_domain$&"
32457 This condition tests the domain of the sender of the message against the given
32458 domain list. &*Note*&: The domain of the sender address is in
32459 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32460 of this condition. This is an exception to the general rule for testing domain
32461 lists. It is done this way so that, if this condition is used in an ACL for a
32462 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32463 influence the sender checking.
32464
32465 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32466 relaying, because sender addresses are easily, and commonly, forged.
32467
32468 .vitem &*senders&~=&~*&<&'address&~list'&>
32469 .cindex "&%senders%& ACL condition"
32470 .cindex "sender" "ACL checking"
32471 .cindex "&ACL;" "testing a sender"
32472 This condition tests the sender of the message against the given list. To test
32473 for a bounce message, which has an empty sender, set
32474 .code
32475 senders = :
32476 .endd
32477 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32478 relaying, because sender addresses are easily, and commonly, forged.
32479
32480 .vitem &*spam&~=&~*&<&'username'&>
32481 .cindex "&%spam%& ACL condition"
32482 .cindex "&ACL;" "scanning for spam"
32483 This condition is available only when Exim is compiled with the
32484 content-scanning extension. It causes the incoming message to be scanned by
32485 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32486
32487 .vitem &*verify&~=&~certificate*&
32488 .cindex "&%verify%& ACL condition"
32489 .cindex "TLS" "client certificate verification"
32490 .cindex "certificate" "verification of client"
32491 .cindex "&ACL;" "certificate verification"
32492 .cindex "&ACL;" "testing a TLS certificate"
32493 This condition is true in an SMTP session if the session is encrypted, and a
32494 certificate was received from the client, and the certificate was verified. The
32495 server requests a certificate only if the client matches &%tls_verify_hosts%&
32496 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32497
32498 .vitem &*verify&~=&~csa*&
32499 .cindex "CSA verification"
32500 This condition checks whether the sending host (the client) is authorized to
32501 send email. Details of how this works are given in section
32502 &<<SECTverifyCSA>>&.
32503
32504 .vitem &*verify&~=&~header_names_ascii*&
32505 .cindex "&%verify%& ACL condition"
32506 .cindex "&ACL;" "verifying header names only ASCII"
32507 .cindex "header lines" "verifying header names only ASCII"
32508 .cindex "verifying" "header names only ASCII"
32509 This condition is relevant only in an ACL that is run after a message has been
32510 received.
32511 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32512 It checks all header names (not the content) to make sure
32513 there are no non-ASCII characters, also excluding control characters.  The
32514 allowable characters are decimal ASCII values 33 through 126.
32515
32516 Exim itself will handle headers with non-ASCII characters, but it can cause
32517 problems for downstream applications, so this option will allow their
32518 detection and rejection in the DATA ACL's.
32519
32520 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32521 .cindex "&%verify%& ACL condition"
32522 .cindex "&ACL;" "verifying sender in the header"
32523 .cindex "header lines" "verifying the sender in"
32524 .cindex "sender" "verifying in header"
32525 .cindex "verifying" "sender in header"
32526 This condition is relevant only in an ACL that is run after a message has been
32527 received, that is, in an ACL specified by &%acl_smtp_data%& or
32528 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32529 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32530 is loosely thought of as a &"sender"& address (hence the name of the test).
32531 However, an address that appears in one of these headers need not be an address
32532 that accepts bounce messages; only sender addresses in envelopes are required
32533 to accept bounces. Therefore, if you use the callout option on this check, you
32534 might want to arrange for a non-empty address in the MAIL command.
32535
32536 Details of address verification and the options are given later, starting at
32537 section &<<SECTaddressverification>>& (callouts are described in section
32538 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32539 condition to restrict it to bounce messages only:
32540 .code
32541 deny    senders = :
32542        !verify  = header_sender
32543         message = A valid sender header is required for bounces
32544 .endd
32545
32546 .vitem &*verify&~=&~header_syntax*&
32547 .cindex "&%verify%& ACL condition"
32548 .cindex "&ACL;" "verifying header syntax"
32549 .cindex "header lines" "verifying syntax"
32550 .cindex "verifying" "header syntax"
32551 This condition is relevant only in an ACL that is run after a message has been
32552 received, that is, in an ACL specified by &%acl_smtp_data%& or
32553 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32554 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32555 and &'Bcc:'&), returning true if there are no problems.
32556 Unqualified addresses (local parts without domains) are
32557 permitted only in locally generated messages and from hosts that match
32558 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32559 appropriate.
32560
32561 Note that this condition is a syntax check only. However, a common spamming
32562 ploy used to be to send syntactically invalid headers such as
32563 .code
32564 To: @
32565 .endd
32566 and this condition can be used to reject such messages, though they are not as
32567 common as they used to be.
32568
32569 .vitem &*verify&~=&~helo*&
32570 .cindex "&%verify%& ACL condition"
32571 .cindex "&ACL;" "verifying HELO/EHLO"
32572 .cindex "HELO" "verifying"
32573 .cindex "EHLO" "verifying"
32574 .cindex "verifying" "EHLO"
32575 .cindex "verifying" "HELO"
32576 This condition is true if a HELO or EHLO command has been received from the
32577 client host, and its contents have been verified. If there has been no previous
32578 attempt to verify the HELO/EHLO contents, it is carried out when this
32579 condition is encountered. See the description of the &%helo_verify_hosts%& and
32580 &%helo_try_verify_hosts%& options for details of how to request verification
32581 independently of this condition, and for detail of the verification.
32582
32583 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32584 option), this condition is always true.
32585
32586
32587 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32588 .cindex "verifying" "not blind"
32589 .cindex "bcc recipients, verifying none"
32590 This condition checks that there are no blind (bcc) recipients in the message.
32591 Every envelope recipient must appear either in a &'To:'& header line or in a
32592 &'Cc:'& header line for this condition to be true. Local parts are checked
32593 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32594 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32595 used only in a DATA or non-SMTP ACL.
32596
32597 There is one possible option, &`case_insensitive`&.  If this is present then
32598 local parts are checked case-insensitively.
32599
32600 There are, of course, many legitimate messages that make use of blind (bcc)
32601 recipients. This check should not be used on its own for blocking messages.
32602
32603
32604 .vitem &*verify&~=&~recipient/*&<&'options'&>
32605 .cindex "&%verify%& ACL condition"
32606 .cindex "&ACL;" "verifying recipient"
32607 .cindex "recipient" "verifying"
32608 .cindex "verifying" "recipient"
32609 .vindex "&$address_data$&"
32610 This condition is relevant only after a RCPT command. It verifies the current
32611 recipient. Details of address verification are given later, starting at section
32612 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32613 of &$address_data$& is the last value that was set while routing the address.
32614 This applies even if the verification fails. When an address that is being
32615 verified is redirected to a single address, verification continues with the new
32616 address, and in that case, the subsequent value of &$address_data$& is the
32617 value for the child address.
32618
32619 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32620 .cindex "&%verify%& ACL condition"
32621 .cindex "&ACL;" "verifying host reverse lookup"
32622 .cindex "host" "verifying reverse lookup"
32623 This condition ensures that a verified host name has been looked up from the IP
32624 address of the client host. (This may have happened already if the host name
32625 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32626 Verification ensures that the host name obtained from a reverse DNS lookup, or
32627 one of its aliases, does, when it is itself looked up in the DNS, yield the
32628 original IP address.
32629
32630 There is one possible option, &`defer_ok`&.  If this is present and a
32631 DNS operation returns a temporary error, the verify condition succeeds.
32632
32633 If this condition is used for a locally generated message (that is, when there
32634 is no client host involved), it always succeeds.
32635
32636 .vitem &*verify&~=&~sender/*&<&'options'&>
32637 .cindex "&%verify%& ACL condition"
32638 .cindex "&ACL;" "verifying sender"
32639 .cindex "sender" "verifying"
32640 .cindex "verifying" "sender"
32641 This condition is relevant only after a MAIL or RCPT command, or after a
32642 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32643 the message's sender is empty (that is, this is a bounce message), the
32644 condition is true. Otherwise, the sender address is verified.
32645
32646 .vindex "&$address_data$&"
32647 .vindex "&$sender_address_data$&"
32648 If there is data in the &$address_data$& variable at the end of routing, its
32649 value is placed in &$sender_address_data$& at the end of verification. This
32650 value can be used in subsequent conditions and modifiers in the same ACL
32651 statement. It does not persist after the end of the current statement. If you
32652 want to preserve the value for longer, you can save it in an ACL variable.
32653
32654 Details of verification are given later, starting at section
32655 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32656 to avoid doing it more than once per message.
32657
32658 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32659 .cindex "&%verify%& ACL condition"
32660 This is a variation of the previous option, in which a modified address is
32661 verified as a sender.
32662
32663 Note that '/' is legal in local-parts; if the address may have such
32664 (eg. is generated from the received message)
32665 they must be protected from the options parsing by doubling:
32666 .code
32667 verify = sender=${listquote{/}{${address:$h_sender:}}}
32668 .endd
32669 .endlist
32670
32671
32672
32673 .section "Using DNS lists" "SECTmorednslists"
32674 .cindex "DNS list" "in ACL"
32675 .cindex "black list (DNS)"
32676 .cindex "&ACL;" "testing a DNS list"
32677 In its simplest form, the &%dnslists%& condition tests whether the calling host
32678 is on at least one of a number of DNS lists by looking up the inverted IP
32679 address in one or more DNS domains. (Note that DNS list domains are not mail
32680 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32681 special options instead.) For example, if the calling host's IP
32682 address is 192.168.62.43, and the ACL statement is
32683 .code
32684 deny dnslists = blackholes.mail-abuse.org : \
32685                 dialups.mail-abuse.org
32686 .endd
32687 the following records are looked up:
32688 .code
32689 43.62.168.192.blackholes.mail-abuse.org
32690 43.62.168.192.dialups.mail-abuse.org
32691 .endd
32692 As soon as Exim finds an existing DNS record, processing of the list stops.
32693 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32694 to test that a host is on more than one list (an &"and"& conjunction), you can
32695 use two separate conditions:
32696 .code
32697 deny dnslists = blackholes.mail-abuse.org
32698      dnslists = dialups.mail-abuse.org
32699 .endd
32700 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32701 behaves as if the host does not match the list item, that is, as if the DNS
32702 record does not exist. If there are further items in the DNS list, they are
32703 processed.
32704
32705 This is usually the required action when &%dnslists%& is used with &%deny%&
32706 (which is the most common usage), because it prevents a DNS failure from
32707 blocking mail. However, you can change this behaviour by putting one of the
32708 following special items in the list:
32709 .itable none 0 0 2 25* left 75* left
32710 .irow "+include_unknown"   "behave as if the item is on the list"
32711 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32712 .irow "+defer_unknown  "   "give a temporary error"
32713 .endtable
32714 .cindex "&`+include_unknown`&"
32715 .cindex "&`+exclude_unknown`&"
32716 .cindex "&`+defer_unknown`&"
32717 Each of these applies to any subsequent items on the list. For example:
32718 .code
32719 deny dnslists = +defer_unknown : foo.bar.example
32720 .endd
32721 Testing the list of domains stops as soon as a match is found. If you want to
32722 warn for one list and block for another, you can use two different statements:
32723 .code
32724 deny  dnslists = blackholes.mail-abuse.org
32725 warn  dnslists = dialups.mail-abuse.org
32726       message  = X-Warn: sending host is on dialups list
32727 .endd
32728 .cindex caching "of dns lookup"
32729 .cindex DNS TTL
32730 DNS list lookups are cached by Exim for the duration of the SMTP session
32731 (but limited by the DNS return TTL value),
32732 so a lookup based on the IP address is done at most once for any incoming
32733 connection (assuming long-enough TTL).
32734 Exim does not share information between multiple incoming
32735 connections (but your local name server cache should be active).
32736
32737 There are a number of DNS lists to choose from, some commercial, some free,
32738 or free for small deployments.  An overview can be found at
32739 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32740
32741
32742
32743 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32744 .cindex "DNS list" "keyed by explicit IP address"
32745 By default, the IP address that is used in a DNS list lookup is the IP address
32746 of the calling host. However, you can specify another IP address by listing it
32747 after the domain name, introduced by a slash. For example:
32748 .code
32749 deny dnslists = black.list.tld/192.168.1.2
32750 .endd
32751 This feature is not very helpful with explicit IP addresses; it is intended for
32752 use with IP addresses that are looked up, for example, the IP addresses of the
32753 MX hosts or nameservers of an email sender address. For an example, see section
32754 &<<SECTmulkeyfor>>& below.
32755
32756
32757
32758
32759 .subsection "DNS lists keyed on domain names" SECID202
32760 .cindex "DNS list" "keyed by domain name"
32761 There are some lists that are keyed on domain names rather than inverted IP
32762 addresses (see, e.g., the &'domain based zones'& link at
32763 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32764 with these lists. You can change the name that is looked up in a DNS list by
32765 listing it after the domain name, introduced by a slash. For example,
32766 .code
32767 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32768       message  = Sender's domain is listed at $dnslist_domain
32769 .endd
32770 This particular example is useful only in ACLs that are obeyed after the
32771 RCPT or DATA commands, when a sender address is available. If (for
32772 example) the message's sender is &'user@tld.example'& the name that is looked
32773 up by this example is
32774 .code
32775 tld.example.dsn.rfc-ignorant.org
32776 .endd
32777 A single &%dnslists%& condition can contain entries for both names and IP
32778 addresses. For example:
32779 .code
32780 deny dnslists = sbl.spamhaus.org : \
32781                 dsn.rfc-ignorant.org/$sender_address_domain
32782 .endd
32783 The first item checks the sending host's IP address; the second checks a domain
32784 name. The whole condition is true if either of the DNS lookups succeeds.
32785
32786
32787
32788
32789 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32790 .cindex "DNS list" "multiple keys for"
32791 The syntax described above for looking up explicitly-defined values (either
32792 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32793 name for the DNS list, what follows the slash can in fact be a list of items.
32794 As with all lists in Exim, the default separator is a colon. However, because
32795 this is a sublist within the list of DNS blacklist domains, it is necessary
32796 either to double the separators like this:
32797 .code
32798 dnslists = black.list.tld/name.1::name.2
32799 .endd
32800 or to change the separator character, like this:
32801 .code
32802 dnslists = black.list.tld/<;name.1;name.2
32803 .endd
32804 If an item in the list is an IP address, it is inverted before the DNS
32805 blacklist domain is appended. If it is not an IP address, no inversion
32806 occurs. Consider this condition:
32807 .code
32808 dnslists = black.list.tld/<;192.168.1.2;a.domain
32809 .endd
32810 The DNS lookups that occur are:
32811 .code
32812 2.1.168.192.black.list.tld
32813 a.domain.black.list.tld
32814 .endd
32815 Once a DNS record has been found (that matches a specific IP return
32816 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32817 are done. If there is a temporary DNS error, the rest of the sublist of domains
32818 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32819 only if no other DNS lookup in this sublist succeeds. In other words, a
32820 successful lookup for any of the items in the sublist overrides a temporary
32821 error for a previous item.
32822
32823 The ability to supply a list of items after the slash is in some sense just a
32824 syntactic convenience. These two examples have the same effect:
32825 .code
32826 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32827 dnslists = black.list.tld/a.domain::b.domain
32828 .endd
32829 However, when the data for the list is obtained from a lookup, the second form
32830 is usually much more convenient. Consider this example:
32831 .code
32832 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32833                                    ${lookup dnsdb {>|mxh=\
32834                                    $sender_address_domain} }} }
32835      message  = The mail servers for the domain \
32836                 $sender_address_domain \
32837                 are listed at $dnslist_domain ($dnslist_value); \
32838                 see $dnslist_text.
32839 .endd
32840 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32841 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32842 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32843 of expanding the condition might be something like this:
32844 .code
32845 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32846 .endd
32847 Thus, this example checks whether or not the IP addresses of the sender
32848 domain's mail servers are on the Spamhaus black list.
32849
32850 The key that was used for a successful DNS list lookup is put into the variable
32851 &$dnslist_matched$& (see section &<<SECID204>>&).
32852
32853
32854
32855
32856 .subsection "Data returned by DNS lists" SECID203
32857 .cindex "DNS list" "data returned from"
32858 DNS lists are constructed using address records in the DNS. The original RBL
32859 just used the address 127.0.0.1 on the right hand side of each record, but the
32860 RBL+ list and some other lists use a number of values with different meanings.
32861 The values used on the RBL+ list are:
32862 .itable none 0 0 2 20* left 80* left
32863 .irow 127.1.0.1  "RBL"
32864 .irow 127.1.0.2  "DUL"
32865 .irow 127.1.0.3  "DUL and RBL"
32866 .irow 127.1.0.4  "RSS"
32867 .irow 127.1.0.5  "RSS and RBL"
32868 .irow 127.1.0.6  "RSS and DUL"
32869 .irow 127.1.0.7  "RSS and DUL and RBL"
32870 .endtable
32871 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32872 different values. Some DNS lists may return more than one address record;
32873 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32874
32875 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32876 range. If a DNSBL operator loses control of the domain, lookups on it
32877 may start returning other addresses.  Because of this, Exim now ignores
32878 returned values outside the 127/8 region.
32879
32880
32881 .subsection "Variables set from DNS lists" SECID204
32882 .cindex "expansion" "variables, set from DNS list"
32883 .cindex "DNS list" "variables set from"
32884 .vindex "&$dnslist_domain$&"
32885 .vindex "&$dnslist_matched$&"
32886 .vindex "&$dnslist_text$&"
32887 .vindex "&$dnslist_value$&"
32888 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32889 the name of the overall domain that matched (for example,
32890 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32891 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32892 the DNS record. When the key is an IP address, it is not reversed in
32893 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32894 cases, for example:
32895 .code
32896 deny dnslists = spamhaus.example
32897 .endd
32898 the key is also available in another variable (in this case,
32899 &$sender_host_address$&). In more complicated cases, however, this is not true.
32900 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32901 might generate a dnslists lookup like this:
32902 .code
32903 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32904 .endd
32905 If this condition succeeds, the value in &$dnslist_matched$& might be
32906 &`192.168.6.7`& (for example).
32907
32908 If more than one address record is returned by the DNS lookup, all the IP
32909 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32910 The variable &$dnslist_text$& contains the contents of any associated TXT
32911 record. For lists such as RBL+ the TXT record for a merged entry is often not
32912 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32913 information.
32914
32915 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32916 &-- even if these appear before the condition in the ACL, they are not
32917 expanded until after it has failed. For example:
32918 .code
32919 deny    hosts = !+local_networks
32920         message = $sender_host_address is listed \
32921                   at $dnslist_domain
32922         dnslists = rbl-plus.mail-abuse.example
32923 .endd
32924
32925
32926
32927 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32928 .cindex "DNS list" "matching specific returned data"
32929 You can add an equals sign and an IP address after a &%dnslists%& domain name
32930 in order to restrict its action to DNS records with a matching right hand side.
32931 For example,
32932 .code
32933 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32934 .endd
32935 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32936 any address record is considered to be a match. For the moment, we assume
32937 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32938 describes how multiple records are handled.
32939
32940 More than one IP address may be given for checking, using a comma as a
32941 separator. These are alternatives &-- if any one of them matches, the
32942 &%dnslists%& condition is true. For example:
32943 .code
32944 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32945 .endd
32946 If you want to specify a constraining address list and also specify names or IP
32947 addresses to be looked up, the constraining address list must be specified
32948 first. For example:
32949 .code
32950 deny dnslists = dsn.rfc-ignorant.org\
32951                 =127.0.0.2/$sender_address_domain
32952 .endd
32953
32954 If the character &`&&`& is used instead of &`=`&, the comparison for each
32955 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32956 In other words, the listed addresses are used as bit masks. The comparison is
32957 true if all the bits in the mask are present in the address that is being
32958 tested. For example:
32959 .code
32960 dnslists = a.b.c&0.0.0.3
32961 .endd
32962 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32963 want to test whether one bit or another bit is present (as opposed to both
32964 being present), you must use multiple values. For example:
32965 .code
32966 dnslists = a.b.c&0.0.0.1,0.0.0.2
32967 .endd
32968 matches if the final component of the address is an odd number or two times
32969 an odd number.
32970
32971
32972
32973 .subsection "Negated DNS matching conditions" SECID205
32974 You can supply a negative list of IP addresses as part of a &%dnslists%&
32975 condition. Whereas
32976 .code
32977 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32978 .endd
32979 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32980 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32981 .code
32982 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32983 .endd
32984 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32985 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32986 words, the result of the test is inverted if an exclamation mark appears before
32987 the &`=`& (or the &`&&`&) sign.
32988
32989 &*Note*&: This kind of negation is not the same as negation in a domain,
32990 host, or address list (which is why the syntax is different).
32991
32992 If you are using just one list, the negation syntax does not gain you much. The
32993 previous example is precisely equivalent to
32994 .code
32995 deny  dnslists = a.b.c
32996      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32997 .endd
32998 However, if you are using multiple lists, the negation syntax is clearer.
32999 Consider this example:
33000 .code
33001 deny  dnslists = sbl.spamhaus.org : \
33002                  list.dsbl.org : \
33003                  dnsbl.njabl.org!=127.0.0.3 : \
33004                  relays.ordb.org
33005 .endd
33006 Using only positive lists, this would have to be:
33007 .code
33008 deny  dnslists = sbl.spamhaus.org : \
33009                  list.dsbl.org
33010 deny  dnslists = dnsbl.njabl.org
33011      !dnslists = dnsbl.njabl.org=127.0.0.3
33012 deny  dnslists = relays.ordb.org
33013 .endd
33014 which is less clear, and harder to maintain.
33015
33016 Negation can also be used with a bitwise-and restriction.
33017 The dnslists condition with only be trus if a result is returned
33018 by the lookup which, anded with the restriction, is all zeroes.
33019 For example:
33020 .code
33021 deny dnslists = zen.spamhaus.org!&0.255.255.0
33022 .endd
33023
33024
33025
33026
33027 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33028 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33029 thereby providing more than one IP address. When an item in a &%dnslists%& list
33030 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33031 the match to specific results from the DNS lookup, there are two ways in which
33032 the checking can be handled. For example, consider the condition:
33033 .code
33034 dnslists = a.b.c=127.0.0.1
33035 .endd
33036 What happens if the DNS lookup for the incoming IP address yields both
33037 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33038 condition true because at least one given value was found, or is it false
33039 because at least one of the found values was not listed? And how does this
33040 affect negated conditions? Both possibilities are provided for with the help of
33041 additional separators &`==`& and &`=&&`&.
33042
33043 .ilist
33044 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33045 IP addresses matches one of the listed addresses. For the example above, the
33046 condition is true because 127.0.0.1 matches.
33047 .next
33048 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33049 looked up IP addresses matches one of the listed addresses. If the condition is
33050 changed to:
33051 .code
33052 dnslists = a.b.c==127.0.0.1
33053 .endd
33054 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33055 false because 127.0.0.2 is not listed. You would need to have:
33056 .code
33057 dnslists = a.b.c==127.0.0.1,127.0.0.2
33058 .endd
33059 for the condition to be true.
33060 .endlist
33061
33062 When &`!`& is used to negate IP address matching, it inverts the result, giving
33063 the precise opposite of the behaviour above. Thus:
33064 .ilist
33065 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33066 addresses matches one of the listed addresses. Consider:
33067 .code
33068 dnslists = a.b.c!&0.0.0.1
33069 .endd
33070 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33071 false because 127.0.0.1 matches.
33072 .next
33073 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33074 looked up IP address that does not match. Consider:
33075 .code
33076 dnslists = a.b.c!=&0.0.0.1
33077 .endd
33078 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33079 true, because 127.0.0.2 does not match. You would need to have:
33080 .code
33081 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33082 .endd
33083 for the condition to be false.
33084 .endlist
33085 When the DNS lookup yields only a single IP address, there is no difference
33086 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33087
33088
33089
33090
33091 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33092 .cindex "DNS list" "information from merged"
33093 When the facility for restricting the matching IP values in a DNS list is used,
33094 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33095 the true reason for rejection. This happens when lists are merged and the IP
33096 address in the A record is used to distinguish them; unfortunately there is
33097 only one TXT record. One way round this is not to use merged lists, but that
33098 can be inefficient because it requires multiple DNS lookups where one would do
33099 in the vast majority of cases when the host of interest is not on any of the
33100 lists.
33101
33102 A less inefficient way of solving this problem is available. If
33103 two domain names, comma-separated, are given, the second is used first to
33104 do an initial check, making use of any IP value restrictions that are set.
33105 If there is a match, the first domain is used, without any IP value
33106 restrictions, to get the TXT record. As a byproduct of this, there is also
33107 a check that the IP being tested is indeed on the first list. The first
33108 domain is the one that is put in &$dnslist_domain$&. For example:
33109 .code
33110 deny   dnslists = \
33111          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33112          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33113        message  = \
33114          rejected because $sender_host_address is blacklisted \
33115          at $dnslist_domain\n$dnslist_text
33116 .endd
33117 For the first blacklist item, this starts by doing a lookup in
33118 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33119 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33120 value, and as long as something is found, it looks for the corresponding TXT
33121 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33122 The second blacklist item is processed similarly.
33123
33124 If you are interested in more than one merged list, the same list must be
33125 given several times, but because the results of the DNS lookups are cached,
33126 the DNS calls themselves are not repeated. For example:
33127 .code
33128 deny dnslists = \
33129          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33130          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33131          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33132          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33133 .endd
33134 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33135 values matches (or if no record is found), this is the only lookup that is
33136 done. Only if there is a match is one of the more specific lists consulted.
33137
33138
33139
33140 .subsection "DNS lists and IPv6" SECTmorednslistslast
33141 .cindex "IPv6" "DNS black lists"
33142 .cindex "DNS list" "IPv6 usage"
33143 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33144 nibble by nibble. For example, if the calling host's IP address is
33145 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33146 .code
33147 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33148   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33149 .endd
33150 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33151 lists contain wildcard records, intended for IPv4, that interact badly with
33152 IPv6. For example, the DNS entry
33153 .code
33154 *.3.some.list.example.    A    127.0.0.1
33155 .endd
33156 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33157 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33158
33159 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33160 &%condition%& condition, as in this example:
33161 .code
33162 deny   condition = ${if isip4{$sender_host_address}}
33163        dnslists  = some.list.example
33164 .endd
33165
33166 If an explicit key is being used for a DNS lookup and it may be an IPv6
33167 address you should specify alternate list separators for both the outer
33168 (DNS list name) list and inner (lookup keys) list:
33169 .code
33170        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33171 .endd
33172
33173
33174 .section "Previously seen user and hosts" "SECTseen"
33175 .cindex "&%seen%& ACL condition"
33176 .cindex greylisting
33177 The &%seen%& ACL condition can be used to test whether a
33178 situation has been previously met.
33179 It uses a hints database to record a timestamp against a key.
33180 The syntax of the condition is:
33181 .display
33182 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33183 .endd
33184
33185 For example,
33186 .code
33187 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33188 .endd
33189 in a RCPT ACL will implement simple greylisting.
33190
33191 The parameters for the condition are
33192 a possible minus sign,
33193 then an interval,
33194 then, slash-separated, a list of options.
33195 The interval is taken as an offset before the current time,
33196 and used for the test.
33197 If the interval is preceded by a minus sign then the condition returns
33198 whether a record is found which is before the test time.
33199 Otherwise, the condition returns whether one is found which is since the
33200 test time.
33201
33202 Options are read in order with later ones overriding earlier ones.
33203
33204 The default key is &$sender_host_address$&.
33205 An explicit key can be set using a &%key=value%& option.
33206
33207 If a &%readonly%& option is given then
33208 no record create or update is done.
33209 If a &%write%& option is given then
33210 a record create or update is always done.
33211 An update is done if the test is for &"since"&.
33212 If none of those hold and there was no existing record,
33213 a record is created.
33214
33215 Creates and updates are marked with the current time.
33216
33217 Finally, a &"before"& test which succeeds, and for which the record
33218 is old enough, will be refreshed with a timestamp of the test time.
33219 This can prevent tidying of the database from removing the entry.
33220 The interval for this is, by default, 10 days.
33221 An explicit interval can be set using a
33222 &%refresh=value%& option.
33223
33224 Note that &"seen"& should be added to the list of hints databases
33225 for maintenance if this ACL condition is used.
33226
33227
33228 .section "Rate limiting incoming messages" "SECTratelimiting"
33229 .cindex "rate limiting" "client sending"
33230 .cindex "limiting client sending rates"
33231 .oindex "&%smtp_ratelimit_*%&"
33232 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33233 which clients can send email. This is more powerful than the
33234 &%smtp_ratelimit_*%& options, because those options control the rate of
33235 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33236 works across all connections (concurrent and sequential) from the same client
33237 host. The syntax of the &%ratelimit%& condition is:
33238 .display
33239 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33240 .endd
33241 If the average client sending rate is less than &'m'& messages per time
33242 period &'p'& then the condition is false; otherwise it is true.
33243
33244 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33245 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33246 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33247 of &'p'&.
33248
33249 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33250 time interval, for example, &`8h`& for eight hours. A larger time constant
33251 means that it takes Exim longer to forget a client's past behaviour. The
33252 parameter &'m'& is the maximum number of messages that a client is permitted to
33253 send in each time interval. It also specifies the number of messages permitted
33254 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33255 constant, you can allow a client to send more messages in a burst without
33256 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33257 both small, messages must be sent at an even rate.
33258
33259 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33260 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33261 when deploying the &%ratelimit%& ACL condition. The script prints usage
33262 instructions when it is run with no arguments.
33263
33264 The key is used to look up the data for calculating the client's average
33265 sending rate. This data is stored in Exim's spool directory, alongside the
33266 retry and other hints databases. The default key is &$sender_host_address$&,
33267 which means Exim computes the sending rate of each client host IP address.
33268 By changing the key you can change how Exim identifies clients for the purpose
33269 of ratelimiting. For example, to limit the sending rate of each authenticated
33270 user, independent of the computer they are sending from, set the key to
33271 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33272 example, &$authenticated_id$& is only meaningful if the client has
33273 authenticated (which you can check with the &%authenticated%& ACL condition).
33274
33275 The lookup key does not have to identify clients: If you want to limit the
33276 rate at which a recipient receives messages, you can use the key
33277 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33278 ACL.
33279
33280 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33281 specifies what Exim measures the rate of, for example, messages or recipients
33282 or bytes. You can adjust the measurement using the &%unique=%& and/or
33283 &%count=%& options. You can also control when Exim updates the recorded rate
33284 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33285 separated by a slash, like the other parameters. They may appear in any order.
33286
33287 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33288 any options that alter the meaning of the stored data. The limit &'m'& is not
33289 stored, so you can alter the configured maximum rate and Exim will still
33290 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33291 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33292 behaviour. The lookup key is not affected by changes to the update mode and
33293 the &%count=%& option.
33294
33295
33296 .subsection "Ratelimit options for what is being measured" ratoptmea
33297 .cindex "rate limiting" "per_* options"
33298 .vlist
33299 .vitem per_conn
33300 .cindex "rate limiting" per_conn
33301 This option limits the client's connection rate. It is not
33302 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33303 &%acl_not_smtp_start%& ACLs.
33304
33305 .vitem per_mail
33306 .cindex "rate limiting" per_conn
33307 This option limits the client's rate of sending messages. This is
33308 the default if none of the &%per_*%& options is specified. It can be used in
33309 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33310 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33311
33312 .vitem per_byte
33313 .cindex "rate limiting" per_conn
33314 This option limits the sender's email bandwidth. It can be used in
33315 the same ACLs as the &%per_mail%& option, though it is best to use this option
33316 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33317 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33318 in its MAIL command, which may be inaccurate or completely missing. You can
33319 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33320 in kilobytes, megabytes, or gigabytes, respectively.
33321
33322 .vitem per_rcpt
33323 .cindex "rate limiting" per_rcpt
33324 This option causes Exim to limit the rate at which recipients are
33325 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33326 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33327 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33328 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33329 in either case the rate limiting engine will see a message with many
33330 recipients as a large high-speed burst.
33331
33332 .vitem per_addr
33333 .cindex "rate limiting" per_addr
33334 This option is like the &%per_rcpt%& option, except it counts the
33335 number of different recipients that the client has sent messages to in the
33336 last time period. That is, if the client repeatedly sends messages to the same
33337 recipient, its measured rate is not increased. This option can only be used in
33338 &%acl_smtp_rcpt%&.
33339
33340 .vitem per_cmd
33341 .cindex "rate limiting" per_cmd
33342 This option causes Exim to recompute the rate every time the
33343 condition is processed. This can be used to limit the rate of any SMTP
33344 command. If it is used in multiple ACLs it can limit the aggregate rate of
33345 multiple different commands.
33346
33347 .vitem count
33348 .cindex "rate limiting" count
33349 This option can be used to alter how much Exim adds to the client's
33350 measured rate.
33351 A value is required, after an equals sign.
33352 For example, the &%per_byte%& option is equivalent to
33353 &`per_mail/count=$message_size`&.
33354 If there is no &%count=%& option, Exim
33355 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33356 other than &%acl_smtp_rcpt%&).
33357 The count does not have to be an integer.
33358
33359 .vitem unique
33360 .cindex "rate limiting" unique
33361 This option is described in section &<<ratoptuniq>>& below.
33362 .endlist
33363
33364
33365 .subsection "Ratelimit update modes" ratoptupd
33366 .cindex "rate limiting" "reading data without updating"
33367 You can specify one of three options with the &%ratelimit%& condition to
33368 control when its database is updated. This section describes the &%readonly%&
33369 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33370
33371 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33372 previously-computed rate to check against the limit.
33373
33374 For example, you can test the client's sending rate and deny it access (when
33375 it is too fast) in the connect ACL. If the client passes this check then it
33376 can go on to send a message, in which case its recorded rate will be updated
33377 in the MAIL ACL. Subsequent connections from the same client will check this
33378 new rate.
33379 .code
33380 acl_check_connect:
33381  deny ratelimit = 100 / 5m / readonly
33382       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33383                   (max $sender_rate_limit)
33384 # ...
33385 acl_check_mail:
33386  warn ratelimit = 100 / 5m / strict
33387       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33388                   (max $sender_rate_limit)
33389 .endd
33390
33391 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33392 processing a message then it may increase the client's measured rate more than
33393 it should. For example, this will happen if you check the &%per_rcpt%& option
33394 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33395 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33396 multiple update problems by using the &%readonly%& option on later ratelimit
33397 checks.
33398
33399 The &%per_*%& options described above do not make sense in some ACLs. If you
33400 use a &%per_*%& option in an ACL where it is not normally permitted then the
33401 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33402 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33403 next section) so you must specify the &%readonly%& option explicitly.
33404
33405
33406 .subsection "Ratelimit options for handling fast clients" ratoptfast
33407 .cindex "rate limiting" "strict and leaky modes"
33408 If a client's average rate is greater than the maximum, the rate limiting
33409 engine can react in two possible ways, depending on the presence of the
33410 &%strict%& or &%leaky%& update modes. This is independent of the other
33411 counter-measures (such as rejecting the message) that may be specified by the
33412 rest of the ACL.
33413
33414 The &%leaky%& (default) option means that the client's recorded rate is not
33415 updated if it is above the limit. The effect of this is that Exim measures the
33416 client's average rate of successfully sent email,
33417 up to the given limit.
33418 This is appropriate if the countermeasure when the condition is true
33419 consists of refusing the message, and
33420 is generally the better choice if you have clients that retry automatically.
33421 If the action when true is anything more complex then this option is
33422 likely not what is wanted.
33423
33424 The &%strict%& option means that the client's recorded rate is always
33425 updated. The effect of this is that Exim measures the client's average rate
33426 of attempts to send email, which can be much higher than the maximum it is
33427 actually allowed. If the client is over the limit it may be subjected to
33428 counter-measures by the ACL. It must slow down and allow sufficient time to
33429 pass that its computed rate falls below the maximum before it can send email
33430 again. The time (the number of smoothing periods) it must wait and not
33431 attempt to send mail can be calculated with this formula:
33432 .code
33433         ln(peakrate/maxrate)
33434 .endd
33435
33436
33437 .subsection "Limiting the rate of different events" ratoptuniq
33438 .cindex "rate limiting" "counting unique events"
33439 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33440 rate of different events. For example, the &%per_addr%& option uses this
33441 mechanism to count the number of different recipients that the client has
33442 sent messages to in the last time period; it is equivalent to
33443 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33444 measure the rate that a client uses different sender addresses with the
33445 options &`per_mail/unique=$sender_address`&.
33446
33447 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33448 has seen for that key. The whole set is thrown away when it is older than the
33449 rate smoothing period &'p'&, so each different event is counted at most once
33450 per period. In the &%leaky%& update mode, an event that causes the client to
33451 go over the limit is not added to the set, in the same way that the client's
33452 recorded rate is not updated in the same situation.
33453
33454 When you combine the &%unique=%& and &%readonly%& options, the specific
33455 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33456 rate.
33457
33458 The &%unique=%& mechanism needs more space in the ratelimit database than the
33459 other &%ratelimit%& options in order to store the event set. The number of
33460 unique values is potentially as large as the rate limit, so the extra space
33461 required increases with larger limits.
33462
33463 The uniqueification is not perfect: there is a small probability that Exim
33464 will think a new event has happened before. If the sender's rate is less than
33465 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33466 the measured rate can go above the limit, in which case Exim may under-count
33467 events by a significant margin. Fortunately, if the rate is high enough (2.7
33468 times the limit) that the false positive rate goes above 9%, then Exim will
33469 throw away the over-full event set before the measured rate falls below the
33470 limit. Therefore the only harm should be that exceptionally high sending rates
33471 are logged incorrectly; any countermeasures you configure will be as effective
33472 as intended.
33473
33474
33475 .subsection "Using rate limiting" useratlim
33476 Exim's other ACL facilities are used to define what counter-measures are taken
33477 when the rate limit is exceeded. This might be anything from logging a warning
33478 (for example, while measuring existing sending rates in order to define
33479 policy), through time delays to slow down fast senders, up to rejecting the
33480 message. For example:
33481 .code
33482 # Log all senders' rates
33483 warn ratelimit = 0 / 1h / strict
33484      log_message = Sender rate $sender_rate / $sender_rate_period
33485
33486 # Slow down fast senders; note the need to truncate $sender_rate
33487 # at the decimal point.
33488 warn ratelimit = 100 / 1h / per_rcpt / strict
33489      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33490                    $sender_rate_limit }s
33491
33492 # Keep authenticated users under control
33493 deny authenticated = *
33494      ratelimit = 100 / 1d / strict / $authenticated_id
33495
33496 # System-wide rate limit
33497 defer ratelimit = 10 / 1s / $primary_hostname
33498       message = Sorry, too busy. Try again later.
33499
33500 # Restrict incoming rate from each host, with a default
33501 # set using a macro and special cases looked up in a table.
33502 defer ratelimit = ${lookup {$sender_host_address} \
33503                    cdb {DB/ratelimits.cdb} \
33504                    {$value} {RATELIMIT} }
33505       message = Sender rate exceeds $sender_rate_limit \
33506                messages per $sender_rate_period
33507 .endd
33508 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33509 especially with the &%per_rcpt%& option, you may suffer from a performance
33510 bottleneck caused by locking on the ratelimit hints database. Apart from
33511 making your ACLs less complicated, you can reduce the problem by using a
33512 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33513 this means that Exim will lose its hints data after a reboot (including retry
33514 hints, the callout cache, and ratelimit data).
33515
33516
33517
33518 .section "Address verification" "SECTaddressverification"
33519 .cindex "verifying address" "options for"
33520 .cindex "policy control" "address verification"
33521 Several of the &%verify%& conditions described in section
33522 &<<SECTaclconditions>>& cause addresses to be verified. Section
33523 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33524 The verification conditions can be followed by options that modify the
33525 verification process. The options are separated from the keyword and from each
33526 other by slashes, and some of them contain parameters. For example:
33527 .code
33528 verify = sender/callout
33529 verify = recipient/defer_ok/callout=10s,defer_ok
33530 .endd
33531 The first stage of address verification, which always happens, is to run the
33532 address through the routers, in &"verify mode"&. Routers can detect the
33533 difference between verification and routing for delivery, and their actions can
33534 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33535 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33536 The available options are as follows:
33537
33538 .ilist
33539 If the &%callout%& option is specified, successful routing to one or more
33540 remote hosts is followed by a &"callout"& to those hosts as an additional
33541 check. Callouts and their sub-options are discussed in the next section.
33542 .next
33543 If there is a defer error while doing verification routing, the ACL
33544 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33545 options, the condition is forced to be true instead. Note that this is a main
33546 verification option as well as a suboption for callouts.
33547 .next
33548 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33549 discusses the reporting of sender address verification failures.
33550 .next
33551 The &%success_on_redirect%& option causes verification always to succeed
33552 immediately after a successful redirection. By default, if a redirection
33553 generates just one address, that address is also verified. See further
33554 discussion in section &<<SECTredirwhilveri>>&.
33555 .next
33556 If the &%quota%& option is specified for recipient verify,
33557 successful routing to an appendfile transport is followed by a call into
33558 the transport to evaluate the quota status for the recipient.
33559 No actual delivery is done, but verification will succeed if the quota
33560 is sufficient for the message (if the sender gave a message size) or
33561 not already exceeded (otherwise).
33562 .endlist
33563
33564 .cindex "verifying address" "differentiating failures"
33565 .vindex "&$recipient_verify_failure$&"
33566 .vindex "&$sender_verify_failure$&"
33567 .vindex "&$acl_verify_message$&"
33568 After an address verification failure, &$acl_verify_message$& contains the
33569 error message that is associated with the failure. It can be preserved by
33570 coding like this:
33571 .code
33572 warn  !verify = sender
33573        set acl_m0 = $acl_verify_message
33574 .endd
33575 If you are writing your own custom rejection message or log message when
33576 denying access, you can use this variable to include information about the
33577 verification failure.
33578 This variable is cleared at the end of processing the ACL verb.
33579
33580 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33581 appropriate) contains one of the following words:
33582
33583 .ilist
33584 &%qualify%&: The address was unqualified (no domain), and the message
33585 was neither local nor came from an exempted host.
33586 .next
33587 &%route%&: Routing failed.
33588 .next
33589 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33590 occurred at or before the MAIL command (that is, on initial
33591 connection, HELO, or MAIL).
33592 .next
33593 &%recipient%&: The RCPT command in a callout was rejected.
33594 .next
33595 &%postmaster%&: The postmaster check in a callout was rejected.
33596 .next
33597 &%quota%&: The quota check for a local recipient did non pass.
33598 .endlist
33599
33600 The main use of these variables is expected to be to distinguish between
33601 rejections of MAIL and rejections of RCPT in callouts.
33602
33603 The above variables may also be set after a &*successful*&
33604 address verification to:
33605
33606 .ilist
33607 &%random%&: A random local-part callout succeeded
33608 .endlist
33609
33610
33611
33612
33613 .section "Callout verification" "SECTcallver"
33614 .cindex "verifying address" "by callout"
33615 .cindex "callout" "verification"
33616 .cindex "SMTP" "callout verification"
33617 For non-local addresses, routing verifies the domain, but is unable to do any
33618 checking of the local part. There are situations where some means of verifying
33619 the local part is desirable. One way this can be done is to make an SMTP
33620 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33621 a subsequent host for a recipient address, to see if the host accepts the
33622 address. We use the term &'callout'& to cover both cases. Note that for a
33623 sender address, the callback is not to the client host that is trying to
33624 deliver the message, but to one of the hosts that accepts incoming mail for the
33625 sender's domain.
33626
33627 Exim does not do callouts by default. If you want them to happen, you must
33628 request them by setting appropriate options on the &%verify%& condition, as
33629 described below. This facility should be used with care, because it can add a
33630 lot of resource usage to the cost of verifying an address. However, Exim does
33631 cache the results of callouts, which helps to reduce the cost. Details of
33632 caching are in section &<<SECTcallvercache>>&.
33633
33634 Recipient callouts are usually used only between hosts that are controlled by
33635 the same administration. For example, a corporate gateway host could use
33636 callouts to check for valid recipients on an internal mailserver. A successful
33637 callout does not guarantee that a real delivery to the address would succeed;
33638 on the other hand, a failing callout does guarantee that a delivery would fail.
33639
33640 If the &%callout%& option is present on a condition that verifies an address, a
33641 second stage of verification occurs if the address is successfully routed to
33642 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33643 &(manualroute)& router, where the router specifies the hosts. However, if a
33644 router that does not set up hosts routes to an &(smtp)& transport with a
33645 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33646 &%hosts_override%& set, its hosts are always used, whether or not the router
33647 supplies a host list.
33648 Callouts are only supported on &(smtp)& transports.
33649
33650 The port that is used is taken from the transport, if it is specified and is a
33651 remote transport. (For routers that do verification only, no transport need be
33652 specified.) Otherwise, the default SMTP port is used. If a remote transport
33653 specifies an outgoing interface, this is used; otherwise the interface is not
33654 specified. Likewise, the text that is used for the HELO command is taken from
33655 the transport's &%helo_data%& option; if there is no transport, the value of
33656 &$smtp_active_hostname$& is used.
33657
33658 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33659 test whether a bounce message could be delivered to the sender address. The
33660 following SMTP commands are sent:
33661 .display
33662 &`HELO `&<&'local host name'&>
33663 &`MAIL FROM:<>`&
33664 &`RCPT TO:`&<&'the address to be tested'&>
33665 &`QUIT`&
33666 .endd
33667 LHLO is used instead of HELO if the transport's &%protocol%& option is
33668 set to &"lmtp"&.
33669
33670 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33671 settings.
33672
33673 A recipient callout check is similar. By default, it also uses an empty address
33674 for the sender. This default is chosen because most hosts do not make use of
33675 the sender address when verifying a recipient. Using the same address means
33676 that a single cache entry can be used for each recipient. Some sites, however,
33677 do make use of the sender address when verifying. These are catered for by the
33678 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33679
33680 If the response to the RCPT command is a 2&'xx'& code, the verification
33681 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33682 Exim tries the next host, if any. If there is a problem with all the remote
33683 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33684 &%callout%& option is given, in which case the condition is forced to succeed.
33685
33686 .cindex "SMTP" "output flushing, disabling for callout"
33687 A callout may take a little time. For this reason, Exim normally flushes SMTP
33688 output before performing a callout in an ACL, to avoid unexpected timeouts in
33689 clients when the SMTP PIPELINING extension is in use. The flushing can be
33690 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33691
33692 .cindex "tainted data" "de-tainting"
33693 .cindex "de-tainting" "using recipient verify"
33694 A recipient callout which gets a 2&'xx'& code
33695 will assign untainted values to the
33696 &$domain_data$& and &$local_part_data$& variables,
33697 corresponding to the domain and local parts of the recipient address.
33698
33699
33700
33701
33702 .subsection "Additional parameters for callouts" CALLaddparcall
33703 .cindex "callout" "additional parameters for"
33704 The &%callout%& option can be followed by an equals sign and a number of
33705 optional parameters, separated by commas. For example:
33706 .code
33707 verify = recipient/callout=10s,defer_ok
33708 .endd
33709 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33710 separate verify options, is retained for backwards compatibility, but is now
33711 deprecated. The additional parameters for &%callout%& are as follows:
33712
33713
33714 .vlist
33715 .vitem <&'a&~time&~interval'&>
33716 .cindex "callout" "timeout, specifying"
33717 This specifies the timeout that applies for the callout attempt to each host.
33718 For example:
33719 .code
33720 verify = sender/callout=5s
33721 .endd
33722 The default is 30 seconds. The timeout is used for each response from the
33723 remote host. It is also used for the initial connection, unless overridden by
33724 the &%connect%& parameter.
33725
33726
33727 .vitem &*connect&~=&~*&<&'time&~interval'&>
33728 .cindex "callout" "connection timeout, specifying"
33729 This parameter makes it possible to set a different (usually smaller) timeout
33730 for making the SMTP connection. For example:
33731 .code
33732 verify = sender/callout=5s,connect=1s
33733 .endd
33734 If not specified, this timeout defaults to the general timeout value.
33735
33736 .vitem &*defer_ok*&
33737 .cindex "callout" "defer, action on"
33738 When this parameter is present, failure to contact any host, or any other kind
33739 of temporary error, is treated as success by the ACL. However, the cache is not
33740 updated in this circumstance.
33741
33742 .vitem &*fullpostmaster*&
33743 .cindex "callout" "full postmaster check"
33744 This operates like the &%postmaster%& option (see below), but if the check for
33745 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33746 accordance with the specification in RFC 2821. The RFC states that the
33747 unqualified address &'postmaster'& should be accepted.
33748
33749
33750 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33751 .cindex "callout" "sender when verifying header"
33752 When verifying addresses in header lines using the &%header_sender%&
33753 verification option, Exim behaves by default as if the addresses are envelope
33754 sender addresses from a message. Callout verification therefore tests to see
33755 whether a bounce message could be delivered, by using an empty address in the
33756 MAIL command. However, it is arguable that these addresses might never be used
33757 as envelope senders, and could therefore justifiably reject bounce messages
33758 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33759 address to use in the MAIL command. For example:
33760 .code
33761 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33762 .endd
33763 This parameter is available only for the &%header_sender%& verification option.
33764
33765
33766 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33767 .cindex "callout" "overall timeout, specifying"
33768 This parameter sets an overall timeout for performing a callout verification.
33769 For example:
33770 .code
33771 verify = sender/callout=5s,maxwait=30s
33772 .endd
33773 This timeout defaults to four times the callout timeout for individual SMTP
33774 commands. The overall timeout applies when there is more than one host that can
33775 be tried. The timeout is checked before trying the next host. This prevents
33776 very long delays if there are a large number of hosts and all are timing out
33777 (for example, when network connections are timing out).
33778
33779
33780 .vitem &*no_cache*&
33781 .cindex "callout" "cache, suppressing"
33782 .cindex "caching callout, suppressing"
33783 When this parameter is given, the callout cache is neither read nor updated.
33784
33785 .vitem &*postmaster*&
33786 .cindex "callout" "postmaster; checking"
33787 When this parameter is set, a successful callout check is followed by a similar
33788 check for the local part &'postmaster'& at the same domain. If this address is
33789 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33790 the postmaster check is recorded in a cache record; if it is a failure, this is
33791 used to fail subsequent callouts for the domain without a connection being
33792 made, until the cache record expires.
33793
33794 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33795 The postmaster check uses an empty sender in the MAIL command by default.
33796 You can use this parameter to do a postmaster check using a different address.
33797 For example:
33798 .code
33799 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33800 .endd
33801 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33802 one overrides. The &%postmaster%& parameter is equivalent to this example:
33803 .code
33804 require  verify = sender/callout=postmaster_mailfrom=
33805 .endd
33806 &*Warning*&: The caching arrangements for postmaster checking do not take
33807 account of the sender address. It is assumed that either the empty address or
33808 a fixed non-empty address will be used. All that Exim remembers is that the
33809 postmaster check for the domain succeeded or failed.
33810
33811
33812 .vitem &*random*&
33813 .cindex "callout" "&""random""& check"
33814 When this parameter is set, before doing the normal callout check, Exim does a
33815 check for a &"random"& local part at the same domain. The local part is not
33816 really random &-- it is defined by the expansion of the option
33817 &%callout_random_local_part%&, which defaults to
33818 .code
33819 $primary_hostname-$tod_epoch-testing
33820 .endd
33821 The idea here is to try to determine whether the remote host accepts all local
33822 parts without checking. If it does, there is no point in doing callouts for
33823 specific local parts. If the &"random"& check succeeds, the result is saved in
33824 a cache record, and used to force the current and subsequent callout checks to
33825 succeed without a connection being made, until the cache record expires.
33826
33827 .vitem &*use_postmaster*&
33828 .cindex "callout" "sender for recipient check"
33829 This parameter applies to recipient callouts only. For example:
33830 .code
33831 deny  !verify = recipient/callout=use_postmaster
33832 .endd
33833 .vindex "&$qualify_domain$&"
33834 It causes a non-empty postmaster address to be used in the MAIL command when
33835 performing the callout for the recipient, and also for a &"random"& check if
33836 that is configured. The local part of the address is &`postmaster`& and the
33837 domain is the contents of &$qualify_domain$&.
33838
33839 .vitem &*use_sender*&
33840 This option applies to recipient callouts only. For example:
33841 .code
33842 require  verify = recipient/callout=use_sender
33843 .endd
33844 It causes the message's actual sender address to be used in the MAIL
33845 command when performing the callout, instead of an empty address. There is no
33846 need to use this option unless you know that the called hosts make use of the
33847 sender when checking recipients. If used indiscriminately, it reduces the
33848 usefulness of callout caching.
33849
33850 .vitem &*hold*&
33851 This option applies to recipient callouts only. For example:
33852 .code
33853 require  verify = recipient/callout=use_sender,hold
33854 .endd
33855 It causes the connection to be held open and used for any further recipients
33856 and for eventual delivery (should that be done quickly).
33857 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33858 when that is used for the connections.
33859 The advantage is only gained if there are no callout cache hits
33860 (which could be enforced by the no_cache option),
33861 if the use_sender option is used,
33862 if neither the random nor the use_postmaster option is used,
33863 and if no other callouts intervene.
33864 .endlist
33865
33866 If you use any of the parameters that set a non-empty sender for the MAIL
33867 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33868 &%use_sender%&), you should think about possible loops. Recipient checking is
33869 usually done between two hosts that are under the same management, and the host
33870 that receives the callouts is not normally configured to do callouts itself.
33871 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33872 these circumstances.
33873
33874 However, if you use a non-empty sender address for a callout to an arbitrary
33875 host, there is the likelihood that the remote host will itself initiate a
33876 callout check back to your host. As it is checking what appears to be a message
33877 sender, it is likely to use an empty address in MAIL, thus avoiding a
33878 callout loop. However, to be on the safe side it would be best to set up your
33879 own ACLs so that they do not do sender verification checks when the recipient
33880 is the address you use for header sender or postmaster callout checking.
33881
33882 Another issue to think about when using non-empty senders for callouts is
33883 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33884 by the sender/recipient combination; thus, for any given recipient, many more
33885 actual callouts are performed than when an empty sender or postmaster is used.
33886
33887
33888
33889
33890 .subsection "Callout caching" SECTcallvercache
33891 .cindex "hints database" "callout cache"
33892 .cindex "callout" "cache, description of"
33893 .cindex "caching" "callout"
33894 Exim caches the results of callouts in order to reduce the amount of resources
33895 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33896 option. A hints database called &"callout"& is used for the cache. Two
33897 different record types are used: one records the result of a callout check for
33898 a specific address, and the other records information that applies to the
33899 entire domain (for example, that it accepts the local part &'postmaster'&).
33900
33901 When an original callout fails, a detailed SMTP error message is given about
33902 the failure. However, for subsequent failures that use the cache data, this message
33903 is not available.
33904
33905 The expiry times for negative and positive address cache records are
33906 independent, and can be set by the global options &%callout_negative_expire%&
33907 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33908
33909 If a host gives a negative response to an SMTP connection, or rejects any
33910 commands up to and including
33911 .code
33912 MAIL FROM:<>
33913 .endd
33914 (but not including the MAIL command with a non-empty address),
33915 any callout attempt is bound to fail. Exim remembers such failures in a
33916 domain cache record, which it uses to fail callouts for the domain without
33917 making new connections, until the domain record times out. There are two
33918 separate expiry times for domain cache records:
33919 &%callout_domain_negative_expire%& (default 3h) and
33920 &%callout_domain_positive_expire%& (default 7d).
33921
33922 Domain records expire when the negative expiry time is reached if callouts
33923 cannot be made for the domain, or if the postmaster check failed.
33924 Otherwise, they expire when the positive expiry time is reached. This
33925 ensures that, for example, a host that stops accepting &"random"& local parts
33926 will eventually be noticed.
33927
33928 The callout caching mechanism is based on the domain of the address that is
33929 being tested. If the domain routes to several hosts, it is assumed that their
33930 behaviour will be the same.
33931
33932
33933
33934 .section "Quota caching" "SECTquotacache"
33935 .cindex "hints database" "quota cache"
33936 .cindex "quota" "cache, description of"
33937 .cindex "caching" "quota"
33938 Exim caches the results of quota verification
33939 in order to reduce the amount of resources used.
33940 The &"callout"& hints database is used.
33941
33942 The default cache periods are five minutes for a positive (good) result
33943 and one hour for a negative result.
33944 To change the periods the &%quota%& option can be followed by an equals sign
33945 and a number of optional paramemters, separated by commas.
33946 For example:
33947 .code
33948 verify = recipient/quota=cachepos=1h,cacheneg=1d
33949 .endd
33950 Possible parameters are:
33951 .vlist
33952 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33953 .cindex "quota cache" "positive entry expiry, specifying"
33954 Set the lifetime for a positive cache entry.
33955 A value of zero seconds is legitimate.
33956
33957 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33958 .cindex "quota cache" "negative entry expiry, specifying"
33959 As above, for a negative entry.
33960
33961 .vitem &*no_cache*&
33962 Set both positive and negative lifetimes to zero.
33963
33964 .section "Sender address verification reporting" "SECTsenaddver"
33965 .cindex "verifying" "suppressing error details"
33966 See section &<<SECTaddressverification>>& for a general discussion of
33967 verification. When sender verification fails in an ACL, the details of the
33968 failure are given as additional output lines before the 550 response to the
33969 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33970 you might see:
33971 .code
33972 MAIL FROM:<xyz@abc.example>
33973 250 OK
33974 RCPT TO:<pqr@def.example>
33975 550-Verification failed for <xyz@abc.example>
33976 550-Called:   192.168.34.43
33977 550-Sent:     RCPT TO:<xyz@abc.example>
33978 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33979 550 Sender verification failed
33980 .endd
33981 If more than one RCPT command fails in the same way, the details are given
33982 only for the first of them. However, some administrators do not want to send
33983 out this much information. You can suppress the details by adding
33984 &`/no_details`& to the ACL statement that requests sender verification. For
33985 example:
33986 .code
33987 verify = sender/no_details
33988 .endd
33989
33990 .section "Redirection while verifying" "SECTredirwhilveri"
33991 .cindex "verifying" "redirection while"
33992 .cindex "address redirection" "while verifying"
33993 A dilemma arises when a local address is redirected by aliasing or forwarding
33994 during verification: should the generated addresses themselves be verified,
33995 or should the successful expansion of the original address be enough to verify
33996 it? By default, Exim takes the following pragmatic approach:
33997
33998 .ilist
33999 When an incoming address is redirected to just one child address, verification
34000 continues with the child address, and if that fails to verify, the original
34001 verification also fails.
34002 .next
34003 When an incoming address is redirected to more than one child address,
34004 verification does not continue. A success result is returned.
34005 .endlist
34006
34007 This seems the most reasonable behaviour for the common use of aliasing as a
34008 way of redirecting different local parts to the same mailbox. It means, for
34009 example, that a pair of alias entries of the form
34010 .code
34011 A.Wol:   aw123
34012 aw123:   :fail: Gone away, no forwarding address
34013 .endd
34014 work as expected, with both local parts causing verification failure. When a
34015 redirection generates more than one address, the behaviour is more like a
34016 mailing list, where the existence of the alias itself is sufficient for
34017 verification to succeed.
34018
34019 It is possible, however, to change the default behaviour so that all successful
34020 redirections count as successful verifications, however many new addresses are
34021 generated. This is specified by the &%success_on_redirect%& verification
34022 option. For example:
34023 .code
34024 require verify = recipient/success_on_redirect/callout=10s
34025 .endd
34026 In this example, verification succeeds if a router generates a new address, and
34027 the callout does not occur, because no address was routed to a remote host.
34028
34029 When verification is being tested via the &%-bv%& option, the treatment of
34030 redirections is as just described, unless the &%-v%& or any debugging option is
34031 also specified. In that case, full verification is done for every generated
34032 address and a report is output for each of them.
34033
34034
34035
34036 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34037 .cindex "CSA" "verifying"
34038 Client SMTP Authorization is a system that allows a site to advertise
34039 which machines are and are not permitted to send email. This is done by placing
34040 special SRV records in the DNS; these are looked up using the client's HELO
34041 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34042 Authorization checks in Exim are performed by the ACL condition:
34043 .code
34044 verify = csa
34045 .endd
34046 This fails if the client is not authorized. If there is a DNS problem, or if no
34047 valid CSA SRV record is found, or if the client is authorized, the condition
34048 succeeds. These three cases can be distinguished using the expansion variable
34049 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34050 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34051 be likely to cause problems for legitimate email.
34052
34053 The error messages produced by the CSA code include slightly more
34054 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34055 looking up the CSA SRV record, or problems looking up the CSA target
34056 address record. There are four reasons for &$csa_status$& being &"fail"&:
34057
34058 .ilist
34059 The client's host name is explicitly not authorized.
34060 .next
34061 The client's IP address does not match any of the CSA target IP addresses.
34062 .next
34063 The client's host name is authorized but it has no valid target IP addresses
34064 (for example, the target's addresses are IPv6 and the client is using IPv4).
34065 .next
34066 The client's host name has no CSA SRV record but a parent domain has asserted
34067 that all subdomains must be explicitly authorized.
34068 .endlist
34069
34070 The &%csa%& verification condition can take an argument which is the domain to
34071 use for the DNS query. The default is:
34072 .code
34073 verify = csa/$sender_helo_name
34074 .endd
34075 This implementation includes an extension to CSA. If the query domain
34076 is an address literal such as [192.0.2.95], or if it is a bare IP
34077 address, Exim searches for CSA SRV records in the reverse DNS as if
34078 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34079 meaningful to say:
34080 .code
34081 verify = csa/$sender_host_address
34082 .endd
34083 In fact, this is the check that Exim performs if the client does not say HELO.
34084 This extension can be turned off by setting the main configuration option
34085 &%dns_csa_use_reverse%& to be false.
34086
34087 If a CSA SRV record is not found for the domain itself, a search
34088 is performed through its parent domains for a record which might be
34089 making assertions about subdomains. The maximum depth of this search is limited
34090 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34091 default. Exim does not look for CSA SRV records in a top level domain, so the
34092 default settings handle HELO domains as long as seven
34093 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34094 of legitimate HELO domains.
34095
34096 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34097 direct SRV lookups, this is not sufficient because of the extra parent domain
34098 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34099 addresses into lookups in the reverse DNS space. The result of a successful
34100 lookup such as:
34101 .code
34102 ${lookup dnsdb {csa=$sender_helo_name}}
34103 .endd
34104 has two space-separated fields: an authorization code and a target host name.
34105 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34106 authorization required but absent, or &"?"& for unknown.
34107
34108
34109
34110
34111 .section "Bounce address tag validation" "SECTverifyPRVS"
34112 .cindex "BATV, verifying"
34113 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34114 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34115 Genuine incoming bounce messages should therefore always be addressed to
34116 recipients that have a valid tag. This scheme is a way of detecting unwanted
34117 bounce messages caused by sender address forgeries (often called &"collateral
34118 spam"&), because the recipients of such messages do not include valid tags.
34119
34120 There are two expansion items to help with the implementation of the BATV
34121 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34122 the original envelope sender address by using a simple key to add a hash of the
34123 address and some time-based randomizing information. The &%prvs%& expansion
34124 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34125 The syntax of these expansion items is described in section
34126 &<<SECTexpansionitems>>&.
34127 The validity period on signed addresses is seven days.
34128
34129 As an example, suppose the secret per-address keys are stored in an MySQL
34130 database. A query to look up the key for an address could be defined as a macro
34131 like this:
34132 .code
34133 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34134                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34135                 }{$value}}
34136 .endd
34137 Suppose also that the senders who make use of BATV are defined by an address
34138 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34139 use this:
34140 .code
34141 # Bounces: drop unsigned addresses for BATV senders
34142 deny senders = :
34143      recipients = +batv_senders
34144      message = This address does not send an unsigned reverse path
34145
34146 # Bounces: In case of prvs-signed address, check signature.
34147 deny senders = :
34148      condition  = ${prvscheck {$local_part@$domain}\
34149                   {PRVSCHECK_SQL}{1}}
34150      !condition = $prvscheck_result
34151      message = Invalid reverse path signature.
34152 .endd
34153 The first statement rejects recipients for bounce messages that are addressed
34154 to plain BATV sender addresses, because it is known that BATV senders do not
34155 send out messages with plain sender addresses. The second statement rejects
34156 recipients that are prvs-signed, but with invalid signatures (either because
34157 the key is wrong, or the signature has timed out).
34158
34159 A non-prvs-signed address is not rejected by the second statement, because the
34160 &%prvscheck%& expansion yields an empty string if its first argument is not a
34161 prvs-signed address, thus causing the &%condition%& condition to be false. If
34162 the first argument is a syntactically valid prvs-signed address, the yield is
34163 the third string (in this case &"1"&), whether or not the cryptographic and
34164 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34165 of the checks (empty for failure, &"1"& for success).
34166
34167 There is one more issue you must consider when implementing prvs-signing:
34168 you have to ensure that the routers accept prvs-signed addresses and
34169 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34170 router to remove the signature with a configuration along these lines:
34171 .code
34172 batv_redirect:
34173   driver = redirect
34174   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34175 .endd
34176 This works because, if the third argument of &%prvscheck%& is empty, the result
34177 of the expansion of a prvs-signed address is the decoded value of the original
34178 address. This router should probably be the first of your routers that handles
34179 local addresses.
34180
34181 To create BATV-signed addresses in the first place, a transport of this form
34182 can be used:
34183 .code
34184 external_smtp_batv:
34185   driver = smtp
34186   return_path = ${prvs {$return_path} \
34187                        {${lookup mysql{SELECT \
34188                        secret FROM batv_prvs WHERE \
34189                        sender='${quote_mysql:$sender_address}'} \
34190                        {$value}fail}}}
34191 .endd
34192 If no key can be found for the existing return path, no signing takes place.
34193
34194
34195
34196 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34197 .cindex "&ACL;" "relay control"
34198 .cindex "relaying" "control by ACL"
34199 .cindex "policy control" "relay control"
34200 An MTA is said to &'relay'& a message if it receives it from some host and
34201 delivers it directly to another host as a result of a remote address contained
34202 within it. Redirecting a local address via an alias or forward file and then
34203 passing the message on to another host is not relaying,
34204 .cindex "&""percent hack""&"
34205 but a redirection as a result of the &"percent hack"& is.
34206
34207 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34208 A host which is acting as a gateway or an MX backup is concerned with incoming
34209 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34210 a host which is acting as a smart host for a number of clients is concerned
34211 with outgoing relaying from those clients to the Internet at large. Often the
34212 same host is fulfilling both functions,
34213 . ///
34214 . as illustrated in the diagram below,
34215 . ///
34216 but in principle these two kinds of relaying are entirely independent. What is
34217 not wanted is the transmission of mail from arbitrary remote hosts through your
34218 system to arbitrary domains.
34219
34220
34221 You can implement relay control by means of suitable statements in the ACL that
34222 runs for each RCPT command. For convenience, it is often easiest to use
34223 Exim's named list facility to define the domains and hosts involved. For
34224 example, suppose you want to do the following:
34225
34226 .ilist
34227 Deliver a number of domains to mailboxes on the local host (or process them
34228 locally in some other way). Let's say these are &'my.dom1.example'& and
34229 &'my.dom2.example'&.
34230 .next
34231 Relay mail for a number of other domains for which you are the secondary MX.
34232 These might be &'friend1.example'& and &'friend2.example'&.
34233 .next
34234 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34235 Suppose your LAN is 192.168.45.0/24.
34236 .endlist
34237
34238
34239 In the main part of the configuration, you put the following definitions:
34240 .code
34241 domainlist local_domains    = my.dom1.example : my.dom2.example
34242 domainlist relay_to_domains = friend1.example : friend2.example
34243 hostlist   relay_from_hosts = 192.168.45.0/24
34244 .endd
34245 Now you can use these definitions in the ACL that is run for every RCPT
34246 command:
34247 .code
34248 acl_check_rcpt:
34249   accept domains = +local_domains : +relay_to_domains
34250   accept hosts   = +relay_from_hosts
34251 .endd
34252 The first statement accepts any RCPT command that contains an address in
34253 the local or relay domains. For any other domain, control passes to the second
34254 statement, which accepts the command only if it comes from one of the relay
34255 hosts. In practice, you will probably want to make your ACL more sophisticated
34256 than this, for example, by including sender and recipient verification. The
34257 default configuration includes a more comprehensive example, which is described
34258 in chapter &<<CHAPdefconfil>>&.
34259
34260
34261
34262 .section "Checking a relay configuration" "SECTcheralcon"
34263 .cindex "relaying" "checking control of"
34264 You can check the relay characteristics of your configuration in the same way
34265 that you can test any ACL behaviour for an incoming SMTP connection, by using
34266 the &%-bh%& option to run a fake SMTP session with which you interact.
34267 .ecindex IIDacl
34268
34269
34270
34271 . ////////////////////////////////////////////////////////////////////////////
34272 . ////////////////////////////////////////////////////////////////////////////
34273
34274 .chapter "Content scanning at ACL time" "CHAPexiscan"
34275 .scindex IIDcosca "content scanning" "at ACL time"
34276 The extension of Exim to include content scanning at ACL time, formerly known
34277 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34278 was integrated into the main source for Exim release 4.50, and Tom continues to
34279 maintain it. Most of the wording of this chapter is taken from Tom's
34280 specification.
34281
34282 It is also possible to scan the content of messages at other times. The
34283 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34284 scanning after all the ACLs have run. A transport filter can be used to scan
34285 messages at delivery time (see the &%transport_filter%& option, described in
34286 chapter &<<CHAPtransportgeneric>>&).
34287
34288 If you want to include the ACL-time content-scanning features when you compile
34289 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34290 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34291
34292 .ilist
34293 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34294 for all MIME parts for SMTP and non-SMTP messages, respectively.
34295 .next
34296 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34297 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34298 run at the end of message reception (the &%acl_smtp_data%& ACL).
34299 .next
34300 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34301 of messages, or parts of messages, for debugging purposes.
34302 .next
34303 Additional expansion variables that are set in the new ACL and by the new
34304 conditions.
34305 .next
34306 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34307 .endlist
34308
34309 Content-scanning is continually evolving, and new features are still being
34310 added. While such features are still unstable and liable to incompatible
34311 changes, they are made available in Exim by setting options whose names begin
34312 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34313 this manual. You can find out about them by reading the file called
34314 &_doc/experimental.txt_&.
34315
34316 All the content-scanning facilities work on a MBOX copy of the message that is
34317 temporarily created in a file called:
34318 .display
34319 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34320 .endd
34321 The &_.eml_& extension is a friendly hint to virus scanners that they can
34322 expect an MBOX-like structure inside that file. The file is created when the
34323 first content scanning facility is called. Subsequent calls to content
34324 scanning conditions open the same file again. The directory is recursively
34325 removed when the &%acl_smtp_data%& ACL has finished running, unless
34326 .code
34327 control = no_mbox_unspool
34328 .endd
34329 has been encountered. When the MIME ACL decodes files, they are put into the
34330 same directory by default.
34331
34332
34333
34334 .section "Scanning for viruses" "SECTscanvirus"
34335 .cindex "virus scanning"
34336 .cindex "content scanning" "for viruses"
34337 .cindex "content scanning" "the &%malware%& condition"
34338 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34339 It supports a &"generic"& interface to scanners called via the shell, and
34340 specialized interfaces for &"daemon"& type virus scanners, which are resident
34341 in memory and thus are much faster.
34342
34343 Since message data needs to have arrived,
34344 the condition may be only called in ACL defined by
34345 &%acl_smtp_data%&,
34346 &%acl_smtp_data_prdr%&,
34347 &%acl_smtp_mime%& or
34348 &%acl_smtp_dkim%&
34349
34350 A timeout of 2 minutes is applied to a scanner call (by default);
34351 if it expires then a defer action is taken.
34352
34353 .oindex "&%av_scanner%&"
34354 You can set the &%av_scanner%& option in the main part of the configuration
34355 to specify which scanner to use, together with any additional options that
34356 are needed. The basic syntax is as follows:
34357 .display
34358 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34359 .endd
34360 If you do not set &%av_scanner%&, it defaults to
34361 .code
34362 av_scanner = sophie:/var/run/sophie
34363 .endd
34364 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34365 before use.
34366 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34367 The following scanner types are supported in this release,
34368 though individual ones can be included or not at build time:
34369
34370 .vlist
34371 .vitem &%avast%&
34372 .cindex "virus scanners" "avast"
34373 This is the scanner daemon of Avast. It has been tested with Avast Core
34374 Security (currently at version 2.2.0).
34375 You can get a trial version at &url(https://www.avast.com) or for Linux
34376 at &url(https://www.avast.com/linux-server-antivirus).
34377 This scanner type takes one option,
34378 which can be either a full path to a UNIX socket,
34379 or host and port specifiers separated by white space.
34380 The host may be a name or an IP address; the port is either a
34381 single number or a pair of numbers with a dash between.
34382 A list of options may follow. These options are interpreted on the
34383 Exim's side of the malware scanner, or are given on separate lines to
34384 the daemon as options before the main scan command.
34385
34386 .cindex &`pass_unscanned`& "avast"
34387 If &`pass_unscanned`&
34388 is set, any files the Avast scanner can't scan (e.g.
34389 decompression bombs, or invalid archives) are considered clean. Use with
34390 care.
34391
34392 For example:
34393 .code
34394 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34395 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34396 av_scanner = avast:192.168.2.22 5036
34397 .endd
34398 If you omit the argument, the default path
34399 &_/var/run/avast/scan.sock_&
34400 is used.
34401 If you use a remote host,
34402 you need to make Exim's spool directory available to it,
34403 as the scanner is passed a file path, not file contents.
34404 For information about available commands and their options you may use
34405 .code
34406 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34407     FLAGS
34408     SENSITIVITY
34409     PACK
34410 .endd
34411
34412 If the scanner returns a temporary failure (e.g. license issues, or
34413 permission problems), the message is deferred and a paniclog entry is
34414 written.  The usual &`defer_ok`& option is available.
34415
34416 .vitem &%aveserver%&
34417 .cindex "virus scanners" "Kaspersky"
34418 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34419 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34420 which is the path to the daemon's UNIX socket. The default is shown in this
34421 example:
34422 .code
34423 av_scanner = aveserver:/var/run/aveserver
34424 .endd
34425
34426
34427 .vitem &%clamd%&
34428 .cindex "virus scanners" "clamd"
34429 This daemon-type scanner is GPL and free. You can get it at
34430 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34431 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34432 in the MIME ACL. This is no longer believed to be necessary.
34433
34434 The options are a list of server specifiers, which may be
34435 a UNIX socket specification,
34436 a TCP socket specification,
34437 or a (global) option.
34438
34439 A socket specification consists of a space-separated list.
34440 For a Unix socket the first element is a full path for the socket,
34441 for a TCP socket the first element is the IP address
34442 and the second a port number,
34443 Any further elements are per-server (non-global) options.
34444 These per-server options are supported:
34445 .code
34446 retry=<timespec>        Retry on connect fail
34447 .endd
34448
34449 The &`retry`& option specifies a time after which a single retry for
34450 a failed connect is made.  The default is to not retry.
34451
34452 If a Unix socket file is specified, only one server is supported.
34453
34454 Examples:
34455 .code
34456 av_scanner = clamd:/opt/clamd/socket
34457 av_scanner = clamd:192.0.2.3 1234
34458 av_scanner = clamd:192.0.2.3 1234:local
34459 av_scanner = clamd:192.0.2.3 1234 retry=10s
34460 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34461 .endd
34462 If the value of av_scanner points to a UNIX socket file or contains the
34463 &`local`&
34464 option, then the ClamAV interface will pass a filename containing the data
34465 to be scanned, which should normally result in less I/O happening and be
34466 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34467 Exim does not assume that there is a common filesystem with the remote host.
34468
34469 The final example shows that multiple TCP targets can be specified.  Exim will
34470 randomly use one for each incoming email (i.e. it load balances them).  Note
34471 that only TCP targets may be used if specifying a list of scanners; a UNIX
34472 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34473 unavailable, Exim will try the remaining one(s) until it finds one that works.
34474 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34475 not keep track of scanner state between multiple messages, and the scanner
34476 selection is random, so the message will get logged in the mainlog for each
34477 email that the down scanner gets chosen first (message wrapped to be readable):
34478 .code
34479 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34480    clamd: connection to localhost, port 3310 failed
34481    (Connection refused)
34482 .endd
34483
34484 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34485 contributing the code for this scanner.
34486
34487 .vitem &%cmdline%&
34488 .cindex "virus scanners" "command line interface"
34489 This is the keyword for the generic command line scanner interface. It can be
34490 used to attach virus scanners that are invoked from the shell. This scanner
34491 type takes 3 mandatory options:
34492
34493 .olist
34494 The full path and name of the scanner binary, with all command line options,
34495 and a placeholder (&`%s`&) for the directory to scan.
34496
34497 .next
34498 A regular expression to match against the STDOUT and STDERR output of the
34499 virus scanner. If the expression matches, a virus was found. You must make
34500 absolutely sure that this expression matches on &"virus found"&. This is called
34501 the &"trigger"& expression.
34502
34503 .next
34504 Another regular expression, containing exactly one pair of parentheses, to
34505 match the name of the virus found in the scanners output. This is called the
34506 &"name"& expression.
34507 .endlist olist
34508
34509 For example, Sophos Sweep reports a virus on a line like this:
34510 .code
34511 Virus 'W32/Magistr-B' found in file ./those.bat
34512 .endd
34513 For the trigger expression, we can match the phrase &"found in file"&. For the
34514 name expression, we want to extract the W32/Magistr-B string, so we can match
34515 for the single quotes left and right of it. Altogether, this makes the
34516 configuration setting:
34517 .code
34518 av_scanner = cmdline:\
34519              /path/to/sweep -ss -all -rec -archive %s:\
34520              found in file:'(.+)'
34521 .endd
34522 .vitem &%drweb%&
34523 .cindex "virus scanners" "DrWeb"
34524 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34525 takes one option,
34526 either a full path to a UNIX socket,
34527 or host and port specifiers separated by white space.
34528 The host may be a name or an IP address; the port is either a
34529 single number or a pair of numbers with a dash between.
34530 For example:
34531 .code
34532 av_scanner = drweb:/var/run/drwebd.sock
34533 av_scanner = drweb:192.168.2.20 31337
34534 .endd
34535 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34536 is used. Thanks to Alex Miller for contributing the code for this scanner.
34537
34538 .vitem &%f-protd%&
34539 .cindex "virus scanners" "f-protd"
34540 The f-protd scanner is accessed via HTTP over TCP.
34541 One argument is taken, being a space-separated hostname and port number
34542 (or port-range).
34543 For example:
34544 .code
34545 av_scanner = f-protd:localhost 10200-10204
34546 .endd
34547 If you omit the argument, the default values shown above are used.
34548
34549 .vitem &%f-prot6d%&
34550 .cindex "virus scanners" "f-prot6d"
34551 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34552 One argument is taken, being a space-separated hostname and port number.
34553 For example:
34554 .code
34555 av_scanner = f-prot6d:localhost 10200
34556 .endd
34557 If you omit the argument, the default values show above are used.
34558
34559 .vitem &%fsecure%&
34560 .cindex "virus scanners" "F-Secure"
34561 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34562 argument which is the path to a UNIX socket. For example:
34563 .code
34564 av_scanner = fsecure:/path/to/.fsav
34565 .endd
34566 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34567 Thelmen for contributing the code for this scanner.
34568
34569 .vitem &%kavdaemon%&
34570 .cindex "virus scanners" "Kaspersky"
34571 This is the scanner daemon of Kaspersky Version 4. This version of the
34572 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34573 scanner type takes one option, which is the path to the daemon's UNIX socket.
34574 For example:
34575 .code
34576 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34577 .endd
34578 The default path is &_/var/run/AvpCtl_&.
34579
34580 .vitem &%mksd%&
34581 .cindex "virus scanners" "mksd"
34582 This was a daemon type scanner that is aimed mainly at Polish users,
34583 though some documentation was available in English.
34584 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34585 and this appears to be a candidate for removal from Exim, unless
34586 we are informed of other virus scanners which use the same protocol
34587 to integrate.
34588 The only option for this scanner type is
34589 the maximum number of processes used simultaneously to scan the attachments,
34590 provided that mksd has
34591 been run with at least the same number of child processes. For example:
34592 .code
34593 av_scanner = mksd:2
34594 .endd
34595 You can safely omit this option (the default value is 1).
34596
34597 .vitem &%sock%&
34598 .cindex "virus scanners" "simple socket-connected"
34599 This is a general-purpose way of talking to simple scanner daemons
34600 running on the local machine.
34601 There are four options:
34602 an address (which may be an IP address and port, or the path of a Unix socket),
34603 a commandline to send (may include a single %s which will be replaced with
34604 the path to the mail file to be scanned),
34605 an RE to trigger on from the returned data,
34606 and an RE to extract malware_name from the returned data.
34607 For example:
34608 .code
34609 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34610 .endd
34611 Note that surrounding whitespace is stripped from each option, meaning
34612 there is no way to specify a trailing newline.
34613 The socket specifier and both regular-expressions are required.
34614 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34615 specify an empty element to get this.
34616
34617 .vitem &%sophie%&
34618 .cindex "virus scanners" "Sophos and Sophie"
34619 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34620 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34621 for this scanner type is the path to the UNIX socket that Sophie uses for
34622 client communication. For example:
34623 .code
34624 av_scanner = sophie:/tmp/sophie
34625 .endd
34626 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34627 the option.
34628 .endlist
34629
34630 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34631 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34632 ACL.
34633
34634 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34635 makes it possible to use different scanners. See further below for an example.
34636 The &%malware%& condition caches its results, so when you use it multiple times
34637 for the same message, the actual scanning process is only carried out once.
34638 However, using expandable items in &%av_scanner%& disables this caching, in
34639 which case each use of the &%malware%& condition causes a new scan of the
34640 message.
34641
34642 The &%malware%& condition takes a right-hand argument that is expanded before
34643 use and taken as a list, slash-separated by default.
34644 The first element can then be one of
34645
34646 .ilist
34647 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34648 The condition succeeds if a virus was found, and fail otherwise. This is the
34649 recommended usage.
34650 .next
34651 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34652 the condition fails immediately.
34653 .next
34654 A regular expression, in which case the message is scanned for viruses. The
34655 condition succeeds if a virus is found and its name matches the regular
34656 expression. This allows you to take special actions on certain types of virus.
34657 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34658 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34659 .endlist
34660
34661 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34662 messages even if there is a problem with the virus scanner.
34663 Otherwise, such a problem causes the ACL to defer.
34664
34665 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34666 specify a non-default timeout.  The default is two minutes.
34667 For example:
34668 .code
34669 malware = * / defer_ok / tmo=10s
34670 .endd
34671 A timeout causes the ACL to defer.
34672
34673 .vindex "&$callout_address$&"
34674 When a connection is made to the scanner the expansion variable &$callout_address$&
34675 is set to record the actual address used.
34676
34677 .vindex "&$malware_name$&"
34678 When a virus is found, the condition sets up an expansion variable called
34679 &$malware_name$& that contains the name of the virus. You can use it in a
34680 &%message%& modifier that specifies the error returned to the sender, and/or in
34681 logging data.
34682
34683 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34684 imposed by your anti-virus scanner.
34685
34686 Here is a very simple scanning example:
34687 .code
34688 deny malware = *
34689      message = This message contains malware ($malware_name)
34690 .endd
34691 The next example accepts messages when there is a problem with the scanner:
34692 .code
34693 deny malware = */defer_ok
34694      message = This message contains malware ($malware_name)
34695 .endd
34696 The next example shows how to use an ACL variable to scan with both sophie and
34697 aveserver. It assumes you have set:
34698 .code
34699 av_scanner = $acl_m0
34700 .endd
34701 in the main Exim configuration.
34702 .code
34703 deny set acl_m0 = sophie
34704      malware = *
34705      message = This message contains malware ($malware_name)
34706
34707 deny set acl_m0 = aveserver
34708      malware = *
34709      message = This message contains malware ($malware_name)
34710 .endd
34711
34712
34713 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34714 .cindex "content scanning" "for spam"
34715 .cindex "spam scanning"
34716 .cindex "SpamAssassin"
34717 .cindex "Rspamd"
34718 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34719 score and a report for the message.
34720 Support is also provided for Rspamd.
34721
34722 For more information about installation and configuration of SpamAssassin or
34723 Rspamd refer to their respective websites at
34724 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34725
34726 SpamAssassin can be installed with CPAN by running:
34727 .code
34728 perl -MCPAN -e 'install Mail::SpamAssassin'
34729 .endd
34730 SpamAssassin has its own set of configuration files. Please review its
34731 documentation to see how you can tweak it. The default installation should work
34732 nicely, however.
34733
34734 .oindex "&%spamd_address%&"
34735 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34736 intend to use an instance running on the local host you do not need to set
34737 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34738 you must set the &%spamd_address%& option in the global part of the Exim
34739 configuration as follows (example):
34740 .code
34741 spamd_address = 192.168.99.45 783
34742 .endd
34743 The SpamAssassin protocol relies on a TCP half-close from the client.
34744 If your SpamAssassin client side is running a Linux system with an
34745 iptables firewall, consider setting
34746 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34747 timeout, Exim uses when waiting for a response from the SpamAssassin
34748 server (currently defaulting to 120s).  With a lower value the Linux
34749 connection tracking may consider your half-closed connection as dead too
34750 soon.
34751
34752
34753 To use Rspamd (which by default listens on all local addresses
34754 on TCP port 11333)
34755 you should add &%variant=rspamd%& after the address/port pair, for example:
34756 .code
34757 spamd_address = 127.0.0.1 11333 variant=rspamd
34758 .endd
34759
34760 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34761 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34762 filename instead of an address/port pair:
34763 .code
34764 spamd_address = /var/run/spamd_socket
34765 .endd
34766 You can have multiple &%spamd%& servers to improve scalability. These can
34767 reside on other hardware reachable over the network. To specify multiple
34768 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34769 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34770 .code
34771 spamd_address = 192.168.2.10 783 : \
34772                 192.168.2.11 783 : \
34773                 192.168.2.12 783
34774 .endd
34775 Up to 32 &%spamd%& servers are supported.
34776 When a server fails to respond to the connection attempt, all other
34777 servers are tried until one succeeds. If no server responds, the &%spam%&
34778 condition defers.
34779
34780 Unix and TCP socket specifications may be mixed in any order.
34781 Each element of the list is a list itself, space-separated by default
34782 and changeable in the usual way (&<<SECTlistsepchange>>&);
34783 take care to not double the separator.
34784
34785 For TCP socket specifications a host name or IP (v4 or v6, but
34786 subject to list-separator quoting rules) address can be used,
34787 and the port can be one or a dash-separated pair.
34788 In the latter case, the range is tried in strict order.
34789
34790 Elements after the first for Unix sockets, or second for TCP socket,
34791 are options.
34792 The supported options are:
34793 .code
34794 pri=<priority>      Selection priority
34795 weight=<value>      Selection bias
34796 time=<start>-<end>  Use only between these times of day
34797 retry=<timespec>    Retry on connect fail
34798 tmo=<timespec>      Connection time limit
34799 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34800 .endd
34801
34802 The &`pri`& option specifies a priority for the server within the list,
34803 higher values being tried first.
34804 The default priority is 1.
34805
34806 The &`weight`& option specifies a selection bias.
34807 Within a priority set
34808 servers are queried in a random fashion, weighted by this value.
34809 The default value for selection bias is 1.
34810
34811 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34812 in the local time zone; each element being one or more digits.
34813 Either the seconds or both minutes and seconds, plus the leading &`.`&
34814 characters, may be omitted and will be taken as zero.
34815
34816 Timeout specifications for the &`retry`& and &`tmo`& options
34817 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34818
34819 The &`tmo`& option specifies an overall timeout for communication.
34820 The default value is two minutes.
34821
34822 The &`retry`& option specifies a time after which a single retry for
34823 a failed connect is made.
34824 The default is to not retry.
34825
34826 The &%spamd_address%& variable is expanded before use if it starts with
34827 a dollar sign. In this case, the expansion may return a string that is
34828 used as the list so that multiple spamd servers can be the result of an
34829 expansion.
34830
34831 .vindex "&$callout_address$&"
34832 When a connection is made to the server the expansion variable &$callout_address$&
34833 is set to record the actual address used.
34834
34835 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34836 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34837 .code
34838 deny spam = joe
34839      message = This message was classified as SPAM
34840 .endd
34841 The right-hand side of the &%spam%& condition specifies a name. This is
34842 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34843 to scan using a specific profile, but rather use the SpamAssassin system-wide
34844 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34845 Rspamd does not use this setting. However, you must put something on the
34846 right-hand side.
34847
34848 The name allows you to use per-domain or per-user antispam profiles in
34849 principle, but this is not straightforward in practice, because a message may
34850 have multiple recipients, not necessarily all in the same domain. Because the
34851 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34852 read the contents of the message, the variables &$local_part$& and &$domain$&
34853 are not set.
34854 Careful enforcement of single-recipient messages
34855 (e.g. by responding with defer in the recipient ACL for all recipients
34856 after the first),
34857 or the use of PRDR,
34858 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34859 are needed to use this feature.
34860
34861 The right-hand side of the &%spam%& condition is expanded before being used, so
34862 you can put lookups or conditions there. When the right-hand side evaluates to
34863 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34864
34865
34866 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34867 large ones may cause significant performance degradation. As most spam messages
34868 are quite small, it is recommended that you do not scan the big ones. For
34869 example:
34870 .code
34871 deny condition = ${if < {$message_size}{10K}}
34872      spam = nobody
34873      message = This message was classified as SPAM
34874 .endd
34875
34876 The &%spam%& condition returns true if the threshold specified in the user's
34877 SpamAssassin profile has been matched or exceeded. If you want to use the
34878 &%spam%& condition for its side effects (see the variables below), you can make
34879 it always return &"true"& by appending &`:true`& to the username.
34880
34881 .cindex "spam scanning" "returned variables"
34882 When the &%spam%& condition is run, it sets up a number of expansion
34883 variables.
34884 Except for &$spam_report$&,
34885 these variables are saved with the received message so are
34886 available for use at delivery time.
34887
34888 .vlist
34889 .vitem &$spam_score$&
34890 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34891 for inclusion in log or reject messages.
34892
34893 .vitem &$spam_score_int$&
34894 The spam score of the message, multiplied by ten, as an integer value. For
34895 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34896 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34897 The integer value is useful for numeric comparisons in conditions.
34898
34899 .vitem &$spam_bar$&
34900 A string consisting of a number of &"+"& or &"-"& characters, representing the
34901 integer part of the spam score value. A spam score of 4.4 would have a
34902 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34903 headers, since MUAs can match on such strings. The maximum length of the
34904 spam bar is 50 characters.
34905
34906 .vitem &$spam_report$&
34907 A multiline text table, containing the full SpamAssassin report for the
34908 message. Useful for inclusion in headers or reject messages.
34909 This variable is only usable in a DATA-time ACL.
34910 Beware that SpamAssassin may return non-ASCII characters, especially
34911 when running in country-specific locales, which are not legal
34912 unencoded in headers.
34913
34914 .vitem &$spam_action$&
34915 For SpamAssassin either 'reject' or 'no action' depending on the
34916 spam score versus threshold.
34917 For Rspamd, the recommended action.
34918
34919 .endlist
34920
34921 The &%spam%& condition caches its results unless expansion in
34922 spamd_address was used. If you call it again with the same user name, it
34923 does not scan again, but rather returns the same values as before.
34924
34925 The &%spam%& condition returns DEFER if there is any error while running
34926 the message through SpamAssassin or if the expansion of spamd_address
34927 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34928 statement block), append &`/defer_ok`& to the right-hand side of the
34929 spam condition, like this:
34930 .code
34931 deny spam    = joe/defer_ok
34932      message = This message was classified as SPAM
34933 .endd
34934 This causes messages to be accepted even if there is a problem with &%spamd%&.
34935
34936 Here is a longer, commented example of the use of the &%spam%&
34937 condition:
34938 .code
34939 # put headers in all messages (no matter if spam or not)
34940 warn  spam = nobody:true
34941       add_header = X-Spam-Score: $spam_score ($spam_bar)
34942       add_header = X-Spam-Report: $spam_report
34943
34944 # add second subject line with *SPAM* marker when message
34945 # is over threshold
34946 warn  spam = nobody
34947       add_header = Subject: *SPAM* $h_Subject:
34948
34949 # reject spam at high scores (> 12)
34950 deny  spam = nobody:true
34951       condition = ${if >{$spam_score_int}{120}{1}{0}}
34952       message = This message scored $spam_score spam points.
34953 .endd
34954
34955
34956
34957 .section "Scanning MIME parts" "SECTscanmimepart"
34958 .cindex "content scanning" "MIME parts"
34959 .cindex "MIME content scanning"
34960 .oindex "&%acl_smtp_mime%&"
34961 .oindex "&%acl_not_smtp_mime%&"
34962 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34963 each MIME part of an SMTP message, including multipart types, in the sequence
34964 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34965 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34966 options may both refer to the same ACL if you want the same processing in both
34967 cases.
34968
34969 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34970 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34971 the case of a non-SMTP message. However, a MIME ACL is called only if the
34972 message contains a &'Content-Type:'& header line. When a call to a MIME
34973 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34974 result code is sent to the client. In the case of an SMTP message, the
34975 &%acl_smtp_data%& ACL is not called when this happens.
34976
34977 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34978 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34979 condition to match against the raw MIME part. You can also use the
34980 &%mime_regex%& condition to match against the decoded MIME part (see section
34981 &<<SECTscanregex>>&).
34982
34983 At the start of a MIME ACL, a number of variables are set from the header
34984 information for the relevant MIME part. These are described below. The contents
34985 of the MIME part are not by default decoded into a disk file except for MIME
34986 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34987 part into a disk file, you can use the &%decode%& condition. The general
34988 syntax is:
34989 .display
34990 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34991 .endd
34992 The right hand side is expanded before use. After expansion,
34993 the value can be:
34994
34995 .olist
34996 &"0"& or &"false"&, in which case no decoding is done.
34997 .next
34998 The string &"default"&. In that case, the file is put in the temporary
34999 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35000 a sequential filename consisting of the message id and a sequence number. The
35001 full path and name is available in &$mime_decoded_filename$& after decoding.
35002 .next
35003 A full path name starting with a slash. If the full name is an existing
35004 directory, it is used as a replacement for the default directory. The filename
35005 is then sequentially assigned. If the path does not exist, it is used as
35006 the full path and filename.
35007 .next
35008 If the string does not start with a slash, it is used as the
35009 filename, and the default path is then used.
35010 .endlist
35011 The &%decode%& condition normally succeeds. It is only false for syntax
35012 errors or unusual circumstances such as memory shortages. You can easily decode
35013 a file with its original, proposed filename using
35014 .code
35015 decode = $mime_filename
35016 .endd
35017 However, you should keep in mind that &$mime_filename$& might contain
35018 anything. If you place files outside of the default path, they are not
35019 automatically unlinked.
35020
35021 For RFC822 attachments (these are messages attached to messages, with a
35022 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35023 as for the primary message, only that the &$mime_is_rfc822$& expansion
35024 variable is set (see below). Attached messages are always decoded to disk
35025 before being checked, and the files are unlinked once the check is done.
35026
35027 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35028 used to match regular expressions against raw and decoded MIME parts,
35029 respectively. They are described in section &<<SECTscanregex>>&.
35030
35031 .cindex "MIME content scanning" "returned variables"
35032 The following list describes all expansion variables that are
35033 available in the MIME ACL:
35034
35035 .vlist
35036 .vitem &$mime_anomaly_level$& &&&
35037        &$mime_anomaly_text$&
35038 .vindex &$mime_anomaly_level$&
35039 .vindex &$mime_anomaly_text$&
35040 If there are problems decoding, these variables contain information on
35041 the detected issue.
35042
35043 .vitem &$mime_boundary$&
35044 .vindex &$mime_boundary$&
35045 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35046 have a boundary string, which is stored in this variable. If the current part
35047 has no boundary parameter in the &'Content-Type:'& header, this variable
35048 contains the empty string.
35049
35050 .vitem &$mime_charset$&
35051 .vindex &$mime_charset$&
35052 This variable contains the character set identifier, if one was found in the
35053 &'Content-Type:'& header. Examples for charset identifiers are:
35054 .code
35055 us-ascii
35056 gb2312 (Chinese)
35057 iso-8859-1
35058 .endd
35059 Please note that this value is not normalized, so you should do matches
35060 case-insensitively.
35061
35062 .vitem &$mime_content_description$&
35063 .vindex &$mime_content_description$&
35064 This variable contains the normalized content of the &'Content-Description:'&
35065 header. It can contain a human-readable description of the parts content. Some
35066 implementations repeat the filename for attachments here, but they are usually
35067 only used for display purposes.
35068
35069 .vitem &$mime_content_disposition$&
35070 .vindex &$mime_content_disposition$&
35071 This variable contains the normalized content of the &'Content-Disposition:'&
35072 header. You can expect strings like &"attachment"& or &"inline"& here.
35073
35074 .vitem &$mime_content_id$&
35075 .vindex &$mime_content_id$&
35076 This variable contains the normalized content of the &'Content-ID:'& header.
35077 This is a unique ID that can be used to reference a part from another part.
35078
35079 .vitem &$mime_content_size$&
35080 .vindex &$mime_content_size$&
35081 This variable is set only after the &%decode%& modifier (see above) has been
35082 successfully run. It contains the size of the decoded part in kilobytes. The
35083 size is always rounded up to full kilobytes, so only a completely empty part
35084 has a &$mime_content_size$& of zero.
35085
35086 .vitem &$mime_content_transfer_encoding$&
35087 .vindex &$mime_content_transfer_encoding$&
35088 This variable contains the normalized content of the
35089 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35090 type. Typical values are &"base64"& and &"quoted-printable"&.
35091
35092 .vitem &$mime_content_type$&
35093 .vindex &$mime_content_type$&
35094 If the MIME part has a &'Content-Type:'& header, this variable contains its
35095 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35096 are some examples of popular MIME types, as they may appear in this variable:
35097 .code
35098 text/plain
35099 text/html
35100 application/octet-stream
35101 image/jpeg
35102 audio/midi
35103 .endd
35104 If the MIME part has no &'Content-Type:'& header, this variable contains the
35105 empty string.
35106
35107 .vitem &$mime_decoded_filename$&
35108 .vindex &$mime_decoded_filename$&
35109 This variable is set only after the &%decode%& modifier (see above) has been
35110 successfully run. It contains the full path and filename of the file
35111 containing the decoded data.
35112 .endlist
35113
35114 .cindex "RFC 2047"
35115 .vlist
35116 .vitem &$mime_filename$&
35117 .vindex &$mime_filename$&
35118 This is perhaps the most important of the MIME variables. It contains a
35119 proposed filename for an attachment, if one was found in either the
35120 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35121 RFC2047
35122 or RFC2231
35123 decoded, but no additional sanity checks are done.
35124  If no filename was
35125 found, this variable contains the empty string.
35126
35127 .vitem &$mime_is_coverletter$&
35128 .vindex &$mime_is_coverletter$&
35129 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35130 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35131 content in the cover letter, while not restricting attachments at all.
35132
35133 The variable contains 1 (true) for a MIME part believed to be part of the
35134 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35135 follows:
35136
35137 .olist
35138 The outermost MIME part of a message is always a cover letter.
35139
35140 .next
35141 If a multipart/alternative or multipart/related MIME part is a cover letter,
35142 so are all MIME subparts within that multipart.
35143
35144 .next
35145 If any other multipart is a cover letter, the first subpart is a cover letter,
35146 and the rest are attachments.
35147
35148 .next
35149 All parts contained within an attachment multipart are attachments.
35150 .endlist olist
35151
35152 As an example, the following will ban &"HTML mail"& (including that sent with
35153 alternative plain text), while allowing HTML files to be attached. HTML
35154 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35155 .code
35156 deny !condition = $mime_is_rfc822
35157      condition = $mime_is_coverletter
35158      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35159      message = HTML mail is not accepted here
35160 .endd
35161
35162 .vitem &$mime_is_multipart$&
35163 .vindex &$mime_is_multipart$&
35164 This variable has the value 1 (true) when the current part has the main type
35165 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35166 Since multipart entities only serve as containers for other parts, you may not
35167 want to carry out specific actions on them.
35168
35169 .vitem &$mime_is_rfc822$&
35170 .vindex &$mime_is_rfc822$&
35171 This variable has the value 1 (true) if the current part is not a part of the
35172 checked message itself, but part of an attached message. Attached message
35173 decoding is fully recursive.
35174
35175 .vitem &$mime_part_count$&
35176 .vindex &$mime_part_count$&
35177 This variable is a counter that is raised for each processed MIME part. It
35178 starts at zero for the very first part (which is usually a multipart). The
35179 counter is per-message, so it is reset when processing RFC822 attachments (see
35180 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35181 complete, so you can use it in the DATA ACL to determine the number of MIME
35182 parts of a message. For non-MIME messages, this variable contains the value -1.
35183 .endlist
35184
35185
35186
35187 .section "Scanning with regular expressions" "SECTscanregex"
35188 .cindex "content scanning" "with regular expressions"
35189 .cindex "regular expressions" "content scanning with"
35190 You can specify your own custom regular expression matches on the full body of
35191 the message, or on individual MIME parts.
35192
35193 The &%regex%& condition takes one or more regular expressions as arguments and
35194 matches them against the full message (when called in the DATA ACL) or a raw
35195 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35196 linewise, with a maximum line length of 32K characters. That means you cannot
35197 have multiline matches with the &%regex%& condition.
35198
35199 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35200 to 32K of decoded content (the whole content at once, not linewise). If the
35201 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35202 is decoded automatically when &%mime_regex%& is executed (using default path
35203 and filename values). If the decoded data is larger than  32K, only the first
35204 32K characters are checked.
35205
35206 The regular expressions are passed as a colon-separated list. To include a
35207 literal colon, you must double it. Since the whole right-hand side string is
35208 expanded before being used, you must also escape dollar signs and backslashes
35209 with more backslashes, or use the &`\N`& facility to disable expansion.
35210 Here is a simple example that contains two regular expressions:
35211 .code
35212 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35213      message = contains blacklisted regex ($regex_match_string)
35214 .endd
35215 The conditions returns true if any one of the regular expressions matches. The
35216 &$regex_match_string$& expansion variable is then set up and contains the
35217 matching regular expression.
35218 The expansion variables &$regex1$& &$regex2$& etc
35219 are set to any substrings captured by the regular expression.
35220
35221 &*Warning*&: With large messages, these conditions can be fairly
35222 CPU-intensive.
35223
35224 .ecindex IIDcosca
35225
35226
35227
35228
35229 . ////////////////////////////////////////////////////////////////////////////
35230 . ////////////////////////////////////////////////////////////////////////////
35231
35232 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35233          "Local scan function"
35234 .scindex IIDlosca "&[local_scan()]& function" "description of"
35235 .cindex "customizing" "input scan using C function"
35236 .cindex "policy control" "by local scan function"
35237 In these days of email worms, viruses, and ever-increasing spam, some sites
35238 want to apply a lot of checking to messages before accepting them.
35239
35240 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35241 passing messages to external virus and spam scanning software. You can also do
35242 a certain amount in Exim itself through string expansions and the &%condition%&
35243 condition in the ACL that runs after the SMTP DATA command or the ACL for
35244 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35245
35246 To allow for further customization to a site's own requirements, there is the
35247 possibility of linking Exim with a private message scanning function, written
35248 in C. If you want to run code that is written in something other than C, you
35249 can of course use a little C stub to call it.
35250
35251 The local scan function is run once for every incoming message, at the point
35252 when Exim is just about to accept the message.
35253 It can therefore be used to control non-SMTP messages from local processes as
35254 well as messages arriving via SMTP.
35255
35256 Exim applies a timeout to calls of the local scan function, and there is an
35257 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35258 Zero means &"no timeout"&.
35259 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35260 before calling the local scan function, so that the most common types of crash
35261 are caught. If the timeout is exceeded or one of those signals is caught, the
35262 incoming message is rejected with a temporary error if it is an SMTP message.
35263 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35264 code. The incident is logged on the main and reject logs.
35265
35266
35267
35268 .section "Building Exim to use a local scan function" "SECID207"
35269 .cindex "&[local_scan()]& function" "building Exim to use"
35270 To make use of the local scan function feature, you must tell Exim where your
35271 function is before building Exim, by setting
35272 both HAVE_LOCAL_SCAN and
35273 LOCAL_SCAN_SOURCE in your
35274 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35275 directory, so you might set
35276 .code
35277 HAVE_LOCAL_SCAN=yes
35278 LOCAL_SCAN_SOURCE=Local/local_scan.c
35279 .endd
35280 for example. The function must be called &[local_scan()]&;
35281 the source file(s) for it should first #define LOCAL_SCAN
35282 and then #include "local_scan.h".
35283 It is called by
35284 Exim after it has received a message, when the success return code is about to
35285 be sent. This is after all the ACLs have been run. The return code from your
35286 function controls whether the message is actually accepted or not. There is a
35287 commented template function (that just accepts the message) in the file
35288 _src/local_scan.c_.
35289
35290 If you want to make use of Exim's runtime configuration file to set options
35291 for your &[local_scan()]& function, you must also set
35292 .code
35293 LOCAL_SCAN_HAS_OPTIONS=yes
35294 .endd
35295 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35296
35297
35298
35299
35300 .section "API for local_scan()" "SECTapiforloc"
35301 .cindex "&[local_scan()]& function" "API description"
35302 .cindex &%dlfunc%& "API description"
35303 You must include this line near the start of your code:
35304 .code
35305 #define LOCAL_SCAN
35306 #include "local_scan.h"
35307 .endd
35308 This header file defines a number of variables and other values, and the
35309 prototype for the function itself. Exim is coded to use unsigned char values
35310 almost exclusively, and one of the things this header defines is a shorthand
35311 for &`unsigned char`& called &`uschar`&.
35312 It also makes available the following macro definitions, to simplify casting character
35313 strings and pointers to character strings:
35314 .code
35315 #define CS   (char *)
35316 #define CCS  (const char *)
35317 #define CSS  (char **)
35318 #define US   (unsigned char *)
35319 #define CUS  (const unsigned char *)
35320 #define USS  (unsigned char **)
35321 .endd
35322 The function prototype for &[local_scan()]& is:
35323 .code
35324 extern int local_scan(int fd, uschar **return_text);
35325 .endd
35326 The arguments are as follows:
35327
35328 .ilist
35329 &%fd%& is a file descriptor for the file that contains the body of the message
35330 (the -D file). The file is open for reading and writing, but updating it is not
35331 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35332
35333 The descriptor is positioned at character 19 of the file, which is the first
35334 character of the body itself, because the first 19 characters are the message
35335 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35336 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35337 case this changes in some future version.
35338 .next
35339 &%return_text%& is an address which you can use to return a pointer to a text
35340 string at the end of the function. The value it points to on entry is NULL.
35341 .endlist
35342
35343 The function must return an &%int%& value which is one of the following macros:
35344
35345 .vlist
35346 .vitem &`LOCAL_SCAN_ACCEPT`&
35347 .vindex "&$local_scan_data$&"
35348 The message is accepted. If you pass back a string of text, it is saved with
35349 the message, and made available in the variable &$local_scan_data$&. No
35350 newlines are permitted (if there are any, they are turned into spaces) and the
35351 maximum length of text is 1000 characters.
35352
35353 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35354 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35355 queued without immediate delivery, and is frozen.
35356
35357 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35358 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35359 queued without immediate delivery.
35360
35361 .vitem &`LOCAL_SCAN_REJECT`&
35362 The message is rejected; the returned text is used as an error message which is
35363 passed back to the sender and which is also logged. Newlines are permitted &--
35364 they cause a multiline response for SMTP rejections, but are converted to
35365 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35366 used.
35367
35368 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35369 The message is temporarily rejected; the returned text is used as an error
35370 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35371 problem"& is used.
35372
35373 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35374 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35375 message is not written to the reject log. It has the effect of unsetting the
35376 &%rejected_header%& log selector for just this rejection. If
35377 &%rejected_header%& is already unset (see the discussion of the
35378 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35379 same as LOCAL_SCAN_REJECT.
35380
35381 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35382 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35383 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35384 .endlist
35385
35386 If the message is not being received by interactive SMTP, rejections are
35387 reported by writing to &%stderr%& or by sending an email, as configured by the
35388 &%-oe%& command line options.
35389
35390
35391
35392 .section "Configuration options for local_scan()" "SECTconoptloc"
35393 .cindex "&[local_scan()]& function" "configuration options"
35394 It is possible to have option settings in the main configuration file
35395 that set values in static variables in the &[local_scan()]& module. If you
35396 want to do this, you must have the line
35397 .code
35398 LOCAL_SCAN_HAS_OPTIONS=yes
35399 .endd
35400 in your &_Local/Makefile_& when you build Exim. (This line is in
35401 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35402 file, you must define static variables to hold the option values, and a table
35403 to define them.
35404
35405 The table must be a vector called &%local_scan_options%&, of type
35406 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35407 and a pointer to the variable that holds the value. The entries must appear in
35408 alphabetical order. Following &%local_scan_options%& you must also define a
35409 variable called &%local_scan_options_count%& that contains the number of
35410 entries in the table. Here is a short example, showing two kinds of option:
35411 .code
35412 static int my_integer_option = 42;
35413 static uschar *my_string_option = US"a default string";
35414
35415 optionlist local_scan_options[] = {
35416   { "my_integer", opt_int,       &my_integer_option },
35417   { "my_string",  opt_stringptr, &my_string_option }
35418 };
35419
35420 int local_scan_options_count =
35421   sizeof(local_scan_options)/sizeof(optionlist);
35422 .endd
35423 The values of the variables can now be changed from Exim's runtime
35424 configuration file by including a local scan section as in this example:
35425 .code
35426 begin local_scan
35427 my_integer = 99
35428 my_string = some string of text...
35429 .endd
35430 The available types of option data are as follows:
35431
35432 .vlist
35433 .vitem &*opt_bool*&
35434 This specifies a boolean (true/false) option. The address should point to a
35435 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35436 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35437 whether such a variable has been set at all, you can initialize it to
35438 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35439 values.)
35440
35441 .vitem &*opt_fixed*&
35442 This specifies a fixed point number, such as is used for load averages.
35443 The address should point to a variable of type &`int`&. The value is stored
35444 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35445
35446 .vitem &*opt_int*&
35447 This specifies an integer; the address should point to a variable of type
35448 &`int`&. The value may be specified in any of the integer formats accepted by
35449 Exim.
35450
35451 .vitem &*opt_mkint*&
35452 This is the same as &%opt_int%&, except that when such a value is output in a
35453 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35454 printed with the suffix K or M.
35455
35456 .vitem &*opt_octint*&
35457 This also specifies an integer, but the value is always interpreted as an
35458 octal integer, whether or not it starts with the digit zero, and it is
35459 always output in octal.
35460
35461 .vitem &*opt_stringptr*&
35462 This specifies a string value; the address must be a pointer to a
35463 variable that points to a string (for example, of type &`uschar *`&).
35464
35465 .vitem &*opt_time*&
35466 This specifies a time interval value. The address must point to a variable of
35467 type &`int`&. The value that is placed there is a number of seconds.
35468 .endlist
35469
35470 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35471 out the values of all the &[local_scan()]& options.
35472
35473
35474
35475 .section "Available Exim variables" "SECID208"
35476 .cindex "&[local_scan()]& function" "available Exim variables"
35477 The header &_local_scan.h_& gives you access to a number of C variables. These
35478 are the only ones that are guaranteed to be maintained from release to release.
35479 Note, however, that you can obtain the value of any Exim expansion variable,
35480 including &$recipients$&, by calling &'expand_string()'&. The exported
35481 C variables are as follows:
35482
35483 .vlist
35484 .vitem &*int&~body_linecount*&
35485 This variable contains the number of lines in the message's body.
35486 It is not valid if the &%spool_wireformat%& option is used.
35487
35488 .vitem &*int&~body_zerocount*&
35489 This variable contains the number of binary zero bytes in the message's body.
35490 It is not valid if the &%spool_wireformat%& option is used.
35491
35492 .vitem &*unsigned&~int&~debug_selector*&
35493 This variable is set to zero when no debugging is taking place. Otherwise, it
35494 is a bitmap of debugging selectors. Two bits are identified for use in
35495 &[local_scan()]&; they are defined as macros:
35496
35497 .ilist
35498 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35499 testing option that is not privileged &-- any caller may set it. All the
35500 other selector bits can be set only by admin users.
35501
35502 .next
35503 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35504 by the &`+local_scan`& debug selector. It is not included in the default set
35505 of debugging bits.
35506 .endlist ilist
35507
35508 Thus, to write to the debugging output only when &`+local_scan`& has been
35509 selected, you should use code like this:
35510 .code
35511 if ((debug_selector & D_local_scan) != 0)
35512   debug_printf("xxx", ...);
35513 .endd
35514 .vitem &*uschar&~*expand_string_message*&
35515 After a failing call to &'expand_string()'& (returned value NULL), the
35516 variable &%expand_string_message%& contains the error message, zero-terminated.
35517
35518 .vitem &*header_line&~*header_list*&
35519 A pointer to a chain of header lines. The &%header_line%& structure is
35520 discussed below.
35521
35522 .vitem &*header_line&~*header_last*&
35523 A pointer to the last of the header lines.
35524
35525 .vitem &*const&~uschar&~*headers_charset*&
35526 The value of the &%headers_charset%& configuration option.
35527
35528 .vitem &*BOOL&~host_checking*&
35529 This variable is TRUE during a host checking session that is initiated by the
35530 &%-bh%& command line option.
35531
35532 .vitem &*uschar&~*interface_address*&
35533 The IP address of the interface that received the message, as a string. This
35534 is NULL for locally submitted messages.
35535
35536 .vitem &*int&~interface_port*&
35537 The port on which this message was received. When testing with the &%-bh%&
35538 command line option, the value of this variable is -1 unless a port has been
35539 specified via the &%-oMi%& option.
35540
35541 .vitem &*uschar&~*message_id*&
35542 This variable contains Exim's message id for the incoming message (the value of
35543 &$message_exim_id$&) as a zero-terminated string.
35544
35545 .vitem &*uschar&~*received_protocol*&
35546 The name of the protocol by which the message was received.
35547
35548 .vitem &*int&~recipients_count*&
35549 The number of accepted recipients.
35550
35551 .vitem &*recipient_item&~*recipients_list*&
35552 .cindex "recipient" "adding in local scan"
35553 .cindex "recipient" "removing in local scan"
35554 The list of accepted recipients, held in a vector of length
35555 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35556 can add additional recipients by calling &'receive_add_recipient()'& (see
35557 below). You can delete recipients by removing them from the vector and
35558 adjusting the value in &%recipients_count%&. In particular, by setting
35559 &%recipients_count%& to zero you remove all recipients. If you then return the
35560 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35561 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35562 and then call &'receive_add_recipient()'& as often as needed.
35563
35564 .vitem &*uschar&~*sender_address*&
35565 The envelope sender address. For bounce messages this is the empty string.
35566
35567 .vitem &*uschar&~*sender_host_address*&
35568 The IP address of the sending host, as a string. This is NULL for
35569 locally-submitted messages.
35570
35571 .vitem &*uschar&~*sender_host_authenticated*&
35572 The name of the authentication mechanism that was used, or NULL if the message
35573 was not received over an authenticated SMTP connection.
35574
35575 .vitem &*uschar&~*sender_host_name*&
35576 The name of the sending host, if known.
35577
35578 .vitem &*int&~sender_host_port*&
35579 The port on the sending host.
35580
35581 .vitem &*BOOL&~smtp_input*&
35582 This variable is TRUE for all SMTP input, including BSMTP.
35583
35584 .vitem &*BOOL&~smtp_batched_input*&
35585 This variable is TRUE for BSMTP input.
35586
35587 .vitem &*int&~store_pool*&
35588 The contents of this variable control which pool of memory is used for new
35589 requests. See section &<<SECTmemhanloc>>& for details.
35590 .endlist
35591
35592
35593 .section "Structure of header lines" "SECID209"
35594 The &%header_line%& structure contains the members listed below.
35595 You can add additional header lines by calling the &'header_add()'& function
35596 (see below). You can cause header lines to be ignored (deleted) by setting
35597 their type to *.
35598
35599
35600 .vlist
35601 .vitem &*struct&~header_line&~*next*&
35602 A pointer to the next header line, or NULL for the last line.
35603
35604 .vitem &*int&~type*&
35605 A code identifying certain headers that Exim recognizes. The codes are printing
35606 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35607 Notice in particular that any header line whose type is * is not transmitted
35608 with the message. This flagging is used for header lines that have been
35609 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35610 lines.) Effectively, * means &"deleted"&.
35611
35612 .vitem &*int&~slen*&
35613 The number of characters in the header line, including the terminating and any
35614 internal newlines.
35615
35616 .vitem &*uschar&~*text*&
35617 A pointer to the text of the header. It always ends with a newline, followed by
35618 a zero byte. Internal newlines are preserved.
35619 .endlist
35620
35621
35622
35623 .section "Structure of recipient items" "SECID210"
35624 The &%recipient_item%& structure contains these members:
35625
35626 .vlist
35627 .vitem &*uschar&~*address*&
35628 This is a pointer to the recipient address as it was received.
35629
35630 .vitem &*int&~pno*&
35631 This is used in later Exim processing when top level addresses are created by
35632 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35633 and must always contain -1 at this stage.
35634
35635 .vitem &*uschar&~*errors_to*&
35636 If this value is not NULL, bounce messages caused by failing to deliver to the
35637 recipient are sent to the address it contains. In other words, it overrides the
35638 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35639 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35640 an unqualified address, Exim qualifies it using the domain from
35641 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35642 is NULL for all recipients.
35643 .endlist
35644
35645
35646
35647 .section "Available Exim functions" "SECID211"
35648 .cindex "&[local_scan()]& function" "available Exim functions"
35649 The header &_local_scan.h_& gives you access to a number of Exim functions.
35650 These are the only ones that are guaranteed to be maintained from release to
35651 release:
35652
35653 .vlist
35654 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35655        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35656
35657 This function creates a child process that runs the command specified by
35658 &%argv%&. The environment for the process is specified by &%envp%&, which can
35659 be NULL if no environment variables are to be passed. A new umask is supplied
35660 for the process in &%newumask%&.
35661
35662 Pipes to the standard input and output of the new process are set up
35663 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35664 standard error is cloned to the standard output. If there are any file
35665 descriptors &"in the way"& in the new process, they are closed. If the final
35666 argument is TRUE, the new process is made into a process group leader.
35667
35668 The function returns the pid of the new process, or -1 if things go wrong.
35669
35670 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35671 This function waits for a child process to terminate, or for a timeout (in
35672 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35673 return value is as follows:
35674
35675 .ilist
35676 >= 0
35677
35678 The process terminated by a normal exit and the value is the process
35679 ending status.
35680
35681 .next
35682 < 0 and > &--256
35683
35684 The process was terminated by a signal and the value is the negation of the
35685 signal number.
35686
35687 .next
35688 &--256
35689
35690 The process timed out.
35691 .next
35692 &--257
35693
35694 The was some other error in wait(); &%errno%& is still set.
35695 .endlist
35696
35697 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35698 This function provide you with a means of submitting a new message to
35699 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35700 want, but this packages it all up for you.) The function creates a pipe,
35701 forks a subprocess that is running
35702 .code
35703 exim -t -oem -oi -f <>
35704 .endd
35705 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35706 that is connected to the standard input. The yield of the function is the PID
35707 of the subprocess. You can then write a message to the file descriptor, with
35708 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35709
35710 When you have finished, call &'child_close()'& to wait for the process to
35711 finish and to collect its ending status. A timeout value of zero is usually
35712 fine in this circumstance. Unless you have made a mistake with the recipient
35713 addresses, you should get a return code of zero.
35714
35715
35716 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35717        *sender_authentication)*&
35718 This function is a more sophisticated version of &'child_open()'&. The command
35719 that it runs is:
35720 .display
35721 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35722 .endd
35723 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35724
35725
35726 .vitem &*void&~debug_printf(char&~*,&~...)*&
35727 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35728 output is written to the standard error stream. If no debugging is selected,
35729 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35730 conditional on the &`local_scan`& debug selector by coding like this:
35731 .code
35732 if ((debug_selector & D_local_scan) != 0)
35733   debug_printf("xxx", ...);
35734 .endd
35735
35736 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35737 This is an interface to Exim's string expansion code. The return value is the
35738 expanded string, or NULL if there was an expansion failure.
35739 The C variable &%expand_string_message%& contains an error message after an
35740 expansion failure. If expansion does not change the string, the return value is
35741 the pointer to the input string. Otherwise, the return value points to a new
35742 block of memory that was obtained by a call to &'store_get()'&. See section
35743 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35744
35745 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35746 This function allows you to an add additional header line at the end of the
35747 existing ones. The first argument is the type, and should normally be a space
35748 character. The second argument is a format string and any number of
35749 substitution arguments as for &[sprintf()]&. You may include internal newlines
35750 if you want, and you must ensure that the string ends with a newline.
35751
35752 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35753         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35754 This function adds a new header line at a specified point in the header
35755 chain. The header itself is specified as for &'header_add()'&.
35756
35757 If &%name%& is NULL, the new header is added at the end of the chain if
35758 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35759 NULL, the header lines are searched for the first non-deleted header that
35760 matches the name. If one is found, the new header is added before it if
35761 &%after%& is false. If &%after%& is true, the new header is added after the
35762 found header and any adjacent subsequent ones with the same name (even if
35763 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35764 option controls where the header is added. If it is true, addition is at the
35765 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35766 headers, or at the top if there are no &'Received:'& headers, you could use
35767 .code
35768 header_add_at_position(TRUE, US"Received", TRUE,
35769   ' ', "X-xxx: ...");
35770 .endd
35771 Normally, there is always at least one non-deleted &'Received:'& header, but
35772 there may not be if &%received_header_text%& expands to an empty string.
35773
35774
35775 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35776 This function removes header lines. If &%occurrence%& is zero or negative, all
35777 occurrences of the header are removed. If occurrence is greater than zero, that
35778 particular instance of the header is removed. If no header(s) can be found that
35779 match the specification, the function does nothing.
35780
35781
35782 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35783         int&~length,&~BOOL&~notdel)*&"
35784 This function tests whether the given header has the given name. It is not just
35785 a string comparison, because white space is permitted between the name and the
35786 colon. If the &%notdel%& argument is true, a false return is forced for all
35787 &"deleted"& headers; otherwise they are not treated specially. For example:
35788 .code
35789 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35790 .endd
35791 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35792 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35793 This function base64-encodes a string, which is passed by address and length.
35794 The text may contain bytes of any value, including zero. The result is passed
35795 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35796 zero-terminated.
35797
35798 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35799 This function decodes a base64-encoded string. Its arguments are a
35800 zero-terminated base64-encoded string and the address of a variable that is set
35801 to point to the result, which is in dynamic memory. The length of the decoded
35802 string is the yield of the function. If the input is invalid base64 data, the
35803 yield is -1. A zero byte is added to the end of the output string to make it
35804 easy to interpret as a C string (assuming it contains no zeros of its own). The
35805 added zero byte is not included in the returned count.
35806
35807 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35808 This function checks for a match in a domain list. Domains are always
35809 matched caselessly. The return value is one of the following:
35810 .itable none 0 0 2 15* left 85* left
35811 .irow &`OK`&    "match succeeded"
35812 .irow &`FAIL`&  "match failed"
35813 .irow &`DEFER`& "match deferred"
35814 .endtable
35815 DEFER is usually caused by some kind of lookup defer, such as the
35816 inability to contact a database.
35817
35818 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35819         BOOL&~caseless)*&"
35820 This function checks for a match in a local part list. The third argument
35821 controls case-sensitivity. The return values are as for
35822 &'lss_match_domain()'&.
35823
35824 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35825         BOOL&~caseless)*&"
35826 This function checks for a match in an address list. The third argument
35827 controls the case-sensitivity of the local part match. The domain is always
35828 matched caselessly. The return values are as for &'lss_match_domain()'&.
35829
35830 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35831         uschar&~*list)*&"
35832 This function checks for a match in a host list. The most common usage is
35833 expected to be
35834 .code
35835 lss_match_host(sender_host_name, sender_host_address, ...)
35836 .endd
35837 .vindex "&$sender_host_address$&"
35838 An empty address field matches an empty item in the host list. If the host name
35839 is NULL, the name corresponding to &$sender_host_address$& is automatically
35840 looked up if a host name is required to match an item in the list. The return
35841 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35842 returns ERROR in the case when it had to look up a host name, but the lookup
35843 failed.
35844
35845 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35846         *format,&~...)*&"
35847 This function writes to Exim's log files. The first argument should be zero (it
35848 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35849 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35850 them. It specifies to which log or logs the message is written. The remaining
35851 arguments are a format and relevant insertion arguments. The string should not
35852 contain any newlines, not even at the end.
35853
35854
35855 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35856 This function adds an additional recipient to the message. The first argument
35857 is the recipient address. If it is unqualified (has no domain), it is qualified
35858 with the &%qualify_recipient%& domain. The second argument must always be -1.
35859
35860 This function does not allow you to specify a private &%errors_to%& address (as
35861 described with the structure of &%recipient_item%& above), because it pre-dates
35862 the addition of that field to the structure. However, it is easy to add such a
35863 value afterwards. For example:
35864 .code
35865  receive_add_recipient(US"monitor@mydom.example", -1);
35866  recipients_list[recipients_count-1].errors_to =
35867    US"postmaster@mydom.example";
35868 .endd
35869
35870 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35871 This is a convenience function to remove a named recipient from the list of
35872 recipients. It returns true if a recipient was removed, and false if no
35873 matching recipient could be found. The argument must be a complete email
35874 address.
35875 .endlist
35876
35877
35878 .cindex "RFC 2047"
35879 .vlist
35880 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35881   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35882 This function decodes strings that are encoded according to RFC 2047. Typically
35883 these are the contents of header lines. First, each &"encoded word"& is decoded
35884 from the Q or B encoding into a byte-string. Then, if provided with the name of
35885 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35886 made  to translate the result to the named character set. If this fails, the
35887 binary string is returned with an error message.
35888
35889 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35890 maximum MIME word length is enforced. The third argument is the target
35891 encoding, or NULL if no translation is wanted.
35892
35893 .cindex "binary zero" "in RFC 2047 decoding"
35894 .cindex "RFC 2047" "binary zero in"
35895 If a binary zero is encountered in the decoded string, it is replaced by the
35896 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35897 not be 0 because header lines are handled as zero-terminated strings.
35898
35899 The function returns the result of processing the string, zero-terminated; if
35900 &%lenptr%& is not NULL, the length of the result is set in the variable to
35901 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35902
35903 If an error is encountered, the function returns NULL and uses the &%error%&
35904 argument to return an error message. The variable pointed to by &%error%& is
35905 set to NULL if there is no error; it may be set non-NULL even when the function
35906 returns a non-NULL value if decoding was successful, but there was a problem
35907 with translation.
35908
35909
35910 .vitem &*int&~smtp_fflush(void)*&
35911 This function is used in conjunction with &'smtp_printf()'&, as described
35912 below.
35913
35914 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35915 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35916 output stream. You should use this function only when there is an SMTP output
35917 stream, that is, when the incoming message is being received via interactive
35918 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35919 is FALSE. If you want to test for an incoming message from another host (as
35920 opposed to a local process that used the &%-bs%& command line option), you can
35921 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35922 is involved.
35923
35924 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35925 output function, so it can be used for all forms of SMTP connection.
35926
35927 The second argument is used to request that the data be buffered
35928 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35929 This is advisory only, but likely to save on system-calls and packets
35930 sent when a sequence of calls to the function are made.
35931
35932 The argument was added in Exim version 4.90 - changing the API/ABI.
35933 Nobody noticed until 4.93 was imminent, at which point the
35934 ABI version number was incremented.
35935
35936 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35937 must start with an appropriate response code: 550 if you are going to return
35938 LOCAL_SCAN_REJECT, 451 if you are going to return
35939 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35940 initial lines of a multi-line response, the code must be followed by a hyphen
35941 to indicate that the line is not the final response line. You must also ensure
35942 that the lines you write terminate with CRLF. For example:
35943 .code
35944 smtp_printf("550-this is some extra info\r\n");
35945 return LOCAL_SCAN_REJECT;
35946 .endd
35947 Note that you can also create multi-line responses by including newlines in
35948 the data returned via the &%return_text%& argument. The added value of using
35949 &'smtp_printf()'& is that, for instance, you could introduce delays between
35950 multiple output lines.
35951
35952 The &'smtp_printf()'& function does not return any error indication, because it
35953 does not
35954 guarantee a flush of
35955 pending output, and therefore does not test
35956 the state of the stream. (In the main code of Exim, flushing and error
35957 detection is done when Exim is ready for the next SMTP input command.) If
35958 you want to flush the output and check for an error (for example, the
35959 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35960 arguments. It flushes the output stream, and returns a non-zero value if there
35961 is an error.
35962
35963 .vitem &*void&~*store_get(int,BOOL)*&
35964 This function accesses Exim's internal store (memory) manager. It gets a new
35965 chunk of memory whose size is given by the first argument.
35966 The second argument should be given as TRUE if the memory will be used for
35967 data possibly coming from an attacker (eg. the message content),
35968 FALSE if it is locally-sourced.
35969 Exim bombs out if it ever
35970 runs out of memory. See the next section for a discussion of memory handling.
35971
35972 .vitem &*void&~*store_get_perm(int,BOOL)*&
35973 This function is like &'store_get()'&, but it always gets memory from the
35974 permanent pool. See the next section for a discussion of memory handling.
35975
35976 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35977 See below.
35978
35979 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35980 See below.
35981
35982 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35983 These three functions create strings using Exim's dynamic memory facilities.
35984 The first makes a copy of an entire string. The second copies up to a maximum
35985 number of characters, indicated by the second argument. The third uses a format
35986 and insertion arguments to create a new string. In each case, the result is a
35987 pointer to a new string in the current memory pool. See the next section for
35988 more discussion.
35989 .endlist
35990
35991
35992
35993 .section "More about Exim's memory handling" "SECTmemhanloc"
35994 .cindex "&[local_scan()]& function" "memory handling"
35995 No function is provided for freeing memory, because that is never needed.
35996 The dynamic memory that Exim uses when receiving a message is automatically
35997 recycled if another message is received by the same process (this applies only
35998 to incoming SMTP connections &-- other input methods can supply only one
35999 message at a time). After receiving the last message, a reception process
36000 terminates.
36001
36002 Because it is recycled, the normal dynamic memory cannot be used for holding
36003 data that must be preserved over a number of incoming messages on the same SMTP
36004 connection. However, Exim in fact uses two pools of dynamic memory; the second
36005 one is not recycled, and can be used for this purpose.
36006
36007 If you want to allocate memory that remains available for subsequent messages
36008 in the same SMTP connection, you should set
36009 .code
36010 store_pool = POOL_PERM
36011 .endd
36012 before calling the function that does the allocation. There is no need to
36013 restore the value if you do not need to; however, if you do want to revert to
36014 the normal pool, you can either restore the previous value of &%store_pool%& or
36015 set it explicitly to POOL_MAIN.
36016
36017 The pool setting applies to all functions that get dynamic memory, including
36018 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36019 There is also a convenience function called &'store_get_perm()'& that gets a
36020 block of memory from the permanent pool while preserving the value of
36021 &%store_pool%&.
36022 .ecindex IIDlosca
36023
36024
36025
36026
36027 . ////////////////////////////////////////////////////////////////////////////
36028 . ////////////////////////////////////////////////////////////////////////////
36029
36030 .chapter "System-wide message filtering" "CHAPsystemfilter"
36031 .scindex IIDsysfil1 "filter" "system filter"
36032 .scindex IIDsysfil2 "filtering all mail"
36033 .scindex IIDsysfil3 "system filter"
36034 The previous chapters (on ACLs and the local scan function) describe checks
36035 that can be applied to messages before they are accepted by a host. There is
36036 also a mechanism for checking messages once they have been received, but before
36037 they are delivered. This is called the &'system filter'&.
36038
36039 The system filter operates in a similar manner to users' filter files, but it
36040 is run just once per message (however many recipients the message has).
36041 It should not normally be used as a substitute for routing, because &%deliver%&
36042 commands in a system router provide new envelope recipient addresses.
36043 The system filter must be an Exim filter. It cannot be a Sieve filter.
36044
36045 The system filter is run at the start of a delivery attempt, before any routing
36046 is done. If a message fails to be completely delivered at the first attempt,
36047 the system filter is run again at the start of every retry.
36048 If you want your filter to do something only once per message, you can make use
36049 .cindex retry condition
36050 of the &%first_delivery%& condition in an &%if%& command in the filter to
36051 prevent it happening on retries.
36052
36053 .vindex "&$domain$&"
36054 .vindex "&$local_part$&"
36055 &*Warning*&: Because the system filter runs just once, variables that are
36056 specific to individual recipient addresses, such as &$local_part$& and
36057 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36058 you want to run a centrally-specified filter for each recipient address
36059 independently, you can do so by setting up a suitable &(redirect)& router, as
36060 described in section &<<SECTperaddfil>>& below.
36061
36062
36063 .section "Specifying a system filter" "SECID212"
36064 .cindex "uid (user id)" "system filter"
36065 .cindex "gid (group id)" "system filter"
36066 The name of the file that contains the system filter must be specified by
36067 setting &%system_filter%&. If you want the filter to run under a uid and gid
36068 other than root, you must also set &%system_filter_user%& and
36069 &%system_filter_group%& as appropriate. For example:
36070 .code
36071 system_filter = /etc/mail/exim.filter
36072 system_filter_user = exim
36073 .endd
36074 If a system filter generates any deliveries directly to files or pipes (via the
36075 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36076 specified by setting &%system_filter_file_transport%& and
36077 &%system_filter_pipe_transport%&, respectively. Similarly,
36078 &%system_filter_reply_transport%& must be set to handle any messages generated
36079 by the &%reply%& command.
36080
36081
36082 .section "Testing a system filter" "SECID213"
36083 You can run simple tests of a system filter in the same way as for a user
36084 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36085 are permitted only in system filters are recognized.
36086
36087 If you want to test the combined effect of a system filter and a user filter,
36088 you can use both &%-bF%& and &%-bf%& on the same command line.
36089
36090
36091
36092 .section "Contents of a system filter" "SECID214"
36093 The language used to specify system filters is the same as for users' filter
36094 files. It is described in the separate end-user document &'Exim's interface to
36095 mail filtering'&. However, there are some additional features that are
36096 available only in system filters; these are described in subsequent sections.
36097 If they are encountered in a user's filter file or when testing with &%-bf%&,
36098 they cause errors.
36099
36100 .cindex "frozen messages" "manual thaw; testing in filter"
36101 There are two special conditions which, though available in users' filter
36102 files, are designed for use in system filters. The condition &%first_delivery%&
36103 is true only for the first attempt at delivering a message, and
36104 &%manually_thawed%& is true only if the message has been frozen, and
36105 subsequently thawed by an admin user. An explicit forced delivery counts as a
36106 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36107
36108 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36109 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36110 succeed, it will not be tried again.
36111 If you want Exim to retry an unseen delivery until it succeeds, you should
36112 arrange to set it up every time the filter runs.
36113
36114 When a system filter finishes running, the values of the variables &$n0$& &--
36115 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36116 users' filter files. Thus a system filter can, for example, set up &"scores"&
36117 to which users' filter files can refer.
36118
36119
36120
36121 .section "Additional variable for system filters" "SECID215"
36122 .vindex "&$recipients$&"
36123 The expansion variable &$recipients$&, containing a list of all the recipients
36124 of the message (separated by commas and white space), is available in system
36125 filters. It is not available in users' filters for privacy reasons.
36126
36127
36128
36129 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36130 .cindex "freezing messages"
36131 .cindex "message" "freezing"
36132 .cindex "message" "forced failure"
36133 .cindex "&%fail%&" "in system filter"
36134 .cindex "&%freeze%& in system filter"
36135 .cindex "&%defer%& in system filter"
36136 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36137 always available in system filters, but are not normally enabled in users'
36138 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36139 for the &(redirect)& router.) These commands can optionally be followed by the
36140 word &%text%& and a string containing an error message, for example:
36141 .code
36142 fail text "this message looks like spam to me"
36143 .endd
36144 The keyword &%text%& is optional if the next character is a double quote.
36145
36146 The &%defer%& command defers delivery of the original recipients of the
36147 message. The &%fail%& command causes all the original recipients to be failed,
36148 and a bounce message to be created. The &%freeze%& command suspends all
36149 delivery attempts for the original recipients. In all cases, any new deliveries
36150 that are specified by the filter are attempted as normal after the filter has
36151 run.
36152
36153 The &%freeze%& command is ignored if the message has been manually unfrozen and
36154 not manually frozen since. This means that automatic freezing by a system
36155 filter can be used as a way of checking out suspicious messages. If a message
36156 is found to be all right, manually unfreezing it allows it to be delivered.
36157
36158 .cindex "log" "&%fail%& command log line"
36159 .cindex "&%fail%&" "log line; reducing"
36160 The text given with a fail command is used as part of the bounce message as
36161 well as being written to the log. If the message is quite long, this can fill
36162 up a lot of log space when such failures are common. To reduce the size of the
36163 log message, Exim interprets the text in a special way if it starts with the
36164 two characters &`<<`& and contains &`>>`& later. The text between these two
36165 strings is written to the log, and the rest of the text is used in the bounce
36166 message. For example:
36167 .code
36168 fail "<<filter test 1>>Your message is rejected \
36169      because it contains attachments that we are \
36170      not prepared to receive."
36171 .endd
36172
36173 .cindex "loop" "caused by &%fail%&"
36174 Take great care with the &%fail%& command when basing the decision to fail on
36175 the contents of the message, because the bounce message will of course include
36176 the contents of the original message and will therefore trigger the &%fail%&
36177 command again (causing a mail loop) unless steps are taken to prevent this.
36178 Testing the &%error_message%& condition is one way to prevent this. You could
36179 use, for example
36180 .code
36181 if $message_body contains "this is spam" and not error_message
36182 then fail text "spam is not wanted here" endif
36183 .endd
36184 though of course that might let through unwanted bounce messages. The
36185 alternative is clever checking of the body and/or headers to detect bounces
36186 generated by the filter.
36187
36188 The interpretation of a system filter file ceases after a
36189 &%defer%&,
36190 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36191 set up earlier in the filter file are honoured, so you can use a sequence such
36192 as
36193 .code
36194 mail ...
36195 freeze
36196 .endd
36197 to send a specified message when the system filter is freezing (or deferring or
36198 failing) a message. The normal deliveries for the message do not, of course,
36199 take place.
36200
36201
36202
36203 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36204 .cindex "header lines" "adding; in system filter"
36205 .cindex "header lines" "removing; in system filter"
36206 .cindex "filter" "header lines; adding/removing"
36207 Two filter commands that are available only in system filters are:
36208 .code
36209 headers add <string>
36210 headers remove <string>
36211 .endd
36212 The argument for the &%headers add%& is a string that is expanded and then
36213 added to the end of the message's headers. It is the responsibility of the
36214 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36215 space is ignored, and if the string is otherwise empty, or if the expansion is
36216 forced to fail, the command has no effect.
36217
36218 You can use &"\n"& within the string, followed by white space, to specify
36219 continued header lines. More than one header may be added in one command by
36220 including &"\n"& within the string without any following white space. For
36221 example:
36222 .code
36223 headers add "X-header-1: ....\n  \
36224              continuation of X-header-1 ...\n\
36225              X-header-2: ...."
36226 .endd
36227 Note that the header line continuation white space after the first newline must
36228 be placed before the backslash that continues the input string, because white
36229 space after input continuations is ignored.
36230
36231 The argument for &%headers remove%& is a colon-separated list of header names.
36232 This command applies only to those headers that are stored with the message;
36233 those that are added at delivery time (such as &'Envelope-To:'& and
36234 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36235 header with the same name, they are all removed.
36236
36237 The &%headers%& command in a system filter makes an immediate change to the set
36238 of header lines that was received with the message (with possible additions
36239 from ACL processing). Subsequent commands in the system filter operate on the
36240 modified set, which also forms the basis for subsequent message delivery.
36241 Unless further modified during routing or transporting, this set of headers is
36242 used for all recipients of the message.
36243
36244 During routing and transporting, the variables that refer to the contents of
36245 header lines refer only to those lines that are in this set. Thus, header lines
36246 that are added by a system filter are visible to users' filter files and to all
36247 routers and transports. This contrasts with the manipulation of header lines by
36248 routers and transports, which is not immediate, but which instead is saved up
36249 until the message is actually being written (see section
36250 &<<SECTheadersaddrem>>&).
36251
36252 If the message is not delivered at the first attempt, header lines that were
36253 added by the system filter are stored with the message, and so are still
36254 present at the next delivery attempt. Header lines that were removed are still
36255 present, but marked &"deleted"& so that they are not transported with the
36256 message. For this reason, it is usual to make the &%headers%& command
36257 conditional on &%first_delivery%& so that the set of header lines is not
36258 modified more than once.
36259
36260 Because header modification in a system filter acts immediately, you have to
36261 use an indirect approach if you want to modify the contents of a header line.
36262 For example:
36263 .code
36264 headers add "Old-Subject: $h_subject:"
36265 headers remove "Subject"
36266 headers add "Subject: new subject (was: $h_old-subject:)"
36267 headers remove "Old-Subject"
36268 .endd
36269
36270
36271
36272 .section "Setting an errors address in a system filter" "SECID217"
36273 .cindex "envelope from"
36274 .cindex "envelope sender"
36275 In a system filter, if a &%deliver%& command is followed by
36276 .code
36277 errors_to <some address>
36278 .endd
36279 in order to change the envelope sender (and hence the error reporting) for that
36280 delivery, any address may be specified. (In a user filter, only the current
36281 user's address can be set.) For example, if some mail is being monitored, you
36282 might use
36283 .code
36284 unseen deliver monitor@spying.example errors_to root@local.example
36285 .endd
36286 to take a copy which would not be sent back to the normal error reporting
36287 address if its delivery failed.
36288
36289
36290
36291 .section "Per-address filtering" "SECTperaddfil"
36292 .vindex "&$domain_data$&"
36293 .vindex "&$local_part_data$&"
36294 In contrast to the system filter, which is run just once per message for each
36295 delivery attempt, it is also possible to set up a system-wide filtering
36296 operation that runs once for each recipient address. In this case, variables
36297 such as &$local_part_data$& and &$domain_data$& can be used,
36298 and indeed, the choice of filter file could be made dependent on them.
36299 This is an example of a router which implements such a filter:
36300 .code
36301 central_filter:
36302   check_local_user
36303   driver = redirect
36304   domains = +local_domains
36305   file = /central/filters/$local_part_data
36306   no_verify
36307   allow_filter
36308   allow_freeze
36309 .endd
36310 The filter is run in a separate process under its own uid. Therefore, either
36311 &%check_local_user%& must be set (as above), in which case the filter is run as
36312 the local user, or the &%user%& option must be used to specify which user to
36313 use. If both are set, &%user%& overrides.
36314
36315 Care should be taken to ensure that none of the commands in the filter file
36316 specify a significant delivery if the message is to go on to be delivered to
36317 its intended recipient. The router will not then claim to have dealt with the
36318 address, so it will be passed on to subsequent routers to be delivered in the
36319 normal way.
36320 .ecindex IIDsysfil1
36321 .ecindex IIDsysfil2
36322 .ecindex IIDsysfil3
36323
36324
36325
36326
36327
36328
36329 . ////////////////////////////////////////////////////////////////////////////
36330 . ////////////////////////////////////////////////////////////////////////////
36331
36332 .chapter "Message processing" "CHAPmsgproc"
36333 .scindex IIDmesproc "message" "general processing"
36334 Exim performs various transformations on the sender and recipient addresses of
36335 all messages that it handles, and also on the messages' header lines. Some of
36336 these are optional and configurable, while others always take place. All of
36337 this processing, except rewriting as a result of routing, and the addition or
36338 removal of header lines while delivering, happens when a message is received,
36339 before it is placed on Exim's queue.
36340
36341 Some of the automatic processing takes place by default only for
36342 &"locally-originated"& messages. This adjective is used to describe messages
36343 that are not received over TCP/IP, but instead are passed to an Exim process on
36344 its standard input. This includes the interactive &"local SMTP"& case that is
36345 set up by the &%-bs%& command line option.
36346
36347 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36348 or ::1) are not considered to be locally-originated. Exim does not treat the
36349 loopback interface specially in any way.
36350
36351 If you want the loopback interface to be treated specially, you must ensure
36352 that there are appropriate entries in your ACLs.
36353
36354
36355
36356
36357 .section "Submission mode for non-local messages" "SECTsubmodnon"
36358 .cindex "message" "submission"
36359 .cindex "submission mode"
36360 Processing that happens automatically for locally-originated messages (unless
36361 &%suppress_local_fixups%& is set) can also be requested for messages that are
36362 received over TCP/IP. The term &"submission mode"& is used to describe this
36363 state. Submission mode is set by the modifier
36364 .code
36365 control = submission
36366 .endd
36367 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36368 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36369 a local submission, and is normally used when the source of the message is
36370 known to be an MUA running on a client host (as opposed to an MTA). For
36371 example, to set submission mode for messages originating on the IPv4 loopback
36372 interface, you could include the following in the MAIL ACL:
36373 .code
36374 warn  hosts = 127.0.0.1
36375       control = submission
36376 .endd
36377 .cindex "&%sender_retain%& submission option"
36378 There are some options that can be used when setting submission mode. A slash
36379 is used to separate options. For example:
36380 .code
36381 control = submission/sender_retain
36382 .endd
36383 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36384 true and &%local_from_check%& false for the current incoming message. The first
36385 of these allows an existing &'Sender:'& header in the message to remain, and
36386 the second suppresses the check to ensure that &'From:'& matches the
36387 authenticated sender. With this setting, Exim still fixes up messages by adding
36388 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36389 attempt to check sender authenticity in header lines.
36390
36391 When &%sender_retain%& is not set, a submission mode setting may specify a
36392 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36393 example:
36394 .code
36395 control = submission/domain=some.domain
36396 .endd
36397 The domain may be empty. How this value is used is described in sections
36398 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36399 that allows you to specify the user's full name for inclusion in a created
36400 &'Sender:'& or &'From:'& header line. For example:
36401 .code
36402 accept authenticated = *
36403        control = submission/domain=wonderland.example/\
36404                             name=${lookup {$authenticated_id} \
36405                                    lsearch {/etc/exim/namelist}}
36406 .endd
36407 Because the name may contain any characters, including slashes, the &%name%&
36408 option must be given last. The remainder of the string is used as the name. For
36409 the example above, if &_/etc/exim/namelist_& contains:
36410 .code
36411 bigegg:  Humpty Dumpty
36412 .endd
36413 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36414 line would be:
36415 .code
36416 Sender: Humpty Dumpty <bigegg@wonderland.example>
36417 .endd
36418 .cindex "return path" "in submission mode"
36419 By default, submission mode forces the return path to the same address as is
36420 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36421 specified, the return path is also left unchanged.
36422
36423 &*Note*&: The changes caused by submission mode take effect after the predata
36424 ACL. This means that any sender checks performed before the fix-ups use the
36425 untrusted sender address specified by the user, not the trusted sender address
36426 specified by submission mode. Although this might be slightly unexpected, it
36427 does mean that you can configure ACL checks to spot that a user is trying to
36428 spoof another's address.
36429
36430 .section "Line endings" "SECTlineendings"
36431 .cindex "line endings"
36432 .cindex "carriage return"
36433 .cindex "linefeed"
36434 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36435 linefeed) is the line ending for messages transmitted over the Internet using
36436 SMTP over TCP/IP. However, within individual operating systems, different
36437 conventions are used. For example, Unix-like systems use just LF, but others
36438 use CRLF or just CR.
36439
36440 Exim was designed for Unix-like systems, and internally, it stores messages
36441 using the system's convention of a single LF as a line terminator. When
36442 receiving a message, all line endings are translated to this standard format.
36443 Originally, it was thought that programs that passed messages directly to an
36444 MTA within an operating system would use that system's convention. Experience
36445 has shown that this is not the case; for example, there are Unix applications
36446 that use CRLF in this circumstance. For this reason, and for compatibility with
36447 other MTAs, the way Exim handles line endings for all messages is now as
36448 follows:
36449
36450 .ilist
36451 LF not preceded by CR is treated as a line ending.
36452 .next
36453 CR is treated as a line ending; if it is immediately followed by LF, the LF
36454 is ignored.
36455 .next
36456 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36457 nor a local message in the state where a line containing only a dot is a
36458 terminator.
36459 .next
36460 If a bare CR is encountered within a header line, an extra space is added after
36461 the line terminator so as not to end the header line. The reasoning behind this
36462 is that bare CRs in header lines are most likely either to be mistakes, or
36463 people trying to play silly games.
36464 .next
36465 If the first header line received in a message ends with CRLF, a subsequent
36466 bare LF in a header line is treated in the same way as a bare CR in a header
36467 line.
36468 .endlist
36469
36470
36471
36472
36473
36474 .section "Unqualified addresses" "SECID218"
36475 .cindex "unqualified addresses"
36476 .cindex "address" "qualification"
36477 By default, Exim expects every envelope address it receives from an external
36478 host to be fully qualified. Unqualified addresses cause negative responses to
36479 SMTP commands. However, because SMTP is used as a means of transporting
36480 messages from MUAs running on personal workstations, there is sometimes a
36481 requirement to accept unqualified addresses from specific hosts or IP networks.
36482
36483 Exim has two options that separately control which hosts may send unqualified
36484 sender or recipient addresses in SMTP commands, namely
36485 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36486 cases, if an unqualified address is accepted, it is qualified by adding the
36487 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36488
36489 .oindex "&%qualify_domain%&"
36490 .oindex "&%qualify_recipient%&"
36491 Unqualified addresses in header lines are automatically qualified for messages
36492 that are locally originated, unless the &%-bnq%& option is given on the command
36493 line. For messages received over SMTP, unqualified addresses in header lines
36494 are qualified only if unqualified addresses are permitted in SMTP commands. In
36495 other words, such qualification is also controlled by
36496 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36497
36498
36499
36500
36501 .section "The UUCP From line" "SECID219"
36502 .cindex "&""From""& line"
36503 .cindex "UUCP" "&""From""& line"
36504 .cindex "sender" "address"
36505 .oindex "&%uucp_from_pattern%&"
36506 .oindex "&%uucp_from_sender%&"
36507 .cindex "envelope from"
36508 .cindex "envelope sender"
36509 .cindex "Sendmail compatibility" "&""From""& line"
36510 Messages that have come from UUCP (and some other applications) often begin
36511 with a line containing the envelope sender and a timestamp, following the word
36512 &"From"&. Examples of two common formats are:
36513 .code
36514 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36515 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36516 .endd
36517 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36518 Exim recognizes such lines at the start of messages that are submitted to it
36519 via the command line (that is, on the standard input). It does not recognize
36520 such lines in incoming SMTP messages, unless the sending host matches
36521 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36522 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36523 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36524 default value matches the two common cases shown above and puts the address
36525 that follows &"From"& into &$1$&.
36526
36527 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36528 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36529 a trusted user, the message's sender address is constructed by expanding the
36530 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36531 then parsed as an RFC 2822 address. If there is no domain, the local part is
36532 qualified with &%qualify_domain%& unless it is the empty string. However, if
36533 the command line &%-f%& option is used, it overrides the &"From"& line.
36534
36535 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36536 sender address is not changed. This is also the case for incoming SMTP messages
36537 that are permitted to contain &"From"& lines.
36538
36539 Only one &"From"& line is recognized. If there is more than one, the second is
36540 treated as a data line that starts the body of the message, as it is not valid
36541 as a header line. This also happens if a &"From"& line is present in an
36542 incoming SMTP message from a source that is not permitted to send them.
36543
36544
36545
36546 .section "Header lines"
36547 .subsection "Resent- header lines" SECID220
36548 .chindex Resent-
36549 RFC 2822 makes provision for sets of header lines starting with the string
36550 &`Resent-`& to be added to a message when it is resent by the original
36551 recipient to somebody else. These headers are &'Resent-Date:'&,
36552 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36553 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36554
36555 .blockquote
36556 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36557 processing of replies or other such automatic actions on messages.'&
36558 .endblockquote
36559
36560 This leaves things a bit vague as far as other processing actions such as
36561 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36562 follows:
36563
36564 .ilist
36565 A &'Resent-From:'& line that just contains the login id of the submitting user
36566 is automatically rewritten in the same way as &'From:'& (see below).
36567 .next
36568 If there's a rewriting rule for a particular header line, it is also applied to
36569 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36570 &'From:'& also rewrites &'Resent-From:'&.
36571 .next
36572 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36573 also removed.
36574 .next
36575 For a locally-submitted message,
36576 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36577 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36578 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36579 included in log lines in this case.
36580 .next
36581 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36582 &%Resent-%& header lines are present.
36583 .endlist
36584
36585
36586
36587
36588 .subsection Auto-Submitted: SECID221
36589 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36590 includes the header line:
36591 .code
36592 Auto-Submitted: auto-replied
36593 .endd
36594
36595 .subsection Bcc: SECID222
36596 .cindex "&'Bcc:'& header line"
36597 If Exim is called with the &%-t%& option, to take recipient addresses from a
36598 message's header, it removes any &'Bcc:'& header line that may exist (after
36599 extracting its addresses). If &%-t%& is not present on the command line, any
36600 existing &'Bcc:'& is not removed.
36601
36602
36603 .subsection Date: SECID223
36604 .cindex Date:
36605 If a locally-generated or submission-mode message has no &'Date:'& header line,
36606 Exim adds one, using the current date and time, unless the
36607 &%suppress_local_fixups%& control has been specified.
36608
36609 .subsection Delivery-date: SECID224
36610 .cindex "&'Delivery-date:'& header line"
36611 .oindex "&%delivery_date_remove%&"
36612 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36613 set. Exim can be configured to add them to the final delivery of messages. (See
36614 the generic &%delivery_date_add%& transport option.) They should not be present
36615 in messages in transit. If the &%delivery_date_remove%& configuration option is
36616 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36617 messages.
36618
36619
36620 .subsection Envelope-to: SECID225
36621 .chindex Envelope-to:
36622 .oindex "&%envelope_to_remove%&"
36623 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36624 Exim can be configured to add them to the final delivery of messages. (See the
36625 generic &%envelope_to_add%& transport option.) They should not be present in
36626 messages in transit. If the &%envelope_to_remove%& configuration option is set
36627 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36628 messages.
36629
36630
36631 .subsection From: SECTthefrohea
36632 .chindex From:
36633 .cindex "Sendmail compatibility" "&""From""& line"
36634 .cindex "message" "submission"
36635 .cindex "submission mode"
36636 If a submission-mode message does not contain a &'From:'& header line, Exim
36637 adds one if either of the following conditions is true:
36638
36639 .ilist
36640 The envelope sender address is not empty (that is, this is not a bounce
36641 message). The added header line copies the envelope sender address.
36642 .next
36643 .vindex "&$authenticated_id$&"
36644 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36645 .olist
36646 .vindex "&$qualify_domain$&"
36647 If no domain is specified by the submission control, the local part is
36648 &$authenticated_id$& and the domain is &$qualify_domain$&.
36649 .next
36650 If a non-empty domain is specified by the submission control, the local
36651 part is &$authenticated_id$&, and the domain is the specified domain.
36652 .next
36653 If an empty domain is specified by the submission control,
36654 &$authenticated_id$& is assumed to be the complete address.
36655 .endlist
36656 .endlist
36657
36658 A non-empty envelope sender takes precedence.
36659
36660 If a locally-generated incoming message does not contain a &'From:'& header
36661 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36662 containing the sender's address. The calling user's login name and full name
36663 are used to construct the address, as described in section &<<SECTconstr>>&.
36664 They are obtained from the password data by calling &[getpwuid()]& (but see the
36665 &%unknown_login%& configuration option). The address is qualified with
36666 &%qualify_domain%&.
36667
36668 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36669 &'From:'& header line containing just the unqualified login name of the calling
36670 user, this is replaced by an address containing the user's login name and full
36671 name as described in section &<<SECTconstr>>&.
36672
36673
36674 .subsection Message-ID: SECID226
36675 .chindex Message-ID:
36676 .cindex "message" "submission"
36677 .oindex "&%message_id_header_text%&"
36678 If a locally-generated or submission-mode incoming message does not contain a
36679 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36680 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36681 to the message. If there are any &'Resent-:'& headers in the message, it
36682 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36683 message id, preceded by the letter E to ensure it starts with a letter, and
36684 followed by @ and the primary host name. Additional information can be included
36685 in this header line by setting the &%message_id_header_text%& and/or
36686 &%message_id_header_domain%& options.
36687
36688
36689 .subsection Received: SECID227
36690 .chindex Received:
36691 A &'Received:'& header line is added at the start of every message. The
36692 contents are defined by the &%received_header_text%& configuration option, and
36693 Exim automatically adds a semicolon and a timestamp to the configured string.
36694
36695 The &'Received:'& header is generated as soon as the message's header lines
36696 have been received. At this stage, the timestamp in the &'Received:'& header
36697 line is the time that the message started to be received. This is the value
36698 that is seen by the DATA ACL and by the &[local_scan()]& function.
36699
36700 Once a message is accepted, the timestamp in the &'Received:'& header line is
36701 changed to the time of acceptance, which is (apart from a small delay while the
36702 -H spool file is written) the earliest time at which delivery could start.
36703
36704
36705 .subsection References: SECID228
36706 .chindex References:
36707 Messages created by the &(autoreply)& transport include a &'References:'&
36708 header line. This is constructed according to the rules that are described in
36709 section 3.64 of RFC 2822 (which states that replies should contain such a
36710 header line), and section 3.14 of RFC 3834 (which states that automatic
36711 responses are not different in this respect). However, because some mail
36712 processing software does not cope well with very long header lines, no more
36713 than 12 message IDs are copied from the &'References:'& header line in the
36714 incoming message. If there are more than 12, the first one and then the final
36715 11 are copied, before adding the message ID of the incoming message.
36716
36717
36718
36719 .subsection Return-path: SECID229
36720 .chindex Return-path:
36721 .oindex "&%return_path_remove%&"
36722 &'Return-path:'& header lines are defined as something an MTA may insert when
36723 it does the final delivery of messages. (See the generic &%return_path_add%&
36724 transport option.) Therefore, they should not be present in messages in
36725 transit. If the &%return_path_remove%& configuration option is set (the
36726 default), Exim removes &'Return-path:'& header lines from incoming messages.
36727
36728
36729
36730 .subsection Sender: SECTthesenhea
36731 .cindex "&'Sender:'& header line"
36732 .cindex "message" "submission"
36733 .chindex Sender:
36734 For a locally-originated message from an untrusted user, Exim may remove an
36735 existing &'Sender:'& header line, and it may add a new one. You can modify
36736 these actions by setting the &%local_sender_retain%& option true, the
36737 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36738 control setting.
36739
36740 When a local message is received from an untrusted user and
36741 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36742 control has not been set, a check is made to see if the address given in the
36743 &'From:'& header line is the correct (local) sender of the message. The address
36744 that is expected has the login name as the local part and the value of
36745 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36746 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36747 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36748 line is added to the message.
36749
36750 If you set &%local_from_check%& false, this checking does not occur. However,
36751 the removal of an existing &'Sender:'& line still happens, unless you also set
36752 &%local_sender_retain%& to be true. It is not possible to set both of these
36753 options true at the same time.
36754
36755 .cindex "submission mode"
36756 By default, no processing of &'Sender:'& header lines is done for messages
36757 received over TCP/IP or for messages submitted by trusted users. However, when
36758 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36759 not specified on the submission control, the following processing takes place:
36760
36761 .vindex "&$authenticated_id$&"
36762 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36763 authenticated, and &$authenticated_id$& is not empty, a sender address is
36764 created as follows:
36765
36766 .ilist
36767 .vindex "&$qualify_domain$&"
36768 If no domain is specified by the submission control, the local part is
36769 &$authenticated_id$& and the domain is &$qualify_domain$&.
36770 .next
36771 If a non-empty domain is specified by the submission control, the local part
36772 is &$authenticated_id$&, and the domain is the specified domain.
36773 .next
36774 If an empty domain is specified by the submission control,
36775 &$authenticated_id$& is assumed to be the complete address.
36776 .endlist
36777
36778 This address is compared with the address in the &'From:'& header line. If they
36779 are different, a &'Sender:'& header line containing the created address is
36780 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36781 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36782
36783 .cindex "return path" "created from &'Sender:'&"
36784 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36785 the message (the envelope sender address) is changed to be the same address,
36786 except in the case of submission mode when &%sender_retain%& is specified.
36787
36788
36789
36790 .section "Adding and removing header lines in routers and transports" &&&
36791          "SECTheadersaddrem"
36792 .cindex "header lines" "adding; in router or transport"
36793 .cindex "header lines" "removing; in router or transport"
36794 When a message is delivered, the addition and removal of header lines can be
36795 specified in a system filter, or on any of the routers and transports that
36796 process the message. Section &<<SECTaddremheasys>>& contains details about
36797 modifying headers in a system filter. Header lines can also be added in an ACL
36798 as a message is received (see section &<<SECTaddheadacl>>&).
36799
36800 In contrast to what happens in a system filter, header modifications that are
36801 specified on routers and transports apply only to the particular recipient
36802 addresses that are being processed by those routers and transports. These
36803 changes do not actually take place until a copy of the message is being
36804 transported. Therefore, they do not affect the basic set of header lines, and
36805 they do not affect the values of the variables that refer to header lines.
36806
36807 &*Note*&: In particular, this means that any expansions in the configuration of
36808 the transport cannot refer to the modified header lines, because such
36809 expansions all occur before the message is actually transported.
36810
36811 For both routers and transports, the argument of a &%headers_add%&
36812 option must be in the form of one or more RFC 2822 header lines, separated by
36813 newlines (coded as &"\n"&). For example:
36814 .code
36815 headers_add = X-added-header: added by $primary_hostname\n\
36816               X-added-second: another added header line
36817 .endd
36818 Exim does not check the syntax of these added header lines.
36819
36820 Multiple &%headers_add%& options for a single router or transport can be
36821 specified; the values will append to a single list of header lines.
36822 Each header-line is separately expanded.
36823
36824 The argument of a &%headers_remove%& option must consist of a colon-separated
36825 list of header names. This is confusing, because header names themselves are
36826 often terminated by colons. In this case, the colons are the list separators,
36827 not part of the names. For example:
36828 .code
36829 headers_remove = return-receipt-to:acknowledge-to
36830 .endd
36831
36832 Multiple &%headers_remove%& options for a single router or transport can be
36833 specified; the arguments will append to a single header-names list.
36834 Each item is separately expanded.
36835 Note that colons in complex expansions which are used to
36836 form all or part of a &%headers_remove%& list
36837 will act as list separators.
36838
36839 When &%headers_add%& or &%headers_remove%& is specified on a router,
36840 items are expanded at routing time,
36841 and then associated with all addresses that are
36842 accepted by that router, and also with any new addresses that it generates. If
36843 an address passes through several routers as a result of aliasing or
36844 forwarding, the changes are cumulative.
36845
36846 .oindex "&%unseen%&"
36847 However, this does not apply to multiple routers that result from the use of
36848 the &%unseen%& option. Any header modifications that were specified by the
36849 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36850
36851 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36852 settings cannot be delivered together in a batch, so a transport is always
36853 dealing with a set of addresses that have the same header-processing
36854 requirements.
36855
36856 The transport starts by writing the original set of header lines that arrived
36857 with the message, possibly modified by the system filter. As it writes out
36858 these lines, it consults the list of header names that were attached to the
36859 recipient address(es) by &%headers_remove%& options in routers, and it also
36860 consults the transport's own &%headers_remove%& option. Header lines whose
36861 names are on either of these lists are not written out. If there are multiple
36862 instances of any listed header, they are all skipped.
36863
36864 After the remaining original header lines have been written, new header
36865 lines that were specified by routers' &%headers_add%& options are written, in
36866 the order in which they were attached to the address. These are followed by any
36867 header lines specified by the transport's &%headers_add%& option.
36868
36869 This way of handling header line modifications in routers and transports has
36870 the following consequences:
36871
36872 .ilist
36873 The original set of header lines, possibly modified by the system filter,
36874 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36875 to it, at all times.
36876 .next
36877 Header lines that are added by a router's
36878 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36879 expansion syntax in subsequent routers or the transport.
36880 .next
36881 Conversely, header lines that are specified for removal by &%headers_remove%&
36882 in a router remain visible to subsequent routers and the transport.
36883 .next
36884 Headers added to an address by &%headers_add%& in a router cannot be removed by
36885 a later router or by a transport.
36886 .next
36887 An added header can refer to the contents of an original header that is to be
36888 removed, even it has the same name as the added header. For example:
36889 .code
36890 headers_remove = subject
36891 headers_add = Subject: new subject (was: $h_subject:)
36892 .endd
36893 .endlist
36894
36895 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36896 for a &(redirect)& router that has the &%one_time%& option set.
36897
36898
36899
36900
36901
36902 .section "Constructed addresses" "SECTconstr"
36903 .cindex "address" "constructed"
36904 .cindex "constructed address"
36905 When Exim constructs a sender address for a locally-generated message, it uses
36906 the form
36907 .display
36908 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36909 .endd
36910 For example:
36911 .code
36912 Zaphod Beeblebrox <zaphod@end.univ.example>
36913 .endd
36914 The user name is obtained from the &%-F%& command line option if set, or
36915 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36916 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36917 ampersand character, this is replaced by the login name with the first letter
36918 upper cased, as is conventional in a number of operating systems. See the
36919 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36920 The &%unknown_username%& option can be used to specify user names in cases when
36921 there is no password file entry.
36922
36923 .cindex "RFC 2047"
36924 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36925 parts of it if necessary. In addition, if it contains any non-printing
36926 characters, it is encoded as described in RFC 2047, which defines a way of
36927 including non-ASCII characters in header lines. The value of the
36928 &%headers_charset%& option specifies the name of the encoding that is used (the
36929 characters are assumed to be in this encoding). The setting of
36930 &%print_topbitchars%& controls whether characters with the top bit set (that
36931 is, with codes greater than 127) count as printing characters or not.
36932
36933
36934
36935 .section "Case of local parts" "SECID230"
36936 .cindex "case of local parts"
36937 .cindex "local part" "case of"
36938 RFC 2822 states that the case of letters in the local parts of addresses cannot
36939 be assumed to be non-significant. Exim preserves the case of local parts of
36940 addresses, but by default it uses a lower-cased form when it is routing,
36941 because on most Unix systems, usernames are in lower case and case-insensitive
36942 routing is required. However, any particular router can be made to use the
36943 original case for local parts by setting the &%caseful_local_part%& generic
36944 router option.
36945
36946 .cindex "mixed-case login names"
36947 If you must have mixed-case user names on your system, the best way to proceed,
36948 assuming you want case-independent handling of incoming email, is to set up
36949 your first router to convert incoming local parts in your domains to the
36950 correct case by means of a file lookup. For example:
36951 .code
36952 correct_case:
36953   driver = redirect
36954   domains = +local_domains
36955   data = ${lookup{$local_part}cdb\
36956               {/etc/usercased.cdb}{$value}fail}\
36957               @$domain
36958 .endd
36959 For this router, the local part is forced to lower case by the default action
36960 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36961 up a new local part in the correct case. If you then set &%caseful_local_part%&
36962 on any subsequent routers which process your domains, they will operate on
36963 local parts with the correct case in a case-sensitive manner.
36964
36965
36966
36967 .section "Dots in local parts" "SECID231"
36968 .cindex "dot" "in local part"
36969 .cindex "local part" "dots in"
36970 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36971 part may not begin or end with a dot, nor have two consecutive dots in the
36972 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36973 empty components for compatibility.
36974
36975
36976
36977 .section "Rewriting addresses" "SECID232"
36978 .cindex "rewriting" "addresses"
36979 Rewriting of sender and recipient addresses, and addresses in headers, can
36980 happen automatically, or as the result of configuration options, as described
36981 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36982 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36983
36984 Automatic rewriting includes qualification, as mentioned above. The other case
36985 in which it can happen is when an incomplete non-local domain is given. The
36986 routing process may cause this to be expanded into the full domain name. For
36987 example, a header such as
36988 .code
36989 To: hare@teaparty
36990 .endd
36991 might get rewritten as
36992 .code
36993 To: hare@teaparty.wonderland.fict.example
36994 .endd
36995 Rewriting as a result of routing is the one kind of message processing that
36996 does not happen at input time, as it cannot be done until the address has
36997 been routed.
36998
36999 Strictly, one should not do &'any'& deliveries of a message until all its
37000 addresses have been routed, in case any of the headers get changed as a
37001 result of routing. However, doing this in practice would hold up many
37002 deliveries for unreasonable amounts of time, just because one address could not
37003 immediately be routed. Exim therefore does not delay other deliveries when
37004 routing of one or more addresses is deferred.
37005 .ecindex IIDmesproc
37006
37007
37008
37009 . ////////////////////////////////////////////////////////////////////////////
37010 . ////////////////////////////////////////////////////////////////////////////
37011
37012 .chapter "SMTP processing" "CHAPSMTP"
37013 .scindex IIDsmtpproc1 "SMTP" "processing details"
37014 .scindex IIDsmtpproc2 "LMTP" "processing details"
37015 Exim supports a number of different ways of using the SMTP protocol, and its
37016 LMTP variant, which is an interactive protocol for transferring messages into a
37017 closed mail store application. This chapter contains details of how SMTP is
37018 processed. For incoming mail, the following are available:
37019
37020 .ilist
37021 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37022 .next
37023 SMTP over the standard input and output (the &%-bs%& option);
37024 .next
37025 Batched SMTP on the standard input (the &%-bS%& option).
37026 .endlist
37027
37028 For mail delivery, the following are available:
37029
37030 .ilist
37031 SMTP over TCP/IP (the &(smtp)& transport);
37032 .next
37033 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37034 &"lmtp"&);
37035 .next
37036 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37037 transport);
37038 .next
37039 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37040 the &%use_bsmtp%& option set).
37041 .endlist
37042
37043 &'Batched SMTP'& is the name for a process in which batches of messages are
37044 stored in or read from files (or pipes), in a format in which SMTP commands are
37045 used to contain the envelope information.
37046
37047
37048
37049 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37050 .cindex "SMTP" "outgoing over TCP/IP"
37051 .cindex "outgoing SMTP over TCP/IP"
37052 .cindex "LMTP" "over TCP/IP"
37053 .cindex "outgoing LMTP over TCP/IP"
37054 .cindex "EHLO"
37055 .cindex "HELO"
37056 .cindex "SIZE" "option on MAIL command"
37057 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37058 The &%protocol%& option selects which protocol is to be used, but the actual
37059 processing is the same in both cases.
37060
37061 .cindex "ESMTP extensions" SIZE
37062 If, in response to its EHLO command, Exim is told that the SIZE
37063 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37064 command. The value of <&'n'&> is the message size plus the value of the
37065 &%size_addition%& option (default 1024) to allow for additions to the message
37066 such as per-transport header lines, or changes made in a
37067 .cindex "transport" "filter"
37068 .cindex "filter" "transport filter"
37069 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37070 suppressed.
37071
37072 If the remote server advertises support for PIPELINING, Exim uses the
37073 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37074 required for the transaction.
37075
37076 If the remote server advertises support for the STARTTLS command, and Exim
37077 was built to support TLS encryption, it tries to start a TLS session unless the
37078 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37079 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37080 is called for verification.
37081
37082 If the remote server advertises support for the AUTH command, Exim scans
37083 the authenticators configuration for any suitable client settings, as described
37084 in chapter &<<CHAPSMTPAUTH>>&.
37085
37086 .cindex "carriage return"
37087 .cindex "linefeed"
37088 Responses from the remote host are supposed to be terminated by CR followed by
37089 LF. However, there are known to be hosts that do not send CR characters, so in
37090 order to be able to interwork with such hosts, Exim treats LF on its own as a
37091 line terminator.
37092
37093 If a message contains a number of different addresses, all those with the same
37094 characteristics (for example, the same envelope sender) that resolve to the
37095 same set of hosts, in the same order, are sent in a single SMTP transaction,
37096 even if they are for different domains, unless there are more than the setting
37097 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37098 they are split into groups containing no more than &%max_rcpt%&s addresses
37099 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37100 in parallel sessions. The order of hosts with identical MX values is not
37101 significant when checking whether addresses can be batched in this way.
37102
37103 When the &(smtp)& transport suffers a temporary failure that is not
37104 message-related, Exim updates its transport-specific database, which contains
37105 records indexed by host name that remember which messages are waiting for each
37106 particular host. It also updates the retry database with new retry times.
37107
37108 .cindex "hints database" "retry keys"
37109 Exim's retry hints are based on host name plus IP address, so if one address of
37110 a multi-homed host is broken, it will soon be skipped most of the time.
37111 See the next section for more detail about error handling.
37112
37113 .cindex "SMTP" "passed connection"
37114 .cindex "SMTP" "batching over TCP/IP"
37115 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37116 looks in the hints database for the transport to see if there are any queued
37117 messages waiting for the host to which it is connected. If it finds one, it
37118 creates a new Exim process using the &%-MC%& option (which can only be used by
37119 a process running as root or the Exim user) and passes the TCP/IP socket to it
37120 so that it can deliver another message using the same socket. The new process
37121 does only those deliveries that are routed to the connected host, and may in
37122 turn pass the socket on to a third process, and so on.
37123
37124 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37125 limit the number of messages sent down a single TCP/IP connection.
37126
37127 .cindex "asterisk" "after IP address"
37128 The second and subsequent messages delivered down an existing connection are
37129 identified in the main log by the addition of an asterisk after the closing
37130 square bracket of the IP address.
37131
37132
37133
37134
37135 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37136 .cindex "error" "in outgoing SMTP"
37137 .cindex "SMTP" "errors in outgoing"
37138 .cindex "host" "error"
37139 Three different kinds of error are recognized for outgoing SMTP: host errors,
37140 message errors, and recipient errors.
37141
37142 .vlist
37143 .vitem "&*Host errors*&"
37144 A host error is not associated with a particular message or with a
37145 particular recipient of a message. The host errors are:
37146
37147 .ilist
37148 Connection refused or timed out,
37149 .next
37150 Any error response code on connection,
37151 .next
37152 Any error response code to EHLO or HELO,
37153 .next
37154 Loss of connection at any time, except after &"."&,
37155 .next
37156 I/O errors at any time,
37157 .next
37158 Timeouts during the session, other than in response to MAIL, RCPT or
37159 the &"."& at the end of the data.
37160 .endlist ilist
37161
37162 For a host error, a permanent error response on connection, or in response to
37163 EHLO, causes all addresses routed to the host to be failed. Any other host
37164 error causes all addresses to be deferred, and retry data to be created for the
37165 host. It is not tried again, for any message, until its retry time arrives. If
37166 the current set of addresses are not all delivered in this run (to some
37167 alternative host), the message is added to the list of those waiting for this
37168 host, so if it is still undelivered when a subsequent successful delivery is
37169 made to the host, it will be sent down the same SMTP connection.
37170
37171 .vitem "&*Message errors*&"
37172 .cindex "message" "error"
37173 A message error is associated with a particular message when sent to a
37174 particular host, but not with a particular recipient of the message. The
37175 message errors are:
37176
37177 .ilist
37178 Any error response code to MAIL, DATA, or the &"."& that terminates
37179 the data,
37180 .next
37181 Timeout after MAIL,
37182 .next
37183 Timeout or loss of connection after the &"."& that terminates the data. A
37184 timeout after the DATA command itself is treated as a host error, as is loss of
37185 connection at any other time.
37186 .endlist ilist
37187
37188 For a message error, a permanent error response (5&'xx'&) causes all addresses
37189 to be failed, and a delivery error report to be returned to the sender. A
37190 temporary error response (4&'xx'&), or one of the timeouts, causes all
37191 addresses to be deferred. Retry data is not created for the host, but instead,
37192 a retry record for the combination of host plus message id is created. The
37193 message is not added to the list of those waiting for this host. This ensures
37194 that the failing message will not be sent to this host again until the retry
37195 time arrives. However, other messages that are routed to the host are not
37196 affected, so if it is some property of the message that is causing the error,
37197 it will not stop the delivery of other mail.
37198
37199 If the remote host specified support for the SIZE parameter in its response
37200 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37201 over-large message will cause a message error because the error arrives as a
37202 response to MAIL.
37203
37204 .vitem "&*Recipient errors*&"
37205 .cindex "recipient" "error"
37206 A recipient error is associated with a particular recipient of a message. The
37207 recipient errors are:
37208
37209 .ilist
37210 Any error response to RCPT,
37211 .next
37212 Timeout after RCPT.
37213 .endlist
37214
37215 For a recipient error, a permanent error response (5&'xx'&) causes the
37216 recipient address to be failed, and a bounce message to be returned to the
37217 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37218 address to be deferred, and routing retry data to be created for it. This is
37219 used to delay processing of the address in subsequent queue runs, until its
37220 routing retry time arrives. This applies to all messages, but because it
37221 operates only in queue runs, one attempt will be made to deliver a new message
37222 to the failing address before the delay starts to operate. This ensures that,
37223 if the failure is really related to the message rather than the recipient
37224 (&"message too big for this recipient"& is a possible example), other messages
37225 have a chance of getting delivered. If a delivery to the address does succeed,
37226 the retry information gets cleared, so all stuck messages get tried again, and
37227 the retry clock is reset.
37228
37229 The message is not added to the list of those waiting for this host. Use of the
37230 host for other messages is unaffected, and except in the case of a timeout,
37231 other recipients are processed independently, and may be successfully delivered
37232 in the current SMTP session. After a timeout it is of course impossible to
37233 proceed with the session, so all addresses get deferred. However, those other
37234 than the one that failed do not suffer any subsequent retry delays. Therefore,
37235 if one recipient is causing trouble, the others have a chance of getting
37236 through when a subsequent delivery attempt occurs before the failing
37237 recipient's retry time.
37238 .endlist
37239
37240 In all cases, if there are other hosts (or IP addresses) available for the
37241 current set of addresses (for example, from multiple MX records), they are
37242 tried in this run for any undelivered addresses, subject of course to their
37243 own retry data. In other words, recipient error retry data does not take effect
37244 until the next delivery attempt.
37245
37246 Some hosts have been observed to give temporary error responses to every
37247 MAIL command at certain times (&"insufficient space"& has been seen). It
37248 would be nice if such circumstances could be recognized, and defer data for the
37249 host itself created, but this is not possible within the current Exim design.
37250 What actually happens is that retry data for every (host, message) combination
37251 is created.
37252
37253 The reason that timeouts after MAIL and RCPT are treated specially is that
37254 these can sometimes arise as a result of the remote host's verification
37255 procedures. Exim makes this assumption, and treats them as if a temporary error
37256 response had been received. A timeout after &"."& is treated specially because
37257 it is known that some broken implementations fail to recognize the end of the
37258 message if the last character of the last line is a binary zero. Thus, it is
37259 helpful to treat this case as a message error.
37260
37261 Timeouts at other times are treated as host errors, assuming a problem with the
37262 host, or the connection to it. If a timeout after MAIL, RCPT,
37263 or &"."& is really a connection problem, the assumption is that at the next try
37264 the timeout is likely to occur at some other point in the dialogue, causing it
37265 then to be treated as a host error.
37266
37267 There is experimental evidence that some MTAs drop the connection after the
37268 terminating &"."& if they do not like the contents of the message for some
37269 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37270 should be given. That is why Exim treats this case as a message rather than a
37271 host error, in order not to delay other messages to the same host.
37272
37273
37274
37275
37276 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37277 .cindex "SMTP" "incoming over TCP/IP"
37278 .cindex "incoming SMTP over TCP/IP"
37279 .cindex "inetd"
37280 .cindex "daemon"
37281 Incoming SMTP messages can be accepted in one of two ways: by running a
37282 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37283 &_/etc/inetd.conf_& should be like this:
37284 .code
37285 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37286 .endd
37287 Exim distinguishes between this case and the case of a locally running user
37288 agent using the &%-bs%& option by checking whether or not the standard input is
37289 a socket. When it is, either the port must be privileged (less than 1024), or
37290 the caller must be root or the Exim user. If any other user passes a socket
37291 with an unprivileged port number, Exim prints a message on the standard error
37292 stream and exits with an error code.
37293
37294 By default, Exim does not make a log entry when a remote host connects or
37295 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37296 unexpected. It can be made to write such log entries by setting the
37297 &%smtp_connection%& log selector.
37298
37299 .cindex "carriage return"
37300 .cindex "linefeed"
37301 Commands from the remote host are supposed to be terminated by CR followed by
37302 LF. However, there are known to be hosts that do not send CR characters. In
37303 order to be able to interwork with such hosts, Exim treats LF on its own as a
37304 line terminator.
37305 Furthermore, because common code is used for receiving messages from all
37306 sources, a CR on its own is also interpreted as a line terminator. However, the
37307 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37308
37309 .cindex "EHLO" "invalid data"
37310 .cindex "HELO" "invalid data"
37311 One area that sometimes gives rise to problems concerns the EHLO or
37312 HELO commands. Some clients send syntactically invalid versions of these
37313 commands, which Exim rejects by default. (This is nothing to do with verifying
37314 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37315 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37316 match the broken hosts that send invalid commands.
37317
37318 .cindex "SIZE option on MAIL command"
37319 .cindex "MAIL" "SIZE option"
37320 The amount of disk space available is checked whenever SIZE is received on
37321 a MAIL command, independently of whether &%message_size_limit%& or
37322 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37323 false. A temporary error is given if there is not enough space. If
37324 &%check_spool_space%& is set, the check is for that amount of space plus the
37325 value given with SIZE, that is, it checks that the addition of the incoming
37326 message will not reduce the space below the threshold.
37327
37328 When a message is successfully received, Exim includes the local message id in
37329 its response to the final &"."& that terminates the data. If the remote host
37330 logs this text it can help with tracing what has happened to a message.
37331
37332 The Exim daemon can limit the number of simultaneous incoming connections it is
37333 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37334 number of simultaneous incoming connections from a single remote host (see the
37335 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37336 rejected using the SMTP temporary error code 421.
37337
37338 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37339 subprocess has finished, as this can get lost at busy times. Instead, it looks
37340 for completed subprocesses every time it wakes up. Provided there are other
37341 things happening (new incoming calls, starts of queue runs), completed
37342 processes will be noticed and tidied away. On very quiet systems you may
37343 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37344 it will be noticed when the daemon next wakes up.
37345
37346 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37347 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37348 high system load &-- for details see the &%smtp_accept_reserve%&,
37349 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37350 applies in both the daemon and &'inetd'& cases.
37351
37352 Exim normally starts a delivery process for each message received, though this
37353 can be varied by means of the &%-odq%& command line option and the
37354 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37355 number of simultaneously running delivery processes started in this way from
37356 SMTP input can be limited by the &%smtp_accept_queue%& and
37357 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37358 subsequently received messages are just put on the input queue without starting
37359 a delivery process.
37360
37361 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37362 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37363 started up from the &'inetd'& daemon, because in that case each connection is
37364 handled by an entirely independent Exim process. Control by load average is,
37365 however, available with &'inetd'&.
37366
37367 Exim can be configured to verify addresses in incoming SMTP commands as they
37368 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37369 to rewrite addresses at this time &-- before any syntax checking is done. See
37370 section &<<SSECTrewriteS>>&.
37371
37372 Exim can also be configured to limit the rate at which a client host submits
37373 MAIL and RCPT commands in a single SMTP session. See the
37374 &%smtp_ratelimit_hosts%& option.
37375
37376
37377
37378 .subsection "Unrecognized SMTP commands" SECID234
37379 .cindex "SMTP" "unrecognized commands"
37380 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37381 commands during a single SMTP connection, it drops the connection after sending
37382 the error response to the last command. The default value for
37383 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37384 abuse that subvert web servers into making connections to SMTP ports; in these
37385 circumstances, a number of non-SMTP lines are sent first.
37386
37387
37388 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37389 .cindex "SMTP" "syntax errors"
37390 .cindex "SMTP" "protocol errors"
37391 A syntax error is detected if an SMTP command is recognized, but there is
37392 something syntactically wrong with its data, for example, a malformed email
37393 address in a RCPT command. Protocol errors include invalid command
37394 sequencing such as RCPT before MAIL. If Exim receives more than
37395 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37396 drops the connection after sending the error response to the last command. The
37397 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37398 broken clients that loop sending bad commands (yes, it has been seen).
37399
37400
37401
37402 .subsection "Use of non-mail SMTP commands" SECID236
37403 .cindex "SMTP" "non-mail commands"
37404 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37405 DATA. Exim counts such commands, and drops the connection if there are too
37406 many of them in a single SMTP session. This action catches some
37407 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37408 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37409 defines what &"too many"& means. Its default value is 10.
37410
37411 When a new message is expected, one occurrence of RSET is not counted. This
37412 allows a client to send one RSET between messages (this is not necessary,
37413 but some clients do it). Exim also allows one uncounted occurrence of HELO
37414 or EHLO, and one occurrence of STARTTLS between messages. After
37415 starting up a TLS session, another EHLO is expected, and so it too is not
37416 counted.
37417
37418 The first occurrence of AUTH in a connection, or immediately following
37419 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37420 RCPT, DATA, and QUIT are counted.
37421
37422 You can control which hosts are subject to the limit set by
37423 &%smtp_accept_max_nonmail%& by setting
37424 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37425 the limit apply to all hosts. This option means that you can exclude any
37426 specific badly-behaved hosts that you have to live with.
37427
37428
37429
37430
37431 .subsection "The VRFY and EXPN commands" SECID237
37432 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37433 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37434 appropriate) in order to decide whether the command should be accepted or not.
37435
37436 .cindex "VRFY" "processing"
37437 When no ACL is defined for VRFY, or if it rejects without
37438 setting an explicit response code, the command is accepted
37439 (with a 252 SMTP response code)
37440 in order to support awkward clients that do a VRFY before every RCPT.
37441 When VRFY is accepted, it runs exactly the same code as when Exim is
37442 called with the &%-bv%& option, and returns 250/451/550
37443 SMTP response codes.
37444
37445 .cindex "EXPN" "processing"
37446 If no ACL for EXPN is defined, the command is rejected.
37447 When EXPN is accepted, a single-level expansion of the address is done.
37448 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37449 than a verification (the &%-bv%& option). If an unqualified local part is given
37450 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37451 of VRFY and EXPN commands are logged on the main and reject logs, and
37452 VRFY verification failures are logged in the main log for consistency with
37453 RCPT failures.
37454
37455
37456
37457 .subsection "The ETRN command" SECTETRN
37458 .cindex "ETRN" "processing"
37459 .cindex "ESMTP extensions" ETRN
37460 RFC 1985 describes an ESMTP command called ETRN that is designed to
37461 overcome the security problems of the TURN command (which has fallen into
37462 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37463 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37464 should be accepted or not. If no ACL is defined, the command is rejected.
37465
37466 The ETRN command is concerned with &"releasing"& messages that are awaiting
37467 delivery to certain hosts. As Exim does not organize its message queue by host,
37468 the only form of ETRN that is supported by default is the one where the
37469 text starts with the &"#"& prefix, in which case the remainder of the text is
37470 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37471 the &%-R%& option to happen, with the remainder of the ETRN text as its
37472 argument. For example,
37473 .code
37474 ETRN #brigadoon
37475 .endd
37476 runs the command
37477 .code
37478 exim -R brigadoon
37479 .endd
37480 which causes a delivery attempt on all messages with undelivered addresses
37481 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37482 default), Exim prevents the simultaneous execution of more than one queue run
37483 for the same argument string as a result of an ETRN command. This stops
37484 a misbehaving client from starting more than one queue runner at once.
37485
37486 .cindex "hints database" "ETRN serialization"
37487 Exim implements the serialization by means of a hints database in which a
37488 record is written whenever a process is started by ETRN, and deleted when
37489 the process completes. However, Exim does not keep the SMTP session waiting for
37490 the ETRN process to complete. Once ETRN is accepted, the client is sent
37491 a &"success"& return code. Obviously there is scope for hints records to get
37492 left lying around if there is a system or program crash. To guard against this,
37493 Exim ignores any records that are more than six hours old.
37494
37495 .oindex "&%smtp_etrn_command%&"
37496 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37497 used. This specifies a command that is run whenever ETRN is received,
37498 whatever the form of its argument. For
37499 example:
37500 .code
37501 smtp_etrn_command = /etc/etrn_command $domain \
37502                     $sender_host_address
37503 .endd
37504 .vindex "&$domain$&"
37505 The string is split up into arguments which are independently expanded. The
37506 expansion variable &$domain$& is set to the argument of the ETRN command,
37507 and no syntax checking is done on the contents of this argument. Exim does not
37508 wait for the command to complete, so its status code is not checked. Exim runs
37509 under its own uid and gid when receiving incoming SMTP, so it is not possible
37510 for it to change them before running the command.
37511
37512
37513
37514 .section "Incoming local SMTP" "SECID238"
37515 .cindex "SMTP" "local incoming"
37516 Some user agents use SMTP to pass messages to their local MTA using the
37517 standard input and output, as opposed to passing the envelope on the command
37518 line and writing the message to the standard input. This is supported by the
37519 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37520 messages over TCP/IP (including the use of ACLs), except that the envelope
37521 sender given in a MAIL command is ignored unless the caller is trusted. In
37522 an ACL you can detect this form of SMTP input by testing for an empty host
37523 identification. It is common to have this as the first line in the ACL that
37524 runs for RCPT commands:
37525 .code
37526 accept hosts = :
37527 .endd
37528 This accepts SMTP messages from local processes without doing any other tests.
37529
37530
37531
37532 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37533 .cindex "SMTP" "batched outgoing"
37534 .cindex "batched SMTP output"
37535 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37536 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37537 be output in BSMTP format. No SMTP responses are possible for this form of
37538 delivery. All it is doing is using SMTP commands as a way of transmitting the
37539 envelope along with the message.
37540
37541 The message is written to the file or pipe preceded by the SMTP commands
37542 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37543 the message that start with a dot have an extra dot added. The SMTP command
37544 HELO is not normally used. If it is required, the &%message_prefix%& option
37545 can be used to specify it.
37546
37547 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37548 one recipient address at a time by default. However, you can arrange for them
37549 to handle several addresses at once by setting the &%batch_max%& option. When
37550 this is done for BSMTP, messages may contain multiple RCPT commands. See
37551 chapter &<<CHAPbatching>>& for more details.
37552
37553 .vindex "&$host$&"
37554 When one or more addresses are routed to a BSMTP transport by a router that
37555 sets up a host list, the name of the first host on the list is available to the
37556 transport in the variable &$host$&. Here is an example of such a transport and
37557 router:
37558 .code
37559 begin routers
37560 route_append:
37561   driver = manualroute
37562   transport = smtp_appendfile
37563   route_list = domain.example  batch.host.example
37564
37565 begin transports
37566 smtp_appendfile:
37567   driver = appendfile
37568   directory = /var/bsmtp/$host
37569   batch_max = 1000
37570   use_bsmtp
37571   user = exim
37572 .endd
37573 This causes messages addressed to &'domain.example'& to be written in BSMTP
37574 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37575 message (unless there are more than 1000 recipients).
37576
37577
37578
37579 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37580 .cindex "SMTP" "batched incoming"
37581 .cindex "batched SMTP input"
37582 The &%-bS%& command line option causes Exim to accept one or more messages by
37583 reading SMTP on the standard input, but to generate no responses. If the caller
37584 is trusted, the senders in the MAIL commands are believed; otherwise the
37585 sender is always the caller of Exim. Unqualified senders and receivers are not
37586 rejected (there seems little point) but instead just get qualified. HELO
37587 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37588 as NOOP; QUIT quits.
37589
37590 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37591 ACL is run in the same way as for non-SMTP local input.
37592
37593 If an error is detected while reading a message, including a missing &"."& at
37594 the end, Exim gives up immediately. It writes details of the error to the
37595 standard output in a stylized way that the calling program should be able to
37596 make some use of automatically, for example:
37597 .code
37598 554 Unexpected end of file
37599 Transaction started in line 10
37600 Error detected in line 14
37601 .endd
37602 It writes a more verbose version, for human consumption, to the standard error
37603 file, for example:
37604 .code
37605 An error was detected while processing a file of BSMTP input.
37606 The error message was:
37607
37608 501 '>' missing at end of address
37609
37610 The SMTP transaction started in line 10.
37611 The error was detected in line 12.
37612 The SMTP command at fault was:
37613
37614 rcpt to:<malformed@in.com.plete
37615
37616 1 previous message was successfully processed.
37617 The rest of the batch was abandoned.
37618 .endd
37619 The return code from Exim is zero only if there were no errors. It is 1 if some
37620 messages were accepted before an error was detected, and 2 if no messages were
37621 accepted.
37622 .ecindex IIDsmtpproc1
37623 .ecindex IIDsmtpproc2
37624
37625
37626
37627 . ////////////////////////////////////////////////////////////////////////////
37628 . ////////////////////////////////////////////////////////////////////////////
37629
37630 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37631          "Customizing messages"
37632 When a message fails to be delivered, or remains in the queue for more than a
37633 configured amount of time, Exim sends a message to the original sender, or
37634 to an alternative configured address. The text of these messages is built into
37635 the code of Exim, but it is possible to change it, either by adding a single
37636 string, or by replacing each of the paragraphs by text supplied in a file.
37637
37638 The &'From:'& and &'To:'& header lines are automatically generated; you can
37639 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37640 option. Exim also adds the line
37641 .code
37642 Auto-Submitted: auto-generated
37643 .endd
37644 to all warning and bounce messages,
37645
37646
37647 .section "Customizing bounce messages" "SECID239"
37648 .cindex "customizing" "bounce message"
37649 .cindex "bounce message" "customizing"
37650 If &%bounce_message_text%& is set, its contents are included in the default
37651 message immediately after &"This message was created automatically by mail
37652 delivery software."& The string is not expanded. It is not used if
37653 &%bounce_message_file%& is set.
37654
37655 When &%bounce_message_file%& is set, it must point to a template file for
37656 constructing error messages. The file consists of a series of text items,
37657 separated by lines consisting of exactly four asterisks. If the file cannot be
37658 opened, default text is used and a message is written to the main and panic
37659 logs. If any text item in the file is empty, default text is used for that
37660 item.
37661
37662 .vindex "&$bounce_recipient$&"
37663 .vindex "&$bounce_return_size_limit$&"
37664 Each item of text that is read from the file is expanded, and there are two
37665 expansion variables which can be of use here: &$bounce_recipient$& is set to
37666 the recipient of an error message while it is being created, and
37667 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37668 option, rounded to a whole number.
37669
37670 The items must appear in the file in the following order:
37671
37672 .ilist
37673 The first item is included in the headers, and should include at least a
37674 &'Subject:'& header. Exim does not check the syntax of these headers.
37675 .next
37676 The second item forms the start of the error message. After it, Exim lists the
37677 failing addresses with their error messages.
37678 .next
37679 The third item is used to introduce any text from pipe transports that is to be
37680 returned to the sender. It is omitted if there is no such text.
37681 .next
37682 The fourth, fifth and sixth items will be ignored and may be empty.
37683 The fields exist for back-compatibility
37684 .endlist
37685
37686 The default state (&%bounce_message_file%& unset) is equivalent to the
37687 following file, in which the sixth item is empty. The &'Subject:'& and some
37688 other lines have been split in order to fit them on the page:
37689 .code
37690 Subject: Mail delivery failed
37691   ${if eq{$sender_address}{$bounce_recipient}
37692   {: returning message to sender}}
37693 ****
37694 This message was created automatically by mail delivery software.
37695
37696 A message ${if eq{$sender_address}{$bounce_recipient}
37697   {that you sent }{sent by
37698
37699 <$sender_address>
37700
37701 }}could not be delivered to all of its recipients.
37702 This is a permanent error. The following address(es) failed:
37703 ****
37704 The following text was generated during the delivery attempt(s):
37705 ****
37706 ------ This is a copy of the message, including all the headers.
37707   ------
37708 ****
37709 ------ The body of the message is $message_size characters long;
37710   only the first
37711 ------ $bounce_return_size_limit or so are included here.
37712 ****
37713 .endd
37714 .section "Customizing warning messages" "SECTcustwarn"
37715 .cindex "customizing" "warning message"
37716 .cindex "warning of delay" "customizing the message"
37717 The option &%warn_message_file%& can be pointed at a template file for use when
37718 warnings about message delays are created. In this case there are only three
37719 text sections:
37720
37721 .ilist
37722 The first item is included in the headers, and should include at least a
37723 &'Subject:'& header. Exim does not check the syntax of these headers.
37724 .next
37725 The second item forms the start of the warning message. After it, Exim lists
37726 the delayed addresses.
37727 .next
37728 The third item then ends the message.
37729 .endlist
37730
37731 The default state is equivalent to the following file, except that some lines
37732 have been split here, in order to fit them on the page:
37733 .code
37734 Subject: Warning: message $message_exim_id delayed
37735   $warn_message_delay
37736 ****
37737 This message was created automatically by mail delivery software.
37738
37739 A message ${if eq{$sender_address}{$warn_message_recipients}
37740 {that you sent }{sent by
37741
37742 <$sender_address>
37743
37744 }}has not been delivered to all of its recipients after
37745 more than $warn_message_delay in the queue on $primary_hostname.
37746
37747 The message identifier is:     $message_exim_id
37748 The subject of the message is: $h_subject
37749 The date of the message is:    $h_date
37750
37751 The following address(es) have not yet been delivered:
37752 ****
37753 No action is required on your part. Delivery attempts will
37754 continue for some time, and this warning may be repeated at
37755 intervals if the message remains undelivered. Eventually the
37756 mail delivery software will give up, and when that happens,
37757 the message will be returned to you.
37758 .endd
37759 .vindex "&$warn_message_delay$&"
37760 .vindex "&$warn_message_recipients$&"
37761 However, in the default state the subject and date lines are omitted if no
37762 appropriate headers exist. During the expansion of this file,
37763 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37764 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37765 of recipients for the warning message. There may be more than one if there are
37766 multiple addresses with different &%errors_to%& settings on the routers that
37767 handled them.
37768
37769
37770
37771
37772 . ////////////////////////////////////////////////////////////////////////////
37773 . ////////////////////////////////////////////////////////////////////////////
37774
37775 .chapter "Some common configuration settings" "CHAPcomconreq"
37776 This chapter discusses some configuration settings that seem to be fairly
37777 common. More examples and discussion can be found in the Exim book.
37778
37779
37780
37781 .section "Sending mail to a smart host" "SECID240"
37782 .cindex "smart host" "example router"
37783 If you want to send all mail for non-local domains to a &"smart host"&, you
37784 should replace the default &(dnslookup)& router with a router which does the
37785 routing explicitly:
37786 .code
37787 send_to_smart_host:
37788   driver = manualroute
37789   route_list = !+local_domains smart.host.name
37790   transport = remote_smtp
37791 .endd
37792 You can use the smart host's IP address instead of the name if you wish.
37793 If you are using Exim only to submit messages to a smart host, and not for
37794 receiving incoming messages, you can arrange for it to do the submission
37795 synchronously by setting the &%mua_wrapper%& option (see chapter
37796 &<<CHAPnonqueueing>>&).
37797
37798
37799
37800
37801 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37802 .cindex "mailing lists"
37803 Exim can be used to run simple mailing lists, but for large and/or complicated
37804 requirements, the use of additional specialized mailing list software such as
37805 Majordomo or Mailman is recommended.
37806
37807 The &(redirect)& router can be used to handle mailing lists where each list
37808 is maintained in a separate file, which can therefore be managed by an
37809 independent manager. The &%domains%& router option can be used to run these
37810 lists in a separate domain from normal mail. For example:
37811 .code
37812 lists:
37813   driver = redirect
37814   domains = lists.example
37815   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37816   forbid_pipe
37817   forbid_file
37818   errors_to = ${quote_local_part:$local_part-request}@lists.example
37819   no_more
37820 .endd
37821 This router is skipped for domains other than &'lists.example'&. For addresses
37822 in that domain, it looks for a file that matches the local part. If there is no
37823 such file, the router declines, but because &%no_more%& is set, no subsequent
37824 routers are tried, and so the whole delivery fails.
37825
37826 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37827 expanded into a filename or a pipe delivery, which is usually inappropriate in
37828 a mailing list.
37829
37830 .oindex "&%errors_to%&"
37831 The &%errors_to%& option specifies that any delivery errors caused by addresses
37832 taken from a mailing list are to be sent to the given address rather than the
37833 original sender of the message. However, before acting on this, Exim verifies
37834 the error address, and ignores it if verification fails.
37835
37836 For example, using the configuration above, mail sent to
37837 &'dicts@lists.example'& is passed on to those addresses contained in
37838 &_/usr/lists/dicts_&, with error reports directed to
37839 &'dicts-request@lists.example'&, provided that this address can be verified.
37840 There could be a file called &_/usr/lists/dicts-request_& containing
37841 the address(es) of this particular list's manager(s), but other approaches,
37842 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37843 or &%local_part_suffix%& options) to handle addresses of the form
37844 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37845
37846
37847
37848 .section "Syntax errors in mailing lists" "SECID241"
37849 .cindex "mailing lists" "syntax errors in"
37850 If an entry in redirection data contains a syntax error, Exim normally defers
37851 delivery of the original address. That means that a syntax error in a mailing
37852 list holds up all deliveries to the list. This may not be appropriate when a
37853 list is being maintained automatically from data supplied by users, and the
37854 addresses are not rigorously checked.
37855
37856 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37857 entries that fail to parse, noting the incident in the log. If in addition
37858 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37859 whenever a broken address is skipped. It is usually appropriate to set
37860 &%syntax_errors_to%& to the same address as &%errors_to%&.
37861
37862
37863
37864 .section "Re-expansion of mailing lists" "SECID242"
37865 .cindex "mailing lists" "re-expansion of"
37866 Exim remembers every individual address to which a message has been delivered,
37867 in order to avoid duplication, but it normally stores only the original
37868 recipient addresses with a message. If all the deliveries to a mailing list
37869 cannot be done at the first attempt, the mailing list is re-expanded when the
37870 delivery is next tried. This means that alterations to the list are taken into
37871 account at each delivery attempt, so addresses that have been added to
37872 the list since the message arrived will therefore receive a copy of the
37873 message, even though it pre-dates their subscription.
37874
37875 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37876 on the &(redirect)& router. If this is done, any addresses generated by the
37877 router that fail to deliver at the first attempt are added to the message as
37878 &"top level"& addresses, and the parent address that generated them is marked
37879 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37880 subsequent delivery attempts. The disadvantage of this is that if any of the
37881 failing addresses are incorrect, correcting them in the file has no effect on
37882 pre-existing messages.
37883
37884 The original top-level address is remembered with each of the generated
37885 addresses, and is output in any log messages. However, any intermediate parent
37886 addresses are not recorded. This makes a difference to the log only if the
37887 &%all_parents%& selector is set, but for mailing lists there is normally only
37888 one level of expansion anyway.
37889
37890
37891
37892 .section "Closed mailing lists" "SECID243"
37893 .cindex "mailing lists" "closed"
37894 The examples so far have assumed open mailing lists, to which anybody may
37895 send mail. It is also possible to set up closed lists, where mail is accepted
37896 from specified senders only. This is done by making use of the generic
37897 &%senders%& option to restrict the router that handles the list.
37898
37899 The following example uses the same file as a list of recipients and as a list
37900 of permitted senders. It requires three routers:
37901 .code
37902 lists_request:
37903   driver = redirect
37904   domains = lists.example
37905   local_part_suffix = -request
37906   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37907   file = /usr/lists/${local_part_data}-request
37908   no_more
37909
37910 lists_post:
37911   driver = redirect
37912   domains = lists.example
37913   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37914   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37915   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37916   forbid_pipe
37917   forbid_file
37918   errors_to = ${quote_local_part:$local_part-request}@lists.example
37919   no_more
37920
37921 lists_closed:
37922   driver = redirect
37923   domains = lists.example
37924   allow_fail
37925   data = :fail: $local_part@lists.example is a closed mailing list
37926 .endd
37927 All three routers have the same &%domains%& setting, so for any other domains,
37928 they are all skipped. The first router runs only if the local part ends in
37929 &%-request%&. It handles messages to the list manager(s) by means of an open
37930 mailing list.
37931
37932 The second router runs only if the &%senders%& precondition is satisfied. It
37933 checks for the existence of a list that corresponds to the local part, and then
37934 checks that the sender is on the list by means of a linear search. It is
37935 necessary to check for the existence of the file before trying to search it,
37936 because otherwise Exim thinks there is a configuration error. If the file does
37937 not exist, the expansion of &%senders%& is *, which matches all senders. This
37938 means that the router runs, but because there is no list, declines, and
37939 &%no_more%& ensures that no further routers are run. The address fails with an
37940 &"unrouteable address"& error.
37941
37942 The third router runs only if the second router is skipped, which happens when
37943 a mailing list exists, but the sender is not on it. This router forcibly fails
37944 the address, giving a suitable error message.
37945
37946
37947
37948
37949 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37950 .cindex "VERP"
37951 .cindex "Variable Envelope Return Paths"
37952 .cindex "envelope from"
37953 .cindex "envelope sender"
37954 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37955 are a way of helping mailing list administrators discover which subscription
37956 address is the cause of a particular delivery failure. The idea is to encode
37957 the original recipient address in the outgoing envelope sender address, so that
37958 if the message is forwarded by another host and then subsequently bounces, the
37959 original recipient can be extracted from the recipient address of the bounce.
37960
37961 .oindex &%errors_to%&
37962 .oindex &%return_path%&
37963 Envelope sender addresses can be modified by Exim using two different
37964 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37965 list examples), or the &%return_path%& option on a transport. The second of
37966 these is effective only if the message is successfully delivered to another
37967 host; it is not used for errors detected on the local host (see the description
37968 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37969 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37970 .code
37971 verp_smtp:
37972   driver = smtp
37973   max_rcpt = 1
37974   return_path = \
37975     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37976       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37977 .endd
37978 This has the effect of rewriting the return path (envelope sender) on outgoing
37979 SMTP messages, if the local part of the original return path ends in
37980 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37981 local part and domain of the recipient into the return path. Suppose, for
37982 example, that a message whose return path has been set to
37983 &'somelist-request@your.dom.example'& is sent to
37984 &'subscriber@other.dom.example'&. In the transport, the return path is
37985 rewritten as
37986 .code
37987 somelist-request+subscriber=other.dom.example@your.dom.example
37988 .endd
37989 .vindex "&$local_part$&"
37990 For this to work, you must tell Exim to send multiple copies of messages that
37991 have more than one recipient, so that each copy has just one recipient. This is
37992 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37993 might be sent to several different recipients in the same domain, in which case
37994 &$local_part$& is not available in the transport, because it is not unique.
37995
37996 Unless your host is doing nothing but mailing list deliveries, you should
37997 probably use a separate transport for the VERP deliveries, so as not to use
37998 extra resources in making one-per-recipient copies for other deliveries. This
37999 can easily be done by expanding the &%transport%& option in the router:
38000 .code
38001 dnslookup:
38002   driver = dnslookup
38003   domains = ! +local_domains
38004   transport = \
38005     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38006       {verp_smtp}{remote_smtp}}
38007   no_more
38008 .endd
38009 If you want to change the return path using &%errors_to%& in a router instead
38010 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38011 routers that handle mailing list addresses. This will ensure that all delivery
38012 errors, including those detected on the local host, are sent to the VERP
38013 address.
38014
38015 On a host that does no local deliveries and has no manual routing, only the
38016 &(dnslookup)& router needs to be changed. A special transport is not needed for
38017 SMTP deliveries. Every mailing list recipient has its own return path value,
38018 and so Exim must hand them to the transport one at a time. Here is an example
38019 of a &(dnslookup)& router that implements VERP:
38020 .code
38021 verp_dnslookup:
38022   driver = dnslookup
38023   domains = ! +local_domains
38024   transport = remote_smtp
38025   errors_to = \
38026     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38027      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38028   no_more
38029 .endd
38030 Before you start sending out messages with VERPed return paths, you must also
38031 configure Exim to accept the bounce messages that come back to those paths.
38032 Typically this is done by setting a &%local_part_suffix%& option for a
38033 router, and using this to route the messages to wherever you want to handle
38034 them.
38035
38036 The overhead incurred in using VERP depends very much on the size of the
38037 message, the number of recipient addresses that resolve to the same remote
38038 host, and the speed of the connection over which the message is being sent. If
38039 a lot of addresses resolve to the same host and the connection is slow, sending
38040 a separate copy of the message for each address may take substantially longer
38041 than sending a single copy with many recipients (for which VERP cannot be
38042 used).
38043
38044
38045
38046
38047
38048
38049 .section "Virtual domains" "SECTvirtualdomains"
38050 .cindex "virtual domains"
38051 .cindex "domain" "virtual"
38052 The phrase &'virtual domain'& is unfortunately used with two rather different
38053 meanings:
38054
38055 .ilist
38056 A domain for which there are no real mailboxes; all valid local parts are
38057 aliases for other email addresses. Common examples are organizational
38058 top-level domains and &"vanity"& domains.
38059 .next
38060 One of a number of independent domains that are all handled by the same host,
38061 with mailboxes on that host, but where the mailbox owners do not necessarily
38062 have login accounts on that host.
38063 .endlist
38064
38065 The first usage is probably more common, and does seem more &"virtual"& than
38066 the second. This kind of domain can be handled in Exim with a straightforward
38067 aliasing router. One approach is to create a separate alias file for each
38068 virtual domain. Exim can test for the existence of the alias file to determine
38069 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38070 to a router of this form:
38071 .code
38072 virtual:
38073   driver = redirect
38074   domains = dsearch;/etc/mail/virtual
38075   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38076   no_more
38077 .endd
38078 The &%domains%& option specifies that the router is to be skipped, unless there
38079 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38080 domain that is being processed.
38081 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38082 being placed into the &$domain_data$& variable.
38083
38084 When the router runs, it looks up the local
38085 part in the file to find a new address (or list of addresses). The &%no_more%&
38086 setting ensures that if the lookup fails (leading to &%data%& being an empty
38087 string), Exim gives up on the address without trying any subsequent routers.
38088
38089 This one router can handle all the virtual domains because the alias filenames
38090 follow a fixed pattern. Permissions can be arranged so that appropriate people
38091 can edit the different alias files. A successful aliasing operation results in
38092 a new envelope recipient address, which is then routed from scratch.
38093
38094 The other kind of &"virtual"& domain can also be handled in a straightforward
38095 way. One approach is to create a file for each domain containing a list of
38096 valid local parts, and use it in a router like this:
38097 .code
38098 my_domains:
38099   driver = accept
38100   domains = dsearch;/etc/mail/domains
38101   local_parts = lsearch;/etc/mail/domains/$domain
38102   transport = my_mailboxes
38103 .endd
38104 The address is accepted if there is a file for the domain, and the local part
38105 can be found in the file. The &%domains%& option is used to check for the
38106 file's existence because &%domains%& is tested before the &%local_parts%&
38107 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38108 because that option is tested after &%local_parts%&. The transport is as
38109 follows:
38110 .code
38111 my_mailboxes:
38112   driver = appendfile
38113   file = /var/mail/$domain_data/$local_part_data
38114   user = mail
38115 .endd
38116 This uses a directory of mailboxes for each domain. The &%user%& setting is
38117 required, to specify which uid is to be used for writing to the mailboxes.
38118
38119 The configuration shown here is just one example of how you might support this
38120 requirement. There are many other ways this kind of configuration can be set
38121 up, for example, by using a database instead of separate files to hold all the
38122 information about the domains.
38123
38124
38125
38126 .section "Multiple user mailboxes" "SECTmulbox"
38127 .cindex "multiple mailboxes"
38128 .cindex "mailbox" "multiple"
38129 .cindex "local part" "prefix"
38130 .cindex "local part" "suffix"
38131 Heavy email users often want to operate with multiple mailboxes, into which
38132 incoming mail is automatically sorted. A popular way of handling this is to
38133 allow users to use multiple sender addresses, so that replies can easily be
38134 identified. Users are permitted to add prefixes or suffixes to their local
38135 parts for this purpose. The wildcard facility of the generic router options
38136 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38137 example, consider this router:
38138 .code
38139 userforward:
38140   driver = redirect
38141   check_local_user
38142   file = $home/.forward
38143   local_part_suffix = -*
38144   local_part_suffix_optional
38145   allow_filter
38146 .endd
38147 .vindex "&$local_part_suffix$&"
38148 It runs a user's &_.forward_& file for all local parts of the form
38149 &'username-*'&. Within the filter file the user can distinguish different
38150 cases by testing the variable &$local_part_suffix$&. For example:
38151 .code
38152 if $local_part_suffix contains -special then
38153 save /home/$local_part_data/Mail/special
38154 endif
38155 .endd
38156 If the filter file does not exist, or does not deal with such addresses, they
38157 fall through to subsequent routers, and, assuming no subsequent use of the
38158 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38159 control over which suffixes are valid.
38160
38161 Alternatively, a suffix can be used to trigger the use of a different
38162 &_.forward_& file &-- which is the way a similar facility is implemented in
38163 another MTA:
38164 .code
38165 userforward:
38166   driver = redirect
38167   check_local_user
38168   local_part_suffix = -*
38169   local_part_suffix_optional
38170   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38171   allow_filter
38172 .endd
38173 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38174 example, &_.forward-special_& is used. Once again, if the appropriate file
38175 does not exist, or does not deal with the address, it is passed on to
38176 subsequent routers, which could, if required, look for an unqualified
38177 &_.forward_& file to use as a default.
38178
38179
38180
38181 .section "Simplified vacation processing" "SECID244"
38182 .cindex "vacation processing"
38183 The traditional way of running the &'vacation'& program is for a user to set up
38184 a pipe command in a &_.forward_& file
38185 (see section &<<SECTspecitredli>>& for syntax details).
38186 This is prone to error by inexperienced users. There are two features of Exim
38187 that can be used to make this process simpler for users:
38188
38189 .ilist
38190 A local part prefix such as &"vacation-"& can be specified on a router which
38191 can cause the message to be delivered directly to the &'vacation'& program, or
38192 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38193 &_.forward_& file are then much simpler. For example:
38194 .code
38195 spqr, vacation-spqr
38196 .endd
38197 .next
38198 The &%require_files%& generic router option can be used to trigger a
38199 vacation delivery by checking for the existence of a certain file in the
38200 user's home directory. The &%unseen%& generic option should also be used, to
38201 ensure that the original delivery also proceeds. In this case, all the user has
38202 to do is to create a file called, say, &_.vacation_&, containing a vacation
38203 message.
38204 .endlist
38205
38206 Another advantage of both these methods is that they both work even when the
38207 use of arbitrary pipes by users is locked out.
38208
38209
38210
38211 .section "Taking copies of mail" "SECID245"
38212 .cindex "message" "copying every"
38213 Some installations have policies that require archive copies of all messages to
38214 be made. A single copy of each message can easily be taken by an appropriate
38215 command in a system filter, which could, for example, use a different file for
38216 each day's messages.
38217
38218 There is also a shadow transport mechanism that can be used to take copies of
38219 messages that are successfully delivered by local transports, one copy per
38220 delivery. This could be used, &'inter alia'&, to implement automatic
38221 notification of delivery by sites that insist on doing such things.
38222
38223
38224
38225 .section "Intermittently connected hosts" "SECID246"
38226 .cindex "intermittently connected hosts"
38227 It has become quite common (because it is cheaper) for hosts to connect to the
38228 Internet periodically rather than remain connected all the time. The normal
38229 arrangement is that mail for such hosts accumulates on a system that is
38230 permanently connected.
38231
38232 Exim was designed for use on permanently connected hosts, and so it is not
38233 particularly well-suited to use in an intermittently connected environment.
38234 Nevertheless there are some features that can be used.
38235
38236
38237 .section "Exim on the upstream server host" "SECID247"
38238 It is tempting to arrange for incoming mail for the intermittently connected
38239 host to remain in Exim's queue until the client connects. However, this
38240 approach does not scale very well. Two different kinds of waiting message are
38241 being mixed up in the same queue &-- those that cannot be delivered because of
38242 some temporary problem, and those that are waiting for their destination host
38243 to connect. This makes it hard to manage the queue, as well as wasting
38244 resources, because each queue runner scans the entire queue.
38245
38246 A better approach is to separate off those messages that are waiting for an
38247 intermittently connected host. This can be done by delivering these messages
38248 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38249 format, from where they are transmitted by other software when their
38250 destination connects. This makes it easy to collect all the mail for one host
38251 in a single directory, and to apply local timeout rules on a per-message basis
38252 if required.
38253
38254 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38255 you are doing this, you should configure Exim with a long retry period for the
38256 intermittent host. For example:
38257 .code
38258 cheshire.wonderland.fict.example    *   F,5d,24h
38259 .endd
38260 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38261 which messages it has queued up for that host. Once the intermittent host comes
38262 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38263 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38264 causes all the queued up messages to be delivered, often down a single SMTP
38265 connection. While the host remains connected, any new messages get delivered
38266 immediately.
38267
38268 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38269 issued with a different IP address each time it connects, Exim's retry
38270 mechanisms on the holding host get confused, because the IP address is normally
38271 used as part of the key string for holding retry information. This can be
38272 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38273 Since this has disadvantages for permanently connected hosts, it is best to
38274 arrange a separate transport for the intermittently connected ones.
38275
38276
38277
38278 .section "Exim on the intermittently connected client host" "SECID248"
38279 The value of &%smtp_accept_queue_per_connection%& should probably be
38280 increased, or even set to zero (that is, disabled) on the intermittently
38281 connected host, so that all incoming messages down a single connection get
38282 delivered immediately.
38283
38284 .cindex "SMTP" "passed connection"
38285 .cindex "SMTP" "multiple deliveries"
38286 .cindex "multiple SMTP deliveries"
38287 .cindex "first pass routing"
38288 Mail waiting to be sent from an intermittently connected host will probably
38289 not have been routed, because without a connection DNS lookups are not
38290 possible. This means that if a normal queue run is done at connection time,
38291 each message is likely to be sent in a separate SMTP session. This can be
38292 avoided by starting the queue run with a command line option beginning with
38293 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38294 first pass, routing is done but no deliveries take place. The second pass is a
38295 normal queue run; since all the messages have been previously routed, those
38296 destined for the same host are likely to get sent as multiple deliveries in a
38297 single SMTP connection.
38298
38299
38300
38301 . ////////////////////////////////////////////////////////////////////////////
38302 . ////////////////////////////////////////////////////////////////////////////
38303
38304 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38305          "Exim as a non-queueing client"
38306 .cindex "client, non-queueing"
38307 .cindex "smart host" "suppressing queueing"
38308 On a personal computer, it is a common requirement for all
38309 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38310 configured to operate that way, for all the popular operating systems.
38311 However, there are some MUAs for Unix-like systems that cannot be so
38312 configured: they submit messages using the command line interface of
38313 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38314 messages this way.
38315
38316 If the personal computer runs continuously, there is no problem, because it can
38317 run a conventional MTA that handles delivery to the smart host, and deal with
38318 any delays via its queueing mechanism. However, if the computer does not run
38319 continuously or runs different operating systems at different times, queueing
38320 email is not desirable.
38321
38322 There is therefore a requirement for something that can provide the
38323 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38324 any queueing or retrying facilities. Furthermore, the delivery to the smart
38325 host should be synchronous, so that if it fails, the sending MUA is immediately
38326 informed. In other words, we want something that extends an MUA that submits
38327 to a local MTA via the command line so that it behaves like one that submits
38328 to a remote smart host using TCP/SMTP.
38329
38330 There are a number of applications (for example, there is one called &'ssmtp'&)
38331 that do this job. However, people have found them to be lacking in various
38332 ways. For instance, you might want to allow aliasing and forwarding to be done
38333 before sending a message to the smart host.
38334
38335 Exim already had the necessary infrastructure for doing this job. Just a few
38336 tweaks were needed to make it behave as required, though it is somewhat of an
38337 overkill to use a fully-featured MTA for this purpose.
38338
38339 .oindex "&%mua_wrapper%&"
38340 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38341 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38342 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38343 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38344 compatible router and transport configuration. Typically there will be just one
38345 router and one transport, sending everything to a smart host.
38346
38347 When run in MUA wrapping mode, the behaviour of Exim changes in the
38348 following ways:
38349
38350 .ilist
38351 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38352 In other words, the only way to submit messages is via the command line.
38353 .next
38354 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38355 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38356 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38357 does not finish until the delivery attempt is complete. If the delivery is
38358 successful, a zero return code is given.
38359 .next
38360 Address redirection is permitted, but the final routing for all addresses must
38361 be to the same remote transport, and to the same list of hosts. Furthermore,
38362 the return address (envelope sender) must be the same for all recipients, as
38363 must any added or deleted header lines. In other words, it must be possible to
38364 deliver the message in a single SMTP transaction, however many recipients there
38365 are.
38366 .next
38367 If these conditions are not met, or if routing any address results in a
38368 failure or defer status, or if Exim is unable to deliver all the recipients
38369 successfully to one of the smart hosts, delivery of the entire message fails.
38370 .next
38371 Because no queueing is allowed, all failures are treated as permanent; there
38372 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38373 smart host. Furthermore, because only a single yes/no response can be given to
38374 the caller, it is not possible to deliver to some recipients and not others. If
38375 there is an error (temporary or permanent) for any recipient, all are failed.
38376 .next
38377 If more than one smart host is listed, Exim will try another host after a
38378 connection failure or a timeout, in the normal way. However, if this kind of
38379 failure happens for all the hosts, the delivery fails.
38380 .next
38381 When delivery fails, an error message is written to the standard error stream
38382 (as well as to Exim's log), and Exim exits to the caller with a return code
38383 value 1. The message is expunged from Exim's spool files. No bounce messages
38384 are ever generated.
38385 .next
38386 No retry data is maintained, and any retry rules are ignored.
38387 .next
38388 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38389 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38390 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38391 .endlist
38392
38393 The overall effect is that Exim makes a single synchronous attempt to deliver
38394 the message, failing if there is any kind of problem. Because no local
38395 deliveries are done and no daemon can be run, Exim does not need root
38396 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38397 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38398 the advantages and disadvantages of running without root privilege.
38399
38400
38401
38402
38403 . ////////////////////////////////////////////////////////////////////////////
38404 . ////////////////////////////////////////////////////////////////////////////
38405
38406 .chapter "Log files" "CHAPlog"
38407 .scindex IIDloggen "log" "general description"
38408 .cindex "log" "types of"
38409 Exim writes three different logs, referred to as the main log, the reject log,
38410 and the panic log:
38411
38412 .ilist
38413 .cindex "main log"
38414 The main log records the arrival of each message and each delivery in a single
38415 line in each case. The format is as compact as possible, in an attempt to keep
38416 down the size of log files. Two-character flag sequences make it easy to pick
38417 out these lines. A number of other events are recorded in the main log. Some of
38418 them are optional, in which case the &%log_selector%& option controls whether
38419 they are included or not. A Perl script called &'eximstats'&, which does simple
38420 analysis of main log files, is provided in the Exim distribution (see section
38421 &<<SECTmailstat>>&).
38422 .next
38423 .cindex "reject log"
38424 The reject log records information from messages that are rejected as a result
38425 of a configuration option (that is, for policy reasons).
38426 The first line of each rejection is a copy of the line that is also written to
38427 the main log. Then, if the message's header has been read at the time the log
38428 is written, its contents are written to this log. Only the original header
38429 lines are available; header lines added by ACLs are not logged. You can use the
38430 reject log to check that your policy controls are working correctly; on a busy
38431 host this may be easier than scanning the main log for rejection messages. You
38432 can suppress the writing of the reject log by setting &%write_rejectlog%&
38433 false.
38434 .next
38435 .cindex "panic log"
38436 .cindex "system log"
38437 When certain serious errors occur, Exim writes entries to its panic log. If the
38438 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38439 are usually written to the main log as well, but can get lost amid the mass of
38440 other entries. The panic log should be empty under normal circumstances. It is
38441 therefore a good idea to check it (or to have a &'cron'& script check it)
38442 regularly, in order to become aware of any problems. When Exim cannot open its
38443 panic log, it tries as a last resort to write to the system log (syslog). This
38444 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38445 message itself is written at priority LOG_CRIT.
38446 .endlist
38447
38448 Every log line starts with a timestamp, in the format shown in the following
38449 example. Note that many of the examples shown in this chapter are line-wrapped.
38450 In the log file, this would be all on one line:
38451 .code
38452 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38453   by QUIT
38454 .endd
38455 By default, the timestamps are in the local timezone. There are two
38456 ways of changing this:
38457
38458 .ilist
38459 You can set the &%timezone%& option to a different time zone; in particular, if
38460 you set
38461 .code
38462 timezone = UTC
38463 .endd
38464 the timestamps will be in UTC (aka GMT).
38465 .next
38466 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38467 example:
38468 .code
38469 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38470 .endd
38471 .endlist
38472
38473 .cindex "log" "process ids in"
38474 .cindex "pid (process id)" "in log lines"
38475 Exim does not include its process id in log lines by default, but you can
38476 request that it does so by specifying the &`pid`& log selector (see section
38477 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38478 brackets, immediately after the time and date.
38479
38480
38481
38482
38483 .section "Where the logs are written" "SECTwhelogwri"
38484 .cindex "log" "destination"
38485 .cindex "log" "to file"
38486 .cindex "log" "to syslog"
38487 .cindex "syslog"
38488 The logs may be written to local files, or to syslog, or both. However, it
38489 should be noted that many syslog implementations use UDP as a transport, and
38490 are therefore unreliable in the sense that messages are not guaranteed to
38491 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38492 It has also been reported that on large log files (tens of megabytes) you may
38493 need to tweak syslog to prevent it syncing the file with each write &-- on
38494 Linux this has been seen to make syslog take 90% plus of CPU time.
38495
38496 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38497 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38498 configuration. This latter string is expanded, so it can contain, for example,
38499 references to the host name:
38500 .code
38501 log_file_path = /var/log/$primary_hostname/exim_%slog
38502 .endd
38503 It is generally advisable, however, to set the string in &_Local/Makefile_&
38504 rather than at runtime, because then the setting is available right from the
38505 start of Exim's execution. Otherwise, if there's something it wants to log
38506 before it has read the configuration file (for example, an error in the
38507 configuration file) it will not use the path you want, and may not be able to
38508 log at all.
38509
38510 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38511 list, currently limited to at most two items. This is one option where the
38512 facility for changing a list separator may not be used. The list must always be
38513 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38514 otherwise the item must either be an absolute path, containing &`%s`& at the
38515 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38516 implying the use of a default path.
38517
38518 When Exim encounters an empty item in the list, it searches the list defined by
38519 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38520 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38521 mean &"use the path specified at build time"&. If no such item exists, log
38522 files are written in the &_log_& subdirectory of the spool directory. This is
38523 equivalent to the configuration file setting:
38524 .code
38525 log_file_path = $spool_directory/log/%slog
38526 .endd
38527 If you do not specify anything at build time or runtime,
38528 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38529 that is where the logs are written.
38530
38531 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38532 are in use &-- see section &<<SECTdatlogfil>>& below.
38533
38534 Here are some examples of possible Makefile settings:
38535 .display
38536 &`LOG_FILE_PATH=syslog                    `& syslog only
38537 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38538 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38539 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38540 .endd
38541 If there are more than two paths in the list, the first is used and a panic
38542 error is logged.
38543
38544
38545
38546 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38547 .cindex "log" "cycling local files"
38548 .cindex "cycling logs"
38549 .cindex "&'exicyclog'&"
38550 .cindex "log" "local files; writing to"
38551 Some operating systems provide centralized and standardized methods for cycling
38552 log files. For those that do not, a utility script called &'exicyclog'& is
38553 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38554 main and reject logs each time it is called. The maximum number of old logs to
38555 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38556
38557 An Exim delivery process opens the main log when it first needs to write to it,
38558 and it keeps the file open in case subsequent entries are required &-- for
38559 example, if a number of different deliveries are being done for the same
38560 message. However, remote SMTP deliveries can take a long time, and this means
38561 that the file may be kept open long after it is renamed if &'exicyclog'& or
38562 something similar is being used to rename log files on a regular basis. To
38563 ensure that a switch of log files is noticed as soon as possible, Exim calls
38564 &[stat()]& on the main log's name before reusing an open file, and if the file
38565 does not exist, or its inode has changed, the old file is closed and Exim
38566 tries to open the main log from scratch. Thus, an old log file may remain open
38567 for quite some time, but no Exim processes should write to it once it has been
38568 renamed.
38569
38570
38571
38572 .section "Datestamped log files" "SECTdatlogfil"
38573 .cindex "log" "datestamped files"
38574 Instead of cycling the main and reject log files by renaming them
38575 periodically, some sites like to use files whose names contain a datestamp,
38576 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38577 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38578 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38579 point where the datestamp is required. For example:
38580 .code
38581 log_file_path = /var/spool/exim/log/%slog-%D
38582 log_file_path = /var/log/exim-%s-%D.log
38583 log_file_path = /var/spool/exim/log/%D-%slog
38584 log_file_path = /var/log/exim/%s.%M
38585 .endd
38586 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38587 examples of names generated by the above examples:
38588 .code
38589 /var/spool/exim/log/mainlog-20021225
38590 /var/log/exim-reject-20021225.log
38591 /var/spool/exim/log/20021225-mainlog
38592 /var/log/exim/main.200212
38593 .endd
38594 When this form of log file is specified, Exim automatically switches to new
38595 files at midnight. It does not make any attempt to compress old logs; you
38596 will need to write your own script if you require this. You should not
38597 run &'exicyclog'& with this form of logging.
38598
38599 The location of the panic log is also determined by &%log_file_path%&, but it
38600 is not datestamped, because rotation of the panic log does not make sense.
38601 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38602 the string. In addition, if it immediately follows a slash, a following
38603 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38604 character is removed. Thus, the four examples above would give these panic
38605 log names:
38606 .code
38607 /var/spool/exim/log/paniclog
38608 /var/log/exim-panic.log
38609 /var/spool/exim/log/paniclog
38610 /var/log/exim/panic
38611 .endd
38612
38613
38614 .section "Logging to syslog" "SECID249"
38615 .cindex "log" "syslog; writing to"
38616 The use of syslog does not change what Exim logs or the format of its messages,
38617 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38618 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38619 that, the same strings are written to syslog as to log files. The syslog
38620 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38621 by default, but you can change these by setting the &%syslog_facility%& and
38622 &%syslog_processname%& options, respectively. If Exim was compiled with
38623 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38624 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38625 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38626 the time and host name to each line.
38627 The three log streams are mapped onto syslog priorities as follows:
38628
38629 .ilist
38630 &'mainlog'& is mapped to LOG_INFO
38631 .next
38632 &'rejectlog'& is mapped to LOG_NOTICE
38633 .next
38634 &'paniclog'& is mapped to LOG_ALERT
38635 .endlist
38636
38637 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38638 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38639 these are routed by syslog to the same place. You can suppress this duplication
38640 by setting &%syslog_duplication%& false.
38641
38642 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38643 entries contain multiple lines when headers are included. To cope with both
38644 these cases, entries written to syslog are split into separate &[syslog()]&
38645 calls at each internal newline, and also after a maximum of
38646 870 data characters. (This allows for a total syslog line length of 1024, when
38647 additions such as timestamps are added.) If you are running a syslog
38648 replacement that can handle lines longer than the 1024 characters allowed by
38649 RFC 3164, you should set
38650 .code
38651 SYSLOG_LONG_LINES=yes
38652 .endd
38653 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38654 lines, but it still splits at internal newlines in &'reject'& log entries.
38655
38656 To make it easy to re-assemble split lines later, each component of a split
38657 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38658 where <&'n'&> is the component number and <&'m'&> is the total number of
38659 components in the entry. The / delimiter is used when the line was split
38660 because it was too long; if it was split because of an internal newline, the \
38661 delimiter is used. For example, supposing the length limit to be 50 instead of
38662 870, the following would be the result of a typical rejection message to
38663 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38664 name, and pid as added by syslog:
38665 .code
38666 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38667 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38668 [3/5]  when scanning for sender: missing or malformed lo
38669 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38670 [5/5] mple>)
38671 .endd
38672 The same error might cause the following lines to be written to &"rejectlog"&
38673 (LOG_NOTICE):
38674 .code
38675 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38676 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38677 [3/18] er when scanning for sender: missing or malformed
38678 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38679 [5\18] .example>)
38680 [6\18] Recipients: ph10@some.domain.cam.example
38681 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38682 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38683 [9\18]        id 16RdAL-0006pc-00
38684 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38685 [11\18] 09:43 +0100
38686 [12\18] F From: <>
38687 [13\18]   Subject: this is a test header
38688 [18\18]   X-something: this is another header
38689 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38690 [16\18] le>
38691 [17\18] B Bcc:
38692 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38693 .endd
38694 Log lines that are neither too long nor contain newlines are written to syslog
38695 without modification.
38696
38697 If only syslog is being used, the Exim monitor is unable to provide a log tail
38698 display, unless syslog is routing &'mainlog'& to a file on the local host and
38699 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38700 where it is.
38701
38702
38703
38704 .section "Log line flags" "SECID250"
38705 One line is written to the main log for each message received, and for each
38706 successful, unsuccessful, and delayed delivery. These lines can readily be
38707 picked out by the distinctive two-character flags that immediately follow the
38708 timestamp. The flags are:
38709 .itable none 0 0 2 10* left 90* left
38710 .irow &%<=%&     "message arrival"
38711 .irow &%(=%&     "message fakereject"
38712 .irow &%=>%&     "normal message delivery"
38713 .irow &%->%&     "additional address in same delivery"
38714 .irow &%>>%&     "cutthrough message delivery"
38715 .irow &%*>%&     "delivery suppressed by &%-N%&"
38716 .irow &%**%&     "delivery failed; address bounced"
38717 .irow &%==%&     "delivery deferred; temporary problem"
38718 .endtable
38719
38720
38721 .section "Logging message reception" "SECID251"
38722 .cindex "log" "reception line"
38723 The format of the single-line entry in the main log that is written for every
38724 message received is shown in the basic example below, which is split over
38725 several lines in order to fit it on the page:
38726 .code
38727 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38728   H=mailer.fict.example [192.168.123.123] U=exim
38729   P=smtp S=5678 id=<incoming message id>
38730 .endd
38731 The address immediately following &"<="& is the envelope sender address. A
38732 bounce message is shown with the sender address &"<>"&, and if it is locally
38733 generated, this is followed by an item of the form
38734 .code
38735 R=<message id>
38736 .endd
38737 which is a reference to the message that caused the bounce to be sent.
38738
38739 .cindex "HELO"
38740 .cindex "EHLO"
38741 For messages from other hosts, the H and U fields identify the remote host and
38742 record the RFC 1413 identity of the user that sent the message, if one was
38743 received. The number given in square brackets is the IP address of the sending
38744 host. If there is a single, unparenthesized  host name in the H field, as
38745 above, it has been verified to correspond to the IP address (see the
38746 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38747 by the remote host in the SMTP HELO or EHLO command, and has not been
38748 verified. If verification yields a different name to that given for HELO or
38749 EHLO, the verified name appears first, followed by the HELO or EHLO
38750 name in parentheses.
38751
38752 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38753 without brackets, in the HELO or EHLO command, leading to entries in
38754 the log containing text like these examples:
38755 .code
38756 H=(10.21.32.43) [192.168.8.34]
38757 H=([10.21.32.43]) [192.168.8.34]
38758 .endd
38759 This can be confusing. Only the final address in square brackets can be relied
38760 on.
38761
38762 For locally generated messages (that is, messages not received over TCP/IP),
38763 the H field is omitted, and the U field contains the login name of the caller
38764 of Exim.
38765
38766 .cindex "authentication" "logging"
38767 .cindex "AUTH" "logging"
38768 For all messages, the P field specifies the protocol used to receive the
38769 message. This is the value that is stored in &$received_protocol$&. In the case
38770 of incoming SMTP messages, the value indicates whether or not any SMTP
38771 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38772 session was encrypted, there is an additional X field that records the cipher
38773 suite that was used.
38774
38775 .cindex log protocol
38776 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38777 hosts that have authenticated themselves using the SMTP AUTH command. The first
38778 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38779 there is an additional item A= followed by the name of the authenticator that
38780 was used. If an authenticated identification was set up by the authenticator's
38781 &%server_set_id%& option, this is logged too, separated by a colon from the
38782 authenticator name.
38783
38784 .cindex "size" "of message"
38785 The id field records the existing message id, if present. The size of the
38786 received message is given by the S field. When the message is delivered,
38787 headers may be removed or added, so that the size of delivered copies of the
38788 message may not correspond with this value (and indeed may be different to each
38789 other).
38790
38791 The &%log_selector%& option can be used to request the logging of additional
38792 data when a message is received. See section &<<SECTlogselector>>& below.
38793
38794
38795
38796 .section "Logging deliveries" "SECID252"
38797 .cindex "log" "delivery line"
38798 The format of the single-line entry in the main log that is written for every
38799 delivery is shown in one of the examples below, for local and remote
38800 deliveries, respectively. Each example has been split into multiple lines in order
38801 to fit it on the page:
38802 .code
38803 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38804   <marv@hitch.fict.example> R=localuser T=local_delivery
38805 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38806   monk@holistic.fict.example R=dnslookup T=remote_smtp
38807   H=holistic.fict.example [192.168.234.234]
38808 .endd
38809 For ordinary local deliveries, the original address is given in angle brackets
38810 after the final delivery address, which might be a pipe or a file. If
38811 intermediate address(es) exist between the original and the final address, the
38812 last of these is given in parentheses after the final address. The R and T
38813 fields record the router and transport that were used to process the address.
38814
38815 If SMTP AUTH was used for the delivery there is an additional item A=
38816 followed by the name of the authenticator that was used.
38817 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38818 option, this is logged too, as a second colon-separated list item.
38819 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38820
38821 If a shadow transport was run after a successful local delivery, the log line
38822 for the successful delivery has an item added on the end, of the form
38823 .display
38824 &`ST=<`&&'shadow transport name'&&`>`&
38825 .endd
38826 If the shadow transport did not succeed, the error message is put in
38827 parentheses afterwards.
38828
38829 .cindex "asterisk" "after IP address"
38830 When more than one address is included in a single delivery (for example, two
38831 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38832 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38833 down a single SMTP connection, an asterisk follows the
38834 remote IP address (and port if enabled)
38835 in the log lines for the second and subsequent messages.
38836 When two or more messages are delivered down a single TLS connection, the
38837 DNS and some TLS-related information logged for the first message delivered
38838 will not be present in the log lines for the second and subsequent messages.
38839 TLS cipher information is still available.
38840
38841 .cindex "delivery" "cutthrough; logging"
38842 .cindex "cutthrough" "logging"
38843 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38844 line precedes the reception line, since cutthrough waits for a possible
38845 rejection from the destination in case it can reject the sourced item.
38846
38847 The generation of a reply message by a filter file gets logged as a
38848 &"delivery"& to the addressee, preceded by &">"&.
38849
38850 The &%log_selector%& option can be used to request the logging of additional
38851 data when a message is delivered. See section &<<SECTlogselector>>& below.
38852
38853
38854 .section "Discarded deliveries" "SECID253"
38855 .cindex "discarded messages"
38856 .cindex "message" "discarded"
38857 .cindex "delivery" "discarded; logging"
38858 When a message is discarded as a result of the command &"seen finish"& being
38859 obeyed in a filter file which generates no deliveries, a log entry of the form
38860 .code
38861 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38862   <low.club@bridge.example> R=userforward
38863 .endd
38864 is written, to record why no deliveries are logged. When a message is discarded
38865 because it is aliased to &":blackhole:"& the log line is like this:
38866 .code
38867 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38868   <hole@nowhere.example> R=blackhole_router
38869 .endd
38870
38871
38872 .section "Deferred deliveries" "SECID254"
38873 When a delivery is deferred, a line of the following form is logged:
38874 .code
38875 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38876   R=dnslookup T=smtp defer (146): Connection refused
38877 .endd
38878 In the case of remote deliveries, the error is the one that was given for the
38879 last IP address that was tried. Details of individual SMTP failures are also
38880 written to the log, so the above line would be preceded by something like
38881 .code
38882 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38883   mail1.endrest.example [192.168.239.239]: Connection refused
38884 .endd
38885 When a deferred address is skipped because its retry time has not been reached,
38886 a message is written to the log, but this can be suppressed by setting an
38887 appropriate value in &%log_selector%&.
38888
38889
38890
38891 .section "Delivery failures" "SECID255"
38892 .cindex "delivery" "failure; logging"
38893 If a delivery fails because an address cannot be routed, a line of the
38894 following form is logged:
38895 .code
38896 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38897   <jim@trek99.example>: unknown mail domain
38898 .endd
38899 If a delivery fails at transport time, the router and transport are shown, and
38900 the response from the remote host is included, as in this example:
38901 .code
38902 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38903   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38904   after pipelined RCPT TO:<ace400@pb.example>: host
38905   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38906   <ace400@pb.example>...Addressee unknown
38907 .endd
38908 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38909 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38910 disabling PIPELINING. The log lines for all forms of delivery failure are
38911 flagged with &`**`&.
38912
38913
38914
38915 .section "Fake deliveries" "SECID256"
38916 .cindex "delivery" "fake; logging"
38917 If a delivery does not actually take place because the &%-N%& option has been
38918 used to suppress it, a normal delivery line is written to the log, except that
38919 &"=>"& is replaced by &"*>"&.
38920
38921
38922
38923 .section "Completion" "SECID257"
38924 A line of the form
38925 .code
38926 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38927 .endd
38928 is written to the main log when a message is about to be removed from the spool
38929 at the end of its processing.
38930
38931
38932
38933
38934 .section "Summary of Fields in Log Lines" "SECID258"
38935 .cindex "log" "summary of fields"
38936 A summary of the field identifiers that are used in log lines is shown in
38937 the following table:
38938 .display
38939 &`A   `&        authenticator name (and optional id and sender)
38940 &`C   `&        SMTP confirmation on delivery
38941 &`    `&        command list for &"no mail in SMTP session"&
38942 &`CV  `&        certificate verification status
38943 &`D   `&        duration of &"no mail in SMTP session"&
38944 &`DKIM`&        domain verified in incoming message
38945 &`DN  `&        distinguished name from peer certificate
38946 &`DS  `&        DNSSEC secured lookups
38947 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38948 &`F   `&        sender address (on delivery lines)
38949 &`H   `&        host name and IP address
38950 &`I   `&        local interface used
38951 &`id  `&        message id (from header) for incoming message
38952 &`K   `&        CHUNKING extension used
38953 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38954 &`M8S `&        8BITMIME status for incoming message
38955 &`P   `&        on &`<=`& lines: protocol used
38956 &`    `&        on &`=>`& and &`**`& lines: return path
38957 &`PRDR`&        PRDR extension used
38958 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38959 &`Q   `&        alternate queue name
38960 &`QT  `&        on &`=>`& lines: time spent on queue so far
38961 &`    `&        on &"Completed"& lines: time spent on queue
38962 &`R   `&        on &`<=`& lines: reference for local bounce
38963 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38964 &`RT  `&        on &`<=`& lines: time taken for reception
38965 &`S   `&        size of message in bytes
38966 &`SNI `&        server name indication from TLS client hello
38967 &`ST  `&        shadow transport name
38968 &`T   `&        on &`<=`& lines: message subject (topic)
38969 &`TFO `&        connection took advantage of TCP Fast Open
38970 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38971 &`U   `&        local user or RFC 1413 identity
38972 &`X   `&        TLS cipher suite
38973 .endd
38974
38975
38976 .section "Other log entries" "SECID259"
38977 Various other types of log entry are written from time to time. Most should be
38978 self-explanatory. Among the more common are:
38979
38980 .ilist
38981 .cindex "retry" "time not reached"
38982 &'retry time not reached'&&~&~An address previously suffered a temporary error
38983 during routing or local delivery, and the time to retry has not yet arrived.
38984 This message is not written to an individual message log file unless it happens
38985 during the first delivery attempt.
38986 .next
38987 &'retry time not reached for any host'&&~&~An address previously suffered
38988 temporary errors during remote delivery, and the retry time has not yet arrived
38989 for any of the hosts to which it is routed.
38990 .next
38991 .cindex "spool directory" "file locked"
38992 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38993 some other Exim process is already working on the message. This can be quite
38994 common if queue running processes are started at frequent intervals. The
38995 &'exiwhat'& utility script can be used to find out what Exim processes are
38996 doing.
38997 .next
38998 .cindex "error" "ignored"
38999 &'error ignored'&&~&~There are several circumstances that give rise to this
39000 message:
39001 .olist
39002 Exim failed to deliver a bounce message whose age was greater than
39003 &%ignore_bounce_errors_after%&. The bounce was discarded.
39004 .next
39005 A filter file set up a delivery using the &"noerror"& option, and the delivery
39006 failed. The delivery was discarded.
39007 .next
39008 A delivery set up by a router configured with
39009 . ==== As this is a nested list, any displays it contains must be indented
39010 . ==== as otherwise they are too far to the left.
39011 .code
39012     errors_to = <>
39013 .endd
39014 failed. The delivery was discarded.
39015 .endlist olist
39016 .next
39017 .cindex DKIM "log line"
39018 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39019 logging and the message has a DKIM signature header.
39020 .endlist ilist
39021
39022
39023
39024
39025
39026 .section "Reducing or increasing what is logged" "SECTlogselector"
39027 .cindex "log" "selectors"
39028 By setting the &%log_selector%& global option, you can disable some of Exim's
39029 default logging to the main log, or you can request additional logging. The value of
39030 &%log_selector%& is made up of names preceded by plus or minus characters. For
39031 example:
39032 .code
39033 log_selector = +arguments -retry_defer
39034 .endd
39035 The list of optional log items is in the following table, with the default
39036 selection marked by asterisks:
39037 .itable none 0 0 3 2.8in left 10pt center 3in left
39038 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39039 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39040 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39041 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39042 .irow &`arguments`&                     &nbsp; "command line arguments"
39043 .irow &`connection_reject`&             *       "connection rejections"
39044 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39045 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39046 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39047 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39048 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
39049 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39050 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39051 .irow &`etrn`&                          *       "ETRN commands"
39052 .irow &`host_lookup_failed`&            *       "as it says"
39053 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39054 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39055 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39056 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39057 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39058 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39059 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39060 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39061 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39062 .irow &`queue_run`&                     *       "start and end queue runs"
39063 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39064 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39065 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39066 .irow &`pid`&                           &nbsp; "Exim process id"
39067 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39068 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39069 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39070 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39071 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39072 .irow &`rejected_header`&               *       "header contents on reject log"
39073 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39074 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39075 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39076 .irow &`sender_verify_fail`&            *       "sender verification failures"
39077 .irow &`size_reject`&                   *       "rejection because too big"
39078 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39079 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39080 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39081 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39082 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39083 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39084 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39085 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39086 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39087 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39088 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39089 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39090 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39091 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39092 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39093 .irow &`all`&                           &nbsp; "&*all of the above*&"
39094 .endtable
39095 See also the &%slow_lookup_log%& main configuration option,
39096 section &<<SECID99>>&
39097
39098 More details on each of these items follows:
39099
39100 .ilist
39101 .cindex "8BITMIME"
39102 .cindex "log" "8BITMIME"
39103 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39104 which may help in tracking down interoperability issues with ancient MTAs
39105 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39106 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39107 &`7BIT`& and &`8BITMIME`& respectively.
39108 .next
39109 .cindex "&%warn%& ACL verb" "log when skipping"
39110 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39111 its conditions cannot be evaluated, a log line to this effect is written if
39112 this log selector is set.
39113 .next
39114 .cindex "log" "rewriting"
39115 .cindex "rewriting" "logging"
39116 &%address_rewrite%&: This applies both to global rewrites and per-transport
39117 rewrites, but not to rewrites in filters run as an unprivileged user (because
39118 such users cannot access the log).
39119 .next
39120 .cindex "log" "full parentage"
39121 &%all_parents%&: Normally only the original and final addresses are logged on
39122 delivery lines; with this selector, intermediate parents are given in
39123 parentheses between them.
39124 .next
39125 .cindex "log" "Exim arguments"
39126 .cindex "Exim arguments, logging"
39127 &%arguments%&: This causes Exim to write the arguments with which it was called
39128 to the main log, preceded by the current working directory. This is a debugging
39129 feature, added to make it easier to find out how certain MUAs call
39130 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39131 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39132 that are empty or that contain white space are quoted. Non-printing characters
39133 are shown as escape sequences. This facility cannot log unrecognized arguments,
39134 because the arguments are checked before the configuration file is read. The
39135 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39136 between the caller and Exim.
39137 .next
39138 .cindex "log" "connection rejections"
39139 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39140 connection is rejected, for whatever reason.
39141 .next
39142 .cindex "log" "delayed delivery"
39143 .cindex "delayed delivery, logging"
39144 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39145 started for an incoming message because the load is too high or too many
39146 messages were received on one connection. Logging does not occur if no delivery
39147 process is started because &%queue_only%& is set or &%-odq%& was used.
39148 .next
39149 .cindex "log" "delivery duration"
39150 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39151 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39152 If millisecond logging is enabled, short times will be shown with greater
39153 precision, eg. &`DT=0.304s`&.
39154 .next
39155 .cindex "log" "message size on delivery"
39156 .cindex "size" "of message"
39157 &%delivery_size%&: For each delivery, the size of message delivered is added to
39158 the &"=>"& line, tagged with S=.
39159 .next
39160 .cindex log "DKIM verification"
39161 .cindex DKIM "verification logging"
39162 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39163 verifies successfully a tag of DKIM is added, with one of the verified domains.
39164 .next
39165 .cindex log "DKIM verification"
39166 .cindex DKIM "verification logging"
39167 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39168 .next
39169 .cindex "log" "dnslist defer"
39170 .cindex "DNS list" "logging defer"
39171 .cindex "black list (DNS)"
39172 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39173 DNS black list suffers a temporary error.
39174 .next
39175 .cindex log dnssec
39176 .cindex dnssec logging
39177 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39178 dns lookups gave secure results a tag of DS is added.
39179 For acceptance this covers the reverse and forward lookups for host name verification.
39180 It does not cover helo-name verification.
39181 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39182 .next
39183 .cindex "log" "ETRN commands"
39184 .cindex "ETRN" "logging"
39185 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39186 is run to determine whether or not it is actually accepted. An invalid ETRN
39187 command, or one received within a message transaction is not logged by this
39188 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39189 .next
39190 .cindex "log" "host lookup failure"
39191 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39192 any addresses, or when a lookup of an IP address fails to find a host name, a
39193 log line is written. This logging does not apply to direct DNS lookups when
39194 routing email addresses, but it does apply to &"byname"& lookups.
39195 .next
39196 .cindex "log" "ident timeout"
39197 .cindex "RFC 1413" "logging timeout"
39198 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39199 client's ident port times out.
39200 .next
39201 .cindex "log" "incoming interface"
39202 .cindex "log" "outgoing interface"
39203 .cindex "log" "local interface"
39204 .cindex "log" "local address and port"
39205 .cindex "TCP/IP" "logging local address and port"
39206 .cindex "interface" "logging"
39207 &%incoming_interface%&: The interface on which a message was received is added
39208 to the &"<="& line as an IP address in square brackets, tagged by I= and
39209 followed by a colon and the port number. The local interface and port are also
39210 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39211 rejection lines, and (despite the name) to outgoing
39212 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39213 The latter can be disabled by turning off the &%outgoing_interface%& option.
39214 .next
39215 .cindex log "incoming proxy address"
39216 .cindex proxy "logging proxy address"
39217 .cindex "TCP/IP" "logging proxy address"
39218 &%proxy%&: The internal (closest to the system running Exim) IP address
39219 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39220 on a proxied connection
39221 or the &"=>"& line for a message delivered on a proxied connection.
39222 See &<<SECTproxyInbound>>& for more information.
39223 .next
39224 .cindex "log" "incoming remote port"
39225 .cindex "port" "logging remote"
39226 .cindex "TCP/IP" "logging incoming remote port"
39227 .vindex "&$sender_fullhost$&"
39228 .vindex "&$sender_rcvhost$&"
39229 &%incoming_port%&: The remote port number from which a message was received is
39230 added to log entries and &'Received:'& header lines, following the IP address
39231 in square brackets, and separated from it by a colon. This is implemented by
39232 changing the value that is put in the &$sender_fullhost$& and
39233 &$sender_rcvhost$& variables. Recording the remote port number has become more
39234 important with the widening use of NAT (see RFC 2505).
39235 .next
39236 .cindex "log" "dropped connection"
39237 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39238 connection is unexpectedly dropped.
39239 .next
39240 .cindex "log" "millisecond timestamps"
39241 .cindex millisecond logging
39242 .cindex timestamps "millisecond, in logs"
39243 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39244 appended to the seconds value.
39245 .next
39246 .cindex "log" "message id"
39247 &%msg_id%&: The value of the Message-ID: header.
39248 .next
39249 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39250 This will be either because the message is a bounce, or was submitted locally
39251 (submission mode) without one.
39252 The field identifier will have an asterix appended: &"id*="&.
39253 .next
39254 .cindex "log" "outgoing interface"
39255 .cindex "log" "local interface"
39256 .cindex "log" "local address and port"
39257 .cindex "TCP/IP" "logging local address and port"
39258 .cindex "interface" "logging"
39259 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39260 interface on which a message was sent is added to delivery lines as an I= tag
39261 followed by IP address in square brackets. You can disable this by turning
39262 off the &%outgoing_interface%& option.
39263 .next
39264 .cindex "log" "outgoing remote port"
39265 .cindex "port" "logging outgoing remote"
39266 .cindex "TCP/IP" "logging outgoing remote port"
39267 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39268 containing => tags) following the IP address.
39269 The local port is also added if &%incoming_interface%& and
39270 &%outgoing_interface%& are both enabled.
39271 This option is not included in the default setting, because for most ordinary
39272 configurations, the remote port number is always 25 (the SMTP port), and the
39273 local port is a random ephemeral port.
39274 .next
39275 .cindex "log" "process ids in"
39276 .cindex "pid (process id)" "in log lines"
39277 &%pid%&: The current process id is added to every log line, in square brackets,
39278 immediately after the time and date.
39279 .next
39280 .cindex log pipelining
39281 .cindex pipelining "logging outgoing"
39282 &%pipelining%&: A field is added to delivery and accept
39283 log lines when the ESMTP PIPELINING extension was used.
39284 The field is a single "L".
39285
39286 On accept lines, where PIPELINING was offered but not used by the client,
39287 the field has a minus appended.
39288
39289 .cindex "pipelining" "early connection"
39290 If Exim is built without the DISABLE_PIPE_CONNECT build option
39291 accept "L" fields have a period appended if the feature was
39292 offered but not used, or an asterisk appended if used.
39293 Delivery "L" fields have an asterisk appended if used.
39294
39295 .next
39296 .cindex "log" "queue run"
39297 .cindex "queue runner" "logging"
39298 &%queue_run%&: The start and end of every queue run are logged.
39299 .next
39300 .cindex "log" "queue time"
39301 &%queue_time%&: The amount of time the message has been in the queue on the
39302 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39303 &`QT=3m45s`&.
39304 If millisecond logging is enabled, short times will be shown with greater
39305 precision, eg. &`QT=1.578s`&.
39306 .next
39307 &%queue_time_overall%&: The amount of time the message has been in the queue on
39308 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39309 example, &`QT=3m45s`&.
39310 .next
39311 .cindex "log" "receive duration"
39312 &%receive_time%&: For each message, the amount of real time it has taken to
39313 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39314 If millisecond logging is enabled, short times will be shown with greater
39315 precision, eg. &`RT=0.204s`&.
39316 .next
39317 .cindex "log" "recipients"
39318 &%received_recipients%&: The recipients of a message are listed in the main log
39319 as soon as the message is received. The list appears at the end of the log line
39320 that is written when a message is received, preceded by the word &"for"&. The
39321 addresses are listed after they have been qualified, but before any rewriting
39322 has taken place.
39323 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39324 in the list.
39325 .next
39326 .cindex "log" "sender reception"
39327 &%received_sender%&: The unrewritten original sender of a message is added to
39328 the end of the log line that records the message's arrival, after the word
39329 &"from"& (before the recipients if &%received_recipients%& is also set).
39330 .next
39331 .cindex "log" "header lines for rejection"
39332 &%rejected_header%&: If a message's header has been received at the time a
39333 rejection is written to the reject log, the complete header is added to the
39334 log. Header logging can be turned off individually for messages that are
39335 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39336 .next
39337 .cindex "log" "retry defer"
39338 &%retry_defer%&: A log line is written if a delivery is deferred because a
39339 retry time has not yet been reached. However, this &"retry time not reached"&
39340 message is always omitted from individual message logs after the first delivery
39341 attempt.
39342 .next
39343 .cindex "log" "return path"
39344 &%return_path_on_delivery%&: The return path that is being transmitted with
39345 the message is included in delivery and bounce lines, using the tag P=.
39346 This is omitted if no delivery actually happens, for example, if routing fails,
39347 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39348 .next
39349 .cindex "log" "sender on delivery"
39350 &%sender_on_delivery%&: The message's sender address is added to every delivery
39351 and bounce line, tagged by F= (for &"from"&).
39352 This is the original sender that was received with the message; it is not
39353 necessarily the same as the outgoing return path.
39354 .next
39355 .cindex "log" "sender verify failure"
39356 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39357 gives details of a sender verification failure is not written. Log lines for
39358 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39359 detail is lost.
39360 .next
39361 .cindex "log" "size rejection"
39362 &%size_reject%&: A log line is written whenever a message is rejected because
39363 it is too big.
39364 .next
39365 .cindex "log" "frozen messages; skipped"
39366 .cindex "frozen messages" "logging skipping"
39367 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39368 queue run because it another process is already delivering it or because
39369 it is frozen.
39370 .cindex "&""spool file is locked""&"
39371 .cindex "&""message is frozen""&"
39372 The message that is written is either &"spool file is locked"& or
39373 &"message is frozen"&.
39374 .next
39375 .cindex "log" "smtp confirmation"
39376 .cindex "SMTP" "logging confirmation"
39377 .cindex "LMTP" "logging confirmation"
39378 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39379 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39380 A number of MTAs (including Exim) return an identifying string in this
39381 response.
39382 .next
39383 .cindex "log" "SMTP connections"
39384 .cindex "SMTP" "logging connections"
39385 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39386 established or closed, unless the connection is from a host that matches
39387 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39388 only when the closure is unexpected.) This applies to connections from local
39389 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39390 dropped in the middle of a message, a log line is always written, whether or
39391 not this selector is set, but otherwise nothing is written at the start and end
39392 of connections unless this selector is enabled.
39393
39394 For TCP/IP connections to an Exim daemon, the current number of connections is
39395 included in the log message for each new connection, but note that the count is
39396 reset if the daemon is restarted.
39397 Also, because connections are closed (and the closure is logged) in
39398 subprocesses, the count may not include connections that have been closed but
39399 whose termination the daemon has not yet noticed. Thus, while it is possible to
39400 match up the opening and closing of connections in the log, the value of the
39401 logged counts may not be entirely accurate.
39402 .next
39403 .cindex "log" "SMTP transaction; incomplete"
39404 .cindex "SMTP" "logging incomplete transactions"
39405 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39406 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39407 and the message sender plus any accepted recipients are included in the log
39408 line. This can provide evidence of dictionary attacks.
39409 .next
39410 .cindex "log" "non-MAIL SMTP sessions"
39411 .cindex "MAIL" "logging session without"
39412 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39413 connection terminates without having issued a MAIL command. This includes both
39414 the case when the connection is dropped, and the case when QUIT is used. It
39415 does not include cases where the connection is rejected right at the start (by
39416 an ACL, or because there are too many connections, or whatever). These cases
39417 already have their own log lines.
39418
39419 The log line that is written contains the identity of the client in the usual
39420 way, followed by D= and a time, which records the duration of the connection.
39421 If the connection was authenticated, this fact is logged exactly as it is for
39422 an incoming message, with an A= item. If the connection was encrypted, CV=,
39423 DN=, and X= items may appear as they do for an incoming message, controlled by
39424 the same logging options.
39425
39426 Finally, if any SMTP commands were issued during the connection, a C= item
39427 is added to the line, listing the commands that were used. For example,
39428 .code
39429 C=EHLO,QUIT
39430 .endd
39431 shows that the client issued QUIT straight after EHLO. If there were fewer
39432 than 20 commands, they are all listed. If there were more than 20 commands,
39433 the last 20 are listed, preceded by &"..."&. However, with the default
39434 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39435 have been aborted before 20 non-mail commands are processed.
39436 .next
39437 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39438 colon-separated, is appended to the A= item for a message arrival or delivery
39439 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39440 was accepted or used.
39441 .next
39442 .cindex "log" "SMTP protocol error"
39443 .cindex "SMTP" "logging protocol error"
39444 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39445 encountered. Exim does not have perfect detection of all protocol errors
39446 because of transmission delays and the use of pipelining. If PIPELINING has
39447 been advertised to a client, an Exim server assumes that the client will use
39448 it, and therefore it does not count &"expected"& errors (for example, RCPT
39449 received after rejecting MAIL) as protocol errors.
39450 .next
39451 .cindex "SMTP" "logging syntax errors"
39452 .cindex "SMTP" "syntax errors; logging"
39453 .cindex "SMTP" "unknown command; logging"
39454 .cindex "log" "unknown SMTP command"
39455 .cindex "log" "SMTP syntax error"
39456 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39457 encountered. An unrecognized command is treated as a syntax error. For an
39458 external connection, the host identity is given; for an internal connection
39459 using &%-bs%& the sender identification (normally the calling user) is given.
39460 .next
39461 .cindex "log" "subject"
39462 .cindex "subject, logging"
39463 &%subject%&: The subject of the message is added to the arrival log line,
39464 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39465 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39466 specifies whether characters with values greater than 127 should be logged
39467 unchanged, or whether they should be rendered as escape sequences.
39468 .next
39469 .cindex "log" "certificate verification"
39470 .cindex log DANE
39471 .cindex DANE logging
39472 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39473 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39474 verified
39475 using a CA trust anchor,
39476 &`CV=dane`& if using a DNS trust anchor,
39477 and &`CV=no`& if not.
39478 .next
39479 .cindex "log" "TLS cipher"
39480 .cindex "TLS" "logging cipher"
39481 &%tls_cipher%&: When a message is sent or received over an encrypted
39482 connection, the cipher suite used is added to the log line, preceded by X=.
39483 .next
39484 .cindex "log" "TLS peer DN"
39485 .cindex "TLS" "logging peer DN"
39486 &%tls_peerdn%&: When a message is sent or received over an encrypted
39487 connection, and a certificate is supplied by the remote host, the peer DN is
39488 added to the log line, preceded by DN=.
39489 .next
39490 .cindex "log" "TLS resumption"
39491 .cindex "TLS" "logging session resumption"
39492 &%tls_resumption%&: When a message is sent or received over an encrypted
39493 connection and the TLS session resumed one used on a previous TCP connection,
39494 an asterisk is appended to the X= cipher field in the log line.
39495 .next
39496 .cindex "log" "TLS SNI"
39497 .cindex "TLS" "logging SNI"
39498 .cindex SNI logging
39499 &%tls_sni%&: When a message is received over an encrypted connection, and
39500 the remote host provided the Server Name Indication extension, the SNI is
39501 added to the log line, preceded by SNI=.
39502 .next
39503 .cindex "log" "DNS failure in list"
39504 &%unknown_in_list%&: This setting causes a log entry to be written when the
39505 result of a list match is failure because a DNS lookup failed.
39506 .endlist
39507
39508
39509 .section "Message log" "SECID260"
39510 .cindex "message" "log file for"
39511 .cindex "log" "message log; description of"
39512 .cindex "&_msglog_& directory"
39513 .oindex "&%preserve_message_logs%&"
39514 In addition to the general log files, Exim writes a log file for each message
39515 that it handles. The names of these per-message logs are the message ids, and
39516 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39517 message log contains copies of the log lines that apply to the message. This
39518 makes it easier to inspect the status of an individual message without having
39519 to search the main log. A message log is deleted when processing of the message
39520 is complete, unless &%preserve_message_logs%& is set, but this should be used
39521 only with great care because they can fill up your disk very quickly.
39522
39523 On a heavily loaded system, it may be desirable to disable the use of
39524 per-message logs, in order to reduce disk I/O. This can be done by setting the
39525 &%message_logs%& option false.
39526 .ecindex IIDloggen
39527
39528
39529
39530
39531 . ////////////////////////////////////////////////////////////////////////////
39532 . ////////////////////////////////////////////////////////////////////////////
39533
39534 .chapter "Exim utilities" "CHAPutils"
39535 .scindex IIDutils "utilities"
39536 A number of utility scripts and programs are supplied with Exim and are
39537 described in this chapter. There is also the Exim Monitor, which is covered in
39538 the next chapter. The utilities described here are:
39539
39540 .itable none 0 0 3  7* left  15* left  40* left
39541 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39542   "list what Exim processes are doing"
39543 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39544 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39545 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39546 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39547                                                 various criteria"
39548 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39549 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39550   "extract statistics from the log"
39551 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39552   "check address acceptance from given IP"
39553 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39554 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39555 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39556 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39557 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39558 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39559 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39560 .endtable
39561
39562 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39563 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39564 &url(https://duncanthrax.net/exilog/) for details.
39565
39566
39567
39568
39569 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39570 .cindex "&'exiwhat'&"
39571 .cindex "process, querying"
39572 .cindex "SIGUSR1"
39573 On operating systems that can restart a system call after receiving a signal
39574 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39575 a line describing what it is doing to the file &_exim-process.info_& in the
39576 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39577 processes it can find, having first emptied the file. It then waits for one
39578 second to allow the Exim processes to react before displaying the results. In
39579 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39580 send the signal to the Exim processes, so it is normally run as root.
39581
39582 &*Warning*&: This is not an efficient process. It is intended for occasional
39583 use by system administrators. It is not sensible, for example, to set up a
39584 script that sends SIGUSR1 signals to Exim processes at short intervals.
39585
39586
39587 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39588 varies in different operating systems. Not only are different options used,
39589 but the format of the output is different. For this reason, there are some
39590 system configuration options that configure exactly how &'exiwhat'& works. If
39591 it doesn't seem to be working for you, check the following compile-time
39592 options:
39593 .itable none 0 0 2 30* left 70* left
39594 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39595 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39596 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39597 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39598 .endtable
39599 An example of typical output from &'exiwhat'& is
39600 .code
39601 164 daemon: -q1h, listening on port 25
39602 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39603 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39604   [10.19.42.42] (editor@ref.example)
39605 10592 handling incoming call from [192.168.243.242]
39606 10628 accepting a local non-SMTP message
39607 .endd
39608 The first number in the output line is the process number. The third line has
39609 been split here, in order to fit it on the page.
39610
39611
39612
39613 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39614 .cindex "&'exiqgrep'&"
39615 .cindex "queue" "grepping"
39616 This utility is a Perl script contributed by Matt Hubbard. It runs
39617 .code
39618 exim -bpu
39619 .endd
39620 or (in case &*-a*& switch is specified)
39621 .code
39622 exim -bp
39623 .endd
39624 to obtain a queue listing, and then greps the output to select messages
39625 that match given criteria. The following selection options are available:
39626
39627 .vlist
39628 .vitem &*-f*&&~<&'regex'&>
39629 Match the sender address using a case-insensitive search. The field that is
39630 tested is enclosed in angle brackets, so you can test for bounce messages with
39631 .code
39632 exiqgrep -f '^<>$'
39633 .endd
39634 .vitem &*-r*&&~<&'regex'&>
39635 Match a recipient address using a case-insensitive search. The field that is
39636 tested is not enclosed in angle brackets.
39637
39638 .vitem &*-s*&&~<&'regex'&>
39639 Match against the size field.
39640
39641 .vitem &*-y*&&~<&'seconds'&>
39642 Match messages that are younger than the given time.
39643
39644 .vitem &*-o*&&~<&'seconds'&>
39645 Match messages that are older than the given time.
39646
39647 .vitem &*-z*&
39648 Match only frozen messages.
39649
39650 .vitem &*-x*&
39651 Match only non-frozen messages.
39652
39653 .vitem &*-G*&&~<&'queuename'&>
39654 Match only messages in the given queue.  Without this, the default queue is searched.
39655 .endlist
39656
39657 The following options control the format of the output:
39658
39659 .vlist
39660 .vitem &*-c*&
39661 Display only the count of matching messages.
39662
39663 .vitem &*-l*&
39664 Long format &-- display the full message information as output by Exim. This is
39665 the default.
39666
39667 .vitem &*-i*&
39668 Display message ids only.
39669
39670 .vitem &*-b*&
39671 Brief format &-- one line per message.
39672
39673 .vitem &*-R*&
39674 Display messages in reverse order.
39675
39676 .vitem &*-a*&
39677 Include delivered recipients in queue listing.
39678 .endlist
39679
39680 The following options give alternates for configuration:
39681
39682 .vlist
39683 .vitem &*-C*&&~<&'config&~file'&>
39684 is used to specify an alternate &_exim.conf_& which might
39685 contain alternate exim configuration the queue management might be using.
39686
39687 .vitem &*-E*&&~<&'path'&>
39688 can be used to specify a path for the exim binary,
39689 overriding the built-in one.
39690 .endlist
39691
39692 There is one more option, &%-h%&, which outputs a list of options.
39693 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39694
39695
39696
39697 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39698 .cindex "&'exiqsumm'&"
39699 .cindex "queue" "summary"
39700 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39701 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39702 running a command such as
39703 .code
39704 exim -bp | exiqsumm
39705 .endd
39706 The output consists of one line for each domain that has messages waiting for
39707 it, as in the following example:
39708 .code
39709 3   2322   74m   66m  msn.com.example
39710 .endd
39711 Each line lists the number of pending deliveries for a domain, their total
39712 volume, and the length of time that the oldest and the newest messages have
39713 been waiting. Note that the number of pending deliveries is greater than the
39714 number of messages when messages have more than one recipient.
39715
39716 A summary line is output at the end. By default the output is sorted on the
39717 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39718 the output to be sorted by oldest message and by count of messages,
39719 respectively. There are also three options that split the messages for each
39720 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39721 separates frozen messages, and &%-s%& separates messages according to their
39722 sender.
39723
39724 The output of &'exim -bp'& contains the original addresses in the message, so
39725 this also applies to the output from &'exiqsumm'&. No domains from addresses
39726 generated by aliasing or forwarding are included (unless the &%one_time%&
39727 option of the &(redirect)& router has been used to convert them into &"top
39728 level"& addresses).
39729
39730
39731
39732
39733 .section "Extracting specific information from the log (exigrep)" &&&
39734          "SECTextspeinf"
39735 .cindex "&'exigrep'&"
39736 .cindex "log" "extracts; grepping for"
39737 The &'exigrep'& utility is a Perl script that searches one or more main log
39738 files for entries that match a given pattern. When it finds a match, it
39739 extracts all the log entries for the relevant message, not just those that
39740 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39741 given message, or all mail for a given user, or for a given host, for example.
39742 The input files can be in Exim log format or syslog format.
39743 If a matching log line is not associated with a specific message, it is
39744 included in &'exigrep'&'s output without any additional lines. The usage is:
39745 .display
39746 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39747 .endd
39748 If no log filenames are given on the command line, the standard input is read.
39749
39750 The &%-t%& argument specifies a number of seconds. It adds an additional
39751 condition for message selection. Messages that are complete are shown only if
39752 they spent more than <&'n'&> seconds in the queue.
39753
39754 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39755 makes it case-sensitive. This may give a performance improvement when searching
39756 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39757 option; with &%-I%& they do not. In both cases it is possible to change the
39758 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39759
39760 The &%-l%& option means &"literal"&, that is, treat all characters in the
39761 pattern as standing for themselves. Otherwise the pattern must be a Perl
39762 regular expression.
39763
39764 The &%-v%& option inverts the matching condition. That is, a line is selected
39765 if it does &'not'& match the pattern.
39766
39767 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39768 that are generated as a result/response to a message that &'exigrep'& matched
39769 normally.
39770
39771 Example of &%-M%&:
39772 user_a sends a message to user_b, which generates a bounce back to user_b. If
39773 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39774 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39775 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39776 when searching for &"user_a"& will show both messages since the bounce is
39777 &"related"& to or a &"result"& of the first message that was found by the
39778 search term.
39779
39780 If the location of a &'zcat'& command is known from the definition of
39781 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39782 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39783 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39784 autodetection of some well known compression extensions.
39785
39786
39787 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39788 .cindex "&'exipick'&"
39789 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39790 lists messages from the queue according to a variety of criteria. For details
39791 of &'exipick'&'s facilities, run &'exipick'& with
39792 the &%--help%& option.
39793
39794
39795 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39796 .cindex "log" "cycling local files"
39797 .cindex "cycling logs"
39798 .cindex "&'exicyclog'&"
39799 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39800 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39801 you are using log files with datestamps in their names (see section
39802 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39803 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39804 There are two command line options for &'exicyclog'&:
39805 .ilist
39806 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39807 default that is set when Exim is built. The default default is 10.
39808 .next
39809 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39810 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39811 overriding the script's default, which is to find the setting from Exim's
39812 configuration.
39813 .endlist
39814
39815 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39816 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39817 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39818 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39819 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39820 logs are handled similarly.
39821
39822 If the limit is greater than 99, the script uses 3-digit numbers such as
39823 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39824 to one that is greater, or &'vice versa'&, you will have to fix the names of
39825 any existing log files.
39826
39827 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39828 the end are deleted. All files with numbers greater than 01 are compressed,
39829 using a compression command which is configured by the COMPRESS_COMMAND
39830 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39831 root &%crontab%& entry of the form
39832 .code
39833 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39834 .endd
39835 assuming you have used the name &"exim"& for the Exim user. You can run
39836 &'exicyclog'& as root if you wish, but there is no need.
39837
39838
39839
39840 .section "Mail statistics (eximstats)" "SECTmailstat"
39841 .cindex "statistics"
39842 .cindex "&'eximstats'&"
39843 A Perl script called &'eximstats'& is provided for extracting statistical
39844 information from log files. The output is either plain text, or HTML.
39845 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39846 . --- 404 error and everything else points to that.
39847
39848 The &'eximstats'& script has been hacked about quite a bit over time. The
39849 latest version is the result of some extensive revision by Steve Campbell. A
39850 lot of information is given by default, but there are options for suppressing
39851 various parts of it. Following any options, the arguments to the script are a
39852 list of files, which should be main log files. For example:
39853 .code
39854 eximstats -nr /var/spool/exim/log/mainlog.01
39855 .endd
39856 By default, &'eximstats'& extracts information about the number and volume of
39857 messages received from or delivered to various hosts. The information is sorted
39858 both by message count and by volume, and the top fifty hosts in each category
39859 are listed on the standard output. Similar information, based on email
39860 addresses or domains instead of hosts can be requested by means of various
39861 options. For messages delivered and received locally, similar statistics are
39862 also produced per user.
39863
39864 The output also includes total counts and statistics about delivery errors, and
39865 histograms showing the number of messages received and deliveries made in each
39866 hour of the day. A delivery with more than one address in its envelope (for
39867 example, an SMTP transaction with more than one RCPT command) is counted
39868 as a single delivery by &'eximstats'&.
39869
39870 Though normally more deliveries than receipts are reported (as messages may
39871 have multiple recipients), it is possible for &'eximstats'& to report more
39872 messages received than delivered, even though the queue is empty at the start
39873 and end of the period in question. If an incoming message contains no valid
39874 recipients, no deliveries are recorded for it. A bounce message is handled as
39875 an entirely separate message.
39876
39877 &'eximstats'& always outputs a grand total summary giving the volume and number
39878 of messages received and deliveries made, and the number of hosts involved in
39879 each case. It also outputs the number of messages that were delayed (that is,
39880 not completely delivered at the first attempt), and the number that had at
39881 least one address that failed.
39882
39883 The remainder of the output is in sections that can be independently disabled
39884 or modified by various options. It consists of a summary of deliveries by
39885 transport, histograms of messages received and delivered per time interval
39886 (default per hour), information about the time messages spent in the queue,
39887 a list of relayed messages, lists of the top fifty sending hosts, local
39888 senders, destination hosts, and destination local users by count and by volume,
39889 and a list of delivery errors that occurred.
39890
39891 The relay information lists messages that were actually relayed, that is, they
39892 came from a remote host and were directly delivered to some other remote host,
39893 without being processed (for example, for aliasing or forwarding) locally.
39894
39895 There are quite a few options for &'eximstats'& to control exactly what it
39896 outputs. These are documented in the Perl script itself, and can be extracted
39897 by running the command &(perldoc)& on the script. For example:
39898 .code
39899 perldoc /usr/exim/bin/eximstats
39900 .endd
39901
39902 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39903 .cindex "&'exim_checkaccess'&"
39904 .cindex "policy control" "checking access"
39905 .cindex "checking access"
39906 The &%-bh%& command line argument allows you to run a fake SMTP session with
39907 debugging output, in order to check what Exim is doing when it is applying
39908 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39909 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39910 sometimes you just want to answer the question &"Does this address have
39911 access?"& without bothering with any further details.
39912
39913 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39914 two arguments, an IP address and an email address:
39915 .code
39916 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39917 .endd
39918 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39919 given email address would be accepted in a RCPT command in a TCP/IP
39920 connection from the host with the given IP address. The output of the utility
39921 is either the word &"accepted"&, or the SMTP error response, for example:
39922 .code
39923 Rejected:
39924 550 Relay not permitted
39925 .endd
39926 When running this test, the utility uses &`<>`& as the envelope sender address
39927 for the MAIL command, but you can change this by providing additional
39928 options. These are passed directly to the Exim command. For example, to specify
39929 that the test is to be run with the sender address &'himself@there.example'&
39930 you can use:
39931 .code
39932 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39933                  -f himself@there.example
39934 .endd
39935 Note that these additional Exim command line items must be given after the two
39936 mandatory arguments.
39937
39938 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39939 while running its checks. You can run checks that include callouts by using
39940 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39941
39942
39943
39944 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39945 .cindex "DBM" "building dbm files"
39946 .cindex "building DBM files"
39947 .cindex "&'exim_dbmbuild'&"
39948 .cindex "lower casing"
39949 .cindex "binary zero" "in lookup key"
39950 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39951 the format used by the &(lsearch)& lookup (see section
39952 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39953 names as keys and the remainder of the information as data. The lower-casing
39954 can be prevented by calling the program with the &%-nolc%& option.
39955
39956 A terminating zero is included as part of the key string. This is expected by
39957 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39958 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39959 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39960 files.
39961
39962 The program requires two arguments: the name of the input file (which can be a
39963 single hyphen to indicate the standard input), and the name of the output file.
39964 It creates the output under a temporary name, and then renames it if all went
39965 well.
39966
39967 .cindex "USE_DB"
39968 If the native DB interface is in use (USE_DB is set in a compile-time
39969 configuration file &-- this is common in free versions of Unix) the two
39970 filenames must be different, because in this mode the Berkeley DB functions
39971 create a single output file using exactly the name given. For example,
39972 .code
39973 exim_dbmbuild /etc/aliases /etc/aliases.db
39974 .endd
39975 reads the system alias file and creates a DBM version of it in
39976 &_/etc/aliases.db_&.
39977
39978 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39979 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39980 environment, the suffixes are added to the second argument of
39981 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39982 when the Berkeley functions are used in compatibility mode (though this is not
39983 recommended), because in that case it adds a &_.db_& suffix to the filename.
39984
39985 If a duplicate key is encountered, the program outputs a warning, and when it
39986 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39987 option is used. By default, only the first of a set of duplicates is used &--
39988 this makes it compatible with &(lsearch)& lookups. There is an option
39989 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39990 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39991 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39992 return code is 2.
39993
39994
39995
39996
39997 .section "Finding individual retry times (exinext)" "SECTfinindret"
39998 .cindex "retry" "times"
39999 .cindex "&'exinext'&"
40000 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40001 fish specific information out of the retry database. Given a mail domain (or a
40002 complete address), it looks up the hosts for that domain, and outputs any retry
40003 information for the hosts or for the domain. At present, the retry information
40004 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40005 output. For example:
40006 .code
40007 $ exinext piglet@milne.fict.example
40008 kanga.milne.example:192.168.8.1 error 146: Connection refused
40009   first failed: 21-Feb-1996 14:57:34
40010   last tried:   21-Feb-1996 14:57:34
40011   next try at:  21-Feb-1996 15:02:34
40012 roo.milne.example:192.168.8.3 error 146: Connection refused
40013   first failed: 20-Jan-1996 13:12:08
40014   last tried:   21-Feb-1996 11:42:03
40015   next try at:  21-Feb-1996 19:42:03
40016   past final cutoff time
40017 .endd
40018 You can also give &'exinext'& a local part, without a domain, and it
40019 will give any retry information for that local part in your default domain.
40020 A message id can be used to obtain retry information pertaining to a specific
40021 message. This exists only when an attempt to deliver a message to a remote host
40022 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40023 &'exinext'& is not particularly efficient, but then it is not expected to be
40024 run very often.
40025
40026 The &'exinext'& utility calls Exim to find out information such as the location
40027 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40028 passed on to the &'exim'& commands. The first specifies an alternate Exim
40029 configuration file, and the second sets macros for use within the configuration
40030 file. These features are mainly to help in testing, but might also be useful in
40031 environments where more than one configuration file is in use.
40032
40033
40034
40035 .section "Hints database maintenance" "SECThindatmai"
40036 .cindex "hints database" "maintenance"
40037 .cindex "maintaining Exim's hints database"
40038 Three utility programs are provided for maintaining the DBM files that Exim
40039 uses to contain its delivery hint information. Each program requires two
40040 arguments. The first specifies the name of Exim's spool directory, and the
40041 second is the name of the database it is to operate on. These are as follows:
40042
40043 .ilist
40044 &'retry'&: the database of retry information
40045 .next
40046 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40047 for remote hosts
40048 .next
40049 &'callout'&: the callout cache
40050 .next
40051 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40052 .next
40053 &'tls'&: TLS session resumption data
40054 .next
40055 &'misc'&: other hints data
40056 .endlist
40057
40058 The &'misc'& database is used for
40059
40060 .ilist
40061 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40062 .next
40063 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40064 &(smtp)& transport)
40065 .next
40066 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40067 in a transport)
40068 .endlist
40069
40070
40071
40072 .section "exim_dumpdb" "SECTdumpdb"
40073 .cindex "&'exim_dumpdb'&"
40074 The entire contents of a database are written to the standard output by the
40075 &'exim_dumpdb'& program,
40076 taking as arguments the spool and database names.
40077 An option &'-z'& may be given to request times in UTC;
40078 otherwise times are in the local timezone.
40079 An option &'-k'& may be given to dump only the record keys.
40080 For example, to dump the retry database:
40081 .code
40082 exim_dumpdb /var/spool/exim retry
40083 .endd
40084 For the retry database
40085 two lines of output are produced for each entry:
40086 .code
40087 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40088 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40089 .endd
40090 The first item on the first line is the key of the record. It starts with one
40091 of the letters R, or T, depending on whether it refers to a routing or
40092 transport retry. For a local delivery, the next part is the local address; for
40093 a remote delivery it is the name of the remote host, followed by its failing IP
40094 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40095 transport). If the remote port is not the standard one (port 25), it is added
40096 to the IP address. Then there follows an error code, an additional error code,
40097 and a textual description of the error.
40098
40099 The three times on the second line are the time of first failure, the time of
40100 the last delivery attempt, and the computed time for the next attempt. The line
40101 ends with an asterisk if the cutoff time for the last retry rule has been
40102 exceeded.
40103
40104 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40105 consists of a host name followed by a list of ids for messages that are or were
40106 waiting to be delivered to that host. If there are a very large number for any
40107 one host, continuation records, with a sequence number added to the host name,
40108 may be seen. The data in these records is often out of date, because a message
40109 may be routed to several alternative hosts, and Exim makes no effort to keep
40110 cross-references.
40111
40112
40113
40114 .section "exim_tidydb" "SECTtidydb"
40115 .cindex "&'exim_tidydb'&"
40116 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40117 database. If run with no options, it removes all records that are more than 30
40118 days old. The age is calculated from the date and time that the record was last
40119 updated. Note that, in the case of the retry database, it is &'not'& the time
40120 since the first delivery failure. Information about a host that has been down
40121 for more than 30 days will remain in the database, provided that the record is
40122 updated sufficiently often.
40123
40124 The cutoff date can be altered by means of the &%-t%& option, which must be
40125 followed by a time. For example, to remove all records older than a week from
40126 the retry database:
40127 .code
40128 exim_tidydb -t 7d /var/spool/exim retry
40129 .endd
40130 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40131 message ids. In the former these appear as data in records keyed by host &--
40132 they were messages that were waiting for that host &-- and in the latter they
40133 are the keys for retry information for messages that have suffered certain
40134 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40135 message ids in database records are those of messages that are still on the
40136 queue. Message ids for messages that no longer exist are removed from
40137 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40138 For the &'retry'& database, records whose keys are non-existent message ids are
40139 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40140 whenever it removes information from the database.
40141
40142 Certain records are automatically removed by Exim when they are no longer
40143 needed, but others are not. For example, if all the MX hosts for a domain are
40144 down, a retry record is created for each one. If the primary MX host comes back
40145 first, its record is removed when Exim successfully delivers to it, but the
40146 records for the others remain because Exim has not tried to use those hosts.
40147
40148 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40149 hints databases. You should do this at a quiet time of day, because it requires
40150 a database to be locked (and therefore inaccessible to Exim) while it does its
40151 work. Removing records from a DBM file does not normally make the file smaller,
40152 but all the common DBM libraries are able to re-use the space that is released.
40153 After an initial phase of increasing in size, the databases normally reach a
40154 point at which they no longer get any bigger, as long as they are regularly
40155 tidied.
40156
40157 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40158 databases is likely to keep on increasing.
40159
40160
40161
40162
40163 .section "exim_fixdb" "SECTfixdb"
40164 .cindex "&'exim_fixdb'&"
40165 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40166 Its main use is for testing Exim, but it might also be occasionally useful for
40167 getting round problems in a live system. Its interface
40168 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40169 key of a database record can then be entered, and the data for that record is
40170 displayed.
40171
40172 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40173 except the &'retry'& database, that is the only operation that can be carried
40174 out. For the &'retry'& database, each field is output preceded by a number, and
40175 data for individual fields can be changed by typing the field number followed
40176 by new data, for example:
40177 .code
40178 > 4 951102:1000
40179 .endd
40180 resets the time of the next delivery attempt. Time values are given as a
40181 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40182 used as optional separators.
40183
40184 Both displayed and input times are in the local timezone by default.
40185 If an option &'-z'& is used on the command line, displayed times
40186 are in UTC.
40187
40188
40189
40190
40191 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40192 .cindex "mailbox" "maintenance"
40193 .cindex "&'exim_lock'&"
40194 .cindex "locking mailboxes"
40195 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40196 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40197 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40198 a user agent while investigating a problem. The utility requires the name of
40199 the file as its first argument. If the locking is successful, the second
40200 argument is run as a command (using C's &[system()]& function); if there is no
40201 second argument, the value of the SHELL environment variable is used; if this
40202 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40203 is unlocked and the utility ends. The following options are available:
40204
40205 .vlist
40206 .vitem &%-fcntl%&
40207 Use &[fcntl()]& locking on the open mailbox.
40208
40209 .vitem &%-flock%&
40210 Use &[flock()]& locking on the open mailbox, provided the operating system
40211 supports it.
40212
40213 .vitem &%-interval%&
40214 This must be followed by a number, which is a number of seconds; it sets the
40215 interval to sleep between retries (default 3).
40216
40217 .vitem &%-lockfile%&
40218 Create a lock file before opening the mailbox.
40219
40220 .vitem &%-mbx%&
40221 Lock the mailbox using MBX rules.
40222
40223 .vitem &%-q%&
40224 Suppress verification output.
40225
40226 .vitem &%-retries%&
40227 This must be followed by a number; it sets the number of times to try to get
40228 the lock (default 10).
40229
40230 .vitem &%-restore_time%&
40231 This option causes &%exim_lock%& to restore the modified and read times to the
40232 locked file before exiting. This allows you to access a locked mailbox (for
40233 example, to take a backup copy) without disturbing the times that the user
40234 subsequently sees.
40235
40236 .vitem &%-timeout%&
40237 This must be followed by a number, which is a number of seconds; it sets a
40238 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40239 default), a non-blocking call is used.
40240
40241 .vitem &%-v%&
40242 Generate verbose output.
40243 .endlist
40244
40245 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40246 default is to create a lock file and also to use &[fcntl()]& locking on the
40247 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40248 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40249 requires that the directory containing the file be writeable. Locking by lock
40250 file does not last forever; Exim assumes that a lock file is expired if it is
40251 more than 30 minutes old.
40252
40253 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40254 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40255 to be taken out on the open mailbox, and an exclusive lock on the file
40256 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40257 number of the mailbox file. When the locking is released, if an exclusive lock
40258 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40259
40260 The default output contains verification of the locking that takes place. The
40261 &%-v%& option causes some additional information to be given. The &%-q%& option
40262 suppresses all output except error messages.
40263
40264 A command such as
40265 .code
40266 exim_lock /var/spool/mail/spqr
40267 .endd
40268 runs an interactive shell while the file is locked, whereas
40269 .display
40270 &`exim_lock -q /var/spool/mail/spqr <<End`&
40271 <&'some commands'&>
40272 &`End`&
40273 .endd
40274 runs a specific non-interactive sequence of commands while the file is locked,
40275 suppressing all verification output. A single command can be run by a command
40276 such as
40277 .code
40278 exim_lock -q /var/spool/mail/spqr \
40279   "cp /var/spool/mail/spqr /some/where"
40280 .endd
40281 Note that if a command is supplied, it must be entirely contained within the
40282 second argument &-- hence the quotes.
40283
40284
40285 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40286 .cindex "exim_msgdate"
40287 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40288 This Perl script converts an Exim Mesage ID back into a human readable form.
40289 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40290
40291 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40292 .ecindex IIDutils
40293 . ////////////////////////////////////////////////////////////////////////////
40294 . ////////////////////////////////////////////////////////////////////////////
40295
40296 .chapter "The Exim monitor" "CHAPeximon"
40297 .scindex IIDeximon "Exim monitor" "description"
40298 .cindex "X-windows"
40299 .cindex "&'eximon'&"
40300 .cindex "Local/eximon.conf"
40301 .cindex "&_exim_monitor/EDITME_&"
40302 The Exim monitor is an application which displays in an X window information
40303 about the state of Exim's queue and what Exim is doing. An admin user can
40304 perform certain operations on messages from this GUI interface; however all
40305 such facilities are also available from the command line, and indeed, the
40306 monitor itself makes use of the command line to perform any actions requested.
40307
40308
40309
40310 .section "Running the monitor" "SECID264"
40311 The monitor is started by running the script called &'eximon'&. This is a shell
40312 script that sets up a number of environment variables, and then runs the
40313 binary called &_eximon.bin_&. The default appearance of the monitor window can
40314 be changed by editing the &_Local/eximon.conf_& file created by editing
40315 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40316 parameters are for.
40317
40318 The parameters that get built into the &'eximon'& script can be overridden for
40319 a particular invocation by setting up environment variables of the same names,
40320 preceded by &`EXIMON_`&. For example, a shell command such as
40321 .code
40322 EXIMON_LOG_DEPTH=400 eximon
40323 .endd
40324 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40325 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40326 overrides the Exim log file configuration. This makes it possible to have
40327 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40328 syslog messages are routed to a file on the local host.
40329
40330 X resources can be used to change the appearance of the window in the normal
40331 way. For example, a resource setting of the form
40332 .code
40333 Eximon*background: gray94
40334 .endd
40335 changes the colour of the background to light grey rather than white. The
40336 stripcharts are drawn with both the data lines and the reference lines in
40337 black. This means that the reference lines are not visible when on top of the
40338 data. However, their colour can be changed by setting a resource called
40339 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40340 For example, if your X server is running Unix, you could set up lighter
40341 reference lines in the stripcharts by obeying
40342 .code
40343 xrdb -merge <<End
40344 Eximon*highlight: gray
40345 End
40346 .endd
40347 .cindex "admin user"
40348 In order to see the contents of messages in the queue, and to operate on them,
40349 &'eximon'& must either be run as root or by an admin user.
40350
40351 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40352 contain X11 resource parameters interpreted by the X11 library.  In addition,
40353 if the first parameter starts with the string "gdb" then it is removed and the
40354 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40355 versioned variants of gdb can be invoked).
40356
40357 The monitor's window is divided into three parts. The first contains one or
40358 more stripcharts and two action buttons, the second contains a &"tail"& of the
40359 main log file, and the third is a display of the queue of messages awaiting
40360 delivery, with two more action buttons. The following sections describe these
40361 different parts of the display.
40362
40363
40364
40365
40366 .section "The stripcharts" "SECID265"
40367 .cindex "stripchart"
40368 The first stripchart is always a count of messages in the queue. Its name can
40369 be configured by setting QUEUE_STRIPCHART_NAME in the
40370 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40371 configuration script by regular expression matches on log file entries, making
40372 it possible to display, for example, counts of messages delivered to certain
40373 hosts or using certain transports. The supplied defaults display counts of
40374 received and delivered messages, and of local and SMTP deliveries. The default
40375 period between stripchart updates is one minute; this can be adjusted by a
40376 parameter in the &_Local/eximon.conf_& file.
40377
40378 The stripchart displays rescale themselves automatically as the value they are
40379 displaying changes. There are always 10 horizontal lines in each chart; the
40380 title string indicates the value of each division when it is greater than one.
40381 For example, &"x2"& means that each division represents a value of 2.
40382
40383 It is also possible to have a stripchart which shows the percentage fullness of
40384 a particular disk partition, which is useful when local deliveries are confined
40385 to a single partition.
40386
40387 .cindex "&%statvfs%& function"
40388 This relies on the availability of the &[statvfs()]& function or equivalent in
40389 the operating system. Most, but not all versions of Unix that support Exim have
40390 this. For this particular stripchart, the top of the chart always represents
40391 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40392 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40393 &_Local/eximon.conf_& file.
40394
40395
40396
40397
40398 .section "Main action buttons" "SECID266"
40399 .cindex "size" "of monitor window"
40400 .cindex "Exim monitor" "window size"
40401 .cindex "window size"
40402 Below the stripcharts there is an action button for quitting the monitor. Next
40403 to this is another button marked &"Size"&. They are placed here so that
40404 shrinking the window to its default minimum size leaves just the queue count
40405 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40406 the window to expand to its maximum size, unless it is already at the maximum,
40407 in which case it is reduced to its minimum.
40408
40409 When expanding to the maximum, if the window cannot be fully seen where it
40410 currently is, it is moved back to where it was the last time it was at full
40411 size. When it is expanding from its minimum size, the old position is
40412 remembered, and next time it is reduced to the minimum it is moved back there.
40413
40414 The idea is that you can keep a reduced window just showing one or two
40415 stripcharts at a convenient place on your screen, easily expand it to show
40416 the full window when required, and just as easily put it back to what it was.
40417 The idea is copied from what the &'twm'& window manager does for its
40418 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40419 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40420
40421 Normally, the monitor starts up with the window at its full size, but it can be
40422 built so that it starts up with the window at its smallest size, by setting
40423 START_SMALL=yes in &_Local/eximon.conf_&.
40424
40425
40426
40427 .section "The log display" "SECID267"
40428 .cindex "log" "tail of; in monitor"
40429 The second section of the window is an area in which a display of the tail of
40430 the main log is maintained.
40431 To save space on the screen, the timestamp on each log line is shortened by
40432 removing the date and, if &%log_timezone%& is set, the timezone.
40433 The log tail is not available when the only destination for logging data is
40434 syslog, unless the syslog lines are routed to a local file whose name is passed
40435 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40436
40437 The log sub-window has a scroll bar at its lefthand side which can be used to
40438 move back to look at earlier text, and the up and down arrow keys also have a
40439 scrolling effect. The amount of log that is kept depends on the setting of
40440 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40441 to use. When this is full, the earlier 50% of data is discarded &-- this is
40442 much more efficient than throwing it away line by line. The sub-window also has
40443 a horizontal scroll bar for accessing the ends of long log lines. This is the
40444 only means of horizontal scrolling; the right and left arrow keys are not
40445 available. Text can be cut from this part of the window using the mouse in the
40446 normal way. The size of this subwindow is controlled by parameters in the
40447 configuration file &_Local/eximon.conf_&.
40448
40449 Searches of the text in the log window can be carried out by means of the ^R
40450 and ^S keystrokes, which default to a reverse and a forward search,
40451 respectively. The search covers only the text that is displayed in the window.
40452 It cannot go further back up the log.
40453
40454 The point from which the search starts is indicated by a caret marker. This is
40455 normally at the end of the text in the window, but can be positioned explicitly
40456 by pointing and clicking with the left mouse button, and is moved automatically
40457 by a successful search. If new text arrives in the window when it is scrolled
40458 back, the caret remains where it is, but if the window is not scrolled back,
40459 the caret is moved to the end of the new text.
40460
40461 Pressing ^R or ^S pops up a window into which the search text can be typed.
40462 There are buttons for selecting forward or reverse searching, for carrying out
40463 the search, and for cancelling. If the &"Search"& button is pressed, the search
40464 happens and the window remains so that further searches can be done. If the
40465 &"Return"& key is pressed, a single search is done and the window is closed. If
40466 ^C is typed the search is cancelled.
40467
40468 The searching facility is implemented using the facilities of the Athena text
40469 widget. By default this pops up a window containing both &"search"& and
40470 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40471 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40472 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40473 provided version of &%TextPop%& when the remaining parts of the text widget
40474 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40475 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40476 on these systems, at the expense of having unwanted items in the search popup
40477 window.
40478
40479
40480
40481 .section "The queue display" "SECID268"
40482 .cindex "queue" "display in monitor"
40483 The bottom section of the monitor window contains a list of all messages that
40484 are in the queue, which includes those currently being received or delivered,
40485 as well as those awaiting delivery. The size of this subwindow is controlled by
40486 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40487 at which it is updated is controlled by another parameter in the same file &--
40488 the default is 5 minutes, since queue scans can be quite expensive. However,
40489 there is an &"Update"& action button just above the display which can be used
40490 to force an update of the queue display at any time.
40491
40492 When a host is down for some time, a lot of pending mail can build up for it,
40493 and this can make it hard to deal with other messages in the queue. To help
40494 with this situation there is a button next to &"Update"& called &"Hide"&. If
40495 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40496 type anything in here and press &"Return"&, the text is added to a chain of
40497 such texts, and if every undelivered address in a message matches at least one
40498 of the texts, the message is not displayed.
40499
40500 If there is an address that does not match any of the texts, all the addresses
40501 are displayed as normal. The matching happens on the ends of addresses so, for
40502 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40503 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40504 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40505 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40506 a hide request is automatically cancelled after one hour.
40507
40508 While the dialogue box is displayed, you can't press any buttons or do anything
40509 else to the monitor window. For this reason, if you want to cut text from the
40510 queue display to use in the dialogue box, you have to do the cutting before
40511 pressing the &"Hide"& button.
40512
40513 The queue display contains, for each unhidden queued message, the length of
40514 time it has been in the queue, the size of the message, the message id, the
40515 message sender, and the first undelivered recipient, all on one line. If it is
40516 a bounce message, the sender is shown as &"<>"&. If there is more than one
40517 recipient to which the message has not yet been delivered, subsequent ones are
40518 listed on additional lines, up to a maximum configured number, following which
40519 an ellipsis is displayed. Recipients that have already received the message are
40520 not shown.
40521
40522 .cindex "frozen messages" "display"
40523 If a message is frozen, an asterisk is displayed at the left-hand side.
40524
40525 The queue display has a vertical scroll bar, and can also be scrolled by means
40526 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40527 The text searching facilities, as described above for the log window, are also
40528 available, but the caret is always moved to the end of the text when the queue
40529 display is updated.
40530
40531
40532
40533 .section "The queue menu" "SECID269"
40534 .cindex "queue" "menu in monitor"
40535 If the &%shift%& key is held down and the left button is clicked when the mouse
40536 pointer is over the text for any message, an action menu pops up, and the first
40537 line of the queue display for the message is highlighted. This does not affect
40538 any selected text.
40539
40540 If you want to use some other event for popping up the menu, you can set the
40541 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40542 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40543 value set in this parameter is a standard X event description. For example, to
40544 run eximon using &%ctrl%& rather than &%shift%& you could use
40545 .code
40546 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40547 .endd
40548 The title of the menu is the message id, and it contains entries which act as
40549 follows:
40550
40551 .ilist
40552 &'message log'&: The contents of the message log for the message are displayed
40553 in a new text window.
40554 .next
40555 &'headers'&: Information from the spool file that contains the envelope
40556 information and headers is displayed in a new text window. See chapter
40557 &<<CHAPspool>>& for a description of the format of spool files.
40558 .next
40559 &'body'&: The contents of the spool file containing the body of the message are
40560 displayed in a new text window. There is a default limit of 20,000 bytes to the
40561 amount of data displayed. This can be changed by setting the BODY_MAX
40562 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40563 .next
40564 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40565 delivery of the message. This causes an automatic thaw if the message is
40566 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40567 a new text window. The delivery is run in a separate process, to avoid holding
40568 up the monitor while the delivery proceeds.
40569 .next
40570 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40571 that the message be frozen.
40572 .next
40573 .cindex "thawing messages"
40574 .cindex "unfreezing messages"
40575 .cindex "frozen messages" "thawing"
40576 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40577 that the message be thawed.
40578 .next
40579 .cindex "delivery" "forcing failure"
40580 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40581 that Exim gives up trying to deliver the message. A bounce message is generated
40582 for any remaining undelivered addresses.
40583 .next
40584 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40585 that the message be deleted from the system without generating a bounce
40586 message.
40587 .next
40588 &'add recipient'&: A dialog box is displayed into which a recipient address can
40589 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40590 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40591 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40592 causes a call to Exim to be made using the &%-Mar%& option to request that an
40593 additional recipient be added to the message, unless the entry box is empty, in
40594 which case no action is taken.
40595 .next
40596 &'mark delivered'&: A dialog box is displayed into which a recipient address
40597 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40598 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40599 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40600 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40601 recipient address as already delivered, unless the entry box is empty, in which
40602 case no action is taken.
40603 .next
40604 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40605 mark all recipient addresses as already delivered.
40606 .next
40607 &'edit sender'&: A dialog box is displayed initialized with the current
40608 sender's address. Pressing RETURN causes a call to Exim to be made using the
40609 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40610 in which case no action is taken. If you want to set an empty sender (as in
40611 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40612 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40613 the address is qualified with that domain.
40614 .endlist
40615
40616 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40617 other cases when a call to Exim is made, if there is any output from Exim (in
40618 particular, if the command fails) a window containing the command and the
40619 output is displayed. Otherwise, the results of the action are normally apparent
40620 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40621 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40622 if no output is generated.
40623
40624 The queue display is automatically updated for actions such as freezing and
40625 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40626 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40627 force an update of the display after one of these actions.
40628
40629 In any text window that is displayed as result of a menu action, the normal
40630 cut-and-paste facility is available, and searching can be carried out using ^R
40631 and ^S, as described above for the log tail window.
40632 .ecindex IIDeximon
40633
40634
40635
40636
40637
40638 . ////////////////////////////////////////////////////////////////////////////
40639 . ////////////////////////////////////////////////////////////////////////////
40640
40641 .chapter "Security considerations" "CHAPsecurity"
40642 .scindex IIDsecurcon "security" "discussion of"
40643 This chapter discusses a number of issues concerned with security, some of
40644 which are also covered in other parts of this manual.
40645
40646 For reasons that this author does not understand, some people have promoted
40647 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40648 existence of this chapter in the documentation. However, the intent of the
40649 chapter is simply to describe the way Exim works in relation to certain
40650 security concerns, not to make any specific claims about the effectiveness of
40651 its security as compared with other MTAs.
40652
40653 What follows is a description of the way Exim is supposed to be. Best efforts
40654 have been made to try to ensure that the code agrees with the theory, but an
40655 absence of bugs can never be guaranteed. Any that are reported will get fixed
40656 as soon as possible.
40657
40658
40659 .section "Building a more &""hardened""& Exim" "SECID286"
40660 .cindex "security" "build-time features"
40661 There are a number of build-time options that can be set in &_Local/Makefile_&
40662 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40663 Exim administrator who does not have the root password, or by someone who has
40664 penetrated the Exim (but not the root) account. These options are as follows:
40665
40666 .ilist
40667 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40668 start of any filenames used with the &%-C%& option. When it is set, these
40669 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40670 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40671 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40672 default setting for &%ALT_CONFIG_PREFIX%&.
40673
40674 If the permitted configuration files are confined to a directory to
40675 which only root has access, this guards against someone who has broken
40676 into the Exim account from running a privileged Exim with an arbitrary
40677 configuration file, and using it to break into other accounts.
40678 .next
40679
40680 If a non-trusted configuration file (i.e. not the default configuration file
40681 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40682 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40683 the next item), then root privilege is retained only if the caller of Exim is
40684 root. This locks out the possibility of testing a configuration using &%-C%&
40685 right through message reception and delivery, even if the caller is root. The
40686 reception works, but by that time, Exim is running as the Exim user, so when
40687 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40688 privilege to be lost. However, root can test reception and delivery using two
40689 separate commands.
40690
40691 .next
40692 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40693 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40694 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40695 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40696 the restrictive side.  Requiring build-time selection of safe macros is onerous
40697 but this option is intended solely as a transition mechanism to permit
40698 previously-working configurations to continue to work after release 4.73.
40699 .next
40700 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40701 is disabled.
40702 .next
40703 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40704 never to be used for any deliveries. This is like the &%never_users%& runtime
40705 option, but it cannot be overridden; the runtime option adds additional users
40706 to the list. The default setting is &"root"&; this prevents a non-root user who
40707 is permitted to modify the runtime file from using Exim as a way to get root.
40708 .endlist
40709
40710
40711
40712 .section "Root privilege" "SECID270"
40713 .cindex "setuid"
40714 .cindex "root privilege"
40715 The Exim binary is normally setuid to root, which means that it gains root
40716 privilege (runs as root) when it starts execution. In some special cases (for
40717 example, when the daemon is not in use and there are no local deliveries), it
40718 may be possible to run Exim setuid to some user other than root. This is
40719 discussed in the next section. However, in most installations, root privilege
40720 is required for two things:
40721
40722 .ilist
40723 To set up a socket connected to the standard SMTP port (25) when initialising
40724 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40725 not required.
40726 .next
40727 To be able to change uid and gid in order to read users' &_.forward_& files and
40728 perform local deliveries as the receiving user or as specified in the
40729 configuration.
40730 .endlist
40731
40732 It is not necessary to be root to do any of the other things Exim does, such as
40733 receiving messages and delivering them externally over SMTP, and it is
40734 obviously more secure if Exim does not run as root except when necessary.
40735 For this reason, a user and group for Exim to use must be defined in
40736 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40737 group"&. Their values can be changed by the runtime configuration, though this
40738 is not recommended. Often a user called &'exim'& is used, but some sites use
40739 &'mail'& or another user name altogether.
40740
40741 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40742 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40743 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40744
40745 After a new Exim process has interpreted its command line options, it changes
40746 uid and gid in the following cases:
40747
40748 .ilist
40749 .oindex "&%-C%&"
40750 .oindex "&%-D%&"
40751 If the &%-C%& option is used to specify an alternate configuration file, or if
40752 the &%-D%& option is used to define macro values for the configuration, and the
40753 calling process is not running as root, the uid and gid are changed to those of
40754 the calling process.
40755 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40756 option may not be used at all.
40757 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40758 can be supplied if the calling process is running as root, the Exim run-time
40759 user or CONFIGURE_OWNER, if defined.
40760 .next
40761 .oindex "&%-be%&"
40762 .oindex "&%-bf%&"
40763 .oindex "&%-bF%&"
40764 If the expansion test option (&%-be%&) or one of the filter testing options
40765 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40766 calling process.
40767 .next
40768 If the process is not a daemon process or a queue runner process or a delivery
40769 process or a process for testing address routing (started with &%-bt%&), the
40770 uid and gid are changed to the Exim user and group. This means that Exim always
40771 runs under its own uid and gid when receiving messages. This also applies when
40772 testing address verification
40773 .oindex "&%-bv%&"
40774 .oindex "&%-bh%&"
40775 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40776 option).
40777 .next
40778 For a daemon, queue runner, delivery, or address testing process, the uid
40779 remains as root at this stage, but the gid is changed to the Exim group.
40780 .endlist
40781
40782 The processes that initially retain root privilege behave as follows:
40783
40784 .ilist
40785 A daemon process changes the gid to the Exim group and the uid to the Exim
40786 user after setting up one or more listening sockets. The &[initgroups()]&
40787 function is called, so that if the Exim user is in any additional groups, they
40788 will be used during message reception.
40789 .next
40790 A queue runner process retains root privilege throughout its execution. Its
40791 job is to fork a controlled sequence of delivery processes.
40792 .next
40793 A delivery process retains root privilege throughout most of its execution,
40794 but any actual deliveries (that is, the transports themselves) are run in
40795 subprocesses which always change to a non-root uid and gid. For local
40796 deliveries this is typically the uid and gid of the owner of the mailbox; for
40797 remote deliveries, the Exim uid and gid are used. Once all the delivery
40798 subprocesses have been run, a delivery process changes to the Exim uid and gid
40799 while doing post-delivery tidying up such as updating the retry database and
40800 generating bounce and warning messages.
40801
40802 While the recipient addresses in a message are being routed, the delivery
40803 process runs as root. However, if a user's filter file has to be processed,
40804 this is done in a subprocess that runs under the individual user's uid and
40805 gid. A system filter is run as root unless &%system_filter_user%& is set.
40806 .next
40807 A process that is testing addresses (the &%-bt%& option) runs as root so that
40808 the routing is done in the same environment as a message delivery.
40809 .endlist
40810
40811
40812
40813
40814 .section "Running Exim without privilege" "SECTrunexiwitpri"
40815 .cindex "privilege, running without"
40816 .cindex "unprivileged running"
40817 .cindex "root privilege" "running without"
40818 Some installations like to run Exim in an unprivileged state for more of its
40819 operation, for added security. Support for this mode of operation is provided
40820 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40821 gid are changed to the Exim user and group at the start of a delivery process
40822 (and also queue runner and address testing processes). This means that address
40823 routing is no longer run as root, and the deliveries themselves cannot change
40824 to any other uid.
40825
40826 .cindex SIGHUP
40827 .cindex "daemon" "restarting"
40828 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40829 that the daemon can still be started in the usual way, and it can respond
40830 correctly to SIGHUP because the re-invocation regains root privilege.
40831
40832 An alternative approach is to make Exim setuid to the Exim user and also setgid
40833 to the Exim group. If you do this, the daemon must be started from a root
40834 process. (Calling Exim from a root process makes it behave in the way it does
40835 when it is setuid root.) However, the daemon cannot restart itself after a
40836 SIGHUP signal because it cannot regain privilege.
40837
40838 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40839 stops Exim from trying to re-invoke itself to do a delivery after a message has
40840 been received. Such a re-invocation is a waste of resources because it has no
40841 effect.
40842
40843 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40844 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40845 to the Exim user seems a clean approach, but there is one complication:
40846
40847 In this style of operation, Exim is running with the real uid and gid set to
40848 those of the calling process, and the effective uid/gid set to Exim's values.
40849 Ideally, any association with the calling process' uid/gid should be dropped,
40850 that is, the real uid/gid should be reset to the effective values so as to
40851 discard any privileges that the caller may have. While some operating systems
40852 have a function that permits this action for a non-root effective uid, quite a
40853 number of them do not. Because of this lack of standardization, Exim does not
40854 address this problem at this time.
40855
40856 For this reason, the recommended approach for &"mostly unprivileged"& running
40857 is to keep the Exim binary setuid to root, and to set
40858 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40859 be used in the most straightforward way.
40860
40861 If you configure Exim not to run delivery processes as root, there are a
40862 number of restrictions on what you can do:
40863
40864 .ilist
40865 You can deliver only as the Exim user/group. You should  explicitly use the
40866 &%user%& and &%group%& options to override routers or local transports that
40867 normally deliver as the recipient. This makes sure that configurations that
40868 work in this mode function the same way in normal mode. Any implicit or
40869 explicit specification of another user causes an error.
40870 .next
40871 Use of &_.forward_& files is severely restricted, such that it is usually
40872 not worthwhile to include them in the configuration.
40873 .next
40874 Users who wish to use &_.forward_& would have to make their home directory and
40875 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40876 and their equivalents in Exim filters, cannot be used. While they could be
40877 enabled in the Exim user's name, that would be insecure and not very useful.
40878 .next
40879 Unless the local user mailboxes are all owned by the Exim user (possible in
40880 some POP3 or IMAP-only environments):
40881
40882 .olist
40883 They must be owned by the Exim group and be writeable by that group. This
40884 implies you must set &%mode%& in the appendfile configuration, as well as the
40885 mode of the mailbox files themselves.
40886 .next
40887 You must set &%no_check_owner%&, since most or all of the files will not be
40888 owned by the Exim user.
40889 .next
40890 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40891 on a newly created mailbox when unprivileged. This also implies that new
40892 mailboxes need to be created manually.
40893 .endlist olist
40894 .endlist ilist
40895
40896
40897 These restrictions severely restrict what can be done in local deliveries.
40898 However, there are no restrictions on remote deliveries. If you are running a
40899 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40900 gives more security at essentially no cost.
40901
40902 If you are using the &%mua_wrapper%& facility (see chapter
40903 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40904
40905
40906
40907
40908 .section "Delivering to local files" "SECID271"
40909 Full details of the checks applied by &(appendfile)& before it writes to a file
40910 are given in chapter &<<CHAPappendfile>>&.
40911
40912
40913
40914 .section "Running local commands" "SECTsecconslocalcmds"
40915 .cindex "security" "local commands"
40916 .cindex "security" "command injection attacks"
40917 There are a number of ways in which an administrator can configure Exim to run
40918 commands based upon received, untrustworthy, data. Further, in some
40919 configurations a user who can control a &_.forward_& file can also arrange to
40920 run commands. Configuration to check includes, but is not limited to:
40921
40922 .ilist
40923 Use of &%use_shell%& in the pipe transport: various forms of shell command
40924 injection may be possible with this option present. It is dangerous and should
40925 be used only with considerable caution. Consider constraints which whitelist
40926 allowed characters in a variable which is to be used in a pipe transport that
40927 has &%use_shell%& enabled.
40928 .next
40929 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40930 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40931 &_.forward_& files in a redirect router. If Exim is running on a central mail
40932 hub to which ordinary users do not have shell access, but home directories are
40933 NFS mounted (for instance) then administrators should review the list of these
40934 forbid options available, and should bear in mind that the options that may
40935 need forbidding can change as new features are added between releases.
40936 .next
40937 The &%${run...}%& expansion item does not use a shell by default, but
40938 administrators can configure use of &_/bin/sh_& as part of the command.
40939 Such invocations should be viewed with prejudicial suspicion.
40940 .next
40941 Administrators who use embedded Perl are advised to explore how Perl's
40942 taint checking might apply to their usage.
40943 .next
40944 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40945 administrators are well advised to view its use with suspicion, in case (for
40946 instance) it allows a local-part to contain embedded Exim directives.
40947 .next
40948 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40949 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40950 each can reference arbitrary lists and files, rather than just being a list
40951 of opaque strings.
40952 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40953 real-world security vulnerabilities caused by its use with untrustworthy data
40954 injected in, for SQL injection attacks.
40955 Consider the use of the &%inlisti%& expansion condition instead.
40956 .endlist
40957
40958
40959
40960
40961 .section "Trust in configuration data" "SECTsecconfdata"
40962 .cindex "security" "data sources"
40963 .cindex "security" "regular expressions"
40964 .cindex "regular expressions" "security"
40965 .cindex "PCRE2" "security"
40966 If configuration data for Exim can come from untrustworthy sources, there
40967 are some issues to be aware of:
40968
40969 .ilist
40970 Use of &%${expand...}%& may provide a path for shell injection attacks.
40971 .next
40972 Letting untrusted data provide a regular expression is unwise.
40973 .next
40974 Using &%${match...}%& to apply a fixed regular expression against untrusted
40975 data may result in pathological behaviour within PCRE2.  Be aware of what
40976 "backtracking" means and consider options for being more strict with a regular
40977 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40978 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40979 possessive quantifiers or just not using regular expressions against untrusted
40980 data.
40981 .next
40982 It can be important to correctly use &%${quote:...}%&,
40983 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40984 items to ensure that data is correctly constructed.
40985 .next
40986 Some lookups might return multiple results, even though normal usage is only
40987 expected to yield one result.
40988 .endlist
40989
40990
40991
40992
40993 .section "IPv4 source routing" "SECID272"
40994 .cindex "source routing" "in IP packets"
40995 .cindex "IP source routing"
40996 Many operating systems suppress IP source-routed packets in the kernel, but
40997 some cannot be made to do this, so Exim does its own check. It logs incoming
40998 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40999 IPv6. No special checking is currently done.
41000
41001
41002
41003 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41004 Support for these SMTP commands is disabled by default. If required, they can
41005 be enabled by defining suitable ACLs.
41006
41007
41008
41009
41010 .section "Privileged users" "SECID274"
41011 .cindex "trusted users"
41012 .cindex "admin user"
41013 .cindex "privileged user"
41014 .cindex "user" "trusted"
41015 .cindex "user" "admin"
41016 Exim recognizes two sets of users with special privileges. Trusted users are
41017 able to submit new messages to Exim locally, but supply their own sender
41018 addresses and information about a sending host. For other users submitting
41019 local messages, Exim sets up the sender address from the uid, and doesn't
41020 permit a remote host to be specified.
41021
41022 .oindex "&%-f%&"
41023 However, an untrusted user is permitted to use the &%-f%& command line option
41024 in the special form &%-f <>%& to indicate that a delivery failure for the
41025 message should not cause an error report. This affects the message's envelope,
41026 but it does not affect the &'Sender:'& header. Untrusted users may also be
41027 permitted to use specific forms of address with the &%-f%& option by setting
41028 the &%untrusted_set_sender%& option.
41029
41030 Trusted users are used to run processes that receive mail messages from some
41031 other mail domain and pass them on to Exim for delivery either locally, or over
41032 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41033 as any user listed in the &%trusted_users%& configuration option, or under any
41034 group listed in the &%trusted_groups%& option.
41035
41036 Admin users are permitted to do things to the messages on Exim's queue. They
41037 can freeze or thaw messages, cause them to be returned to their senders, remove
41038 them entirely, or modify them in various ways. In addition, admin users can run
41039 the Exim monitor and see all the information it is capable of providing, which
41040 includes the contents of files on the spool.
41041
41042 .oindex "&%-M%&"
41043 .oindex "&%-q%&"
41044 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41045 delivery of messages on its queue is restricted to admin users. This
41046 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41047 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41048 queue is also restricted to admin users. This restriction can be relaxed by
41049 setting &%no_queue_list_requires_admin%&.
41050
41051 Exim recognizes an admin user if the calling process is running as root or as
41052 the Exim user or if any of the groups associated with the calling process is
41053 the Exim group. It is not necessary actually to be running under the Exim
41054 group. However, if admin users who are not root or the Exim user are to access
41055 the contents of files on the spool via the Exim monitor (which runs
41056 unprivileged), Exim must be built to allow group read access to its spool
41057 files.
41058
41059 By default, regular users are trusted to perform basic testing and
41060 introspection commands, as themselves.  This setting can be tightened by
41061 setting the &%commandline_checks_require_admin%& option.
41062 This affects most of the checking options,
41063 such as &%-be%& and anything else &%-b*%&.
41064
41065
41066 .section "Spool files" "SECID275"
41067 .cindex "spool directory" "files"
41068 Exim's spool directory and everything it contains is owned by the Exim user and
41069 set to the Exim group. The mode for spool files is defined in the
41070 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41071 any user who is a member of the Exim group can access these files.
41072
41073
41074
41075 .section "Use of argv[0]" "SECID276"
41076 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41077 of specific strings, Exim assumes certain options. For example, calling Exim
41078 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41079 to calling it with the option &%-bS%&. There are no security implications in
41080 this.
41081
41082
41083
41084 .section "Use of %f formatting" "SECID277"
41085 The only use made of &"%f"& by Exim is in formatting load average values. These
41086 are actually stored in integer variables as 1000 times the load average.
41087 Consequently, their range is limited and so therefore is the length of the
41088 converted output.
41089
41090
41091
41092 .section "Embedded Exim path" "SECID278"
41093 Exim uses its own path name, which is embedded in the code, only when it needs
41094 to re-exec in order to regain root privilege. Therefore, it is not root when it
41095 does so. If some bug allowed the path to get overwritten, it would lead to an
41096 arbitrary program's being run as exim, not as root.
41097
41098
41099
41100 .section "Dynamic module directory" "SECTdynmoddir"
41101 Any dynamically loadable modules must be installed into the directory
41102 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41103 loading it.
41104
41105
41106 .section "Use of sprintf()" "SECID279"
41107 .cindex "&[sprintf()]&"
41108 A large number of occurrences of &"sprintf"& in the code are actually calls to
41109 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41110 The intermediate formatting is done into a large fixed buffer by a function
41111 that runs through the format string itself, and checks the length of each
41112 conversion before performing it, thus preventing buffer overruns.
41113
41114 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41115 the output buffer is known to be sufficiently long to contain the converted
41116 string.
41117
41118
41119
41120 .section "Use of debug_printf() and log_write()" "SECID280"
41121 Arbitrary strings are passed to both these functions, but they do their
41122 formatting by calling the function &'string_vformat()'&, which runs through
41123 the format string itself, and checks the length of each conversion.
41124
41125
41126
41127 .section "Use of strcat() and strcpy()" "SECID281"
41128 These are used only in cases where the output buffer is known to be large
41129 enough to hold the result.
41130 .ecindex IIDsecurcon
41131
41132
41133
41134
41135 . ////////////////////////////////////////////////////////////////////////////
41136 . ////////////////////////////////////////////////////////////////////////////
41137
41138 .chapter "Format of spool files" "CHAPspool"
41139 .scindex IIDforspo1 "format" "spool files"
41140 .scindex IIDforspo2 "spool directory" "format of files"
41141 .scindex IIDforspo3 "spool files" "format of"
41142 .cindex "spool files" "editing"
41143 A message on Exim's queue consists of two files, whose names are the message id
41144 followed by -D and -H, respectively. The data portion of the message is kept in
41145 the -D file on its own. The message's envelope, status, and headers are all
41146 kept in the -H file, whose format is described in this chapter. Each of these
41147 two files contains the final component of its own name as its first line. This
41148 is insurance against disk crashes where the directory is lost but the files
41149 themselves are recoverable.
41150
41151 The file formats may be changed, or new formats added, at any release.
41152 Spool files are not intended as an interface to other programs
41153 and should not be used as such.
41154
41155 Some people are tempted into editing -D files in order to modify messages. You
41156 need to be extremely careful if you do this; it is not recommended and you are
41157 on your own if you do it. Here are some of the pitfalls:
41158
41159 .ilist
41160 You must ensure that Exim does not try to deliver the message while you are
41161 fiddling with it. The safest way is to take out a write lock on the -D file,
41162 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41163 place, the lock will be retained. If you write a new file and rename it, the
41164 lock will be lost at the instant of rename.
41165 .next
41166 .vindex "&$body_linecount$&"
41167 If you change the number of lines in the file, the value of
41168 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41169 cause incomplete transmission of messages or undeliverable messages.
41170 .next
41171 If the message is in MIME format, you must take care not to break it.
41172 .next
41173 If the message is cryptographically signed, any change will invalidate the
41174 signature.
41175 .endlist
41176 All in all, modifying -D files is fraught with danger.
41177
41178 Files whose names end with -J may also be seen in the &_input_& directory (or
41179 its subdirectories when &%split_spool_directory%& is set). These are journal
41180 files, used to record addresses to which the message has been delivered during
41181 the course of a delivery attempt. If there are still undelivered recipients at
41182 the end, the -H file is updated, and the -J file is deleted. If, however, there
41183 is some kind of crash (for example, a power outage) before this happens, the -J
41184 file remains in existence. When Exim next processes the message, it notices the
41185 -J file and uses it to update the -H file before starting the next delivery
41186 attempt.
41187
41188 Files whose names end with -K or .eml may also be seen in the spool.
41189 These are temporaries used for DKIM or malware processing, when that is used.
41190 They should be tidied up by normal operations; any old ones are probably
41191 relics of crashes and can be removed.
41192
41193 .section "Format of the -H file" "SECID282"
41194 .cindex "uid (user id)" "in spool file"
41195 .cindex "gid (group id)" "in spool file"
41196 The second line of the -H file contains the login name for the uid of the
41197 process that called Exim to read the message, followed by the numerical uid and
41198 gid. For a locally generated message, this is normally the user who sent the
41199 message. For a message received over TCP/IP via the daemon, it is
41200 normally the Exim user.
41201
41202 The third line of the file contains the address of the message's sender as
41203 transmitted in the envelope, contained in angle brackets. The sender address is
41204 empty for bounce messages. For incoming SMTP mail, the sender address is given
41205 in the MAIL command. For locally generated mail, the sender address is
41206 created by Exim from the login name of the current user and the configured
41207 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41208 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41209 &"<>"& or an address that matches &%untrusted_set_senders%&.
41210
41211 The fourth line contains two numbers. The first is the time that the message
41212 was received, in the conventional Unix form &-- the number of seconds since the
41213 start of the epoch. The second number is a count of the number of messages
41214 warning of delayed delivery that have been sent to the sender.
41215
41216 There follow a number of lines starting with a hyphen.
41217 These contain variables, can appear in any
41218 order, and are omitted when not relevant.
41219
41220 If there is a second hyphen after the first,
41221 the corresponding data is tainted.
41222 If there is a value in parentheses, the data is quoted for a lookup.
41223
41224 The following word specifies a variable,
41225 and the remainder of the item depends on the variable.
41226
41227 .vlist
41228 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41229 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41230 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41231 recognized, to provide backward compatibility. In the old format, a line of
41232 this form is present for every ACL variable that is not empty. The number
41233 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41234 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41235 the data string for the variable. The string itself starts at the beginning of
41236 the next line, and is followed by a newline character. It may contain internal
41237 newlines.
41238
41239 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41240 A line of this form is present for every ACL connection variable that is
41241 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41242 The length is the length of the data string for the variable. The string itself
41243 starts at the beginning of the next line, and is followed by a newline
41244 character. It may contain internal newlines.
41245
41246 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41247 A line of this form is present for every ACL message variable that is defined.
41248 Note that there is a space between &%-aclm%& and the rest of the name. The
41249 length is the length of the data string for the variable. The string itself
41250 starts at the beginning of the next line, and is followed by a newline
41251 character. It may contain internal newlines.
41252
41253 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41254 This is present if, when the message was received over SMTP, the value of
41255 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41256
41257 .vitem &%-allow_unqualified_recipient%&
41258 This is present if unqualified recipient addresses are permitted in header
41259 lines (to stop such addresses from being qualified if rewriting occurs at
41260 transport time). Local messages that were input using &%-bnq%& and remote
41261 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41262
41263 .vitem &%-allow_unqualified_sender%&
41264 This is present if unqualified sender addresses are permitted in header lines
41265 (to stop such addresses from being qualified if rewriting occurs at transport
41266 time). Local messages that were input using &%-bnq%& and remote messages from
41267 hosts that match &%sender_unqualified_hosts%& set this flag.
41268
41269 .vitem "&%-auth_id%&&~<&'text'&>"
41270 The id information for a message received on an authenticated SMTP connection
41271 &-- the value of the &$authenticated_id$& variable.
41272
41273 .vitem "&%-auth_sender%&&~<&'address'&>"
41274 The address of an authenticated sender &-- the value of the
41275 &$authenticated_sender$& variable.
41276
41277 .vitem "&%-body_linecount%&&~<&'number'&>"
41278 This records the number of lines in the body of the message, and is
41279 present unless &%-spool_file_wireformat%& is.
41280
41281 .vitem "&%-body_zerocount%&&~<&'number'&>"
41282 This records the number of binary zero bytes in the body of the message, and is
41283 present if the number is greater than zero.
41284
41285 .vitem &%-deliver_firsttime%&
41286 This is written when a new message is first added to the spool. When the spool
41287 file is updated after a deferral, it is omitted.
41288
41289 .vitem "&%-frozen%&&~<&'time'&>"
41290 .cindex "frozen messages" "spool data"
41291 The message is frozen, and the freezing happened at <&'time'&>.
41292
41293 .vitem "&%-helo_name%&&~<&'text'&>"
41294 This records the host name as specified by a remote host in a HELO or EHLO
41295 command.
41296
41297 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41298 This records the IP address of the host from which the message was received and
41299 the remote port number that was used. It is omitted for locally generated
41300 messages.
41301
41302 .vitem "&%-host_auth%&&~<&'text'&>"
41303 If the message was received on an authenticated SMTP connection, this records
41304 the name of the authenticator &-- the value of the
41305 &$sender_host_authenticated$& variable.
41306
41307 .vitem &%-host_lookup_failed%&
41308 This is present if an attempt to look up the sending host's name from its IP
41309 address failed. It corresponds to the &$host_lookup_failed$& variable.
41310
41311 .vitem "&%-host_name%&&~<&'text'&>"
41312 .cindex "reverse DNS lookup"
41313 .cindex "DNS" "reverse lookup"
41314 This records the name of the remote host from which the message was received,
41315 if the host name was looked up from the IP address when the message was being
41316 received. It is not present if no reverse lookup was done.
41317
41318 .vitem "&%-ident%&&~<&'text'&>"
41319 For locally submitted messages, this records the login of the originating user,
41320 unless it was a trusted user and the &%-oMt%& option was used to specify an
41321 ident value. For messages received over TCP/IP, this records the ident string
41322 supplied by the remote host, if any.
41323
41324 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41325 This records the IP address of the local interface and the port number through
41326 which a message was received from a remote host. It is omitted for locally
41327 generated messages.
41328
41329 .vitem &%-local%&
41330 The message is from a local sender.
41331
41332 .vitem &%-localerror%&
41333 The message is a locally-generated bounce message.
41334
41335 .vitem "&%-local_scan%&&~<&'string'&>"
41336 This records the data string that was returned by the &[local_scan()]& function
41337 when the message was received &-- the value of the &$local_scan_data$&
41338 variable. It is omitted if no data was returned.
41339
41340 .vitem &%-manual_thaw%&
41341 The message was frozen but has been thawed manually, that is, by an explicit
41342 Exim command rather than via the auto-thaw process.
41343
41344 .vitem &%-N%&
41345 A testing delivery process was started using the &%-N%& option to suppress any
41346 actual deliveries, but delivery was deferred. At any further delivery attempts,
41347 &%-N%& is assumed.
41348
41349 .vitem &%-received_protocol%&
41350 This records the value of the &$received_protocol$& variable, which contains
41351 the name of the protocol by which the message was received.
41352
41353 .vitem &%-sender_set_untrusted%&
41354 The envelope sender of this message was set by an untrusted local caller (used
41355 to ensure that the caller is displayed in queue listings).
41356
41357 .vitem "&%-spam_score_int%&&~<&'number'&>"
41358 If a message was scanned by SpamAssassin, this is present. It records the value
41359 of &$spam_score_int$&.
41360
41361 .vitem &%-spool_file_wireformat%&
41362 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41363 rather than Unix-format.
41364 The line-ending is CRLF rather than newline.
41365 There is still, however, no leading-dot-stuffing.
41366
41367 .vitem &%-tls_certificate_verified%&
41368 A TLS certificate was received from the client that sent this message, and the
41369 certificate was verified by the server.
41370
41371 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41372 When the message was received over an encrypted connection, this records the
41373 name of the cipher suite that was used.
41374
41375 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41376 When the message was received over an encrypted connection, and a certificate
41377 was received from the client, this records the Distinguished Name from that
41378 certificate.
41379 .endlist
41380
41381 Following the options there is a list of those addresses to which the message
41382 is not to be delivered. This set of addresses is initialized from the command
41383 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41384 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41385 the address is added to this set. The addresses are kept internally as a
41386 balanced binary tree, and it is a representation of that tree which is written
41387 to the spool file. If an address is expanded via an alias or forward file, the
41388 original address is added to the tree when deliveries to all its child
41389 addresses are complete.
41390
41391 If the tree is empty, there is a single line in the spool file containing just
41392 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41393 Y or N, followed by an address. The address is the value for the node of the
41394 tree, and the letters indicate whether the node has a left branch and/or a
41395 right branch attached to it, respectively. If branches exist, they immediately
41396 follow. Here is an example of a three-node tree:
41397 .code
41398 YY darcy@austen.fict.example
41399 NN alice@wonderland.fict.example
41400 NN editor@thesaurus.ref.example
41401 .endd
41402 After the non-recipients tree, there is a list of the message's recipients.
41403 This is a simple list, preceded by a count. It includes all the original
41404 recipients of the message, including those to whom the message has already been
41405 delivered. In the simplest case, the list contains one address per line. For
41406 example:
41407 .code
41408 4
41409 editor@thesaurus.ref.example
41410 darcy@austen.fict.example
41411 rdo@foundation
41412 alice@wonderland.fict.example
41413 .endd
41414 However, when a child address has been added to the top-level addresses as a
41415 result of the use of the &%one_time%& option on a &(redirect)& router, each
41416 line is of the following form:
41417 .display
41418 <&'top-level address'&> <&'errors_to address'&> &&&
41419   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41420 .endd
41421 The 01 flag bit indicates the presence of the three other fields that follow
41422 the top-level address. Other bits may be used in future to support additional
41423 fields. The <&'parent number'&> is the offset in the recipients list of the
41424 original parent of the &"one time"& address. The first two fields are the
41425 envelope sender that is associated with this address and its length. If the
41426 length is zero, there is no special envelope sender (there are then two space
41427 characters in the line). A non-empty field can arise from a &(redirect)& router
41428 that has an &%errors_to%& setting.
41429
41430
41431 A blank line separates the envelope and status information from the headers
41432 which follow. A header may occupy several lines of the file, and to save effort
41433 when reading it in, each header is preceded by a number and an identifying
41434 character. The number is the number of characters in the header, including any
41435 embedded newlines and the terminating newline. The character is one of the
41436 following:
41437
41438 .table2 50pt
41439 .row <&'blank'&>         "header in which Exim has no special interest"
41440 .row &`B`&               "&'Bcc:'& header"
41441 .row &`C`&               "&'Cc:'& header"
41442 .row &`F`&               "&'From:'& header"
41443 .row &`I`&               "&'Message-id:'& header"
41444 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41445 .row &`R`&               "&'Reply-To:'& header"
41446 .row &`S`&               "&'Sender:'& header"
41447 .row &`T`&               "&'To:'& header"
41448 .row &`*`&               "replaced or deleted header"
41449 .endtable
41450
41451 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41452 purposes. They are not transmitted when the message is delivered. Here is a
41453 typical set of headers:
41454 .code
41455 111P Received: by hobbit.fict.example with local (Exim 4.00)
41456 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41457 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41458 038* X-rewrote-sender: bb@hobbit.fict.example
41459 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41460 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41461 099* To: alice@wonderland.fict.example, rdo@foundation,
41462 darcy@austen.fict.example, editor@thesaurus.ref.example
41463 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41464 darcy@austen.fict.example, editor@thesaurus.ref.example
41465 038  Date: Fri, 11 May 2001 10:28:59 +0100
41466 .endd
41467 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41468 &'To:'& header have been rewritten, the last one because routing expanded the
41469 unqualified domain &'foundation'&.
41470 .ecindex IIDforspo1
41471 .ecindex IIDforspo2
41472 .ecindex IIDforspo3
41473
41474 .section "Format of the -D file" "SECID282a"
41475 The data file is traditionally in Unix-standard format: lines are ended with
41476 an ASCII newline character.
41477 However, when the &%spool_wireformat%& main option is used some -D files
41478 can have an alternate format.
41479 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41480 The -D file lines (not including the first name-component line) are
41481 suitable for direct copying to the wire when transmitting using the
41482 ESMTP CHUNKING option, meaning lower processing overhead.
41483 Lines are terminated with an ASCII CRLF pair.
41484 There is no dot-stuffing (and no dot-termination).
41485
41486 . ////////////////////////////////////////////////////////////////////////////
41487 . ////////////////////////////////////////////////////////////////////////////
41488
41489 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41490          "DKIM, SPF, SRS and DMARC Support"
41491
41492 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41493 .cindex "DKIM"
41494
41495 DKIM is a mechanism by which messages sent by some entity can be provably
41496 linked to a domain which that entity controls.  It permits reputation to
41497 be tracked on a per-domain basis, rather than merely upon source IP address.
41498 DKIM is documented in RFC 6376.
41499
41500 As DKIM relies on the message being unchanged in transit, messages handled
41501 by a mailing-list (which traditionally adds to the message) will not match
41502 any original DKIM signature.
41503
41504 DKIM support is compiled into Exim by default if TLS support is present.
41505 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41506
41507 Exim's DKIM implementation allows for
41508 .olist
41509 Signing outgoing messages: This function is implemented in the SMTP transport.
41510 It can co-exist with all other Exim features
41511 (including transport filters)
41512 except cutthrough delivery.
41513 .next
41514 Verifying signatures in incoming messages: This is implemented by an additional
41515 ACL (acl_smtp_dkim), which can be called several times per message, with
41516 different signature contexts.
41517 .endlist
41518
41519 In typical Exim style, the verification implementation does not include any
41520 default "policy". Instead it enables you to build your own policy using
41521 Exim's standard controls.
41522
41523 Please note that verification of DKIM signatures in incoming mail is turned
41524 on by default for logging (in the <= line) purposes.
41525
41526 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41527 When set, for each signature in incoming email,
41528 exim will log a line displaying the most important signature details, and the
41529 signature status. Here is an example (with line-breaks added for clarity):
41530 .code
41531 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41532     d=facebookmail.com s=q1-2009b
41533     c=relaxed/relaxed a=rsa-sha1
41534     i=@facebookmail.com t=1252484542 [verification succeeded]
41535 .endd
41536
41537 You might want to turn off DKIM verification processing entirely for internal
41538 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41539 control modifier. This should typically be done in the RCPT ACL, at points
41540 where you accept mail from relay sources (internal hosts or authenticated
41541 senders).
41542
41543
41544 .subsection "Signing outgoing messages" SECDKIMSIGN
41545 .cindex DKIM signing
41546
41547 For signing to be usable you must have published a DKIM record in DNS.
41548 Note that RFC 8301 (which does not cover EC keys) says:
41549 .code
41550 rsa-sha1 MUST NOT be used for signing or verifying.
41551
41552 Signers MUST use RSA keys of at least 1024 bits for all keys.
41553 Signers SHOULD use RSA keys of at least 2048 bits.
41554 .endd
41555
41556 Note also that the key content (the 'p=' field)
41557 in the DNS record is different between RSA and EC keys;
41558 for the former it is the base64 of the ASN.1 for the RSA public key
41559 (equivalent to the private-key .pem with the header/trailer stripped)
41560 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41561
41562 Signing is enabled by setting private options on the SMTP transport.
41563 These options take (expandable) strings as arguments.
41564
41565 .option dkim_domain smtp "string list&!!" unset
41566 The domain(s) you want to sign with.
41567 After expansion, this can be a list.
41568 Each element in turn,
41569 lowercased,
41570 .vindex "&$dkim_domain$&"
41571 is put into the &%$dkim_domain%& expansion variable
41572 while expanding the remaining signing options.
41573 If it is empty after expansion, DKIM signing is not done,
41574 and no error will result even if &%dkim_strict%& is set.
41575
41576 .option dkim_selector smtp "string list&!!" unset
41577 This sets the key selector string.
41578 After expansion, which can use &$dkim_domain$&, this can be a list.
41579 Each element in turn is put in the expansion
41580 .vindex "&$dkim_selector$&"
41581 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41582 option along with &%$dkim_domain%&.
41583 If the option is empty after expansion, DKIM signing is not done for this domain,
41584 and no error will result even if &%dkim_strict%& is set.
41585
41586 To do, for example, dual-signing with RSA and EC keys
41587 this could be be used:
41588 .code
41589 dkim_selector = ec_sel : rsa_sel
41590 dkim_private_key = KEYS_DIR/$dkim_selector
41591 .endd
41592
41593 .option dkim_private_key smtp string&!! unset
41594 This sets the private key to use.
41595 You can use the &%$dkim_domain%& and
41596 &%$dkim_selector%& expansion variables to determine the private key to use.
41597 The result can either
41598 .ilist
41599 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41600 .next
41601 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41602 be a valid Ed25519 private key (same format as above)
41603 .next
41604 start with a slash, in which case it is treated as a file that contains
41605 the private key
41606 .next
41607 be "0", "false" or the empty string, in which case the message will not
41608 be signed. This case will not result in an error, even if &%dkim_strict%&
41609 is set.
41610 .endlist
41611
41612 To generate keys under OpenSSL:
41613 .code
41614 openssl genrsa -out dkim_rsa.private 2048
41615 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41616 .endd
41617 The result file from the first command should be retained, and
41618 this option set to use it.
41619 Take the base-64 lines from the output of the second command, concatenated,
41620 for the DNS TXT record.
41621 See section 3.6 of RFC6376 for the record specification.
41622
41623 Under GnuTLS:
41624 .code
41625 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41626 certtool --load-privkey=dkim_rsa.private --pubkey-info
41627 .endd
41628
41629 Note that RFC 8301 says:
41630 .code
41631 Signers MUST use RSA keys of at least 1024 bits for all keys.
41632 Signers SHOULD use RSA keys of at least 2048 bits.
41633 .endd
41634
41635 EC keys for DKIM are defined by RFC 8463.
41636 They are considerably smaller than RSA keys for equivalent protection.
41637 As they are a recent development, users should consider dual-signing
41638 (by setting a list of selectors, and an expansion for this option)
41639 for some transition period.
41640 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41641 for EC keys.
41642
41643 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41644 .code
41645 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41646 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41647 .endd
41648
41649 To produce the required public key value for a DNS record:
41650 .code
41651 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41652 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41653 .endd
41654
41655 Exim also supports an alternate format
41656 of Ed25519 keys in DNS which was a candidate during development
41657 of the standard, but not adopted.
41658 A future release will probably drop that support.
41659
41660 .option dkim_hash smtp string&!! sha256
41661 Can be set to any one of the supported hash methods, which are:
41662 .ilist
41663 &`sha1`& &-- should not be used, is old and insecure
41664 .next
41665 &`sha256`& &-- the default
41666 .next
41667 &`sha512`& &-- possibly more secure but less well supported
41668 .endlist
41669
41670 Note that RFC 8301 says:
41671 .code
41672 rsa-sha1 MUST NOT be used for signing or verifying.
41673 .endd
41674
41675 .option dkim_identity smtp string&!! unset
41676 If set after expansion, the value is used to set an "i=" tag in
41677 the signing header.  The DKIM standards restrict the permissible
41678 syntax of this optional tag to a mail address, with possibly-empty
41679 local part, an @, and a domain identical to or subdomain of the "d="
41680 tag value.  Note that Exim does not check the value.
41681
41682 .option dkim_canon smtp string&!! unset
41683 This option sets the canonicalization method used when signing a message.
41684 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41685 The option defaults to "relaxed" when unset. Note: the current implementation
41686 only supports signing with the same canonicalization method for both headers and body.
41687
41688 .option dkim_strict smtp string&!! unset
41689 This  option  defines  how  Exim  behaves  when  signing a message that
41690 should be signed fails for some reason.  When the expansion evaluates to
41691 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41692 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41693 variables here.
41694
41695 .option dkim_sign_headers smtp string&!! "see below"
41696 If set, this option must expand to a colon-separated
41697 list of header names.
41698 Headers with these names, or the absence or such a header, will be included
41699 in the message signature.
41700 When unspecified, the header names listed in RFC4871 will be used,
41701 whether or not each header is present in the message.
41702 The default list is available for the expansion in the macro
41703 &"_DKIM_SIGN_HEADERS"&
41704 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41705
41706 If a name is repeated, multiple headers by that name (or the absence thereof)
41707 will be signed.  The textually later headers in the headers part of the
41708 message are signed first, if there are multiples.
41709
41710 A name can be prefixed with either an &"="& or a &"+"& character.
41711 If an &"="& prefix is used, all headers that are present with this name
41712 will be signed.
41713 If a &"+"& prefix if used, all headers that are present with this name
41714 will be signed, and one signature added for a missing header with the
41715 name will be appended.
41716
41717 .option dkim_timestamps smtp integer&!! unset
41718 This option controls the inclusion of timestamp information in the signature.
41719 If not set, no such information will be included.
41720 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41721 for the expiry tag
41722 (eg. 1209600 for two weeks);
41723 both creation (t=) and expiry (x=) tags will be included.
41724
41725 RFC 6376 lists these tags as RECOMMENDED.
41726
41727
41728 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41729 .cindex DKIM verification
41730
41731 Verification of DKIM signatures in SMTP incoming email is done for all
41732 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41733 .cindex DKIM "selecting signature algorithms"
41734 Individual classes of signature algorithm can be ignored by changing
41735 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41736 The &%dkim_verify_minimal%& option can be set to cease verification
41737 processing for a message once the first passing signature is found.
41738
41739 .cindex authentication "expansion item"
41740 Performing verification sets up information used by the
41741 &%authresults%& expansion item.
41742
41743 For most purposes the default option settings suffice and the remainder
41744 of this section can be ignored.
41745
41746 The results of verification are made available to the
41747 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41748 A missing ACL definition defaults to accept.
41749 By default, the ACL is called once for each
41750 syntactically(!) correct signature in the incoming message.
41751 If any ACL call does not accept, the message is not accepted.
41752 If a cutthrough delivery was in progress for the message, that is
41753 summarily dropped (having wasted the transmission effort).
41754
41755 To evaluate the verification result in the ACL
41756 a large number of expansion variables
41757 containing the signature status and its details are set up during the
41758 runtime of the ACL.
41759
41760 Calling the ACL only for existing signatures is not sufficient to build
41761 more advanced policies. For that reason, the main option
41762 &%dkim_verify_signers%&, and an expansion variable
41763 &%$dkim_signers%& exist.
41764
41765 The main option &%dkim_verify_signers%& can be set to a colon-separated
41766 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41767 called. It is expanded when the message has been received. At this point,
41768 the expansion variable &%$dkim_signers%& already contains a colon-separated
41769 list of signer domains and identities for the message. When
41770 &%dkim_verify_signers%& is not specified in the main configuration,
41771 it defaults as:
41772 .code
41773 dkim_verify_signers = $dkim_signers
41774 .endd
41775 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41776 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41777 call the ACL for known domains or identities. This would be achieved as follows:
41778 .code
41779 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41780 .endd
41781 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41782 and "ebay.com", plus all domains and identities that have signatures in the message.
41783 You can also be more creative in constructing your policy. For example:
41784 .code
41785 dkim_verify_signers = $sender_address_domain:$dkim_signers
41786 .endd
41787
41788 If a domain or identity is listed several times in the (expanded) value of
41789 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41790
41791 Note that if the option is set using untrustworthy data
41792 (such as the From: header)
41793 care should be taken to force lowercase for domains
41794 and for the domain part if identities.
41795 The default setting can be regarded as trustworthy in this respect.
41796
41797 If multiple signatures match a domain (or identity), the ACL is called once
41798 for each matching signature.
41799
41800
41801 Inside the DKIM ACL, the following expansion variables are
41802 available (from most to least important):
41803
41804
41805 .vlist
41806 .vitem &%$dkim_cur_signer%&
41807 The signer that is being evaluated in this ACL run. This can be a domain or
41808 an identity. This is one of the list items from the expanded main option
41809 &%dkim_verify_signers%& (see above).
41810
41811 .vitem &%$dkim_verify_status%&
41812 Within the DKIM ACL,
41813 a string describing the general status of the signature. One of
41814 .ilist
41815 &%none%&: There is no signature in the message for the current domain or
41816 identity (as reflected by &%$dkim_cur_signer%&).
41817 .next
41818 &%invalid%&: The signature could not be verified due to a processing error.
41819 More detail is available in &%$dkim_verify_reason%&.
41820 .next
41821 &%fail%&: Verification of the signature failed.  More detail is
41822 available in &%$dkim_verify_reason%&.
41823 .next
41824 &%pass%&: The signature passed verification. It is valid.
41825 .endlist
41826
41827 This variable can be overwritten using an ACL 'set' modifier.
41828 This might, for instance, be done to enforce a policy restriction on
41829 hash-method or key-size:
41830 .code
41831   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41832        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41833        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41834                                   {< {$dkim_key_length}{1024}}}}
41835        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41836        set dkim_verify_status = fail
41837        set dkim_verify_reason = hash too weak or key too short
41838 .endd
41839
41840 So long as a DKIM ACL is defined (it need do no more than accept),
41841 after all the DKIM ACL runs have completed, the value becomes a
41842 colon-separated list of the values after each run.
41843 This is maintained for the mime, prdr and data ACLs.
41844
41845 .vitem &%$dkim_verify_reason%&
41846 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41847 "fail" or "invalid". One of
41848 .ilist
41849 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41850 key for the domain could not be retrieved. This may be a temporary problem.
41851 .next
41852 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41853 record for the domain is syntactically invalid.
41854 .next
41855 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41856 body hash does not match the one specified in the signature header. This
41857 means that the message body was modified in transit.
41858 .next
41859 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41860 could not be verified. This may mean that headers were modified,
41861 re-written or otherwise changed in a way which is incompatible with
41862 DKIM verification. It may of course also mean that the signature is forged.
41863 .endlist
41864
41865 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41866
41867 .vitem &%$dkim_domain%&
41868 The signing domain. IMPORTANT: This variable is only populated if there is
41869 an actual signature in the message for the current domain or identity (as
41870 reflected by &%$dkim_cur_signer%&).
41871
41872 .vitem &%$dkim_identity%&
41873 The signing identity, if present. IMPORTANT: This variable is only populated
41874 if there is an actual signature in the message for the current domain or
41875 identity (as reflected by &%$dkim_cur_signer%&).
41876
41877 .vitem &%$dkim_selector%&
41878 The key record selector string.
41879
41880 .vitem &%$dkim_algo%&
41881 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41882 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41883 may also be 'ed25519-sha256'.
41884 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41885 for EC keys.
41886
41887 Note that RFC 8301 says:
41888 .code
41889 rsa-sha1 MUST NOT be used for signing or verifying.
41890
41891 DKIM signatures identified as having been signed with historic
41892 algorithms (currently, rsa-sha1) have permanently failed evaluation
41893 .endd
41894
41895 To enforce this you must either have a DKIM ACL which checks this variable
41896 and overwrites the &$dkim_verify_status$& variable as discussed above,
41897 or have set the main option &%dkim_verify_hashes%& to exclude
41898 processing of such signatures.
41899
41900 .vitem &%$dkim_canon_body%&
41901 The body canonicalization method. One of 'relaxed' or 'simple'.
41902
41903 .vitem &%$dkim_canon_headers%&
41904 The header canonicalization method. One of 'relaxed' or 'simple'.
41905
41906 .vitem &%$dkim_copiedheaders%&
41907 A transcript of headers and their values which are included in the signature
41908 (copied from the 'z=' tag of the signature).
41909 Note that RFC6376 requires that verification fail if the From: header is
41910 not included in the signature.  Exim does not enforce this; sites wishing
41911 strict enforcement should code the check explicitly.
41912
41913 .vitem &%$dkim_bodylength%&
41914 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41915 limit was set by the signer, "9999999999999" is returned. This makes sure
41916 that this variable always expands to an integer value.
41917 &*Note:*& The presence of the signature tag specifying a signing body length
41918 is one possible route to spoofing of valid DKIM signatures.
41919 A paranoid implementation might wish to regard signature where this variable
41920 shows less than the "no limit" return as being invalid.
41921
41922 .vitem &%$dkim_created%&
41923 UNIX timestamp reflecting the date and time when the signature was created.
41924 When this was not specified by the signer, "0" is returned.
41925
41926 .vitem &%$dkim_expires%&
41927 UNIX timestamp reflecting the date and time when the signer wants the
41928 signature to be treated as "expired". When this was not specified by the
41929 signer, "9999999999999" is returned. This makes it possible to do useful
41930 integer size comparisons against this value.
41931 Note that Exim does not check this value.
41932
41933 .vitem &%$dkim_headernames%&
41934 A colon-separated list of names of headers included in the signature.
41935
41936 .vitem &%$dkim_key_testing%&
41937 "1" if the key record has the "testing" flag set, "0" if not.
41938
41939 .vitem &%$dkim_key_nosubdomains%&
41940 "1" if the key record forbids subdomaining, "0" otherwise.
41941
41942 .vitem &%$dkim_key_srvtype%&
41943 Service type (tag s=) from the key record. Defaults to "*" if not specified
41944 in the key record.
41945
41946 .vitem &%$dkim_key_granularity%&
41947 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41948 in the key record.
41949
41950 .vitem &%$dkim_key_notes%&
41951 Notes from the key record (tag n=).
41952
41953 .vitem &%$dkim_key_length%&
41954 Number of bits in the key.
41955 Valid only once the key is loaded, which is at the time the header signature
41956 is verified, which is after the body hash is.
41957
41958 Note that RFC 8301 says:
41959 .code
41960 Verifiers MUST NOT consider signatures using RSA keys of
41961 less than 1024 bits as valid signatures.
41962 .endd
41963
41964 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41965 option.
41966
41967 .endlist
41968
41969 In addition, two ACL conditions are provided:
41970
41971 .vlist
41972 .vitem &%dkim_signers%&
41973 ACL condition that checks a colon-separated list of domains or identities
41974 for a match against the domain or identity that the ACL is currently verifying
41975 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41976 verb to a group of domains or identities. For example:
41977
41978 .code
41979 # Warn when Mail purportedly from GMail has no gmail signature
41980 warn sender_domains = gmail.com
41981      dkim_signers = gmail.com
41982      dkim_status = none
41983      log_message = GMail sender without gmail.com DKIM signature
41984 .endd
41985
41986 Note that the above does not check for a total lack of DKIM signing;
41987 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41988
41989 .vitem &%dkim_status%&
41990 ACL condition that checks a colon-separated list of possible DKIM verification
41991 results against the actual result of verification. This is typically used
41992 to restrict an ACL verb to a list of verification outcomes, for example:
41993
41994 .code
41995 deny sender_domains = paypal.com:paypal.de
41996      dkim_signers = paypal.com:paypal.de
41997      dkim_status = none:invalid:fail
41998      message = Mail from Paypal with invalid/missing signature
41999 .endd
42000
42001 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42002 see the documentation of the &%$dkim_verify_status%& expansion variable above
42003 for more information of what they mean.
42004 .endlist
42005
42006
42007
42008
42009 .section "SPF (Sender Policy Framework)" SECSPF
42010 .cindex SPF verification
42011
42012 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42013 messages with its domain in the envelope from, documented by RFC 7208.
42014 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42015 the &url(http://openspf.org).
42016 . --- 2019-10-28: still not https, open-spf.org is told to be a
42017 . --- web-archive copy of the now dead openspf.org site
42018 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42019 . --- discussion.
42020
42021 Messages sent by a system not authorised will fail checking of such assertions.
42022 This includes retransmissions done by traditional forwarders.
42023
42024 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42025 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42026 &url(https://www.libspf2.org/).
42027 There is no Exim involvement in the transmission of messages;
42028 publishing certain DNS records is all that is required.
42029
42030 For verification, an ACL condition and an expansion lookup are provided.
42031 .cindex authentication "expansion item"
42032 Performing verification sets up information used by the
42033 &%authresults%& expansion item.
42034
42035
42036 .cindex SPF "ACL condition"
42037 .cindex ACL "spf condition"
42038 The ACL condition "spf" can be used at or after the MAIL ACL.
42039 It takes as an argument a list of strings giving the outcome of the SPF check,
42040 and will succeed for any matching outcome.
42041 Valid strings are:
42042 .vlist
42043 .vitem &%pass%&
42044 The SPF check passed, the sending host is positively verified by SPF.
42045
42046 .vitem &%fail%&
42047 The SPF check failed, the sending host is NOT allowed to send mail for the
42048 domain in the envelope-from address.
42049
42050 .vitem &%softfail%&
42051 The SPF check failed, but the queried domain can't absolutely confirm that this
42052 is a forgery.
42053
42054 .vitem &%none%&
42055 The queried domain does not publish SPF records.
42056
42057 .vitem &%neutral%&
42058 The SPF check returned a "neutral" state.  This means the queried domain has
42059 published a SPF record, but wants to allow outside servers to send mail under
42060 its domain as well.  This should be treated like "none".
42061
42062 .vitem &%permerror%&
42063 This indicates a syntax error in the SPF record of the queried domain.
42064 You may deny messages when this occurs.
42065
42066 .vitem &%temperror%&
42067 This indicates a temporary error during all processing, including Exim's
42068 SPF processing.  You may defer messages when this occurs.
42069
42070 .vitem &%invalid%&
42071 There was an error during processing of the SPF lookup
42072 .endlist
42073
42074 You can prefix each string with an exclamation mark to  invert
42075 its meaning,  for example  "!fail" will  match all  results but
42076 "fail".  The  string  list is  evaluated  left-to-right,  in a
42077 short-circuit fashion.
42078
42079 Example:
42080 .code
42081 deny spf = fail
42082      message = $sender_host_address is not allowed to send mail from \
42083                ${if def:sender_address_domain \
42084                     {$sender_address_domain}{$sender_helo_name}}.  \
42085                Please see http://www.open-spf.org/Why;\
42086                identity=${if def:sender_address_domain \
42087                              {$sender_address}{$sender_helo_name}};\
42088                ip=$sender_host_address
42089 .endd
42090
42091 Note: The above mentioned URL may not be as helpful as expected. You are
42092 encouraged to replace the link with a link to a site with more
42093 explanations.
42094
42095 When the spf condition has run, it sets up several expansion
42096 variables:
42097
42098 .cindex SPF "verification variables"
42099 .vlist
42100 .vitem &$spf_header_comment$&
42101 .vindex &$spf_header_comment$&
42102   This contains a human-readable string describing the outcome
42103   of the SPF check. You can add it to a custom header or use
42104   it for logging purposes.
42105
42106 .vitem &$spf_received$&
42107 .vindex &$spf_received$&
42108   This contains a complete Received-SPF: header (name and
42109   content) that can be added to the message. Please note that
42110   according to the SPF draft, this header must be added at the
42111   top of the header list, i.e. with
42112 .code
42113 add_header = :at_start:$spf_received
42114 .endd
42115   See section &<<SECTaddheadacl>>& for further details.
42116
42117   Note: in case of "Best-guess" (see below), the convention is
42118   to put this string in a header called X-SPF-Guess: instead.
42119
42120 .vitem &$spf_result$&
42121 .vindex &$spf_result$&
42122   This contains the outcome of the SPF check in string form,
42123   currently one of pass, fail, softfail, none, neutral, permerror,
42124   temperror, or &"(invalid)"&.
42125
42126 .vitem &$spf_result_guessed$&
42127 .vindex &$spf_result_guessed$&
42128   This boolean is true only if a best-guess operation was used
42129   and required in order to obtain a result.
42130
42131 .vitem &$spf_smtp_comment$&
42132 .vindex &$spf_smtp_comment$&
42133 .vindex &%spf_smtp_comment_template%&
42134   This contains a string that can be used in a SMTP response
42135   to the calling party. Useful for "fail".
42136   The string is generated by the SPF library from the template configured in the main config
42137   option &%spf_smtp_comment_template%&.
42138 .endlist
42139
42140
42141 .cindex SPF "ACL condition"
42142 .cindex ACL "spf_guess condition"
42143 .cindex SPF "best guess"
42144 In addition to SPF, you can also perform checks for so-called
42145 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42146 SPF, but it is supported by the same framework that enables SPF
42147 capability.
42148 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42149 for a description of what it means.
42150 . --- 2019-10-28: still not https:
42151
42152 To access this feature, simply use the spf_guess condition in place
42153 of the spf one.  For example:
42154
42155 .code
42156 deny spf_guess = fail
42157      message = $sender_host_address doesn't look trustworthy to me
42158 .endd
42159
42160 In case you decide to reject messages based on this check, you
42161 should note that although it uses the same framework, "Best-guess"
42162 is not SPF, and therefore you should not mention SPF at all in your
42163 reject message.
42164
42165 When the spf_guess condition has run, it sets up the same expansion
42166 variables as when spf condition is run, described above.
42167
42168 Additionally, since Best-guess is not standardized, you may redefine
42169 what "Best-guess" means to you by redefining the main configuration
42170 &%spf_guess%& option.
42171 For example, the following:
42172
42173 .code
42174 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42175 .endd
42176
42177 would relax host matching rules to a broader network range.
42178
42179
42180 .cindex SPF "lookup expansion"
42181 .cindex lookup spf
42182 A lookup expansion is also available. It takes an email
42183 address as the key and an IP address
42184 (v4 or v6)
42185 as the database:
42186
42187 .code
42188   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42189 .endd
42190
42191 The lookup will return the same result strings as can appear in
42192 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42193
42194
42195
42196
42197
42198 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42199 .cindex SRS "sender rewriting scheme"
42200
42201 SRS can be used to modify sender addresses when forwarding so that
42202 SPF verification does not object to them.
42203 It operates by encoding the original envelope sender in a new
42204 sender local part and using a domain run by the forwarding site
42205 as the new domain for the sender.  Any DSN message should be returned
42206 to this new sender at the forwarding site, which can extract the
42207 original sender from the coded local part and forward the DSN to
42208 the originator.
42209
42210 This is a way of avoiding the breakage that SPF does to forwarding.
42211 The constructed local-part will be longer than the original,
42212 leading to possible problems with very long addresses.
42213 The changing of the sender address also hinders the tracing of mail
42214 problems.
42215
42216 Exim can be built to include native SRS support.  To do this
42217 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42218 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42219 will be defined.
42220 The support is limited to SRS0-encoding; SRS1 is not supported.
42221
42222 .cindex SRS excoding
42223 To encode an address use this expansion item:
42224 .vlist
42225 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42226 .cindex "&%srs_encode%& expansion item"
42227 .cindex SRS "expansion item"
42228 The first argument should be a secret known and used by all systems
42229 handling the recipient domain for the original message.
42230 There is no need to periodically change this key; a timestamp is also
42231 encoded.
42232 The second argument should be given as the envelope sender address before this
42233 encoding operation.
42234 If this value is empty the the expansion result will be empty.
42235 The third argument should be the recipient domain of the message when
42236 it arrived at this system.
42237 .endlist
42238
42239 .cindex SRS decoding
42240 To decode an address use this expansion condition:
42241 .vlist
42242 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42243 The first argument should be the recipient local prt as is was received.
42244 The second argument is the site secret.
42245
42246 If the messages is not for an SRS-encoded recipient the condition will
42247 return false.  If it is, the condition will return true and the variable
42248 &$srs_recipient$& will be set to the decoded (original) value.
42249 .endlist
42250
42251 Example usage:
42252 .code
42253   #macro
42254   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42255
42256   #routers
42257
42258   outbound:
42259     driver =    dnslookup
42260     # if outbound, and forwarding has been done, use an alternate transport
42261     domains =   ! +my_domains
42262     transport = ${if eq {$local_part@$domain} \
42263                         {$original_local_part@$original_domain} \
42264                      {remote_smtp} {remote_forwarded_smtp}}
42265
42266   inbound_srs:
42267     driver =    redirect
42268     senders =   :
42269     domains =   +my_domains
42270     # detect inbound bounces which are SRS'd, and decode them
42271     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42272     data =      $srs_recipient
42273
42274   inbound_srs_failure:
42275     driver =    redirect
42276     senders =   :
42277     domains =   +my_domains
42278     # detect inbound bounces which look SRS'd but are invalid
42279     condition = ${if inbound_srs {$local_part} {}}
42280     allow_fail
42281     data =      :fail: Invalid SRS recipient address
42282
42283   #... further routers here
42284
42285
42286   # transport; should look like the non-forward outbound
42287   # one, plus the max_rcpt and return_path options
42288   remote_forwarded_smtp:
42289     driver =              smtp
42290     # single-recipient so that $original_domain is valid
42291     max_rcpt =            1
42292     # modify the envelope from, for mails that we forward
42293     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42294 .endd
42295
42296
42297
42298
42299
42300 .section DMARC SECDMARC
42301 .cindex DMARC verification
42302
42303 DMARC combines feedback from SPF, DKIM, and header From: in order
42304 to attempt to provide better indicators of the authenticity of an
42305 email.  This document does not explain the fundamentals; you
42306 should read and understand how it works by visiting the website at
42307 &url(http://www.dmarc.org/).
42308
42309 If Exim is built with DMARC support,
42310 the libopendmarc library is used.
42311
42312 For building Exim yourself, obtain the library from
42313 &url(http://sourceforge.net/projects/opendmarc/)
42314 to obtain a copy, or find it in your favorite package
42315 repository.  You will need to attend to the local/Makefile feature
42316 SUPPORT_DMARC and the associated LDFLAGS addition.
42317 This description assumes
42318 that headers will be in /usr/local/include, and that the libraries
42319 are in /usr/local/lib.
42320
42321 .subsection Configuration SSECDMARCCONFIG
42322 .cindex DMARC configuration
42323
42324 There are three main-configuration options:
42325 .cindex DMARC "configuration options"
42326
42327 The &%dmarc_tld_file%& option
42328 .oindex &%dmarc_tld_file%&
42329 defines the location of a text file of valid
42330 top level domains the opendmarc library uses
42331 during domain parsing. Maintained by Mozilla,
42332 the most current version can be downloaded
42333 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42334 See also the util/renew-opendmarc-tlds.sh script.
42335 The default for the option is unset.
42336 If not set, DMARC processing is disabled.
42337
42338
42339 The &%dmarc_history_file%& option, if set
42340 .oindex &%dmarc_history_file%&
42341 defines the location of a file to log results
42342 of dmarc verification on inbound emails. The
42343 contents are importable by the opendmarc tools
42344 which will manage the data, send out DMARC
42345 reports, and expire the data. Make sure the
42346 directory of this file is writable by the user
42347 exim runs as.
42348 The default is unset.
42349
42350 The &%dmarc_forensic_sender%& option
42351 .oindex &%dmarc_forensic_sender%&
42352 defines an alternate email address to use when sending a
42353 forensic report detailing alignment failures
42354 if a sender domain's dmarc record specifies it
42355 and you have configured Exim to send them.
42356 If set, this is expanded and used for the
42357 From: header line; the address is extracted
42358 from it and used for the envelope from.
42359 If not set (the default), the From: header is expanded from
42360 the dsn_from option, and <> is used for the
42361 envelope from.
42362
42363 .subsection Controls SSECDMARCCONTROLS
42364 .cindex DMARC controls
42365
42366 By default, the DMARC processing will run for any remote,
42367 non-authenticated user.  It makes sense to only verify DMARC
42368 status of messages coming from remote, untrusted sources.  You can
42369 use standard conditions such as hosts, senders, etc, to decide that
42370 DMARC verification should *not* be performed for them and disable
42371 DMARC with an ACL control modifier:
42372 .code
42373   control = dmarc_disable_verify
42374 .endd
42375 A DMARC record can also specify a "forensic address", which gives
42376 exim an email address to submit reports about failed alignment.
42377 Exim does not do this by default because in certain conditions it
42378 results in unintended information leakage (what lists a user might
42379 be subscribed to, etc).  You must configure exim to submit forensic
42380 reports to the owner of the domain.  If the DMARC record contains a
42381 forensic address and you specify the control statement below, then
42382 exim will send these forensic emails.  It is also advised that you
42383 configure a &%dmarc_forensic_sender%& because the default sender address
42384 construction might be inadequate.
42385 .code
42386   control = dmarc_enable_forensic
42387 .endd
42388 (AGAIN: You can choose not to send these forensic reports by simply
42389 not putting the dmarc_enable_forensic control line at any point in
42390 your exim config.  If you don't tell exim to send them, it will not
42391 send them.)
42392
42393 There are no options to either control.  Both must appear before
42394 the DATA acl.
42395
42396 .subsection ACL SSECDMARCACL
42397 .cindex DMARC "ACL condition"
42398
42399 DMARC checks can be run on incoming SMTP  messages by using the
42400 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42401 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42402 condition.  Putting this condition in the ACLs is required in order
42403 for a DMARC check to actually occur.  All of the variables are set
42404 up before the DATA ACL, but there is no actual DMARC check that
42405 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42406
42407 The &"dmarc_status"& condition takes a list of strings on its
42408 right-hand side.  These strings describe recommended action based
42409 on the DMARC check.  To understand what the policy recommendations
42410 mean, refer to the DMARC website above.  Valid strings are:
42411 .itable none 0 0 2 20* left 80* left
42412 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42413 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42414 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42415 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42416 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42417 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42418 .irow &'temperror'&     "Library error or dns error"
42419 .irow &'off'&           "The DMARC check was disabled for this email"
42420 .endtable
42421 You can prefix each string with an exclamation mark to invert its
42422 meaning, for example "!accept" will match all results but
42423 "accept".  The string list is evaluated left-to-right in a
42424 short-circuit fashion.  When a string matches the outcome of the
42425 DMARC check, the condition succeeds.  If none of the listed
42426 strings matches the outcome of the DMARC check, the condition
42427 fails.
42428
42429 Of course, you can also use any other lookup method that Exim
42430 supports, including LDAP, Postgres, MySQL, etc, as long as the
42431 result is a list of colon-separated strings.
42432
42433 Performing the check sets up information used by the
42434 &%authresults%& expansion item.
42435
42436 Several expansion variables are set before the DATA ACL is
42437 processed, and you can use them in this ACL.  The following
42438 expansion variables are available:
42439
42440 .vlist
42441 .vitem &$dmarc_status$&
42442 .vindex &$dmarc_status$&
42443 .cindex DMARC result
42444 A one word status indicating what the DMARC library
42445 thinks of the email.  It is a combination of the results of
42446 DMARC record lookup and the SPF/DKIM/DMARC processing results
42447 (if a DMARC record was found).  The actual policy declared
42448 in the DMARC record is in a separate expansion variable.
42449
42450 .vitem &$dmarc_status_text$&
42451 .vindex &$dmarc_status_text$&
42452 Slightly longer, human readable status.
42453
42454 .vitem &$dmarc_used_domain$&
42455 .vindex &$dmarc_used_domain$&
42456 The domain which DMARC used to look up the DMARC policy record.
42457
42458 .vitem &$dmarc_domain_policy$&
42459 .vindex &$dmarc_domain_policy$&
42460 The policy declared in the DMARC record.  Valid values
42461 are "none", "reject" and "quarantine".  It is blank when there
42462 is any error, including no DMARC record.
42463 .endlist
42464
42465 .subsection Logging SSECDMARCLOGGING
42466 .cindex DMARC logging
42467
42468 By default, Exim's DMARC configuration is intended to be
42469 non-intrusive and conservative.  To facilitate this, Exim will not
42470 create any type of logging files without explicit configuration by
42471 you, the admin.  Nor will Exim send out any emails/reports about
42472 DMARC issues without explicit configuration by you, the admin (other
42473 than typical bounce messages that may come about due to ACL
42474 processing or failure delivery issues).
42475
42476 In order to log statistics suitable to be imported by the opendmarc
42477 tools, you need to:
42478 .ilist
42479 Configure the global option &%dmarc_history_file%&
42480 .next
42481 Configure cron jobs to call the appropriate opendmarc history
42482 import scripts and truncating the dmarc_history_file
42483 .endlist
42484
42485 In order to send forensic reports, you need to:
42486 .ilist
42487 Configure the global option &%dmarc_forensic_sender%&
42488 .next
42489 Configure, somewhere before the DATA ACL, the control option to
42490 enable sending DMARC forensic reports
42491 .endlist
42492
42493 .subsection Example SSECDMARCEXAMPLE
42494 .cindex DMARC example
42495
42496 Example usage:
42497 .code
42498 (RCPT ACL)
42499   warn    domains        = +local_domains
42500           hosts          = +local_hosts
42501           control        = dmarc_disable_verify
42502
42503   warn    !domains       = +screwed_up_dmarc_records
42504           control        = dmarc_enable_forensic
42505
42506   warn    condition      = (lookup if destined to mailing list)
42507           set acl_m_mailing_list = 1
42508
42509 (DATA ACL)
42510   warn    dmarc_status   = accept : none : off
42511           !authenticated = *
42512           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42513
42514   warn    dmarc_status   = !accept
42515           !authenticated = *
42516           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42517
42518   warn    dmarc_status   = quarantine
42519           !authenticated = *
42520           set $acl_m_quarantine = 1
42521           # Do something in a transport with this flag variable
42522
42523   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42524           condition      = ${if eq{$acl_m_mailing_list}{1}}
42525           message        = Messages from $dmarc_used_domain break mailing lists
42526
42527   deny    dmarc_status   = reject
42528           !authenticated = *
42529           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42530
42531   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42532 .endd
42533
42534
42535
42536
42537
42538 . ////////////////////////////////////////////////////////////////////////////
42539 . ////////////////////////////////////////////////////////////////////////////
42540
42541 .chapter "Proxies" "CHAPproxies" &&&
42542          "Proxy support"
42543 .cindex "proxy support"
42544 .cindex "proxy" "access via"
42545
42546 A proxy is an intermediate system through which communication is passed.
42547 Proxies may provide a security, availability or load-distribution function.
42548
42549
42550 .section "Inbound proxies" SECTproxyInbound
42551 .cindex proxy inbound
42552 .cindex proxy "server side"
42553 .cindex proxy "Proxy protocol"
42554 .cindex "Proxy protocol" proxy
42555
42556 Exim has support for receiving inbound SMTP connections via a proxy
42557 that uses &"Proxy Protocol"& to speak to it.
42558 To include this support, include &"SUPPORT_PROXY=yes"&
42559 in Local/Makefile.
42560
42561 It was built on the HAProxy specification, found at
42562 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42563
42564 The purpose of this facility is so that an application load balancer,
42565 such as HAProxy, can sit in front of several Exim servers
42566 to distribute load.
42567 Exim uses the local protocol communication with the proxy to obtain
42568 the remote SMTP system IP address and port information.
42569 There is no logging if a host passes or
42570 fails Proxy Protocol negotiation, but it can easily be determined and
42571 recorded in an ACL (example is below).
42572
42573 Use of a proxy is enabled by setting the &%hosts_proxy%&
42574 main configuration option to a hostlist; connections from these
42575 hosts will use Proxy Protocol.
42576 Exim supports both version 1 and version 2 of the Proxy Protocol and
42577 automatically determines which version is in use.
42578
42579 The Proxy Protocol header is the first data received on a TCP connection
42580 and is inserted before any TLS-on-connect handshake from the client; Exim
42581 negotiates TLS between Exim-as-server and the remote client, not between
42582 Exim and the proxy server. The Proxy Protocol header must be received
42583 within &%proxy_protocol_timeout%&, which defaults to 3s.
42584
42585 The following expansion variables are usable
42586 (&"internal"& and &"external"& here refer to the interfaces
42587 of the proxy):
42588 .itable none 0 0 2 30* left 70* left
42589 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42590 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42591 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42592 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42593 .irow $proxy_session            "boolean: SMTP connection via proxy"
42594 .endtable
42595 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42596 there was a protocol error.
42597 The variables &$sender_host_address$& and &$sender_host_port$&
42598 will have values for the actual client system, not the proxy.
42599
42600 Since the real connections are all coming from the proxy, and the
42601 per host connection tracking is done before Proxy Protocol is
42602 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42603 handle all of the parallel volume you expect per inbound proxy.
42604 With the option set so high, you lose the ability
42605 to protect your server from many connections from one IP.
42606 In order to prevent your server from overload, you
42607 need to add a per connection ratelimit to your connect ACL.
42608 A possible solution is:
42609 .display
42610   # Set max number of connections per host
42611   LIMIT   = 5
42612   # Or do some kind of IP lookup in a flat file or database
42613   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42614
42615   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42616           message        = Too many connections from this IP right now
42617 .endd
42618
42619
42620
42621 .section "Outbound proxies" SECTproxySOCKS
42622 .cindex proxy outbound
42623 .cindex proxy "client side"
42624 .cindex proxy SOCKS
42625 .cindex SOCKS proxy
42626 Exim has support for sending outbound SMTP via a proxy
42627 using a protocol called SOCKS5 (defined by RFC1928).
42628 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42629 Local/Makefile.
42630
42631 Use of a proxy is enabled by setting the &%socks_proxy%& option
42632 on an smtp transport.
42633 The option value is expanded and should then be a list
42634 (colon-separated by default) of proxy specifiers.
42635 Each proxy specifier is a list
42636 (space-separated by default) where the initial element
42637 is an IP address and any subsequent elements are options.
42638
42639 Options are a string <name>=<value>.
42640 The list of options is in the following table:
42641 .itable none 0 0 2 10* left 90* left
42642 .irow &'auth'&  "authentication method"
42643 .irow &'name'&  "authentication username"
42644 .irow &'pass'&  "authentication password"
42645 .irow &'port'&  "tcp port"
42646 .irow &'tmo'&   "connection timeout"
42647 .irow &'pri'&   "priority"
42648 .irow &'weight'& "selection bias"
42649 .endtable
42650
42651 More details on each of these options follows:
42652
42653 .ilist
42654 .cindex authentication "to proxy"
42655 .cindex proxy authentication
42656 &%auth%&: Either &"none"& (default) or &"name"&.
42657 Using &"name"& selects username/password authentication per RFC 1929
42658 for access to the proxy.
42659 Default is &"none"&.
42660 .next
42661 &%name%&: sets the username for the &"name"& authentication method.
42662 Default is empty.
42663 .next
42664 &%pass%&: sets the password for the &"name"& authentication method.
42665 Default is empty.
42666 .next
42667 &%port%&: the TCP port number to use for the connection to the proxy.
42668 Default is 1080.
42669 .next
42670 &%tmo%&: sets a connection timeout in seconds for this proxy.
42671 Default is 5.
42672 .next
42673 &%pri%&: specifies a priority for the proxy within the list,
42674 higher values being tried first.
42675 The default priority is 1.
42676 .next
42677 &%weight%&: specifies a selection bias.
42678 Within a priority set servers are queried in a random fashion,
42679 weighted by this value.
42680 The default value for selection bias is 1.
42681 .endlist
42682
42683 Proxies from the list are tried according to their priority
42684 and weight settings until one responds.  The timeout for the
42685 overall connection applies to the set of proxied attempts.
42686
42687 .section Logging SECTproxyLog
42688 To log the (local) IP of a proxy in the incoming or delivery logline,
42689 add &"+proxy"& to the &%log_selector%& option.
42690 This will add a component tagged with &"PRX="& to the line.
42691
42692 . ////////////////////////////////////////////////////////////////////////////
42693 . ////////////////////////////////////////////////////////////////////////////
42694
42695 .chapter "Internationalisation" "CHAPi18n" &&&
42696          "Internationalisation""
42697 .cindex internationalisation "email address"
42698 .cindex EAI
42699 .cindex i18n
42700 .cindex utf8 "mail name handling"
42701
42702 Exim has support for Internationalised mail names.
42703 To include this it must be built with SUPPORT_I18N and the libidn library.
42704 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42705
42706 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42707 instead of it) then IDNA2008 is supported; this adds an extra library
42708 requirement, upon libidn2.
42709
42710 .section "MTA operations" SECTi18nMTA
42711 .cindex SMTPUTF8 "ESMTP option"
42712 .cindex "ESMTP extensions" SMTPUTF8
42713 The main configuration option &%smtputf8_advertise_hosts%& specifies
42714 a host list.  If this matches the sending host and
42715 accept_8bitmime is true (the default) then the ESMTP option
42716 SMTPUTF8 will be advertised.
42717
42718 If the sender specifies the SMTPUTF8 option on a MAIL command
42719 international handling for the message is enabled and
42720 the expansion variable &$message_smtputf8$& will have value TRUE.
42721
42722 The option &%allow_utf8_domains%& is set to true for this
42723 message. All DNS lookups are converted to a-label form
42724 whatever the setting of &%allow_utf8_domains%&
42725 when Exim is built with SUPPORT_I18N.
42726
42727 Both localparts and domain are maintained as the original
42728 UTF-8 form internally; any comparison or regular-expression use will
42729 require appropriate care.  Filenames created, eg. by
42730 the appendfile transport, will have UTF-8 names.
42731
42732 HELO names sent by the smtp transport will have any UTF-8
42733 components expanded to a-label form,
42734 and any certificate name checks will be done using the a-label
42735 form of the name.
42736
42737 .cindex log protocol
42738 .cindex SMTPUTF8 logging
42739 .cindex i18n logging
42740 Log lines and Received-by: header lines will acquire a "utf8"
42741 prefix on the protocol element, eg. utf8esmtp.
42742
42743 The following expansion operators can be used:
42744 .code
42745 ${utf8_domain_to_alabel:str}
42746 ${utf8_domain_from_alabel:str}
42747 ${utf8_localpart_to_alabel:str}
42748 ${utf8_localpart_from_alabel:str}
42749 .endd
42750
42751 .cindex utf8 "address downconversion"
42752 .cindex i18n "utf8 address downconversion"
42753 The RCPT ACL
42754 may use the following modifier:
42755 .display
42756 control = utf8_downconvert
42757 control = utf8_downconvert/<value>
42758 .endd
42759 This sets a flag requiring that envelope addresses are converted to
42760 a-label form before smtp delivery.
42761 This is usually for use in a Message Submission Agent context,
42762 but could be used for any message.
42763
42764 If a value is appended it may be:
42765 .itable none 0 0 2 5* right 95* left
42766 .irow &`1`&     "mandatory downconversion"
42767 .irow &`0`&     "no downconversion"
42768 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42769 .endtable
42770 If no value is given, 1 is used.
42771
42772 If mua_wrapper is set, the utf8_downconvert control
42773 is initially set to -1.
42774
42775 The smtp transport has an option &%utf8_downconvert%&.
42776 If set it must expand to one of the three values described above,
42777 or an empty string.
42778 If non-empty it overrides value previously set
42779 (due to mua_wrapper or by an ACL control).
42780
42781
42782 There is no explicit support for VRFY and EXPN.
42783 Configurations supporting these should inspect
42784 &$smtp_command_argument$& for an SMTPUTF8 argument.
42785
42786 There is no support for LMTP on Unix sockets.
42787 Using the "lmtp" protocol option on an smtp transport,
42788 for LMTP over TCP, should work as expected.
42789
42790 There is no support for DSN unitext handling,
42791 and no provision for converting logging from or to UTF-8.
42792
42793
42794
42795 .section "MDA operations" SECTi18nMDA
42796 To aid in constructing names suitable for IMAP folders
42797 the following expansion operator can be used:
42798 .code
42799 ${imapfolder {<string>} {<sep>} {<specials>}}
42800 .endd
42801
42802 The string is converted from the charset specified by
42803 the "headers charset" command (in a filter file)
42804 or &%headers_charset%& main configuration option (otherwise),
42805 to the
42806 modified UTF-7 encoding specified by RFC 2060,
42807 with the following exception: All occurrences of <sep>
42808 (which has to be a single character)
42809 are replaced with periods ("."), and all periods and slashes that are not
42810 <sep> and are not in the <specials> string are BASE64 encoded.
42811
42812 The third argument can be omitted, defaulting to an empty string.
42813 The second argument can be omitted, defaulting to "/".
42814
42815 This is the encoding used by Courier for Maildir names on disk, and followed
42816 by many other IMAP servers.
42817
42818 Examples:
42819 .display
42820 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42821 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42822 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42823 .endd
42824
42825 Note that the source charset setting is vital, and also that characters
42826 must be representable in UTF-16.
42827
42828
42829 . ////////////////////////////////////////////////////////////////////////////
42830 . ////////////////////////////////////////////////////////////////////////////
42831
42832 .chapter "Events" "CHAPevents" &&&
42833          "Events"
42834 .cindex events
42835
42836 The events mechanism in Exim can be used to intercept processing at a number
42837 of points.  It was originally invented to give a way to do customised logging
42838 actions (for example, to a database) but can also be used to modify some
42839 processing actions.
42840
42841 Most installations will never need to use Events.
42842 The support can be left out of a build by defining DISABLE_EVENT=yes
42843 in &_Local/Makefile_&.
42844
42845 There are two major classes of events: main and transport.
42846 The main configuration option &%event_action%& controls reception events;
42847 a transport option &%event_action%& controls delivery events.
42848
42849 Both options are a string which is expanded when the event fires.
42850 An example might look like:
42851 .cindex logging custom
42852 .code
42853 event_action = ${if eq {msg:delivery}{$event_name} \
42854 {${lookup pgsql {SELECT * FROM record_Delivery( \
42855     '${quote_pgsql:$sender_address_domain}',\
42856     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42857     '${quote_pgsql:$domain}', \
42858     '${quote_pgsql:${lc:$local_part}}', \
42859     '${quote_pgsql:$host_address}', \
42860     '${quote_pgsql:${lc:$host}}', \
42861     '${quote_pgsql:$message_exim_id}')}} \
42862 } {}}
42863 .endd
42864
42865 Events have names which correspond to the point in process at which they fire.
42866 The name is placed in the variable &$event_name$& and the event action
42867 expansion must check this, as it will be called for every possible event type.
42868
42869 The current list of events is:
42870 .itable all 0 0 4 25* left 10* center 15* center 50* left
42871 .row auth:fail              after    both       "per driver per authentication attempt"
42872 .row dane:fail              after    transport  "per connection"
42873 .row msg:complete           after    main       "per message"
42874 .row msg:defer              after    transport  "per message per delivery try"
42875 .row msg:delivery           after    transport  "per recipient"
42876 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42877 .row msg:rcpt:defer         after    transport  "per recipient"
42878 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42879 .row msg:fail:delivery      after    transport  "per recipient"
42880 .row msg:fail:internal      after    main       "per recipient"
42881 .row tcp:connect            before   transport  "per connection"
42882 .row tcp:close              after    transport  "per connection"
42883 .row tls:cert               before   both       "per certificate in verification chain"
42884 .row tls:fail:connect       after    main       "per connection"
42885 .row smtp:connect           after    transport  "per connection"
42886 .row smtp:ehlo              after    transport  "per connection"
42887 .endtable
42888 New event types may be added in future.
42889
42890 The event name is a colon-separated list, defining the type of
42891 event in a tree of possibilities.  It may be used as a list
42892 or just matched on as a whole.  There will be no spaces in the name.
42893
42894 The second column in the table above describes whether the event fires
42895 before or after the action is associates with.  Those which fire before
42896 can be used to affect that action (more on this below).
42897
42898 The third column in the table above says what section of the configuration
42899 should define the event action.
42900
42901 An additional variable, &$event_data$&, is filled with information varying
42902 with the event type:
42903 .itable all 0 0 2 20* left 80* left
42904 .row auth:fail            "smtp response"
42905 .row dane:fail            "failure reason"
42906 .row msg:defer            "error string"
42907 .row msg:delivery         "smtp confirmation message"
42908 .row msg:fail:internal    "failure reason"
42909 .row msg:fail:delivery    "smtp error message"
42910 .row msg:host:defer       "error string"
42911 .row msg:rcpt:host:defer  "error string"
42912 .row msg:rcpt:defer       "error string"
42913 .row tls:cert             "verification chain depth"
42914 .row tls:fail:connect     "error string"
42915 .row smtp:connect         "smtp banner"
42916 .row smtp:ehlo            "smtp ehlo response"
42917 .endtable
42918
42919 The :defer events populate one extra variable: &$event_defer_errno$&.
42920
42921 For complex operations an ACL expansion can be used in &%event_action%&,
42922 however due to the multiple contexts that Exim operates in during
42923 the course of its processing:
42924 .ilist
42925 variables set in transport events will not be visible outside that
42926 transport call
42927 .next
42928 acl_m variables in a server context are lost on a new connection,
42929 and after smtp helo/ehlo/mail/starttls/rset commands
42930 .endlist
42931 Using an ACL expansion with the logwrite modifier can be
42932 a useful way of writing to the main log.
42933
42934 The expansion of the event_action option should normally
42935 return an empty string.  Should it return anything else the
42936 following will be forced:
42937 .itable all 0 0 2 20* left 80* left
42938 .row auth:fail        "log information to write"
42939 .row tcp:connect      "do not connect"
42940 .row tls:cert         "refuse verification"
42941 .row smtp:connect     "close connection"
42942 .endtable
42943 All other message types ignore the result string, and
42944 no other use is made of it.
42945
42946 For a tcp:connect event, if the connection is being made to a proxy
42947 then the address and port variables will be that of the proxy and not
42948 the target system.
42949
42950 For tls:cert events, if GnuTLS is in use this will trigger only per
42951 chain element received on the connection.
42952 For OpenSSL it will trigger for every chain element including those
42953 loaded locally.
42954
42955 . ////////////////////////////////////////////////////////////////////////////
42956 . ////////////////////////////////////////////////////////////////////////////
42957
42958 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42959          "Adding drivers or lookups"
42960 .cindex "adding drivers"
42961 .cindex "new drivers, adding"
42962 .cindex "drivers" "adding new"
42963 The following actions have to be taken in order to add a new router, transport,
42964 authenticator, or lookup type to Exim:
42965
42966 .olist
42967 Choose a name for the driver or lookup type that does not conflict with any
42968 existing name; I will use &"newdriver"& in what follows.
42969 .next
42970 Add to &_src/EDITME_& the line:
42971 .display
42972 <&'type'&>&`_NEWDRIVER=yes`&
42973 .endd
42974 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42975 code is not to be included in the binary by default, comment this line out. You
42976 should also add any relevant comments about the driver or lookup type.
42977 .next
42978 Add to &_src/config.h.defaults_& the line:
42979 .code
42980 #define <type>_NEWDRIVER
42981 .endd
42982 .next
42983 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42984 and create a table entry as is done for all the other drivers and lookup types.
42985 .next
42986 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42987 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42988 Add your &`NEWDRIVER`& to that list.
42989 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42990 simple form that most lookups have.
42991 .next
42992 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42993 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42994 driver or lookup type and add it to the definition of OBJ.
42995 .next
42996 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42997 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42998 .next
42999 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43000 &_src_&.
43001 .next
43002 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43003 as for other drivers and lookups.
43004 .endlist
43005
43006 Then all you need to do is write the code! A good way to start is to make a
43007 proforma by copying an existing module of the same type, globally changing all
43008 occurrences of the name, and cutting out most of the code. Note that any
43009 options you create must be listed in alphabetical order, because the tables are
43010 searched using a binary chop procedure.
43011
43012 There is a &_README_& file in each of the sub-directories of &_src_& describing
43013 the interface that is expected.
43014
43015
43016
43017
43018 . ////////////////////////////////////////////////////////////////////////////
43019 . ////////////////////////////////////////////////////////////////////////////
43020
43021 . /////////////////////////////////////////////////////////////////////////////
43022 . These lines are processing instructions for the Simple DocBook Processor that
43023 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43024 . PDFs than using xmlto and fop. They will be ignored by all other XML
43025 . processors.
43026 . /////////////////////////////////////////////////////////////////////////////
43027
43028 .literal xml
43029 <?sdop
43030   format="newpage"
43031   foot_right_recto="&chaptertitle;"
43032   foot_right_verso="&chaptertitle;"
43033 ?>
43034 .literal off
43035
43036 .makeindex "Options index"   "option"
43037 .makeindex "Variables index" "variable"
43038 .makeindex "Concept index"   "concept"
43039
43040
43041 . /////////////////////////////////////////////////////////////////////////////
43042 . /////////////////////////////////////////////////////////////////////////////